错误处理（ErrorHandler）

程序在执行过程中总会遇到一些可预测或者不可预测的异常，如果对这些异常不做处理，可能会导致程序的崩溃，所以我们需要对程序的异常进行捕获并做相应的处理。下面介绍下在使用 Uma 进行开发时有哪些方法可以捕获程序的异常。

在方法中 try-catch

在需要的地方进行try-catch是开发语言为我们提供的捕获错误方法，我们将可能出错的代码通过try-catch进行包裹，在catch中对异常进行处理。

import { BaseController } from '@umajs/core'

export default class Index extends BaseController {
  index() {
    try {
      // ......
      return this.json({ code: 100, msg: 'success' })
    } catch (err) {
      // 出现错误时处理
      return this.json({ code: -100, msg: 'error' })
    }
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13

使用Around

Uma 提供的 Aspect 中，我们可以通过Around来处理异常。

在AOP一节中我们介绍了，当方法执行过程中，Around装饰器传入的函数可以拦截目标函数的执行，我们可以在函数执行过程中通过try,catch捕获异常并且进行统一返回处理。

// ${URSA_ROOT}/aspect/err.aspect.ts
// /aspect/method.aspect.ts
import { IProceedJoinPoint } from '@umajs/core';

export async function throwErr(proceedPoint: IProceedJoinPoint<any>) {
    let result;
    try{
       // 执行被修饰的方法
      const result = await proceedPoint.proceed();
    }catch(e:Error){
      return Result.json({code:1,message:'执行方法异常！',stack:e.stack})
    }
   
    return result;
}

// ${URSA_ROOT}/controller/index.controller.ts
export default class Index extends  BaseController {
    // 添加异常处理切面方法，当index执行出错时会执行afterThrowing
    @Around(throwErr)
    index() {
        throw new Error('error');
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

中间件方式

在plugin中，我们可以通过插件加载全局中间件，而在中间件中我们可以对next中间件进行捕获，因为插件中引入的中间件执行顺序总是在controller函数被调用之前。

// plugin/error-handler/index.ts
export default (uma: Uma, options: TView = {}): Koa.Middleware => {
    // uma 实例化对象；options 插件配置的 options，等同于 uma.plugin['error-handler'].options
    return async(ctx,next)=>{
        try{
          await next();
        }catch(e){
          console.error('error-handler插件捕获异常',e);
        }
    };
};

1
2
3
4
5
6
7
8
9
10
11

使用 plugin-status

plugin-status是 Uma 为了方便用户对 response不同状态码情况和错误进行处理提供的插件。

具体使用方法可以参考插件/Status一章

// status.config.ts
export default {
    // 针对状态码进行处理
    _404(ctx) {
        return ctx.render('404.html');
    }
    // 针对未被捕获错误进行处理
    _error(e: Error, ctx) {
        // ...
    }
}

1
2
3
4
5
6
7
8
9
10
11

三种错误处理方式的使用场景

try-catch: 适合对方法单独进行错误处理
Around: 更具可复用性，可以对多个方法进行错误处理
中间件方式: 属于全局异常兜底策略，适用于全局范围内未知异常捕获处理
plugin-status: 对整个系统在运行中未被捕获的错误的兜底操作，让系统更健壮，同时除了错误处理外，更多的是对不同状态码的统一处理

# 错误处理（ErrorHandler）

# 在方法中 try-catch

# 使用Around

# 中间件方式

# 使用 plugin-status

# 三种错误处理方式的使用场景