egg-orm

Author: csxiaoyaojianxian

17-nodejs/02-egg/.eslintignore

@@ -1,2 +1,3 @@
 **/*.d.ts
 node_modules/
+test/

17-nodejs/02-egg/.sequelizerc

@@ -0,0 +1,10 @@
+'use strict';
+
+const path = require('path');
+
+module.exports = {
+  config: path.join(__dirname, 'database/config.json'),
+  'migrations-path': path.join(__dirname, 'database/migrations'),
+  'seeders-path': path.join(__dirname, 'database/seeders'),
+  'models-path': path.join(__dirname, 'app/model'),
+};

17-nodejs/02-egg/LICENSE

@@ -0,0 +1 @@
+MIT LICENSE

17-nodejs/02-egg/README.md

@@ -31,3 +31,24 @@ $ npm start
 
 - Node.js 8.x
 - Typescript 2.8+
+
+
+$ redis-server
+
+redis
+seed
+docs
+cros
+TDD
+域名
+登录态
+权限校验
+whistle
+husky
+lint-staged
+prettier
+
+
+sequelize
+https://sequelize.org/master/manual/query-interface.html
+https://sequelize.org/master/variable/index.html#static-variable-DataTypes

17-nodejs/02-egg/app.ts

@@ -57,4 +57,4 @@ class AppBootHook {
   }
 }
 
-export default AppBootHook;
+export default AppBootHook;

17-nodejs/02-egg/app/controller/demo.ts

@@ -0,0 +1,72 @@
+import { Controller } from 'egg';
+
+// 定义创建接口的请求参数规则
+// https://github.com/node-modules/parameter#rule
+const createRule = {
+  name: 'string',
+  type: { type: 'enum', values: [ 'ask', 'share' ], required: false },
+};
+
+export default class DemoController extends Controller {
+  // GET	/demo
+  public async index() {
+    const { ctx } = this;
+    ctx.logger.debug('test logger');
+    ctx.body = `<h1>${ctx.app.env}</h1>`; // local
+    ctx.response.type = 'text/html';
+    ctx.status = 200;
+
+    // ctx.app.redis.get()
+    // client.on('connect', function () {
+    //     // set 语法
+    //     client.set('lubanH5makerTest', 'csxiaoyao', function (err, data) {
+    //         console.log(1, data)
+    //     })
+    //     // get 语法
+    //     client.get('lubanH5makerTest', function (err, data) {
+    //         console.log(2, data)
+    //     })
+    // })
+  }
+
+  // GET	/demo/new
+  public async new() {
+    const { app, ctx } = this;
+    ctx.throw({
+      code: app.config.CODE.TEST_ERROR,
+      message: '测试错误抛出',
+    });
+  }
+
+  // POST	/demo
+  public async create() {
+    const { ctx } = this;
+    // 校验 `ctx.request.body` 是否符合我们预期的格式
+    // 如果参数校验未通过，将会抛出一个 status = 422 的异常
+    ctx.validate(createRule, ctx.request.body);
+    // 调用 service 创建一个 demo
+    const data = await ctx.service.demo.create(ctx.request.body);
+    // 设置响应体和状态码
+    ctx.helper.rest({
+      ...data,
+    }, 'ok', 0);
+  }
+  // GET	/demo/:id
+  public async show() {
+    const { ctx } = this;
+    ctx.logger.debug('fetch id: %j', ctx.params.id);
+    console.log('test show');
+  }
+  // GET	/demo/:id/edit	edit_demo
+  public async edit() {
+    console.log('test edit');
+  }
+  // PUT	/demo/:id	demo
+  public async update() {
+    console.log('test update');
+  }
+  // DELETE	/demo/:id	demo
+  public async destroy() {
+    console.log('test destroy');
+  }
+}

17-nodejs/02-egg/app/controller/index.ts

@@ -0,0 +1,66 @@
+import { Controller } from 'egg';
+
+export default class PostController extends Controller {
+  // GET	/api/posts?limit=5&offset=5 6~10
+  public async index() {
+    const ctx = this.ctx;
+    const query = {
+      limit: parseInt(ctx.query.limit) || 10,
+      offset: parseInt(ctx.query.offset) || 0,
+    };
+    const data = await ctx.service.post.list(query);
+    ctx.helper.rest({
+      ...data, // { "count": 2, "rows": [{...}, {...}] }
+    });
+  }
+
+  // GET	/api/posts/:id
+  public async show() {
+    const ctx = this.ctx;
+    const data = await ctx.service.post.find(parseInt(ctx.params.id) || 0);
+    ctx.helper.rest(data); // {...}
+  }
+
+  // POST	/api/posts
+  public async create() {
+    const ctx = this.ctx;
+    const createRule = {
+      title: 'string',
+      content: 'string',
+      user_id: 'int',
+    };
+    const body = ctx.request.body;
+    ctx.validate(createRule, body);
+    const data = await ctx.service.post.create(body);
+    ctx.helper.rest(data); // {...}
+    ctx.status = 201;
+  }
+
+  // PUT	/api/posts/:id
+  public async update() {
+    const ctx = this.ctx;
+    const id = parseInt(ctx.params.id) || 0;
+    const updates = {
+      user_id: ctx.request.body.user_id,
+      title: ctx.request.body.title,
+      content: ctx.request.body.content,
+    };
+    const updateRule = {
+      user_id: { type: 'int', required: false },
+      title: { type: 'string', required: false },
+      content: { type: 'string', required: false },
+    };
+    ctx.validate(updateRule, updates);
+    const data = await ctx.service.post.update({ id, user_id: updates.user_id, updates });
+    ctx.helper.rest(data); // {...}
+  }
+
+  // DELETE	/api/posts/:id
+  public async destroy() {
+    const ctx = this.ctx;
+    const id = parseInt(ctx.params.id) || 0;
+    const user_id = parseInt(ctx.request.body.user_id);
+    await ctx.service.post.destroy({ id, user_id });
+    ctx.helper.rest({ id, user_id });
+  }
+}

17-nodejs/02-egg/app/controller/post.ts

@@ -0,0 +1,70 @@
+import { Controller } from 'egg';
+
+export default class UserController extends Controller {
+  // GET	/api/users?limit=5&offset=5 6~10
+  public async index() {
+    const { ctx } = this;
+    const query = {
+      limit: parseInt(ctx.query.limit) || 10,
+      offset: parseInt(ctx.query.offset) || 0,
+    };
+    const data = await ctx.service.user.list(query);
+    ctx.helper.rest({
+      ...data, // { "count": 2, "rows": [{...}, {...}] }
+    }, 'ok', 0);
+  }
+
+  // GET	/api/users/:id
+  public async show() {
+    const ctx = this.ctx;
+    const data = await ctx.service.user.find(parseInt(ctx.params.id) || 0);
+    ctx.helper.rest(data); // {...}
+  }
+
+  // POST	/api/users
+  public async create() {
+    const { ctx } = this;
+    // 参数校验 `ctx.request.body` 未通过将抛出 status = 422 的异常
+    // https://github.com/node-modules/parameter#rule
+    const createRule = {
+      name: 'string',
+      age: 'int',
+      gender: { type: 'enum', values: [ 'male', 'female', 'unknown' ], required: false },
+      // createdAt: { type: 'datetime', required: false },
+      // updatedAt: { type: 'datetime', required: false },
+    };
+    const body = ctx.request.body;
+    ctx.validate(createRule, body);
+    const data = await ctx.service.user.create(body);
+    ctx.helper.rest(data); // {...}
+    ctx.status = 201;
+  }
+
+  // PUT	/api/users/:id
+  public async update() {
+    const { ctx } = this;
+    const id = parseInt(ctx.params.id) || 0;
+    const updates = {
+      name: ctx.request.body.name,
+      age: ctx.request.body.age,
+      gender: ctx.request.body.gender,
+      // updatedAt: new Date(),
+    };
+    const updateRule = {
+      name: { type: 'string', required: false },
+      age: { type: 'int', required: false },
+      gender: { type: 'enum', values: [ 'male', 'female', 'unknown' ], required: false },
+    };
+    ctx.validate(updateRule, updates);
+    const data = await ctx.service.user.update({ id, updates });
+    ctx.helper.rest(data); // {...}
+  }
+
+  // DELETE	/api/users/:id
+  public async destroy() {
+    const { ctx } = this;
+    const id = parseInt(ctx.params.id) || 0;
+    await ctx.service.user.del(id);
+    ctx.helper.rest({ id });
+  }
+}

17-nodejs/02-egg/app/controller/topics.ts

@@ -15,5 +15,5 @@ export default {
       message,
       data,
     };
-  }
+  },
 };

17-nodejs/02-egg/app/controller/user.ts

@@ -6,34 +6,38 @@ export default () => {
       // 所有的异常都在 app 上触发一个 error 事件，框架会记录一条错误日志
       ctx.app.emit('error', err, ctx);
 
-      const status = err.status || 500;
+      const code = parseInt(err.code) || -1;
+      const status = err.status || (code >= 0 ? 400 : 500);
+
       // 生产环境时 500 错误的详细错误内容不返回给客户端，因为可能包含敏感信息
       const error = status === 500 && ctx.app.config.env === 'prod'
         ? 'Internal Server Error'
         : err.message;
 
       // 从 error 对象上读出各个属性，设置到响应中
       ctx.body = {
-        code: parseInt(err.code) || -1,
+        code,
         message: error,
       };
       switch (status) {
         // 参数校验未通过
         case 422:
           ctx.body.detail = err.errors;
           break;
+        default:
+          //
       }
       ctx.status = status;
     }
 
     // 404 单独处理
     if (ctx.status === 404 && !ctx.body) {
-      console.log(ctx.acceptJSON)
+      console.log(ctx.acceptJSON);
       if (ctx.acceptJSON) {
         ctx.body = { error: 'Not Found' };
       } else {
         ctx.body = '<h1>Page Not Found</h1>';
       }
     }
   };
-};
+};

17-nodejs/02-egg/app/extend/helper.ts

@@ -12,5 +12,5 @@ export default (options, app) => {
     } else {
       await next();
     }
-  }
+  };
 };