egg-update

Author: csxiaoyaojianxian

17-nodejs/02-egg/.gitignore

@@ -6,7 +6,6 @@ coverage/
 run/
 logs/
 .DS_Store
-.vscode
 *.swp
 *.lock
 *.js
@@ -18,3 +17,5 @@ config/**/*.js
 app/**/*.map
 test/**/*.map
 config/**/*.map
+
+!database/**/*

17-nodejs/02-egg/.vscode/launch.json

@@ -0,0 +1,19 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Launch Egg",
+      "type": "node",
+      "request": "launch",
+      "cwd": "${workspaceRoot}",
+      "runtimeExecutable": "npm",
+      "windows": { "runtimeExecutable": "npm.cmd" },
+      "runtimeArgs": [ "run", "debug" ],
+      "console": "integratedTerminal",
+      "protocol": "auto",
+      "restart": true,
+      "port": 9229,
+      "autoAttachChildProcesses": true
+    }
+  ]
+}

17-nodejs/02-egg/.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    { "language": "typescript", "autoFix": true },
+    { "language": "typescriptreact", "autoFix": true },
+  ]
+}

17-nodejs/02-egg/LICENSE

@@ -1 +1,22 @@
-MIT LICENSE
+MIT LICENSE
+
+Copyright (c) 2015-present Ant UED, https://xtech.antfin.com/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

17-nodejs/02-egg/README.md

@@ -1,6 +1,4 @@
-# hackernews-async-ts
-
-[Hacker News](https://news.ycombinator.com/) showcase using typescript && egg
+# egg-demo-csxiaoyao
 
 ## QuickStart
 
@@ -9,7 +7,7 @@
 ```bash
 $ npm i
 $ npm run dev
-$ open http://localhost:7001/
+$ open http://localhost:2048/
 ```
 
 Don't tsc compile at development mode, if you had run `tsc` then you need to `npm run clean` before `npm run dev`.
@@ -32,26 +30,31 @@ $ npm start
 - Node.js 8.x
 - Typescript 2.8+
 
-
+## Other
+Need to start `mysql` & `redis`
+```
+$ brew services start mysql
 $ redis-server
+```
+
+## TODO
+1. docs
+2. whistle & domain
+3. login & passport & auth
+4. husky
+5. lint-staged
+6. prettier
+
+## Docs
+**validate**
+
+https://github.com/node-modules/parameter#rule
+
+**mocha**
+
+https://mochajs.cn/
+
+**sequelize**
 
-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
-
-validate
-https://github.com/node-modules/parameter#rule

17-nodejs/02-egg/app/middleware/errorHandler.ts

@@ -1,3 +1,6 @@
+/**
+ * 错误处理中间件
+ */
 export default () => {
   return async function errorHandler(ctx, next) {
     try {

17-nodejs/02-egg/app/middleware/robot.ts

@@ -1,5 +1,6 @@
-
-
+/**
+ * robot拦截
+ */
 // options === app.config.robot
 export default (options, app) => {
   console.log(app.config.robot);

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

@@ -33,6 +33,5 @@ export default function(app: Application) {
       app.model.User.hasMany(app.model.Post, { as: 'posts' });
     }
   };
-
   // return User;
 }

17-nodejs/02-egg/app/router.ts

@@ -7,7 +7,7 @@ export default (app: Application) => {
   router.get('/api/demo', controller.demo.testEnv);
   router.get('/api/demo/:id', controller.demo.testThrowError);
   router.post('/api/demo', controller.demo.testRedis);
-
+  // restful
   router.resources('users', '/api/users', controller.user);
   router.resources('posts', '/api/posts', controller.post);
 };

17-nodejs/02-egg/config/Code.ts

@@ -0,0 +1,6 @@
+export default {
+  SUCCESS: '0',
+  TEST_ERROR: '-1', // only for test
+  CURL_ERROR: '-1000',
+  DATA_NOT_FOUND: '404',
+};

17-nodejs/02-egg/config/config.default.ts

@@ -1,4 +1,10 @@
+/**
+ * config default
+ * csxiaoyao
+ * 2020.07.19
+ */
 import { EggAppConfig, EggAppInfo, PowerPartial } from 'egg';
+import CODE from './CODE';
 
 export default (appInfo: EggAppInfo) => {
   const config = {} as PowerPartial<EggAppConfig>;
@@ -7,13 +13,7 @@ export default (appInfo: EggAppInfo) => {
   // use for cookie sign key, should change to your own and keep security
   config.keys = appInfo.name + '_csxiaoyao';
 
-  config.CODE = {
-    SUCCESS: '0',
-    TEST_ERROR: '-1',
-    CURL_ERROR: '-1000',
-    DATA_NOT_FOUND: '404',
-  };
-
+  // mysql
   config.sequelize = {
     dialect: 'mysql',
     host: '127.0.0.1',
@@ -24,55 +24,58 @@ export default (appInfo: EggAppInfo) => {
     timezone: '+08:00',
   };
 
+  // redis
+  config.redis = {
+    client: {
+      port: 6379,
+      host: '127.0.0.1',
+      password: '',
+      db: 0,
+    },
+  };
+
+  // 全局错误处理
   config.onerror = {
     all(err, ctx) {
       console.log(err);
-      // 在此处定义针对所有响应类型的错误处理方法
-      // 注意，定义了 config.all 之后，其他错误处理方法不会再生效
       ctx.body = 'error';
       ctx.status = 500;
     },
     html(err, ctx) {
       console.log(err);
-      // html hander
       ctx.body = '<h3>error</h3>';
       ctx.status = 500;
     },
     json(err, ctx) {
       console.log(err);
-      // json hander
       ctx.body = { message: 'error' };
       ctx.status = 500;
     },
   };
 
+  // body数据解析
   const bodyParser = {
     jsonLimit: '3mb',
     // ignore: '/api',
   };
 
-  // add your egg config in here
+  /**
+   * 自定义中间件配置
+   */
   config.middleware = [
     'robot',
     'errorHandler',
   ];
-
-  // robot's configurations
   const robot = {
-    ua: [
-      /curl/i,
-      /Baiduspider/i,
-    ],
+    ua: [ /curl/i ],
   };
-
-  // 只对 /api 前缀的 url 路径生效
   const errorHandler = {
-    match: '/api',
+    match: '/api', // 只对 /api 前缀的 url 路径生效
   };
 
-  // the return config will combines to EggAppConfig
   return {
     ...config,
+    CODE,
     bodyParser,
     robot,
     errorHandler,

17-nodejs/02-egg/config/config.local.ts

@@ -3,6 +3,7 @@ import { EggAppConfig, PowerPartial } from 'egg';
 export default () => {
   const config: PowerPartial<EggAppConfig> = {};
 
+  // 日志输出等级调整
   config.logger = {
     level: 'DEBUG', // 输出到文件级别
     consoleLevel: 'DEBUG', // 输出到console级别
@@ -14,15 +15,6 @@ export default () => {
     },
   };
 
-  config.redis = {
-    client: {
-      port: 6379,
-      host: '127.0.0.1',
-      password: '',
-      db: 0,
-    },
-  };
-
   return {
     ...config,
   };

17-nodejs/02-egg/database/migrations/20200718172025-init-users.js

@@ -0,0 +1,45 @@
+'use strict';
+
+module.exports = {
+  // 在执行数据库升级时调用的函数，创建 users 表
+  up: async (queryInterface, Sequelize) => {
+    /**
+     * Add altering commands here.
+     *
+     * Example:
+     * await queryInterface.createTable('users', { id: Sequelize.INTEGER });
+     */
+    const { BIGINT, INTEGER, DATE, STRING, NOW } = Sequelize;
+    await queryInterface.createTable('users', {
+      id: {
+        type: BIGINT(11),
+        primaryKey: true,
+        allowNull: false,
+        unique: true,
+        autoIncrement: true,
+      },
+      name: STRING(30),
+      age: INTEGER,
+      created_at: {
+        type: DATE,
+        defaultValue: NOW,
+        allowNull: false
+      },
+      updated_at: {
+        type: DATE,
+        defaultValue: NOW,
+        allowNull: false
+      },
+    });
+  },
+  // 在执行数据库降级时调用的函数，删除 users 表
+  down: async (queryInterface, Sequelize) => {
+    /**
+     * Add reverting commands here.
+     *
+     * Example:
+     * await queryInterface.dropTable('users');
+     */
+    await queryInterface.dropTable('users');
+  },
+};

17-nodejs/02-egg/database/migrations/20200718183447-init-post.js

@@ -0,0 +1,27 @@
+'use strict';
+
+module.exports = {
+  up: async (queryInterface, Sequelize) => {
+    const { INTEGER, STRING, DATE, NOW } = Sequelize;
+    await queryInterface.createTable('posts', {
+      id: { type: INTEGER, primaryKey: true, autoIncrement: true },
+      title: STRING(30),
+      content: STRING(255),
+      user_id: INTEGER,
+      created_at: {
+        type: DATE,
+        defaultValue: NOW,
+        allowNull: false
+      },
+      updated_at: {
+        type: DATE,
+        defaultValue: NOW,
+        allowNull: false
+      },
+    });
+  },
+
+  down: async queryInterface => {
+    await queryInterface.dropTable('posts');
+  },
+};

17-nodejs/02-egg/database/migrations/20200719021234-update-users.js

@@ -0,0 +1,14 @@
+'use strict';
+
+module.exports = {
+  up: async (queryInterface, Sequelize) => {
+    const { STRING } = Sequelize;
+    await queryInterface.addColumn('users', 'gender', STRING(10), {
+      after: 'age'
+    });
+  },
+
+  down: async (queryInterface, Sequelize) => {
+    await queryInterface.removeColumn('users', 'gender');
+  }
+};