目录结构

• UI 应用目录结构

  ├── app
  │   ├── pages         业务组件
  |   └── globals.d.ts  全局配置文件
  ├── config            
  │   ├── config.ts     项目配置文件
  ├── package.json
  ├── tsconfig.json
  ├── .eslintrc.js
  ├── .prettierrc.js
  ├── .stylelintrc.js
  ├── tslint.json
  ├── README.md - 项目README
  

  说明

  • README.md 项目 readme
  • app/pages 业务组件目录，约定该目录下编写业务组件
  • config/config.ts 项目配置文件
  • tsconfig.json TypeScript 配置文件
  • .eslintrc.js eslint 配置文件
  • .prettierrc.js 代码自动格式化配置文件

• BFF 应用目录结构

  bff-project
  ├── README.md
  ├── package.json
  ├── server
  │   ├── base_dao.js
  │   ├── index.js
  │   └── user.js
  ├── src
  │   ├── app
  │   │   ├── controller
  │   │   ├── extend
  │   │   ├── middleware
  │   │   ├── mock
  │   │   └── public
  │   ├── app.ts
  │   ├── config
  │   │   ├── config.default.ts
  │   │   └── plugin.ts
  │   └── lib
  │       ├── dao
  │       ├── schedule
  │       └── service
  ├── test
  │   └── app
  │   └── controller
  └── tsconfig.json
  

  说明

  • server 这是一个 mock 服务，模拟后端接口服务，一般用于框架开发测试用，业务开发一般使用不到

  • src/app/controller/** 用于解析用户的输入，处理后返回相应的结果,具体参见 Controller

  • src/app/extend/** 可选，用于框架的扩展，具体参见框架扩展

  • src/app/middleware/** 可选，用于编写中间件，具体参见 Middleware

  • src/config/config.{env}.ts 用于编写配置文件，具体参见配置

  • src/config/plugin.ts 用于配置需要加载的插件，具体参见插件。

  • src/app.ts 和 agent.ts 用于自定义启动时的初始化工作，可选，具体参见启动自定义。关于 agent.js 的作用参见Agent 机制

  • src/app/public/** 用于放置静态资源，可选，具体参见内置插件 egg-static

    另外，也有一些自定义的目录

  • src/app/mock mock 代码，为 UI 提供 mock 服务

  • src/lib/service service 层代码

  • src/lib/dao dao 层代码，

  • src/lib/schedule 用于定时任务,具体参见定时任务