egg初始化项目

  • 创建文件，初始化egg框架 ```javascript mkdir egg-example && cd egg-example

npm init egg —type=simple

npm i

  2. - 启动项目
  3. ```javascript
  4. npm run dev

// npm run cov：代码测试率 npm run lint — —fix ：— —fix 是自动修复eslint中不符合规范的语句

husky插件（做git hooks）

参考文档：husky、husky官网
是做git hooks的（在git操作的时候的钩子。即在git操作的时候进行响应的操作）

  • 安装husky ```javascript // Edit package.json > prepare script and run it once: npm set-script prepare “husky install” && npm run prepare

// Add a hook: npx husky add .husky/pre-commit “npm test”

  1. > 钩子没有触发的情况：
  2. > 当第一次安装`husky`的时候，可能会出现`.git/hooks`里面的文件没有被覆盖的情况；此时，`git hooks`仍然是之前的状态（默认是没有效果的）；如果是`husky`安装正常，使用命令`ls .git/hoooks`查看文件则是下面这样：
  3. > 随便打开任意脚本文件
  4. > 
  6. ```javascript
  7. #!/bin/sh
  8. # husky
  10. # Created by Husky v4.2.5 (https://github.com/typicode/husky#readme)
  11. #   At: 2020-6-16 17:14:54
  12. #   From: /Users/snowdream/Desktop/bhb/dp-admin/node_modules/husky (https://github.com/typicode/husky#readme)
  14. . "$(dirname "$0")/husky.sh"

如果不是上述形式，那么就是husky注入失败；可以通过重新安装（先uninstall再install）进行重新注入，因为每次安装husky时会重新覆盖一次.git/hooks脚本文件。

配置eslint规范

在.eslintrc中配置

  1. {
  2.   "extends": "eslint-config-egg",
  3.   "rules": {
  4.     "semi": ["error", "never"] // 在语句末尾从来不加分号，并且如果有分号则报错
  5.   }
  6. }

提交日志规范

参考文档和方案：Commit message、commitizen、validate-commit-msg（还有其他很多插件）
主要是为了让规范代码提交的语句

commitizen

  • 安装

    1. npm install -g commitizen

  • 初始化项目，符合commitizen的环境

    1. commitizen init cz-conventional-changelog --save-dev --save-exact

  • 提交代码 ```javascript git add .

// 根据提示选择 git cz

  2. > [validate-commit-msg](https://www.npmjs.com/package/validate-commit-msg)比较严格
  6. <a name="fsQik"></a>
  7. ## 使用JWT的方式来进行存储登录信息
  10. <a name="HMXuy"></a>
  11. ## 后端使用验证码的插件-- svg-captcha
  12. > 前端主要展示图片，具体的图片生成是后端生成的
  14. 参考：[官网](https://www.npmjs.com/package/svg-captcha)
  16. - 安装
  17. ```javascript
  18. npm install --save svg-captcha
  • 后端服务中使用
    • 添加路由

app\router.js

  1. // 验证码
  2.   router.get('/captcha', controller.util.captcha)
  • 添加路由的代码

app\controller\util.js

  1. 'use strict'
  2. // 引入插件
  3. const svgCaptcha = require('svg-captcha')
  4. const Controller = require('egg').Controller
  6. class UtilController extends Controller {
  7.   async captcha() {
  8.     const captcha = svgCaptcha.create({
  9.       size: 4,
  10.       fontSize: 50,
  11.       width: 100,
  12.       height: 40,
  13.       noise: 10,
  14.     })
  16.     // 检验文本放入session：captcha.text
  17.     this.ctx.session.captcha = captcha.text
  19.     this.ctx.response.type = 'image/svg+xml'
  21.     this.ctx.body = captcha.data
  23.     console.log('captcha:' + captcha.text)
  24.   }
  25. }
  27. module.exports = UtilController

对后端的路由进行分组的插件 —- egg-router-group

  1. npm i egg-router-group --save

连接mongodb的插件 —- egg-mongoose

  1. npm i egg-mongoose --save

校验接口传输的数据的插件 —- egg-validate

  1. npm i egg-validate --save

使用md5插件加解密 —- md5

  1. npm i md5 --save

JWT的认证需要的插件 —- jsonwebtoken

  1. npm i jsonwebtoken --save

字符的加密、校验、解密的过程

设置基本的接口规范

  1. ## 接口返回规范
  2. {
  3.   code: 0,
  4.   data: {},
  5.   message: '',
  6.   <!-- errors: 具体的报错信息  （可以根据是否是线上环境来判断是否要展示errors） -->
  7. }
  9. code 0 是成功  其他都是失败
  11. -1 错误
  12. -666 登录状态过期
  14. <!-- 权限 -->

app\controller\base.js 基本的规范结构

  1. 'use strict'
  2. // 定制规范
  4. const { Controller } = require('egg')
  6. // 在egg的Controller和业务Controller之间加了一层，这一层是规范层
  7. class BaseController extends Controller {
  8.   success(data) {
  9.     this.ctx.body = {
  10.       code: 0,
  11.       data,
  12.     }
  13.   }
  14.   message(message) {
  15.     this.ctx.body = {
  16.       code: 0,
  17.       message,
  18.     }
  19.   }
  20.   error(message, code = -1, errors = {}) {
  21.     this.ctx.body = {
  22.       code,
  23.       message,
  24.       errors,
  25.     }
  26.   }
  27. }
  29. module.exports = BaseController

使用接口规范返回数据，并且设置非Resful的接口
app\controller\user.js

  1. 'use strict'
  3. const BaseController = require('./base')
  5. const createRule = {
  6.   email: { type: 'email' },
  7.   nickname: { type: 'string' },
  8.   passwd: { type: 'string' },
  9.   captcha: { type: 'string' },
  10. }
  12. class UserController extends BaseController {
  13.   async login() {
  14.     console.log('login')
  15.   }
  17.   async register() {
  18.     const { ctx } = this
  19.     try {
  20.       // 校验传递的参数
  21.       ctx.validate(createRule)
  22.     } catch (e) {
  23.       console.log(e)
  24.       // 因为从baseController继承了，所以可以有基类可以使用
  25.       return this.error('参数校验失败', -1, e.errors)
  26.     }
  28.     const { email, nickname, passwd, captcha } = ctx.request.body
  29.     console.log({ email, nickname, passwd, captcha })
  31.     this.success({ name: 'kkb' })
  32.   }
  34.   async verify() {
  35.     // 校验用户名是否存在
  36.   }
  38.   async info() {
  39.     console.log('info')
  40.   }
  41. }
  44. module.exports = UserController

app\router.js

  1. 'use strict'
  3. /**
  4.  * @param {Egg.Application} app - egg application
  5.  */
  6. module.exports = app => {
  7.   const { router, controller } = app
  9.   router.group({
  10.     name: 'user',
  11.     prefix: '/user', // 路由前缀
  12.   }, router => {
  13.     const {info, register, login, verify} = controller.user
  14.     router.get('/info', info)
  15.     router.post('/register', register)
  16.     router.post('/login', login)
  17.     router.get('/verify', verify)
  18.   })
  21. }

对安装的插件进行配置

config\config.default.js是默认配置

config\plugin.js是对安装的插件进行配置

  1. 'use strict'
  3. // /** @type Egg.EggPlugin */
  4. // module.exports = {
  5. //   // had enabled by egg
  6. //   // static: {
  7. //   //   enable: true,
  8. //   // }
  9. // }
  11. // 分开配置
  12. exports.mongoose = {
  13.   enable: true,
  14.   package: 'egg-mongoose'
  15. }
  17. exports.routerGroup = {
  18.   enable: true,
  19.   package: 'egg-router-group'
  20. }
  22. exports.validate = {
  23.   enable: true,
  24.   package: 'egg-validate'
  25. }

配置数据库和其他

config\config.default.js

  1. /* eslint valid-jsdoc: "off" */
  3. 'use strict'
  5. /**
  6.  * @param {Egg.EggAppInfo} appInfo app info
  7.  */
  8. module.exports = appInfo => {
  9.   /**
  10.    * built-in config
  11.    * @type {Egg.EggAppConfig}
  12.    **/
  13.   const config = exports = {}
  15.   // use for cookie sign key, should change to your own and keep security
  16.   config.keys = appInfo.name + '_1617240484420_9074'
  18.   // add your middleware config here
  19.   config.middleware = []
  21.   // add your user config here
  22.   const userConfig = {
  23.     // myAppName: 'egg',
  24.   }
  26.   return {
  27.     ...config,
  28.     ...userConfig,
  29.     // 配置egg,js
  30.     security: {
  31.       csrf: { // csrf是egg对post请求自带的，先临时关闭
  32.         enable: false,
  33.       },
  34.     },
  35.     // 配置数据库
  36.     mongoose: {
  37.       client: {
  38.         url: 'mongodb://127.0.0.1:27017/kkbhub',
  39.         options: {
  41.         },
  42.       },
  43.     },
  44.   }
  45. }

发邮件的库——nodemailer

参考文档：官网文档

  1. 安装

    1. npm install nodemailer --save

  2. 使用

app\service\tools.js

  1. 'use strict'
  3. const { Service } = require('egg')
  4. const nodemailer = require('nodemailer')
  6. // 新建一个发送者，service是配置一个什么服务
  7. const userEmail = '223859391@qq.com'
  8. const transporter = nodemailer.createTransport({
  9.   service: 'QQ',
  10.   secureConnection: true,
  11.   auth: {
  12.     user: userEmail,
  13.     pass: 'jrmpukkyreynbhib', // jrmpukkyreynbhib
  14.   },
  15. })
  17. class ToolService extends Service {
  18.   async sendMail(email, subject, text, html) {
  19.     const mailOptions = {
  20.       from: userEmail,
  21.       cc: userEmail, // 抄送，可以避免有的邮箱认为这个是垃圾邮件（这个是一个小tip）
  22.       to: email,
  23.       subject,
  24.       text,
  25.       html,
  26.     }
  27.     try {
  28.       await transporter.sendMail(mailOptions)
  29.       return true
  30.     } catch (err) {
  31.       console.log('email error', err)
  32.       return false
  33.     }
  34.   }
  35. }
  37. module.exports = ToolService

如果是qq邮箱的话，则需要到下面的这个网址开启相关的服务：qq开启服务指导手册

egg-mongoose的使用

参考：https://juejin.cn/post/6844903772775268366