# 前言

上一章学习了如何将 GitLab Api 封装成工具类作为后期业务开发的基础。

除了 GitLab 工具类之外，实际开发中还会需要一些额外的工具类辅助开发，可以预先将这些工具类封装好，业务开发的时候效率更高。

本章会介绍其他的一些全局与工具类的开发与使用。

# 封装基础 Controller

上一章中，用户的业务 Controller 是继承了 BaseController 而不是直接继承 Egg 的 Controller，这是因为使用了运用继承的原理，对 Controller 做一层基础的封装，内置一些常用的功能，比如获取用户信息、全局返回参数等。

import { Controller } from "egg";

export default class BaseController extends Controller {
  get user() {
    return this.ctx.user;
  }

  success(data) {
    this.ctx.body = {
      code: 0,
      data,
    };
  }

  error({ code, data, message }) {
    // 根据业务返回不同的错误 code，提供给前端做业务判断处理
    this.ctx.body = {
      code,
      data,
      message,
    };
  }
}

@前端进阶之旅: 代码已经复制到剪贴板

定义全局返回参数基础类之后，业务 Controller 继承基础类，业务类可以根据条件判断使用 success 或 error 方法，前端可以根据返回的 code 值进行业务判断。如果项目中还需要其他的额外处理，可以继续添加或者创建多个基础类。合理利用继承的优势，可以提高代码质量。

# 添加全局报错拦截

没有绝对安全的程序，所有程序在运行中可能因各种情况会出现异常，但有些情况并不需要将所有的报错内容直接抛给前端，展示给用户，所以全局错误回调是基础模块必要的。

全局错误拦截常用两种方式：

# 框架内置异常处理

Egg 框架自带的 onerror 插件支持自定义配置错误处理方法，可以覆盖默认的错误处理方法，需要的话可以根据实际业务重写。

// config/config.default.js
module.exports = {
  onerror: {
    all(err, ctx) {
      // 在此处定义针对所有响应类型的错误处理方法
      // 注意，定义了 config.all 之后，其他错误处理方法不会再生效
      ctx.body = 'error';
      ctx.status = 500;
    },
    html(err, ctx) {
      // html hander
      ctx.body = '<h3>error</h3>';
      ctx.status = 500;
    },
    json(err, ctx) {
      // json hander
      ctx.body = { message: 'error' };
      ctx.status = 500;
    },
  },
};

@前端进阶之旅: 代码已经复制到剪贴板

# 异常中间件

除了使用框架自带的 onerror 插件之外，也可以使用自定义中间件拦截所有请求，采用用 try/catch 统一捕获错误。

新建文件 app/middleware/error_handler.ts, 复制下述代码

export default class HttpExceptions extends Error { // 继承修改 error 类型
  code: number;
  msg: string;
  httpCode: number;

  constructor({ msg = "服务器异常", code = 1, httpCode = 400 }) {
    super();
    this.msg = msg;
    this.code = code;
    this.httpCode = httpCode;
  }
}

import HttpExceptions from "../exceptions/http_exceptions"; // 全局拦截错误处理

export default () => {
  return async function errorHandler(ctx, next) {
    try {
      await next();
    } catch (err) {
      // 所有的异常都在 app 上触发一个 error 事件，框架会记录一条错误日志
      ctx.app.emit("error", err, ctx);

      let status = err.status || 500;
      let error: any = {};

      if (err instanceof HttpExceptions) {
        status = err.httpCode;
        error.requestUrl = `${ctx.method} : ${ctx.path}`;
        error.msg = err.msg;
        error.code = err.code;
        error.httpCode = err.httpCode;
      } else {
        // 未知异常，系统异常，线上不显示堆栈信息
        // 生产环境时 500 错误的详细错误内容不返回给客户端，因为可能包含敏感信息
        error.code = 500;
        error.errsInfo =
          status === 500 && ctx.app.config.env === "prod"
            ? "Internal Server Error"
            : err.message;
      }
      // 从 error 对象上读出各个属性，设置到响应中
      ctx.body = error;
      if (status === 422) {
        ctx.body.detail = err.errors;
      }
      ctx.status = status;
    }
  };
};

@前端进阶之旅: 代码已经复制到剪贴板

如上，添加错误中间件拦截全局异常，如果出现自定义异常抛出的时候，则处理全局异常，否则统一抛出 500 错误，去除敏感信息。自定义中间件的使用下一章的 jwtAuth 插件。

# 消息通知

项目中会有各种流程节点，比如发布状态、测试反馈、流程流转等等，如果只在 web 界面中展示状态变更，显然是不及时，可以先将消息通知的工具类开发完，后期业务侧可以直接调用。

# 邮件推送

一般邮件是正式沟通交流的方式，例如状态流转比如提测、正式发布上线、测试打回等跟项目流程相关的内容，需要使用邮件通知。

发送邮件使用 nodemailer
邮件模板使用 nunjucks 模板引擎，配置邮件模板
邮件前端自定义内容使用 marked 插件解析 markdown 语法

nodemailer 发送邮件工具类封装

import { MAIL_CONFIG } from "../../config/default.config";

const marked = require("marked"); // marked 转换
const nodemailer = require("nodemailer"); // 发送邮件
const nunjucks = require("nunjucks"); // 模板引擎
const path = require("path");

// 邮箱配置初始化
const transporter = nodemailer.createTransport({
  host: MAIL_CONFIG.service,
  secureConnection: true, // 使用 SSL 方式（安全方式，防止被窃取信息）
  port: MAIL_CONFIG.port,
  auth: {
    user: MAIL_CONFIG.user_email, // 账号
    pass: MAIL_CONFIG.auth_code, // 授权码
  },
});

const htmlModel = ({ storyMail, exitInfo, summitUser, iterationMail }) => {
  const html = nunjucks.render(path.join(__dirname, "./emailTpl/email.njk"), {
    storyMail,
    exitInfo,
    summitUser,
    iterationMail,
  });
  return html;
};

/*
 * toEmail: String 接收者,可以同时发送多个,以逗号隔开
 * subject: String 标题
 * cc: String 抄送
 * text: String 文本
 * html: Object titleList表头 conterFontList内容
 * attachments: any 附件
 * [
 *  {
     filename: 'img1.png',            // 改成你的附件名
     path: 'public/images/img1.png',  // 改成你的附件路径
     cid : '00000001'                 // cid可被邮件使用
    }
 * ]
 */

interface mailInterface {
  toEmail: string;
  subject: string;
  cc?: string;
  text?: string;
  html?: any;
  attachments?: any;
  storyMail?: any;
  exitInfo?: any;
  summitUser?: String;
  iterationMail?: any;
}

const sendMail = async (mailOptions: mailInterface) => {
  const {
    toEmail,
    subject,
    cc,
    text,
    attachments,
    storyMail,
    exitInfo,
    summitUser,
    iterationMail,
  } = mailOptions;
  Object.keys(exitInfo).forEach((key) => {
    exitInfo[key] = marked(exitInfo[key]);
  });
  const html = htmlModel({ storyMail, exitInfo, summitUser, iterationMail });
  const mailOpts = {
    from: MAIL_CONFIG.user_email, // 发送者,与上面的 user 一致
    to: toEmail,
    subject,
    cc,
    text,
    html,
    attachments,
  };
  try {
    transporter.sendMail(mailOpts);
    return true;
  } catch (err) {
    console.log(err);
    return false;
  }
};

export default { sendMail };

@前端进阶之旅: 代码已经复制到剪贴板

nunjucks 模板使用

邮件模板可以使用 html 格式，但是自己直接画的话，样式并不好控制，可以使用 QQ 邮箱的邮件转代码功能

如下图所示，先将邮件的内容填好

点击格式，选择代码功能，可以将转成 code 的邮件内容复制出来

最后转成 nunjucks 模板即可

# 群机器人

除了流程通知之外的，其他例如代码检测失败、构建状态通知，可以使用机器人这种聊天工具推送，时效、便捷。

群机器人这里选择钉钉群机器人，参考钉钉机器人文档下面附带具体的实现代码(为了安全且简单，采用加签的安全验证)。

如果是企业微信用户的话，可以参考企业微信机器人文档，两者使用原理差不多，都是通过 webhook 进行消息推送。

上述只附带了 text 文本消息推送，markdown、link、FeedCard 等其他消息类型，照着例子直接上手改就行了

# 前言

# 封装基础 Controller

# 添加全局报错拦截

# 框架内置异常处理

# 异常中间件

# 消息通知

# 邮件推送

# 群机器人

# Sequelize

# 配置

# 使用

# 本章小结

Node 工具篇 全局与工具类|Node Devops专题

Node 工具篇 全局与工具类|Node Devops专题

Node 工具篇全局与工具类|Node Devops专题

Node 工具篇全局与工具类|Node Devops专题