如何用Eggjs从零开始开发一个项目（1）

前言

“纸上得来终觉浅，绝知此事要躬行。”虽然node一直在断断续续地学，但总是东一榔头西一榔头的，没有一点系统，所以打算写一个项目来串联一下之前的学习成果。

为什么选择Eggjs呢？其实我觉得如果是个人开发或者小型项目Koa就足够轻量与灵活了，但是如果是有过团队开发的经历，就会更注重项目的管理。Eggjs项目相对于Koa我比较看中的有以下几点：

1. 完善的文档，这意味不管是交接还是项目有新成员加入，直接把官方文档甩出去就行了，而且官方文档同时也是一个很好的学习材料；
2. Egg 奉行『约定优于配置』。我很中意这个设定，在多人协作的项目中，我们有时候需要花很多功夫来统一不同的编程习惯，比如有人喜欢把公用的方法放到utils/index文件夹中，有的干脆直接建一个utils.js，还有的util不加s的，这些都没有对错之分，但是多人协作项目中会使得项目混乱，难以管理，增加code review的成本。『约定优于配置』则很好地解决了这个问题，大家都统一按官方要求写，有偏差的直接翻文档，没有撕逼了；
3. 基于Koa，所以Koa的轮子做一下适配就能用，不担心生态问题。

我也是一个node菜鸟，所以这个系列我会按照自己从零实现的步骤去记录整个开发过程。

创建一个Eggjs项目

$ mkdir egg-server && cd egg-server
$ npm init egg --type=simple
$ npm i

OK，项目初始成功了，下面我们的任务是链接数据库。

数据库链接

数据库我选择mysql，毕竟行业主流嘛，这里我们使用Sequelize来管理、操作数据库，Sequelize 是一个基于 promise 的 Node.js ORM,这样你就不用去写一坨一坨的sql语句了。数据库安装这里就不细说了，跟着菜鸟教程安装就好了。安装好并打开数据库。

1. 安装并配置 egg-sequelize 插件（它会辅助我们将定义好的 Model 对象加载到 app 和 ctx 上）和 mysql2 模块：

   npm install --save egg-sequelize mysql2

2. 在app/config/plugin.js中引入插件（egg中引入插件都需要在这个文件中配置）：

   sequelize: {
       enable: true,
       package: 'egg-sequelize',
   }

3. 在app/config/config.default.js中配置Sequelize的配置项：

   config.sequelize = {
       dialect: 'mysql', // 表示使用mysql
       host: '127.0.0.1', // 连接的数据库主机地址
       port: 3306, // mysql服务端口
       database: 'egg-db', // 数据库名
       username: 'root', // 你的数据库用户名
       password: 'root', // 你的数据库密码
       define: {
           timestamps: true, // 默认添加createdAt,updatedAt,deletedAt时间戳
           paranoid: true, // 设置软删除，删除时不删除数据，而是通过更新deleteAt标识删除
           freezeTableName: true, // 冻结表名，防止建表时表名修改为复数形式
           underscored: false, // 防止驼峰式字段被转为下划线
       },
       // 这里有坑，sequelize用的是UTC时间，我们在东八区，所以要加8
       // https://stackoverflow.com/questions/47367893/sequelize-reads-datetime-in-utc-only
       dialectOptions: {
           dateStrings: true,
           typeCast(field, next) {
               if (field.type === 'DATETIME') {
                   return field.string();
               }
               return next();
           },
       },
       timezone: '+8:00',
   };

4. 创建model

   在app文件夹下创建一个model文件夹，所有的model文件都放在这里，现在我们创建一个user的model，创建以下文件app/model/user.js。

   module.exports = (app) => {
       const { STRING, INTEGER } = app.Sequelize;
       const User = app.model.define('user', {
           id: {
               type: INTEGER,
               autoIncrement: true, //自增
               primaryKey: true, //设置为主键
           },
           name: STRING(20),
           password: STRING(100),
           phone: STRING(11),
           email: STRING(30),
       });
       return User;
   };

   OK，现在数据库这块好像都处理的差不多了，那接下来就开些写一下代码，快乐地进行CRUD吧~

5. 编写controller

   创建app/controller/user.js文件，写入以下内容：

   const Controller = require('egg').Controller;
   
   class UserController extends Controller {
       // 添加user
       async createUser() {
           const params = this.ctx.request.body;
           const user = await this.ctx.model.User.create({
               ...params
           });
           if (user) {
               this.ctx.body = {
                   code: 200,
                   data: user
               };
           } else {
               this.ctx.throw(500, 'internal server error');
           }
       }
       
       // 获取所有的user
       async getUsers() {
           const users = await this.ctx.model.User.findAll();
           this.ctx.body = {
               code: 200,
               data: users
           };
       }
   }
   
   module.exports = UserController;
   

6. 添加路由

   在app/router.js中添加getUsers和createUser的路由，代码如下：

   module.exports = app => {
       const { router, controller } = app;
       router.get('/', controller.home.index);
       router.post('/createUser',controller.user.createUser);
       router.get('/getUsers', controller.user.getUsers);
   };

7. 测试功能

   这个时候我们的代码已经基本完成，请求对应的路由就可以看到对应的数据库变化了，但是我们在请求之前不要忘记在数据库创建对应的数据库和user表哦，不然会报错的，现在可以手动的去创建，后面我们可以借助Sequelize帮我们在项目启动的时候自动创建并更新表。

   一切准备妥当之后，打开Postman来试试吧，通过get请求localhost:7001/getUsers得到以下数据：

   {
       "code": 200,
       "data": []
   }

   这个时候，表是空的，所以查不到，那我们来通过post请求来访问localhost:7001/createUser来创建一条数据：

   {
       "name":"curry",
       "password":"test1234",
       "phone":"13412341234",
       "email":"[email protected]"
   }

   然而，这个时候报错了：

   invalid csrf token. See https://eggjs.org/zh-cn/core/...

   看一下文档怎么说的：

   CSRF（Cross-site request forgery跨站请求伪造，也被称为 One Click Attack 或者 Session Riding，通常缩写为 CSRF 或者 XSRF，是一种对网站的恶意利用。 CSRF 攻击会对网站发起恶意伪造的请求，严重影响网站的安全。因此框架内置了 CSRF 防范方案。

   这是Eggjs框架的安全策略，我们在开发的时候可以先关掉，在app/onfig/config.default.js中添加以下代码：

   config.security = {
       csrf: {
           enable: false
       }
   };

   改好以后让我们再试一次：

   {
       "code": 200,
       "data": {
           "id": 1,
           "name": "curry",
           "password": "test1234",
           "phone": "13412341234",
           "email": "[email protected]",
           "updatedAt": "2020-12-13T07:39:29.990Z",
           "createdAt": "2020-12-13T07:39:29.990Z"
       }
   }

   成功了！打开数据库刷新一下user表看看，已经插入了这条数据，再重新通过get请求localhost:7001/getUsers：

   {
       "code": 200,
       "data": [
           {
               "id": 1,
               "name": "curry",
               "password": "test1234",
               "phone": "13412341234",
               "email": "[email protected]",
               "createdAt": "2020-12-13 15:39:29",
               "updatedAt": "2020-12-13 15:39:29",
               "deletedAt": null
           }
       ]
   }

   Well done！一番折腾以后终于看到了成果，但这只是开始，后面我们会继续实现用户的注册、登录功能，涉及到用户注册时密码的处理，用户认证等功能。