阿西河

所有教程

公众号
🌙
阿西河前端的公众号

我的收藏

    最近访问  (文章)

    教程列表

    数据库
    抓包专区
    测试专区

    Egg.js 异常处理

    异常捕获

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

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

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

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

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

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

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

    为了保证异常可追踪,必须保证所有抛出的异常都是 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

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

    自定义统一异常处理

    尽管框架提供了默认的统一异常处理机制,但是应用开发中经常需要对异常时的响应做自定义,特别是在做一些接口开发的时候。框架自带的 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;
        },
        jsonp(err, ctx) {
          // 一般来说,不需要特殊针对 jsonp 进行错误定义,jsonp 的错误处理会自动调用 json 错误处理,并包装成 jsonp 的响应格式
        },
      },
    };
    

    404

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

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

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

      <h1>404 Not Found</h1>
      

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

    // config/config.default.js
    module.exports = {
      notfound: {
        pageUrl: '/404.html',
      },
    };
    

    自定义 404 响应

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

    // app/middleware/notfound_handler.js
    module.exports = () => {
      return async function notFoundHandler(ctx, next) {
        await next();
        if (ctx.status === 404 && !ctx.body) {
          if (ctx.acceptJSON) {
            ctx.body = { error: 'Not Found' };
          } else {
            ctx.body = '<h1>Page Not Found</h1>';
          }
        }
      };
    };
    

    在配置中引入中间件:

    // config/config.default.js
    module.exports = {
      middleware: [ 'notfoundHandler' ],
    };
    
    卖前端学习教程

    只需几十元,就能买到培训班的内部教程!开启高薪之路!

    零基础小白阿里P7的教程都有!

    同时长期收购所有培训班的前端教程

    目录
    目录