Egg框架知识点1.目录结构和具体内容

在进行项目之前，最应该了解的就是项目结构，了解每一个文件存放的地方，为后续的修改做准备。
在这篇文章中，结合项目中的经历和EGG框架的目录结构进行详细整理。

目录结构：

server(egg-project)
├── app
| ├── router.js
│ ├── controller
│ | └── home.js
│ ├── service (可选)
│ | └── user.js
│ ├── middleware (可选)
│ | └── accesslog.js
│ └── extend (可选)
│ ├── helper.js
│ ├── request.js
│ ├── response.js
│ ├── context.js
│ ├── application.js
│ └── agent.js
├── config
| ├── plugin.js
| ├── config.default.js(默认环境)
| ├── config.local.js(本地开发环境)
│ ├── config.prod.js(线上环境)
| ├── config.test.js (测试环境)
| └── config.stage.js (预发环境)
├── logs
├── node_modules
├── jcloud
├── run
├── test
| ├── app
| | └── response_time.test.js
| └── config
| └── config.default.js
| └── config.default.js
├── package.json
├── app.js
├── build.js
├── sever.js
目录结构说明：
1. app/router.js ：用于配置 URL 路由规则
2. app/controller/** ：用于解析用户的输入，处理后返回相应的结果
3. app/service/**：用于编写业务逻辑层，可选，建议使用
4. app/middleware/**： 用于编写中间件
5. app/public/** ：用于放置静态资源，可选
6. app/extend/** ：用于框架的扩展，可选
7. config/config.{ENV}.js：用于编写配置文件
8. config/plugin.js： 用于配置需要加载的插件
9. test/**：用于单元测试
10. app.js 和 agent.js：用于自定义启动时的初始化工作，可选
11. app/schedule/** 用于定时任务，可选

具体内容

1.app/router.js ：

Router 主要用来描述请求 URL 和具体承担执行动作的 Controller 的对应关系， 框架约定了 app/router.js 文件用于统一所有路由规则。
定义router方法：
app/router.js 里面定义 URL 路由规则

// app/router.js
module.exports = app => {
  const { router, controller } = app
  router.get(`/user/:id`, controller.home.index)
}

app/controller 目录下面实现 Controller

// app/controller/home.js
const Controller = require(`egg`).Controller
class HomeController extends Controller {
   
  async index(ctx) {
    ctx.body = 'hello buddy'
  }
}

module.exports = HomeController

这样就完成了一个最简单的 Router 定义，当用户执行 GET /user/123，home.js 这个里面的 index 方法就会执行
备注：params.id中params在路由表示为/id，若改为qurey.id在路由表示为? id
下面是一些路由定义的方式：

// app/router.js
module.exports = app => {
 const { router, controller } = app;
router.get('/home', controller.home);
router.get('/user/:id', controller.user.page);
router.post('/admin', isAdmin, controller.admin);
router.post('/user', isLoginUser, hasAdminPermission, controller.user.create);
router.post('/api/v1/comments',controller.v1.comments.create); 
  // app/controller/v1/comments.js
};

如上诉所示，路由完整定义主要包括5个主要部分:

router.verb(‘router-name’, ‘path-match’, middleware1, …,middlewareN,
app.controller.action);

1.verb - 用户触发动作，支持 get，post 等所有 HTTP 方法
2.router-name 给路由设定一个别名，可以通过 Helper 提供的辅助函数 pathFor 和 urlFor 来生成 URL
3.path-match - 路由 URL 路径
4.middleware1 - 在 Router 里面可以配置多个 Middleware
5.controller - 指定路由映射到的具体的 controller 上，controller 可以有两种写法：
其中：app.controller.user.fetch - 直接指定一个具体的 controller
‘user.fetch’ - 可以简写为字符串形式
(但在我的项目中，主要的路由配置在Vue的框架里)

2.app/controller/ ：**

Controller 负责解析用户的输入，处理后返回相应的结果，例如：
a.在 RESTful 接口中，Controller 接受用户的参数，从数据库中查找内容返回给用户或者将用户的请求