Tiny pro sever egg (#57)

* feat: egg API getUserInfo

* feat: egg API login register

* fix: fix err code

* fix: fix PR suggestion

* fix: fix database name

Author: wjiangwang

packages/toolkits/pro/template/server/eggJs/app/controller/user.ts

@@ -0,0 +1,104 @@
+import { Controller } from 'egg';
+import BcryptUtils from '../utils/bcrypt-utils';
+
+export default class UserController extends Controller {
+  // 注册用户
+  public async registerUser() {
+    const { ctx, app } = this;
+    const payload = ctx.request.body || {};
+    const transaction = await ctx.model.transaction();
+    try {
+      this.logger.info('[ controller | user ] registerUser : 进入registerUser方法');
+      // 校验参数
+      const registerUserRule = {
+        user_name: { type: 'email' },
+        password: {
+          type: 'string',
+          format: /^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z\d]{8,}$/,
+        },
+      };
+      const err = app.validator.validate(registerUserRule, payload);
+      if (err?.length) {
+        ctx.helper.commonJson(ctx, {}, 500, 'InvalidParameter');
+        return;
+      }
+      const { user_name, password } = payload;
+      // 判断用户是否已经存在
+      const user = await ctx.service.user.getUserByName(user_name);
+      if (user) {
+        ctx.helper.commonJson(ctx, {}, 500, 'UserAlreadyExist');
+        return;
+      }
+      const hash = BcryptUtils.genHash(password);
+      // 创建用户
+      const { id } = await ctx.service.user.createUser({ user_name, password: hash }, { transaction });
+      const userInfo = await ctx.service.user.createUserInfo({ user_name, user_id: id }, { transaction });
+      await transaction.commit();
+      ctx.helper.commonJson(ctx, userInfo, 200);
+    } catch (error) {
+      await transaction.rollback();
+      ctx.helper.commonJson(ctx, {}, 500, 'InterError');
+    }
+  }
+
+  // 获取用户信息
+  public async getUserInfo() {
+    const { ctx } = this;
+    const { id } = ctx.params;
+
+    try {
+      this.logger.info('[ controller | user ] getUserInfo : 进入getUserInfo方法');
+      const userInfo = await ctx.service.user.getUserInfoById(id);
+      if (!userInfo) {
+        ctx.helper.commonJson(ctx, {}, 500, 'UserNotFound');
+        return;
+      }
+      ctx.helper.commonJson(ctx, userInfo, 200);
+    } catch (error) {
+      ctx.helper.commonJson(ctx, {}, 500, 'InterError');
+    }
+  }
+
+  // 登录
+  public async login() {
+    const { ctx, app } = this;
+    const payload = ctx.request.body || {};
+    try {
+      this.logger.info('[ controller | user ] login : 进入login方法');
+      // 校验参数格式
+      const err = app.validator.validate(
+        {
+          user_name: { type: 'email' },
+          password: { type: 'string' },
+        },
+        payload,
+      );
+      if (err?.length) {
+        ctx.helper.commonJson(ctx, {}, 500, 'InvalidParameter');
+        return;
+      }
+
+      // 用户是否存在
+      const user = await ctx.service.user.getUserByName(payload.user_name);
+      if (!user) {
+        ctx.helper.commonJson(ctx, {}, 500, 'UserNotFound');
+        return;
+      }
+
+      // 密码是否正确
+      const match = BcryptUtils.compare(payload.password, user.password);
+      if (!match) {
+        ctx.helper.commonJson(ctx, {}, 500, 'ErrorPassword');
+        return;
+      }
+
+      // 生成Token
+      const { secret, sign } = this.app.config.jwt;
+      const userInfo = await ctx.service.user.getUserInfoById(user.id);
+      const token = this.app.jwt.sign(userInfo, secret, sign);
+      ctx.helper.commonJson(ctx, { token }, 200);
+    } catch (error) {
+      ctx.helper.commonJson(ctx, {}, 500, 'InterError');
+    }
+  }
+}

packages/toolkits/pro/template/server/eggJs/app/model/registerUser.ts

@@ -0,0 +1,40 @@
+/* indent size: 4 */
+
+module.exports = (app: any) => {
+  const DataTypes = app.Sequelize;
+
+  const RegisterUser = app.model.define(
+    'RegisterUser',
+    {
+      id: {
+        type: DataTypes.INTEGER(20).UNSIGNED,
+        allowNull: false,
+        primaryKey: true,
+        autoIncrement: true,
+      },
+      user_name: {
+        type: DataTypes.STRING(32),
+        allowNull: false,
+      },
+      password: {
+        type: DataTypes.STRING(60),
+        allowNull: false,
+      },
+      register_type: {
+        type: DataTypes.ENUM('email'),
+        allowNull: false,
+        defaultValue: 'email',
+      },
+    },
+    {
+      tableName: 'registeruser',
+      underscored: false,
+      freezeTableName: true,
+      omitNull: false,
+      timestamps: false,
+      paranoid: false,
+    },
+  );
+
+  return RegisterUser;
+};

packages/toolkits/pro/template/server/eggJs/app/model/userInfo.ts

@@ -0,0 +1,76 @@
+/* indent size: 4 */
+
+module.exports = (app: any) => {
+  const DataTypes = app.Sequelize;
+
+  const UserInfo = app.model.define(
+    'UserInfo',
+    {
+      id: {
+        type: DataTypes.INTEGER(20).UNSIGNED,
+        allowNull: false,
+        primaryKey: true,
+        autoIncrement: true,
+      },
+      user_name: {
+        type: DataTypes.STRING(32),
+        allowNull: false,
+      },
+      user_id: {
+        type: DataTypes.INTEGER(20),
+        allowNull: false,
+      },
+      department: {
+        type: DataTypes.STRING(32),
+        allowNull: false,
+        defaultValue: '',
+      },
+      employee_type: {
+        type: DataTypes.STRING(32),
+        defaultValue: null,
+      },
+      roles: {
+        type: DataTypes.STRING(32),
+        defaultValue: null,
+      },
+      probation_start: {
+        type: DataTypes.DATE,
+        defaultValue: null,
+      },
+      probation_end: {
+        type: DataTypes.DATE,
+        defaultValue: null,
+      },
+      probation_duration: {
+        type: DataTypes.INTEGER(11).UNSIGNED,
+        defaultValue: null,
+      },
+      protocol_start: {
+        type: DataTypes.DATE,
+        defaultValue: null,
+      },
+      protocol_end: {
+        type: DataTypes.DATE,
+        defaultValue: null,
+      },
+      address: {
+        type: DataTypes.STRING(32),
+        defaultValue: null,
+      },
+      status: {
+        type: DataTypes.STRING(32),
+        defaultValue: null,
+      },
+    },
+    {
+      tableName: 'userinfo',
+      underscored: false,
+      freezeTableName: true,
+      omitNull: false,
+      timestamps: false,
+      paranoid: false,
+    },
+  );
+
+  return UserInfo;
+};

packages/toolkits/pro/template/server/eggJs/app/router.ts

@@ -11,4 +11,9 @@ export default (app: Application) => {
 
   router.post('/v1/employee/getEmployee', controller.employee.getEmployee);
 
+  router.post('/v1/user/register', controller.user.registerUser);
+
+  router.get('/v1/user/userInfo/:id', controller.user.getUserInfo);
+
+  router.post('/v1/user/login', controller.user.login);
 };

packages/toolkits/pro/template/server/eggJs/app/service/user.ts

@@ -0,0 +1,19 @@
+import { Service } from 'egg';
+
+export default class User extends Service {
+  public async getUserInfoById(user_id: string): Promise<any> {
+    return this.ctx.model.UserInfo.findOne({ where: { user_id }, raw: true });
+  }
+
+  public async getUserByName(user_name: string): Promise<any> {
+    return this.ctx.model.RegisterUser.findOne({ where: { user_name } });
+  }
+
+  public async createUser(params: { user_name: string; password: string }, options?): Promise<any> {
+    return this.ctx.model.RegisterUser.create(params, options);
+  }
+
+  public async createUserInfo(info, options?): Promise<any> {
+    return this.ctx.model.UserInfo.create(info, options);
+  }
+}

packages/toolkits/pro/template/server/eggJs/app/utils/bcrypt-utils.ts

@@ -0,0 +1,11 @@
+import * as bcrypt from 'bcrypt';
+
+export default class BcryptUtils {
+  private static saltRounds = 10;
+  public static genHash(password: string): string {
+    return bcrypt.hashSync(password, this.saltRounds);
+  }
+  public static compare(password: string, encrypted: string): boolean {
+    return bcrypt.compareSync(password, encrypted);
+  }
+}

packages/toolkits/pro/template/server/eggJs/config/config.default.ts

@@ -17,18 +17,26 @@ export default (appInfo: EggAppInfo) => {
     username: 'root',
     password: '123456',
     define: {
-        timestamps: true,
-        freezeTableName: true,
-        underscored: false,
-        createdAt: 'created_at',
-        updatedAt: 'updated_at',
+      timestamps: true,
+      freezeTableName: true,
+      underscored: false,
+      createdAt: 'created_at',
+      updatedAt: 'updated_at',
     },
     timezone: '+08:00',
-    database: 'tiny_server_test'
+    database: 'tiny_pro_server',
   };
 
+  config.jwt = {
+    enable: true,
+    ignore: /user\/(login|register)/,
+    secret: 'tiny_pro_server',
+    sign: {
+      expiresIn: 60 * 60 * 24,
+    },
+  };
   // the return config will combines to EggAppConfig
   return {
-    ...config
+    ...config,
   };
 };

packages/toolkits/pro/template/server/eggJs/config/plugin.ts

@@ -5,6 +5,14 @@ const plugin: EggPlugin = {
     enable: true,
     package: 'egg-sequelize',
   },
+  validate: {
+    enable: true,
+    package: 'egg-validate',
+  },
+  jwt: {
+    enable: true,
+    package: 'egg-jwt',
+  },
 };
 
 export default plugin;

packages/toolkits/pro/template/server/eggJs/package.json

@@ -21,9 +21,12 @@
     "clean": "ets clean"
   },
   "dependencies": {
+    "bcrypt": "^5.1.0",
     "egg": "^2.6.1",
+    "egg-jwt": "^3.1.7",
     "egg-scripts": "^2.6.0",
     "egg-sequelize": "^5.2.2",
+    "egg-validate": "^2.0.2",
     "mysql2": "^2.1.0"
   },
   "devDependencies": {

packages/toolkits/pro/template/server/eggJs/typings/app/controller/index.d.ts

@@ -3,10 +3,14 @@
 /* eslint-disable */
 
 import 'egg';
+import ExportCsrf from '../../../app/controller/csrf';
 import ExportEmployee from '../../../app/controller/employee';
+import ExportUser from '../../../app/controller/user';
 
 declare module 'egg' {
   interface IController {
+    csrf: ExportCsrf;
     employee: ExportEmployee;
+    user: ExportUser;
   }
 }