@fastcar/cli 0.1.2 → 0.1.4

package/skills/fastcar-framework/SKILL.md

@@ -1,856 +1,577 @@
----
-name: fastcar-framework
-description: FastCar 是一个基于 TypeScript 的 Node.js 企业级应用开发框架，采用 IoC（控制反转）设计思想，提供模块化、可扩展的架构支持。Use when working with FastCar framework for: (1) Creating IoC-based Node.js applications, (2) Using dependency injection with decorators (@Component, @Service, @Autowired), (3) Building web APIs with @fastcar/koa, (4) Database operations with MySQL/MongoDB/Redis, (5) Setting up scheduled tasks or worker pools, (6) Managing application lifecycle and configuration, (7) Selecting and configuring project templates (web, rpc, cos, static, microservices), (8) Writing application.yml for different templates.
----
-
-# FastCar Framework
-
-FastCar 是基于 TypeScript 的 Node.js 企业级应用开发框架，灵感来源于 Spring Boot，采用 IoC（控制反转）设计思想。
-
-## 核心概念
-
-### IoC 容器与装饰器
-
-| 装饰器 | 用途 | 示例 |
-|--------|------|------|
-| `@Application` | 入口应用类 | `@Application class App {}` |
-| `@Component` | 通用组件 | `@Component class UtilService {}` |
-| `@Service` | 服务层 | `@Service class UserService {}` |
-| `@Controller` | 控制器层 | `@Controller class UserController {}` |
-| `@Repository` | 数据访问层 | `@Repository class UserRepository {}` |
-| `@Autowired` | 依赖注入 | `@Autowired private userService!: UserService;` |
-
-### 基础应用结构
-
-```typescript
-import { FastCarApplication } from "@fastcar/core";
-import { Application, Autowired, Component, Service } from "@fastcar/core/annotation";
-
-// 服务层
-@Service
-class UserService {
-  getUsers() {
-    return [{ id: 1, name: "Alice" }];
-  }
-}
-
-// 控制器层
-@Controller
-class UserController {
-  @Autowired
-  private userService!: UserService;
-  
-  getUsers() {
-    return this.userService.getUsers();
-  }
-}
-
-// 应用入口
-@Application
-class App {
-  app!: FastCarApplication;
-  
-  async start() {
-    console.log("应用启动成功!");
-  }
-}
-
-// 启动
-const app = new App();
-app.start();
-```
-
-## 模块速查
-
-### Web 开发 (@fastcar/koa)
-
-**正确的路由装饰器使用方式：**
-
-```typescript
-import { GET, POST, REQUEST } from "@fastcar/koa/annotation";
-
-@Controller
-@REQUEST("/api/users")
-class UserController {
-  // GET 请求 - 无路径参数时必须有括号
-  @GET()
-  async list() {
-    return { data: [] };
-  }
-  
-  // GET 请求 - 有路径参数
-  @GET("/:id")
-  async getById(id: string) {
-    return { id };
-  }
-  
-  // POST 请求
-  @POST()
-  async create(body: UserDTO) {
-    return { created: true };
-  }
-}
-```
-
-**⚠️ 重要：FastCar 没有 `@Body`, `@Param`, `@Query` 装饰器**
-
-- 请求参数直接作为方法参数传入
-- GET 请求参数通过方法参数直接获取
-- POST 请求体通过 `body` 参数获取
-- 路径参数通过方法参数直接获取
-
-### 数据库 (@fastcar/mysql)
-
-**实体定义：**
-
-```typescript
-import { Table, Field, DBType, PrimaryKey, NotNull, Size } from "@fastcar/core/annotation";
-
-@Table("users")
-class User {
-  @Field("id")
-  @DBType("int")
-  @PrimaryKey
-  id!: number;
-  
-  @Field("name")
-  @DBType("varchar")
-  @NotNull
-  @Size({ maxSize: 50 })
-  name!: string;
-}
-```
-
-**Mapper 定义：**
-
-```typescript
-import { Entity, Repository } from "@fastcar/core/annotation";
-import { MysqlMapper } from "@fastcar/mysql";
-
-@Entity(User)
-@Repository
-class UserMapper extends MysqlMapper<User> {}
-
-export default UserMapper;
-```
-
-**Service 中使用：**
-
-```typescript
-import { Service, Autowired } from "@fastcar/core/annotation";
-import { OrderEnum } from "@fastcar/core/db";
-import UserMapper from "./UserMapper";
-
-@Service
-class UserService {
-  @Autowired
-  private userMapper!: UserMapper;
-
-  // 查询列表
-  async getUsers() {
-    return this.userMapper.select({
-      where: { status: 1 },
-      orders: { createTime: OrderEnum.desc },
-      limit: 10
-    });
-  }
-
-  // 查询单个
-  async getUser(id: number) {
-    return this.userMapper.selectOne({ where: { id } });
-  }
-
-  // 根据主键查询
-  async getUserById(id: number) {
-    return this.userMapper.selectByPrimaryKey({ id } as User);
-  }
-
-  // 插入
-  async createUser(user: User) {
-    return this.userMapper.saveOne(user);
-  }
-
-  // 更新
-  async updateUser(id: number, data: Partial<User>) {
-    return this.userMapper.update({ where: { id }, row: data });
-  }
-
-  // 根据主键更新
-  async updateById(user: User) {
-    return this.userMapper.updateByPrimaryKey(user);
-  }
-
-  // 删除
-  async deleteUser(id: number) {
-    return this.userMapper.delete({ where: { id } });
-  }
-
-  // 统计
-  async count() {
-    return this.userMapper.count({});
-  }
-}
-```
-
-### 表单验证 (@fastcar/core)
-
-**正确的表单验证方式：**
-
-```typescript
-import { ValidForm, NotNull, Size, Rule } from "@fastcar/core/annotation";
-
-// DTO 类定义在单独的文件中，如 dto/UserDTO.ts
-class UserDTO {
-  @NotNull
-  name!: string;
-  
-  @Size({ minSize: 1, maxSize: 150 })
-  age!: number;
-}
-
-@Controller
-@REQUEST("/api/users")
-class UserController {
-  
-  // GET 请求 - 无需表单验证
-  @GET()
-  async list(page: number = 1, pageSize: number = 10) {
-    return { page, pageSize, data: [] };
-  }
-
-  // POST 请求 - 使用 @ValidForm + @Rule 进行表单验证
-  @ValidForm
-  @POST()
-  async create(@Rule() body: UserDTO) {
-    // 参数会自动校验，如果校验失败会抛出异常
-    const { name, age } = body;
-    return this.userService.create({ name, age });
-  }
-}
-```
-
-**表单验证规则：**
-
-| 装饰器 | 用途 | 示例 |
-|--------|------|------|
-| `@ValidForm` | 开启方法参数校验 | 放在方法上 |
-| `@Rule()` | 标记校验对象 | 放在 DTO 参数前 |
-| `@NotNull` | 参数不能为空 | 放在 DTO 字段上 |
-| `@Size({min, max})` | 大小限制 | 放在 DTO 字段上 |
-
-**⚠️ 常见错误：**
-
-❌ **错误** - 使用不存在的装饰器：
-```typescript
-// 这些装饰器在 FastCar 中不存在！
-import { Body, Param, Query } from "@fastcar/koa/annotation"; // ❌ 错误
-
-@GET("/:id")
-async getById(@Param("id") id: string) { ... } // ❌ 错误
-
-@POST()
-async create(@Body body: UserDTO) { ... } // ❌ 错误
-```
-
-✅ **正确** - 直接使用方法参数：
-```typescript
-@GET("/:id")
-async getById(id: string) { ... } // ✅ 正确
-
-@POST()
-async create(body: UserDTO) { ... } // ✅ 正确
-
-@GET()
-async list(page: number = 1) { ... } // ✅ 正确
-```
-
-### Redis (@fastcar/redis)
-
-```typescript
-import { Service, Autowired } from "@fastcar/core/annotation";
-import { RedisClient } from "@fastcar/redis/annotation";
-
-@Service
-class CacheService {
-  @RedisClient
-  private redis!: RedisClient;
-  
-  async get(key: string) {
-    return this.redis.get(key);
-  }
-  
-  async set(key: string, value: string, ttl?: number) {
-    await this.redis.set(key, value, ttl);
-  }
-}
-```
-
-### 定时任务 (@fastcar/timer)
-
-```typescript
-import { Scheduled, Cron } from "@fastcar/timer/annotation";
-
-@Component
-class TaskService {
-  // 间隔执行（毫秒）
-  @Scheduled(60000)
-  async intervalTask() {
-    console.log("每分钟执行");
-  }
-  
-  // Cron 表达式
-  @Cron("0 0 * * * *")
-  async hourlyTask() {
-    console.log("每小时执行");
-  }
-}
-```
-
-### 工作线程池 (@fastcar/workerpool)
-
-```typescript
-import { WorkerPool, WorkerTask } from "@fastcar/workerpool/annotation";
-
-@Component
-class ComputeService {
-  @WorkerPool({ minWorkers: 2, maxWorkers: 4 })
-  private pool!: WorkerPool;
-  
-  @WorkerTask
-  heavyComputation(data: number[]): number {
-    // 在 worker 线程中执行
-    return data.reduce((a, b) => a + b, 0);
-  }
-}
-```
-
-## 项目模板速查
-
-FastCar CLI 提供 5 种项目模板，分别适用于不同的业务场景。
-
-### 模板选择指南
-
-| 模板 | 适用场景 | 核心依赖 | 关键注解 |
-|------|---------|---------|---------|
-| web | RESTful API 服务 | @fastcar/koa, @fastcar/server | @EnableKoa |
-| static | 静态资源服务器 | @fastcar/koa, @fastcar/server | @EnableKoa + KoaStatic |
-| rpc | RPC 微服务通信 | @fastcar/rpc, @fastcar/server | @EnableRPC |
-| cos | 对象存储/文件上传/直播转码 | @fastcar/koa, @fastcar/cossdk, @fastcar/server | @EnableKoa |
-| microservices | 分布式多服务架构 | @fastcar/koa, @fastcar/rpc, @fastcar/server, @fastcar/timer | @EnableKoa / @EnableRPC（按服务模块） |
-
-### 各模板入口示例
-
-#### Web 模板
-```typescript
-import { FastCarApplication } from "@fastcar/core";
-import { Application } from "@fastcar/core/annotation";
-import { EnableKoa, KoaMiddleware } from "@fastcar/koa/annotation";
-import { ExceptionGlobalHandler, KoaBodyParser } from "@fastcar/koa";
-
-@Application
-@EnableKoa
-@KoaMiddleware(ExceptionGlobalHandler)
-@KoaMiddleware(KoaBodyParser)
-class APP {
-  app!: FastCarApplication;
-}
-export default new APP();
-```
-
-#### Static 模板
-```typescript
-import { Application } from "@fastcar/core/annotation";
-import { EnableKoa, KoaMiddleware } from "@fastcar/koa/annotation";
-import { ExceptionGlobalHandler, KoaStatic } from "@fastcar/koa";
-
-@Application
-@EnableKoa
-@KoaMiddleware(ExceptionGlobalHandler)
-@KoaMiddleware(KoaStatic)
-class APP {
-  app!: any;
-}
-export default new APP();
-```
-
-#### RPC 模板
-```typescript
-import { Application } from "@fastcar/core/annotation";
-import { EnableRPC } from "@fastcar/rpc/annotation";
-
-@Application
-@EnableRPC
-class APP {}
-export default new APP();
-```
-
-#### COS 模板
-```typescript
-import { Application } from "@fastcar/core/annotation";
-import { EnableKoa, KoaMiddleware } from "@fastcar/koa/annotation";
-import { ExceptionGlobalHandler, KoaBody, KoaBodyParser, KoaCors } from "@fastcar/koa";
-
-@EnableKoa
-@Application
-@KoaMiddleware(ExceptionGlobalHandler, KoaBody, KoaBodyParser, KoaCors)
-class APP {}
-export default new APP();
-```
-
-#### Microservices 模板
-微服务模板采用多服务架构，包含 `app-node.ts`（子进程启动多服务）和 `app-pm2.ts`（PM2 启动入口）。服务模块分为：
-- **center**：服务中心，提供服务注册与发现
-- **connector**：连接器服务，处理客户端连接
-- **chat**：聊天服务，处理实时消息
-- **web**：Web 服务，提供 HTTP 接口
-- **base**：基础服务，提供公共功能
-
-各服务模块内部根据职责使用 `@EnableKoa` 或 `@EnableRPC`。
-
-### 项目结构示例
-
-**Web / Static / RPC / COS 模板**
-```
-template/
-├── src/
-│   ├── controller/       # 控制器（web/cos）
-│   ├── dto/              # DTO 类（表单验证）
-│   ├── middleware/       # 中间件（web/cos）
-│   ├── model/            # 数据模型
-│   └── app.ts            # 应用入口
-├── resource/
-│   └── application.yml   # 配置文件
-├── target/               # 编译输出
-├── package.json
-├── tsconfig.json
-└── ecosystem.config.yml
-```
-
-**Microservices 模板**
-```
-template/
-├── src/
-│   ├── annotation/       # 注解定义
-│   ├── common/           # 公共代码
-│   ├── middleware/       # 中间件
-│   ├── servers/          # 服务目录
-│   │   ├── base/         # 基础服务
-│   │   ├── center/       # 服务中心
-│   │   ├── chat/         # 聊天服务
-│   │   ├── connector/    # 连接器服务
-│   │   └── web/          # Web 服务
-│   ├── types/            # 类型定义
-│   ├── utils/            # 工具函数
-│   ├── app-node.ts       # 单节点入口（子进程启动）
-│   └── app-pm2.ts        # PM2 入口
-├── resource/
-│   ├── application.yml
-│   ├── application-dev.yml
-│   └── ecosystem.config.yml
-├── test/
-├── package.json
-└── tsconfig.json
-```
-
-### 模板依赖安装
-
-```bash
-# Web / Static
-npm i @fastcar/core @fastcar/koa @fastcar/server
-
-# RPC
-npm i @fastcar/core @fastcar/rpc @fastcar/server
-
-# COS
-npm i @fastcar/core @fastcar/koa @fastcar/cossdk @fastcar/server
-
-# Microservices
-npm i @fastcar/core @fastcar/koa @fastcar/rpc @fastcar/server @fastcar/timer
-```
-
-## 配置管理
-
-配置文件放在 `resource/application.yml`。FastCar 支持按 `env` 加载多文件，例如 `application-dev.yml` 会与主配置合并。
-
-### 基础配置示例
-
-```yaml
-application:
-  name: my-app
-  version: 1.0.0
-  env: dev
-
-mysql:
-  host: localhost
-  port: 3306
-  database: mydb
-  username: root
-  password: password
-
-redis:
-  host: localhost
-  port: 6379
-```
-
-使用配置：
-
-```typescript
-import { Configure, Value } from "@fastcar/core/annotation";
-
-@Configure
-class AppConfig {
-  @Value("server.port")
-  port!: number;
-
-  @Value("mysql.host")
-  dbHost!: string;
-}
-```
-
-### 各模板 application.yml 详解
-
-#### Web / Static / COS 通用 Koa 配置
-
-```yaml
-application:
-  env: "dev"
-
-settings:
-  koa:
-    server:
-      - { port: 8080, host: "0.0.0.0" }
-      # HTTPS 示例：
-      # - { port: 443, host: "0.0.0.0", protocol: https, ssl: { key: "./ssl/server.key", cert: "./ssl/server.pem" } }
-    koaStatic: # 静态资源映射
-      { "public": "public" } # 别名: 路径（相对 resource 目录或绝对路径）
-    koaBodyParser: # 请求体解析
-      enableTypes: ["json", "form", "text"]
-      extendTypes: { text: ["text/xml", "application/xml"] }
-```
-
-- `settings.koa.server`：服务器监听配置数组。支持 `http`（默认）、`http2`、`https`；启用 HTTPS 时需额外指定 `protocol: https` 和 `ssl.key / ssl.cert`。
-- `settings.koa.koaStatic`：静态资源访问映射，格式为 `{ "别名": "路径" }`。
-- `settings.koa.koaBodyParser`：Koa Body 解析器配置，`enableTypes` 控制允许的请求体类型，`extendTypes` 可扩展 XML 等特殊类型。
-
-#### RPC 模板配置
-
-```yaml
-application:
-  name: "fastcar-boot-rpc"
-
-settings:
-  rpc:
-    list:
-      - id: "server-1"
-        type: "ws"              # 通信协议：ws / http / grpc / mqtt
-        server: { port: 1235 }
-        extra: {}
-        serviceType: "base"     # 服务类型分类
-        secure:
-          username: "user"
-          password: "123456"
-```
-
-- `settings.rpc.list`：RPC 服务端点数组。
-  - `id`：节点唯一标识。
-  - `type`：通信协议，常见取值 `ws`、`http`、`grpc`、`mqtt`。
-  - `server`：监听配置，通常只写 `{ port }`。
-  - `extra`：协议扩展参数。
-  - `serviceType`：服务类型，用于服务分组或路由。
-  - `secure`：安全认证信息，包含 `username` 和 `password`。
-
-#### COS 模板特有配置
-
-```yaml
-application:
-  env: "prod"
-
-settings:
-  hotterSysConfig: true # 启用系统配置热更新监听
-```
-
-- `settings.hotterSysConfig`：设为 `true` 时，框架会监听配置变更并自动热更新。
-
-#### Microservices 模板配置
-
-主配置通常只声明环境：
-
-```yaml
-application:
-  env: "dev"
-```
-
-详细集群配置放在 `application-dev.yml`：
-
-```yaml
-settings:
-  hotterSysConfig: true # 监听系统配置变更
-
-  microservices:
-    center: # 服务中心
-      token: "nW0tT4bZ6qM7mF7wD2rT2pR9dT7gK3hZ"
-      servers:
-        - host: "localhost"
-          clusters: 1 # 实例数，serviceId 和端口号自动递增
-          list:
-            - type: "ws"
-              server: { port: 60000 }
-              timeout: 0 # 0 表示永不超时
-              connectionLimit: 1
-              disconnectInterval: 1000 # 断线重连间隔（毫秒）
-              retry:
-                retryCount: 3
-                retryInterval: 3000
-                timeout: 30000
-                maxMsgNum: 10000
-                increase: true
-
-    connector: # 连接器服务
-      token: "x3TGsWC9uloZu235LA07eAiJ61nQ1A5f"
-      servers:
-        - host: "localhost"
-          clusters: 1
-          list:
-            - front: true # 标记为面向客户端的前置节点
-              type: "ws"
-              server: { port: 60100 }
-
-    chat: # 聊天服务
-      token: "go0kbkNM3wQ4e2Vgo0kbkNM3wQ4e2V"
-      servers:
-        - host: "localhost"
-          clusters: 1
-          list:
-            - type: "ws"
-              server: { port: 60200 }
-
-    web: # Web 服务
-      token: "go0kbkNM3wQ4e2Vgo0kbkNM3wQ4e2V"
-      koa:
-        koaBodyParser:
-          enableTypes: ["json", "form", "text"]
-          extendTypes: { text: ["text/xml", "application/xml"] }
-      servers:
-        - host: "localhost"
-          clusters: 1
-          list:
-            - type: "http"
-              server: { port: 8080 }
-            - type: "ws"
-              server: { port: 60300 }
-```
-
-- `settings.microservices.<服务名>`：定义各微服务模块的集群配置。
-  - `token`：服务间通信鉴权令牌，防止非法节点接入。
-  - `servers`：服务器集群列表。
-    - `host`：主机地址。
-    - `clusters`：集群实例数量。若大于 1，框架会自动递增 `serviceId` 和端口号生成多个实例。
-    - `list`：该集群对外暴露的协议端点列表。
-      - `type`：协议类型，如 `ws`、`http`。
-      - `server`：端口配置 `{ port }`。
-      - `front: true`：仅 connector 等前置服务需要，表示该节点直接面向客户端。
-      - `timeout`：连接超时时间（毫秒），`0` 表示永不超时。
-      - `connectionLimit`：最大连接数限制。
-      - `disconnectInterval`：断线后重连间隔（毫秒）。
-      - `retry`：消息重试策略。
-        - `retryCount`：最大重试次数。
-        - `retryInterval`：重试间隔。
-        - `timeout`：重试总超时。
-        - `maxMsgNum`：消息队列最大长度。
-        - `increase`：是否递增重试间隔。
-
-## 生命周期钩子
-
-```typescript
-import { ApplicationStart, ApplicationStop, ApplicationInit } from "@fastcar/core/annotation";
-
-@Component
-class LifecycleService {
-  // 应用启动时执行
-  @ApplicationStart
-  async onStart() {
-    console.log("应用启动");
-  }
-  
-  // 应用停止前执行
-  @ApplicationStop
-  async onStop() {
-    console.log("应用停止");
-  }
-  
-  // 初始化（配合 @ApplicationRunner）
-  @ApplicationInit
-  async init() {
-    console.log("初始化完成");
-  }
-}
-```
-
-## 工具类
-
-```typescript
-import { DateUtil, CryptoUtil, FileUtil, TypeUtil } from "@fastcar/core/utils";
-
-// 日期时间
-DateUtil.toDateTime(); // "2024-03-10 15:30:45"
-DateUtil.toDay();      // "2024-03-10"
-
-// 加密
-CryptoUtil.aesEncode(key, iv, "data");
-CryptoUtil.sha256Encode("password");
-
-// 文件操作
-FileUtil.getFilePathList("./src");
-FileUtil.getResource("./config.yml");
-
-// 类型判断
-TypeUtil.isFunction(() => {});  // true
-TypeUtil.isClass(MyClass);       // true
-```
-
-## 完整模块列表
-
-| 模块 | 安装命令 | 用途 |
-|------|----------|------|
-| @fastcar/core | `npm i @fastcar/core` | IoC 容器、配置管理 |
-| @fastcar/koa | `npm i @fastcar/koa @fastcar/server` | Web 开发 |
-| @fastcar/mysql | `npm i @fastcar/mysql` | MySQL 数据库 |
-| @fastcar/pgsql | `npm i @fastcar/pgsql` | PostgreSQL |
-| @fastcar/mongo | `npm i @fastcar/mongo` | MongoDB |
-| @fastcar/redis | `npm i @fastcar/redis` | Redis 缓存 |
-| @fastcar/cache | `npm i @fastcar/cache` | 缓存组件 |
-| @fastcar/timer | `npm i @fastcar/timer` | 定时任务 |
-| @fastcar/timewheel | `npm i @fastcar/timewheel` | 时间轮延时任务 |
-| @fastcar/workerpool | `npm i @fastcar/workerpool` | 工作线程池 |
-| @fastcar/rpc | `npm i @fastcar/rpc` | RPC 通信 |
-| @fastcar/serverless | `npm i @fastcar/serverless` | Serverless 支持 |
-| @fastcar/cos-sdk | `npm i @fastcar/cos-sdk` | 对象存储 |
-
-## 快速开始新项目
-
-### 使用 CLI 创建项目（推荐）
-
-```bash
-# Web 项目
-mkdir my-web-app && cd my-web-app
-fastcar-cli init web
-npm install
-npm run debug
-
-# Static 项目
-mkdir my-static-app && cd my-static-app
-fastcar-cli init static
-npm install
-npm run debug
-
-# RPC 项目
-mkdir my-rpc-app && cd my-rpc-app
-fastcar-cli init rpc
-npm install
-npm run debug
-
-# COS 项目
-mkdir my-cos-app && cd my-cos-app
-fastcar-cli init cos
-npm install
-npm run debug
-
-# Microservices 项目
-mkdir my-ms-app && cd my-ms-app
-fastcar-cli init microservices
-npm install
-npm run start-node   # 单节点模式（子进程启动全部服务）
-# 或
-npm run start-pm2    # PM2 模式
-```
-
-### 手动创建项目
-
-```bash
-# 1. 创建项目
-mkdir my-fastcar-app && cd my-fastcar-app
-npm init -y
-
-# 2. 安装依赖
-npm i @fastcar/core @fastcar/koa @fastcar/server
-npm i -D typescript ts-node @types/node
-
-# 3. 初始化 TypeScript
-npx tsc --init
-
-# 4. 启用装饰器（tsconfig.json）
-# "experimentalDecorators": true
-# "emitDecoratorMetadata": true
-
-# 5. 创建入口文件和配置文件，开始开发
-```
-
-## 常见错误与注意事项
-
-### 1. 路由装饰器必须有括号
-
-❌ **错误：**
-```typescript
-@GET
-async list() { }
-```
-
-✅ **正确：**
-```typescript
-@GET()
-async list() { }
-```
-
-### 2. 不要使用不存在的装饰器
-
-❌ **错误：**
-```typescript
-import { Body, Param, Query } from "@fastcar/koa/annotation";
-
-@GET("/:id")
-async getById(@Param("id") id: string) { }
-
-@POST()
-async create(@Body body: UserDTO) { }
-```
-
-✅ **正确：**
-```typescript
-@GET("/:id")
-async getById(id: string) { }
-
-@POST()
-async create(body: UserDTO) { }
-```
-
-### 3. 表单验证使用 @ValidForm + @Rule
-
-❌ **错误：**
-```typescript
-@POST()
-async create(@Body body: UserDTO) { }
-```
-
-✅ **正确：**
-```typescript
-@ValidForm
-@POST()
-async create(@Rule() body: UserDTO) { }
-```
-
-### 4. DTO 类放在单独文件夹
-
-推荐项目结构：
-```
-src/
-├── controller/     # 控制器
-├── dto/            # DTO 类（表单验证）
-├── service/        # 服务层
-├── model/          # 数据模型
-└── app.ts
-```
-
-## 参考资源
-
-- 详细 API 文档：[references/api-reference.md](references/api-reference.md)
-- 项目模板：[assets/project-template/](assets/project-template/)
+---
+name: fastcar-framework
+description: FastCar 是一个基于 TypeScript 的 Node.js 企业级应用开发框架，采用 IoC（控制反转）设计思想。Use when working with FastCar framework for: (1) Creating IoC-based Node.js applications, (2) Using dependency injection with decorators (@Component, @Service, @Autowired), (3) Building web APIs with @fastcar/koa, (4) Database operations with MySQL/MongoDB/Redis, (5) Setting up scheduled tasks or worker pools, (6) Managing application lifecycle and configuration.
+---
+
+# FastCar Framework
+
+FastCar 是基于 TypeScript 的 Node.js 企业级应用开发框架，采用 IoC（控制反转）设计思想。
+
+## 核心概念
+
+### IoC 容器与装饰器
+
+| 装饰器 | 用途 | 示例 |
+|--------|------|------|
+| `@Application` | 入口应用类 | `@Application class App {}` |
+| `@Component` | 通用组件 | `@Component class UtilService {}` |
+| `@Service` | 服务层 | `@Service class BizService {}` |
+| `@Controller` | 控制器层 | `@Controller class ApiController {}` |
+| `@Repository` | 数据访问层 | `@Repository class DataRepository {}` |
+| `@Autowired` | 依赖注入 | `@Autowired private service!: BizService;` |
+
+### 基础应用结构
+
+```typescript
+import { FastCarApplication } from "@fastcar/core";
+import { Application, Autowired, Component, Service, Controller } from "@fastcar/core/annotation";
+
+@Service
+class BizService {
+  getData() {
+    return [{ id: 1, name: "示例" }];
+  }
+}
+
+@Controller
+class ApiController {
+  @Autowired
+  private service!: BizService;
+  
+  getData() {
+    return this.service.getData();
+  }
+}
+
+@Application
+class App {
+  app!: FastCarApplication;
+  
+  async start() {
+    console.log("应用启动成功!");
+  }
+}
+
+const app = new App();
+app.start();
+```
+
+## 模块速查
+
+### Web 开发 (@fastcar/koa)
+
+**路由装饰器使用方式：**
+
+```typescript
+import { GET, POST, REQUEST } from "@fastcar/koa/annotation";
+import { Context } from "koa";
+
+@Controller
+@REQUEST("/api/items")
+class ItemController {
+  // GET 请求 - 无路径参数时必须有括号
+  @GET()
+  async list() {
+    return { data: [] };
+  }
+
+  // GET 请求 - 有路径参数
+  @GET("/:id")
+  async getById(id: string, ctx: Context) {
+    return { id };
+  }
+
+  // POST 请求
+  @POST()
+  async create(body: ItemDTO, ctx: Context) {
+    return { created: true };
+  }
+}
+```
+
+**⚠️ 重要：FastCar 没有 `@Body`, `@Param`, `@Query` 装饰器**
+
+- 请求参数直接作为方法参数传入
+- 第一个参数为请求数据（GET 的 query / POST 的 body / 路径参数）
+- 第二个参数为 Koa 上下文 `ctx: Context`，**可省略**
+- `Context` 需从 `koa` 导入：`import { Context } from "koa"`
+
+### 数据库 (@fastcar/mysql)
+
+**实体定义：**
+
+```typescript
+import { Table, Field, DBType, PrimaryKey, NotNull, Size } from "@fastcar/core/annotation";
+
+@Table("entities")
+class Entity {
+  @Field("id")
+  @DBType("int")
+  @PrimaryKey
+  id!: number;
+  
+  @Field("name")
+  @DBType("varchar")
+  @NotNull
+  @Size({ maxSize: 50 })
+  name!: string;
+}
+```
+
+**Mapper 定义：**
+
+```typescript
+import { Entity, Repository } from "@fastcar/core/annotation";
+import { MysqlMapper } from "@fastcar/mysql";
+
+@Entity(Entity)
+@Repository
+class EntityMapper extends MysqlMapper<Entity> {}
+export default EntityMapper;
+```
+
+**Service 中使用：**
+
+```typescript
+import { Service, Autowired } from "@fastcar/core/annotation";
+import { OrderEnum } from "@fastcar/core/db";
+import EntityMapper from "./EntityMapper";
+
+@Service
+class EntityService {
+  @Autowired
+  private mapper!: EntityMapper;
+
+  async getList() {
+    return this.mapper.select({
+      where: { status: 1 },
+      orders: { createTime: OrderEnum.desc },
+      limit: 10
+    });
+  }
+
+  async getOne(id: number) {
+    return this.mapper.selectOne({ where: { id } });
+  }
+
+  async create(data: Entity) {
+    return this.mapper.saveOne(data);
+  }
+
+  async update(id: number, data: Partial<Entity>) {
+    return this.mapper.update({ where: { id }, row: data });
+  }
+
+  async delete(id: number) {
+    return this.mapper.delete({ where: { id } });
+  }
+}
+```
+
+### 表单验证 (@fastcar/core)
+
+```typescript
+import { ValidForm, NotNull, Size, Rule } from "@fastcar/core/annotation";
+
+class ItemDTO {
+  @NotNull
+  name!: string;
+  
+  @Size({ minSize: 1, maxSize: 150 })
+  value!: number;
+}
+
+@Controller
+@REQUEST("/api/items")
+class ItemController {
+  @GET()
+  async list(page: number = 1, pageSize: number = 10) {
+    return { page, pageSize, data: [] };
+  }
+
+  @ValidForm
+  @POST()
+  async create(@Rule() body: ItemDTO) {
+    const { name, value } = body;
+    return this.service.create({ name, value });
+  }
+}
+```
+
+**表单验证规则：**
+
+| 装饰器 | 用途 | 示例 |
+|--------|------|------|
+| `@ValidForm` | 开启方法参数校验 | 放在方法上 |
+| `@Rule()` | 标记校验对象 | 放在 DTO 参数前 |
+| `@NotNull` | 参数不能为空 | 放在 DTO 字段上 |
+| `@Size({min, max})` | 大小限制 | 放在 DTO 字段上 |
+
+### Redis (@fastcar/redis)
+
+```typescript
+import { Service, Autowired } from "@fastcar/core/annotation";
+import { RedisClient } from "@fastcar/redis/annotation";
+
+@Service
+class CacheService {
+  @RedisClient
+  private redis!: RedisClient;
+  
+  async get(key: string) {
+    return this.redis.get(key);
+  }
+  
+  async set(key: string, value: string, ttl?: number) {
+    await this.redis.set(key, value, ttl);
+  }
+}
+```
+
+### 定时任务 (@fastcar/timer)
+
+> **推荐使用 `@fastcar/timer/scheduling2` 模块**
+
+```typescript
+import { ScheduledInterval, ScheduledCron } from "@fastcar/timer/scheduling2";
+
+@Component
+class TaskService {
+  // 间隔执行（毫秒）
+  @ScheduledInterval({ fixedRate: 60000 })
+  async intervalTask() {
+    console.log("每分钟执行");
+  }
+  
+  // Cron 表达式
+  @ScheduledCron("0 0 * * * *")
+  async hourlyTask() {
+    console.log("每小时执行");
+  }
+}
+```
+
+### 工作线程池 (@fastcar/workerpool)
+
+```typescript
+import { WorkerPool, WorkerTask } from "@fastcar/workerpool/annotation";
+
+@Component
+class ComputeService {
+  @WorkerPool({ minWorkers: 2, maxWorkers: 4 })
+  private pool!: WorkerPool;
+  
+  @WorkerTask
+  heavyComputation(data: number[]): number {
+    return data.reduce((a, b) => a + b, 0);
+  }
+}
+```
+
+## 项目模板速查
+
+FastCar CLI 提供 5 种项目模板：
+
+| 模板 | 适用场景 | 核心依赖 | 关键注解 |
+|------|---------|---------|---------|
+| web | RESTful API 服务 | @fastcar/koa, @fastcar/server | @EnableKoa |
+| static | 静态资源服务器 | @fastcar/koa, @fastcar/server | @EnableKoa + KoaStatic |
+| rpc | RPC 微服务通信 | @fastcar/rpc, @fastcar/server | @EnableRPC |
+| cos | 对象存储/文件上传 | @fastcar/koa, @fastcar/cossdk, @fastcar/server | @EnableKoa |
+| microservices | 分布式多服务架构 | @fastcar/koa, @fastcar/rpc, @fastcar/server, @fastcar/timer | @EnableKoa / @EnableRPC |
+
+### 各模板入口示例
+
+**Web 模板**
+```typescript
+import { Application } from "@fastcar/core/annotation";
+import { EnableKoa, KoaMiddleware } from "@fastcar/koa/annotation";
+import { ExceptionGlobalHandler, KoaBodyParser } from "@fastcar/koa";
+
+@Application
+@EnableKoa
+@KoaMiddleware(ExceptionGlobalHandler)
+@KoaMiddleware(KoaBodyParser)
+class APP {
+  app!: FastCarApplication;
+}
+export default new APP();
+```
+
+**RPC 模板**
+```typescript
+import { Application } from "@fastcar/core/annotation";
+import { EnableRPC } from "@fastcar/rpc/annotation";
+
+@Application
+@EnableRPC
+class APP {}
+export default new APP();
+```
+
+**Microservices 模板**
+微服务模板包含多服务架构：center（服务中心）、connector（连接器）、message（消息服务）、web（Web服务）、base（基础服务）。
+
+### 项目结构示例
+
+```
+template/
+├── src/
+│   ├── controller/       # 控制器（web/cos）
+│   ├── dto/              # DTO 类（表单验证）
+│   ├── service/          # 服务层
+│   ├── model/            # 数据模型
+│   └── app.ts            # 应用入口
+├── resource/
+│   └── application.yml   # 配置文件
+├── package.json
+└── tsconfig.json
+```
+
+### 模板依赖安装
+
+```bash
+# Web / Static
+npm i @fastcar/core @fastcar/koa @fastcar/server
+
+# RPC
+npm i @fastcar/core @fastcar/rpc @fastcar/server
+
+# COS
+npm i @fastcar/core @fastcar/koa @fastcar/cossdk @fastcar/server
+
+# Microservices
+npm i @fastcar/core @fastcar/koa @fastcar/rpc @fastcar/server @fastcar/timer
+```
+
+## 配置管理
+
+配置文件放在 `resource/application.yml`。支持按 `env` 加载多文件，例如 `application-dev.yml` 会与主配置合并。
+
+### 基础配置示例
+
+```yaml
+application:
+  name: my-app
+  version: 1.0.0
+  env: dev
+
+mysql:
+  host: localhost
+  port: 3306
+  database: mydb
+  username: root
+  password: password
+
+redis:
+  host: localhost
+  port: 6379
+```
+
+使用配置：
+
+```typescript
+import { Configure, Value } from "@fastcar/core/annotation";
+
+@Configure
+class AppConfig {
+  @Value("server.port")
+  port!: number;
+
+  @Value("mysql.host")
+  dbHost!: string;
+}
+```
+
+### Web 模板 application.yml
+
+```yaml
+application:
+  env: "dev"
+
+settings:
+  koa:
+    server:
+      - { port: 8080, host: "0.0.0.0" }
+    koaStatic:
+      { "public": "public" }
+    koaBodyParser:
+      enableTypes: ["json", "form", "text"]
+```
+
+### RPC 模板配置
+
+```yaml
+application:
+  name: "fastcar-boot-rpc"
+
+settings:
+  rpc:
+    list:
+      - id: "server-1"
+        type: "ws"
+        server: { port: 1235 }
+        serviceType: "base"
+        secure:
+          username: "user"
+          password: "password"
+```
+
+### Microservices 模板配置
+
+```yaml
+settings:
+  microservices:
+    center:
+      token: "your-token-here"
+      servers:
+        - host: "localhost"
+          clusters: 1
+          list:
+            - type: "ws"
+              server: { port: 60000 }
+    connector:
+      token: "your-token-here"
+      servers:
+        - host: "localhost"
+          clusters: 1
+          list:
+            - front: true
+              type: "ws"
+              server: { port: 60100 }
+```
+
+## 生命周期钩子
+
+```typescript
+import { ApplicationStart, ApplicationStop, ApplicationInit } from "@fastcar/core/annotation";
+
+@Component
+class LifecycleService {
+  @ApplicationStart
+  async onStart() {
+    console.log("应用启动");
+  }
+  
+  @ApplicationStop
+  async onStop() {
+    console.log("应用停止");
+  }
+  
+  @ApplicationInit
+  async init() {
+    console.log("初始化完成");
+  }
+}
+```
+
+## 工具类
+
+```typescript
+import { DateUtil, CryptoUtil, FileUtil, TypeUtil } from "@fastcar/core/utils";
+
+// 日期时间
+DateUtil.toDateTime(); // "2024-03-10 15:30:45"
+DateUtil.toDay();      // "2024-03-10"
+
+// 加密
+CryptoUtil.aesEncode(key, iv, "data");
+CryptoUtil.sha256Encode("password");
+
+// 文件操作
+FileUtil.getFilePathList("./src");
+FileUtil.getResource("./config.yml");
+
+// 类型判断
+TypeUtil.isFunction(() => {});  // true
+TypeUtil.isClass(MyClass);       // true
+```
+
+## 完整模块列表
+
+| 模块 | 安装命令 | 用途 |
+|------|----------|------|
+| @fastcar/core | `npm i @fastcar/core` | IoC 容器、配置管理 |
+| @fastcar/koa | `npm i @fastcar/koa @fastcar/server` | Web 开发 |
+| @fastcar/mysql | `npm i @fastcar/mysql` | MySQL 数据库 |
+| @fastcar/pgsql | `npm i @fastcar/pgsql` | PostgreSQL |
+| @fastcar/mongo | `npm i @fastcar/mongo` | MongoDB |
+| @fastcar/redis | `npm i @fastcar/redis` | Redis 缓存 |
+| @fastcar/cache | `npm i @fastcar/cache` | 缓存组件 |
+| @fastcar/timer | `npm i @fastcar/timer` | 定时任务 |
+| @fastcar/timewheel | `npm i @fastcar/timewheel` | 时间轮延时任务 |
+| @fastcar/workerpool | `npm i @fastcar/workerpool` | 工作线程池 |
+| @fastcar/rpc | `npm i @fastcar/rpc` | RPC 通信 |
+| @fastcar/serverless | `npm i @fastcar/serverless` | Serverless 支持 |
+| @fastcar/cos-sdk | `npm i @fastcar/cos-sdk` | 对象存储 |
+
+## 快速开始新项目
+
+### 使用 CLI 创建项目（推荐）
+
+```bash
+# Web 项目
+mkdir my-web-app && cd my-web-app
+fastcar-cli init web
+npm install
+npm run debug
+
+# RPC 项目
+mkdir my-rpc-app && cd my-rpc-app
+fastcar-cli init rpc
+npm install
+npm run debug
+
+# Microservices 项目
+mkdir my-ms-app && cd my-ms-app
+fastcar-cli init microservices
+npm install
+npm run start-node
+```
+
+## 常见错误与注意事项
+
+### 1. 路由装饰器必须有括号
+
+❌ **错误：**
+```typescript
+@GET
+async list() { }
+```
+
+✅ **正确：**
+```typescript
+@GET()
+async list() { }
+```
+
+### 2. 不要使用不存在的装饰器
+
+❌ **错误：**
+```typescript
+import { Body, Param, Query } from "@fastcar/koa/annotation";
+
+@GET("/:id")
+async getById(@Param("id") id: string) { }
+```
+
+✅ **正确：**
+```typescript
+@GET("/:id")
+async getById(id: string) { }
+```
+
+### 3. 表单验证使用 @ValidForm + @Rule
+
+❌ **错误：**
+```typescript
+@POST()
+async create(@Body body: ItemDTO) { }
+```
+
+✅ **正确：**
+```typescript
+@ValidForm
+@POST()
+async create(@Rule() body: ItemDTO) { }
+```