Merge pull request #81 from Koatty/3.x

3.x

Author: richenlin

.rollup.config.js

@@ -1,9 +1,11 @@
-/*
+/**
+ * 
  * @Description: 
- * @Usage: 
  * @Author: richen
- * @Date: 2021-12-17 10:20:44
- * @LastEditTime: 2025-03-15 18:06:51
+ * @Date: 2024-11-07 11:22:26
+ * @LastEditTime: 2025-04-02 15:05:36
+ * @License: BSD (3-Clause)
+ * @Copyright (c): <richenlin(at)gmail.com>
  */
 import commonjs from '@rollup/plugin-commonjs';
 import json from "@rollup/plugin-json";
@@ -12,7 +14,7 @@ import { builtinModules } from 'module';
 import del from "rollup-plugin-delete";
 import typescript from 'rollup-plugin-typescript2';
 // import babel from '@rollup/plugin-babel';
-// import terser from '@rollup/plugin-terser';
+import terser from "@rollup/plugin-terser";
 const pkg = require('./package.json');
 
 export default [
@@ -28,7 +30,7 @@ export default [
         format: 'es',
         file: './dist/index.mjs',
         banner: require('./scripts/copyright'),
-      },
+      }
     ],
     plugins: [
       del({ targets: ["dist/*", "temp/*", "docs/api"] }),
@@ -51,11 +53,24 @@ export default [
           }
         }
       }),
-      // terser({
-      //   format: { comments: false },
-      //   compress: false,
-      //   mangle: false
-      // }),
+      terser({
+        compress: {
+          defaults: false,   // 改为 `false`（新版本默认启用所有优化）
+          arrows: true,      // 保留箭头函数转换
+          booleans: true,    // 保留布尔简化
+          drop_console: false, // 保留 console
+          keep_fnames: true  // 保留函数名
+        },
+        mangle: {
+          reserved: ['$super'], // 保留关键字
+          keep_classnames: true // 保留类名
+        },
+        format: {
+          beautify: true,    // 启用格式化
+          indent_level: 2,    // 缩进层级
+          comments: /@Author|@License|@Copyright/ // 保留特定注释  
+        }
+      })
     ],
     external: [
       ...builtinModules, // 排除 Node.js 内置模块
@@ -64,4 +79,4 @@ export default [
     ],
   },
 
-]
+]

CHANGELOG.md

@@ -3,30 +3,31 @@
 [![npm version](https://img.shields.io/npm/v/koatty)](https://www.npmjs.com/package/koatty)
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 
-Koa2 + Typescript + IOC = koatty. **Koatty** is a progressive Node.js framework for building efficient and scalable server-side applications. Perfect for crafting enterprise-level APIs, microservices, and full-stack applications with TypeScript excellence.
+Koa2 + TypeScript + IOC = Koatty. **Koatty** is a progressive Node.js framework for building efficient and scalable server-side applications. It's perfect for crafting enterprise-level APIs, microservices, and full-stack applications with TypeScript excellence.
 
 ## Why Koatty? 💡
 
 - 🚄 **High Performance**: Built on top of Koa2 with optimized architecture
-- 🧩 **Full-Featured**: Supports gRPC, HTTP, WebSocket, Schedule tasks, and more
+- 🧩 **Full-Featured**: Supports gRPC, HTTP, WebSocket, scheduled tasks, and more
 - 🧠 **TypeScript First**: Native TypeScript support with elegant OOP design
 - 🌀 **Spring-like IOC Container**: Powerful dependency injection system with autowiring
 - ✂️ **AOP Support**: Aspect-oriented programming with decorator-based interceptors
 - 🔌 **Extensible Architecture**: Plugin system with dependency injection
-- 📦 **Modern Tooling**: CLI scaffolding, testing utilities, and production-ready configs
+- 📦 **Modern Tooling**: CLI scaffolding, testing utilities, and production-ready configurations
 - 🌐 **Protocol Agnostic**: Write once, deploy as HTTP/gRPC/WebSocket services
 
+## New Features ✨
 
-## New features ✨
-
-* HTTP、HTTPS、HTTP2、gRPC、WebSocket server.✔️
-* Support loading configurations based on the environment, support command-line argument parsing(process.argv), and support environment variable parsing(process.env).✔️
-* `@ExceptionHandler()` Register global exception handling.✔️
-* Graceful shutdown and pre-exit event.✔️
-* Supports custom decorators, bound to app events for execution.✔️
-* GraphQL supporting. ✔️
-* OpenTelemetry . 💪
-
+- HTTP, HTTPS, HTTP2, gRPC, and WebSocket server support ✔️
+- Environment-based configuration loading, command-line argument parsing (process.argv), and environment variable parsing (process.env) ✔️
+- `@ExceptionHandler()` for global exception handling ✔️
+- Graceful shutdown and pre-exit events ✔️
+- Custom decorators bound to app events ✔️
+- GraphQL integration ✔️
+- Full-stack tracing through OpenTelemetry ✔️
+- Middleware binding to controllers and method routes ✔️
+- gRPC streaming support ✔️
+- Swagger OpenAPI 3.0 support 💪
 
 ## Core Features ✨
 
@@ -35,7 +36,7 @@ Koa2 + Typescript + IOC = koatty. **Koatty** is a progressive Node.js framework
 // config/config.ts
 export default {
   ...
-  protocol: "grpc", // Server protocol 'http' | 'https' | 'http2' | 'grpc' | 'ws' | 'wss'
+  protocol: "grpc", // Server protocol 'http' | 'https' | 'http2' | 'grpc' | 'ws' | 'wss' | 'graphql'
   ...
 }
 ```
@@ -53,6 +54,8 @@ export class UserService {
 export class IndexController {
     app: App;
     ctx: KoattyContext;
+    @Config("protocol")
+    conf: { protocol: string };
     ...
 
     @Autowired()
@@ -66,7 +69,7 @@ export class IndexController {
 ```
 
 ### ✂️ Aspect-Oriented Programming
-```javascript
+```typescript
 @Aspect()
 export class LogAspect implements IAspect {
   app: App;
@@ -79,11 +82,17 @@ export class LogAspect implements IAspect {
 // Apply aspect to controller
 @Controller()
 @BeforeEach(LogAspect)
-export class UserController {}
+export class UserController {
+  ...
+  @After(LogAspect)
+  test() {
+    ...
+  }
+}
 ```
 
 ### 🔌 Plugin System
-```javascript
+```typescript
 // plugin/logger.ts
 export class LoggerPlugin implements IPlugin {
   app: App;
@@ -96,7 +105,6 @@ export class LoggerPlugin implements IPlugin {
 }
 ```
 
-
 ## Benchmarks 📊
 
 | Framework  | Requests/sec | Latency | Memory Usage |
@@ -115,7 +123,6 @@ export class LoggerPlugin implements IPlugin {
 - [Recipes & Best Practices](https://github.com/Koatty/koatty_awesome)
 - [Example](https://github.com/Koatty/koatty_demo)
 
-
 ## Quick Start ⚡
 
 1. **Install CLI**:
@@ -134,7 +141,6 @@ cd awesome-app
 npm run dev
 ```
 
-
 ## Community 🌍
 
 - [GitHub Discussions](https://github.com/Koatty/koatty/discussions)
@@ -145,7 +151,6 @@ Thanks to these amazing developers:
 
 <!-- Add contributor list here -->
 
-
 ## License 📄
 
 BSD-3 © [Koatty Team](https://github.com/Koatty)

README.md

@@ -7,16 +7,5 @@
  */
 export default {
   /*app config*/
-  app_port: 3000, // Listening port
-  app_host: "", // Hostname
-  protocol: "http", // Server protocol 'http' | 'https' | 'http2' | 'grpc' | 'ws' | 'wss' | 'graphql'
-  open_trace: true, // Full stack debug & trace, default: false
-  http_timeout: 10, // HTTP request timeout time(seconds)
-  key_file: "", // HTTPS certificate key
-  crt_file: "", // HTTPS certificate crt
-  encoding: "utf-8", // Character Encoding
 
-  logs_level: "debug", // Level log is printed to the console, "debug" | "info" | "warning" | "error"
-  // logs_path: "./logs", // Log file directory
-  // sens_fields: ["password"] // Sensitive words
 };

demo/src/config/config.ts

@@ -10,11 +10,11 @@ export default {
   list: [], //加载的中间件列表
   config: { //中间件配置
     // 静态服务器中间件默认未开启
-    StaticMiddleware: false,
+    // StaticMiddleware: false,
     // 需要开启请修改为:
-    // StaticMiddleware: {
-    //     cache: true
-    // },
+    StaticMiddleware: {
+      cache: true
+    },
 
     SessionMiddleware: {
       key: 'koa.sess', /** (string) cookie key (default is koa.sess) */

demo/src/config/middleware.ts

@@ -12,7 +12,7 @@
 
 
 // @Middleware()
-// export class SessionMiddleware implements IMiddleware {
+// export class SessionMiddleware {
 //   run(options: any, app: App) {
 //     return session(options, app);
 //   }

demo/src/middleware/SessionMiddleware.ts

@@ -9,7 +9,7 @@ import { App } from '../App';
 // import { Static } from "koatty_static";
 
 @Middleware()
-export class StaticMiddleware implements IMiddleware {
+export class StaticMiddleware {
   run(options: any, app: App) {
     return function (ctx: KoattyContext, next: KoattyNext) {
       return next();

demo/src/middleware/StaticMiddleware.ts

@@ -1,29 +1,29 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md)
-
-## API Reference
-
-## Packages
-
-<table><thead><tr><th>
-
-Package
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[koatty](./koatty.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+<table><thead><tr><th>
+
+Package
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[koatty](./koatty.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>