文档
基础功能
目录结构

目录结构

├── package.json
├── README.md
├── tsconfig.json  
├── .gitignore
├── src
│    ├── config
│    │  └── config.default.ts
│    │  └── config.local.ts (可选)
│    │  └── config.test.ts  (可选)
│    │  └── config.release.ts (可选)
│    │  └── config.prod.ts (可选)
│    │  └── config.middleware.ts (可选)
│    ├── controller
│    │  └── ExampleController.ts
│    ├── middleware
│    │  └── ExampleMIddleware.ts
│    ├── service
│    │  └── ExampleService.ts
│    ├── alone
│    │  └── alone1.ts
│    │  └── alone2.ts 
│    ├── schedule
│    │  └── task1.ts
│    │  └── task2.ts
│    ├── socket
│    │  ├── controller
│    │  │   └── MainController.ts     
│    │  └── middleware
│    │      └── socketMiddleware.ts
│    ├── plugin
│    │   └── yunfly-plugin-email
│    │       ├── src
│    │       │   ├── config
│    │       │   │   └── config.default.ts
│    │       │   └── app.ts
│    │       ├── tsconfig.json
│    │       ├── README.md
│    │       └── package.json
│    └── app.ts
  • tsconfig.json Ts规则配置项 详细配置参考 (opens in a new tab)
  • controller BFF controller 层
  • middleware 中间件
  • service BFF service 层
  • alone alone 进程执行文件
  • schedule 定时任务文件 (一个文件表示一个定时任务)
  • config BFF 配置器
  • app.ts 可配置服务启动文件

备注

  • 为保持代码规范一致性 controllerservice 文件尽量以大写字母开头,分别以 ControllerService 后缀结尾。
  • 根据自身业务的复杂度来决定 controllerservice 下是否再拆分文件夹。