Koa 中的错误处理解析

 更新时间:2019年04月09日 08:29:34   作者:刘哇勇的部落格  
这篇文章主要介绍了Koa 中的错误处理解析,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

不像 express 中在末尾处注册一个声明为 (err, req, res, next) 中间件的方式,koa 刚好相反,在开头进行注册。

app.use(async (ctx, next) => {
 try {
  await next();
 } catch (err) {
  ctx.status = err.status || 500;
  ctx.body = err.message;
  ctx.app.emit("error", err, ctx);
 }
});

这样程序中任何报错都会收敛到此处。此时可以方便地将错误打印到页面,开发时非常便捷。

+   ctx.app.emit('error', err, ctx);

koa 也建议通过 app 来派发错误,然后通过监听 app 上的 error 事件对这些错误做进一步的统一处理和集中管理。

app.on("error", (err, ctx) => {
 /* 错误的集中处理:
  * log 出来
  * 写入日志
  * 写入数据库
  *  ...
  */
});

一个错误捕获并打印到页面的示例:

const Koa = require("koa");
const app = new Koa();

app.use(async (ctx, next) => {
 try {
  await next();
 } catch (err) {
  const status = err.status || 500;
  ctx.status = status;
  ctx.type = "html";
  ctx.body = `
  <b>${status}</b> ${err}
  `;
  // emmit
  ctx.app.emit("error", err, ctx);
 }
});

app.use(ctx => {
 const a = "hello";
 a = "hello world!"; // TypeError: Assignment to constant variable.
 ctx.body = a;
});

app.on("error", (err, ctx) => {
 console.error("Ooops..\n", err);
});

app.listen(3000);

通过 node server.js 启动后访问页面可看到命令行的错误输出。

如果使用 pm2,可通过 —no-daemon 参数使其停留在在命令行以查看输出。

如果不使用上述参数,可通过 pm2 logs [app-name] 来查看。

ctx.throw

朴素的抛错方式需要手动设置状态码及信息对客户端的可见性。

const err = new Error("err msg");
err.status = 401;
err.expose = true;
throw err;

expose 决定是否会返回错误详情给客户端,否则只展示状态对应的错误文案,比如 500 会在浏览器中展示为 Internal Server Error 。

而通过 ctx.throw 这个 helper 方法会更加简洁。

上面的代码片段等价于:

ctx.throw(401, "err msg");

如果不指定状态码,默认为 500。5xx 类错误 expose 默认为 false ,即不会将错误信息返回到 response。

抛错时还可以传递一些额外数据,这些数据会合并到错误对象上,在处理错误的地方可以从 error 上获取。

app.use(ctx => {
 ctx.throw(401, "access_denied", { user: { name: "foo" } });
});

app.on("error", (err, ctx) => {
 console.error("Ooops..\n", err.user);
});

参考

Error Handling
ctx.throw

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • Node.js+Express+Vue+MySQL+axios的项目搭建全过程

    Node.js+Express+Vue+MySQL+axios的项目搭建全过程

    这篇文章主要介绍了Node.js+Express+Vue+MySQL+axios的项目搭建全过程,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-12-12
  • npm install的--save和--save-dev使用说明(推荐)

    npm install的--save和--save-dev使用说明(推荐)

    这篇文章主要介绍了npm install的--save和--save-dev使用说明,文中给大家提到了各个命令的区别及各种安装参数的区别,需要的朋友可以参考下
    2022-08-08
  • Node.js使用express写接口的具体代码

    Node.js使用express写接口的具体代码

    这篇文章主要介绍了Node.js使用express写接口,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-03-03
  • 利用Node.js和MySQL实现创建API服务器

    利用Node.js和MySQL实现创建API服务器

    这篇文章主要为大家详细介绍了如何使用Node.js和MySQL创建API服务器的步骤,这也是从前端迈向全栈的一个开始,文中的示例代码讲解详细,感兴趣的小伙伴可以了解下
    2024-01-01
  • Node.js工具库yeoman使用介绍

    Node.js工具库yeoman使用介绍

    这篇文章主要为大家介绍了Node.js工具库yeoman的使用介绍,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2024-01-01
  • nodejs制作爬虫实现批量下载图片

    nodejs制作爬虫实现批量下载图片

    本文给大家分享的是作者使用nodejs制作爬虫来爬去图片并批量下载的全过程,非常的细致,有需要的小伙伴可以参考下
    2017-05-05
  • NodeJS使用JWT跨域身份验证方案详解

    NodeJS使用JWT跨域身份验证方案详解

    JWT是为了在网络应用环境间传递声明而执行的一种基于JSON的开放标准,其组成部分为Header、Payload、Signature.Payload部分才是真正的用户信息,它是用户信息经过加密之后生成的字符串,Header和Signature是安全性相关的部分,只是为了保证token的安全性
    2023-02-02
  • nodejs 图解express+supervisor+ejs的用法(推荐)

    nodejs 图解express+supervisor+ejs的用法(推荐)

    下面小编就为大家带来一篇nodejs 图解express+supervisor+ejs的用法(推荐)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-09-09
  • NodeJs内置模块超详细讲解

    NodeJs内置模块超详细讲解

    Node.js内置模块也叫核心模块,跟随Node.js一起安装。console模块提供了一个简单的调试控制台,类似于网络浏览器提供的 JavaScript控制台机制
    2023-01-01
  • node.js连接mongoose数据库方法详解

    node.js连接mongoose数据库方法详解

    之前我们都是通过shell来完成对数据库的各种操作的,在开发中大部分时候我们都需要通过程序来完成对数据库的操作。而Mongoose就是一个让我们可以通过Node来操作MongoDB的模块
    2022-08-08

最新评论