以 egg-auth为例，如何写一个规范的 egg中间件
可以查看，node_modules目录下的 egg-开头的，例如 egg-static静态目录插件，查看egg的插件规范。
image.png

config

/config/plugin.js 注册 egg插件

  1. const path = require('path');
  2. const pathJoin = url => path.join(__dirname, url);
  4. // 模板引擎
  5. exports.nunjucks = {
  6.   enable: true,
  7.   package: 'egg-view-nunjucks', // npm安装的插件用 package
  8. };
  10. // 登录鉴权
  11. exports.auth = {
  12.   enable: true,
  13.   // 本地的插件用 path
  14.   path: pathJoin('../lib/plugin/egg-auth'),
  15. };

package 和 path是互斥的，只能使用一个

  • package npm安装的插件，用 package
  • path 本地插件用 path

config.default.js

配置插件参数，例如 白名单

  1. // exclude 不需要验证的路由
  2. config.auth = {
  3.   exclude: ['/home', '/login', 'logout']
  4. }

options 参数里获取 config.auth的 exclude配置

app

middleware

/lib/plugin/egg-auth/app/middleware/auth.js

  1. 'use strict';
  3. module.exports = options => {
  5.   return async (ctx, next) => {
  6.     const { url } = ctx.request;
  7.     const { user } = ctx.session;
  8.     // const user = await ctx.app.redis.get(ctx.username);
  9.     // 比较 redis 里存的用户名和请求传过来的是否相等
  10.     // const user = username ? username === token : username;
  12.     // '/index.html?id=123&name=ok'.split('?')
  13.     const [ path ] = url.split('?');
  14.     // 排除的白名单, config.default.js里面的 config.auth就是 options
  15.     const include = options.exclude?.includes(path);
  17.     if (!user && !include) {
  18.       ctx.redirect(`/login?callback=${url}`);
  19.       // ctx.body = {
  20.       //   status: 1001,
  21.       //   message: '用户未登录',
  22.       // };
  23.       return; // 必须要 return，否则下面的代码会执行
  24.     }
  26.     await next();
  27.   };
  28. };

package.json

  1. {
  2.   "name": "egg-auth",
  3.   "version": "1.0.0",
  4.   "eggPlugin": {
  5.     "name": "auth"
  6.   },
  7.   "dependencies": {
  8.   }
  9. }

coreMiddleware 注册中间件

app.config.coreMiddleware 是个数组

  1. app.config.coreMiddleware.push('auth');