title: 异常处理

异常捕获

得益于框架支持的异步编程模型,错误完全可以用 try catch 来捕获。在编写应用代码时,所有地方都可以直接用 try catch 来捕获异常。

  1. // app/service/test.js
  2. try {
  3. const res = await this.ctx.curl('http://eggjs.com/api/echo', { dataType: 'json' });
  4. if (res.status !== 200) throw new Error('response status is not 200');
  5. return res.data;
  6. } catch (err) {
  7. this.logger.error(err);
  8. return {};
  9. }

按照正常代码写法,所有的异常都可以用这个方式进行捕获并处理,但是一定要注意一些特殊的写法可能带来的问题。打一个不太正式的比方,我们的代码全部都在一个异步调用链上,所有的异步操作都通过 await 串接起来了,但是只要有一个地方跳出了异步调用链,异常就捕获不到了。

  1. // app/controller/home.js
  2. class HomeController extends Controller {
  3. async buy () {
  4. const request = {};
  5. const config = await ctx.service.trade.buy(request);
  6. // 下单后需要进行一次核对,且不阻塞当前请求
  7. setImmediate(() => {
  8. ctx.service.trade.check(request).catch(err => ctx.logger.error(err));
  9. });
  10. }
  11. }

在这个场景中,如果 service.trade.check 方法中代码有问题,导致执行时抛出了异常,尽管框架会在最外层通过 try catch 统一捕获错误,但是由于 setImmediate 中的代码『跳出』了异步链,它里面的错误就无法被捕捉到了。因此在编写类似代码的时候一定要注意。

当然,框架也考虑到了这类场景,提供了 ctx.runInBackground(scope) 辅助方法,通过它又包装了一个异步链,所有在这个 scope 里面的错误都会统一捕获。

  1. class HomeController extends Controller {
  2. async buy () {
  3. const request = {};
  4. const config = await ctx.service.trade.buy(request);
  5. // 下单后需要进行一次核对,且不阻塞当前请求
  6. ctx.runInBackground(async () => {
  7. // 这里面的异常都会统统被 Backgroud 捕获掉,并打印错误日志
  8. await ctx.service.trade.check(request);
  9. });
  10. }
  11. }

为了保证异常可追踪,必须保证所有抛出的异常都是 Error 类型,因为只有 Error 类型才会带上堆栈信息,定位到问题。

框架层统一异常处理

框架通过 onerror 插件提供了统一的错误处理机制。对一个请求的所有处理方法(Middleware、Controller、Service)中抛出的任何异常都会被它捕获,并自动根据请求想要获取的类型返回不同类型的错误(基于 Content Negotiation)。

请求需求的格式 环境 errorPageUrl 是否配置 返回内容
HTML & TEXT local & unittest - onerror 自带的错误页面,展示详细的错误信息
HTML & TEXT 其他 重定向到 errorPageUrl
HTML & TEXT 其他 onerror 自带的没有错误信息的简单错误页(不推荐)
JSON & JSONP local & unittest - JSON 对象或对应的 JSONP 格式响应,带详细的错误信息
JSON & JSONP 其他 - JSON 对象或对应的 JSONP 格式响应,不带详细的错误信息

errorPageUrl

onerror 插件的配置中支持 errorPageUrl 属性,当配置了 errorPageUrl 时,一旦用户请求线上应用的 HTML 页面异常,就会重定向到这个地址。

config/config.default.js

  1. // config/config.default.js
  2. module.exports = {
  3. onerror: {
  4. // 线上页面发生异常时,重定向到这个页面上
  5. errorPageUrl: '/50x.html',
  6. },
  7. };

自定义统一异常处理

尽管框架提供了默认的统一异常处理机制,但是应用开发中经常需要对异常时的响应做自定义,特别是在做一些接口开发的时候。框架自带的 onerror 插件支持自定义配置错误处理方法,可以覆盖默认的错误处理方法。

  1. // config/config.default.js
  2. module.exports = {
  3. onerror: {
  4. all(err, ctx) {
  5. // 在此处定义针对所有响应类型的错误处理方法
  6. // 注意,定义了 config.all 之后,其他错误处理方法不会再生效
  7. ctx.body = 'error';
  8. ctx.status = 500;
  9. },
  10. html(err, ctx) {
  11. // html hander
  12. ctx.body = '<h3>error</h3>';
  13. ctx.status = 500;
  14. },
  15. json(err, ctx) {
  16. // json hander
  17. ctx.body = { message: 'error' };
  18. ctx.status = 500;
  19. },
  20. jsonp(err, ctx) {
  21. // 一般来说,不需要特殊针对 jsonp 进行错误定义,jsonp 的错误处理会自动调用 json 错误处理,并包装成 jsonp 的响应格式
  22. },
  23. },
  24. };

404

框架并不会将服务端返回的 404 状态当做异常来处理,但是框架提供了当响应为 404 且没有返回 body 时的默认响应。

  • 当请求被框架判定为需要 JSON 格式的响应时,会返回一段 JSON:

    1. { "message": "Not Found" }
  • 当请求被框架判定为需要 HTML 格式的响应时,会返回一段 HTML:

    1. <h1>404 Not Found</h1>

框架支持通过配置,将默认的 HTML 请求的 404 响应重定向到指定的页面。

  1. // config/config.default.js
  2. module.exports = {
  3. notfound: {
  4. pageUrl: '/404.html',
  5. },
  6. };

自定义 404 响应

在一些场景下,我们需要自定义服务器 404 时的响应,和自定义异常处理一样,我们也只需要加入一个中间件即可对 404 做统一处理:

  1. // app/middleware/notfound_handler.js
  2. module.exports = () => {
  3. return async function notFoundHandler(ctx, next) {
  4. await next();
  5. if (ctx.status === 404 && !ctx.body) {
  6. if (ctx.acceptJSON) {
  7. ctx.body = { error: 'Not Found' };
  8. } else {
  9. ctx.body = '<h1>Page Not Found</h1>';
  10. }
  11. }
  12. };
  13. };

在配置中引入中间件:

  1. // config/config.default.js
  2. module.exports = {
  3. middleware: [ 'notfoundHandler' ],
  4. };