feat: add koa-error & koa-api-error-response middleware

src/app/middlewares/index.ts

@@ -1,8 +1,12 @@
+import koaApiErrorResponse from './koa-api-error-response';
+import koaError from './koa-error';
 import koaCors from './koa-cors';
 import koaNotFound from './koa-not-found';
 import koaResponseTime from './koa-response-time';
 
 export {
+  koaApiErrorResponse,
+  koaError,
   koaCors,
   koaNotFound,
   koaResponseTime

src/app/middlewares/koa-api-error-response.ts

@@ -0,0 +1,21 @@
+import { Context } from 'koa';
+import { apiServerInstance } from '../services';
+
+/**
+ * 处理自定义接口错误，并响应错误信息
+ */
+const koaError = async function (ctx: Context, next) {
+  try {
+    await next();
+  } catch (_err) {
+    const err = _err || new Error('Null or undefined error');
+    // 判断是否为通用 api error
+    if (apiServerInstance.isApiErrorResponse(err.message)) {
+      ctx.body = JSON.parse(err.message);
+      return;
+    }
+    throw (err);
+  }
+};
+
+export default koaError;

src/app/middlewares/koa-error.ts

@@ -0,0 +1,28 @@
+import { Context } from 'koa';
+import GLOBAL_CONFIG from '../config/system.config';
+/**
+ * 异常处理
+ */
+const koaError = async function (ctx: Context, next) {
+  try {
+    await next();
+  } catch (_err) {
+    const err = _err || new Error('Null or undefined error');
+    ctx.app.emit('error', err, ctx);
+    ctx.set('Cache-Control', 'no-cache, max-age=0');
+    ctx.status = err.status || 500;
+    ctx.type = 'application/json';
+    const resp = err.response || {};
+    ctx.body = {
+      code: err.code,
+      error: resp.body || err.error,
+      message: err.message,
+    };
+    // 在开发环境下,显示错误堆栈信息
+    if (GLOBAL_CONFIG.isDev) {
+      ctx.body.stack = err.stack;
+    }
+  }
+};
+
+export default koaError;

src/app/preset.middleware.ts

@@ -8,16 +8,22 @@ import koaJson from 'koa-json';
 import koaFavicon from 'koa-favicon';
 import koaStaticServer from 'koa-static-server';
 import {
-  koaCors, koaNotFound
+  koaCors,
+  koaError,
+  koaNotFound,
+  koaApiErrorResponse
 } from './middlewares';
 import { join as pathJoin } from 'path';
+
 export class PresetMiddleware {
   app: Koa;
   constructor(app: Koa) {
     this.app = app;
   }
 
   use(): Koa {
+    // 统一处理错误响应信息
+    this.app.use(koaError);
     // 处理跨域
     this.app.use(koaCors);
     // 打印每一次接口请求响应时间
@@ -42,6 +48,7 @@ export class PresetMiddleware {
     this.app.use(views(pathJoin(__dirname, '../assets/views'), {
       extension: 'pug'
     }));
+    this.app.use(koaApiErrorResponse);
     this.app.use(index.routes());
     this.app.use(api.routes());
     /**