npm 包 egg-response 使用教程-JavaScript中文网-JavaScript教程资源分享门户

简介

egg-response 是一个针对 Egg.js 框架的响应拦截器，可以帮助开发者更方便地响应请求，并提供了多种常用的响应类型，如 json、html、text 等。

此教程将介绍如何使用 egg-response，示例代码将结合 Egg.js 进行演示。

安装

在 Egg.js 项目根目录下执行以下命令：

npm install egg-response --save

安装完成后，在 config/plugin.js 文件中增加对 egg-response 的配置：

exports.response = {
  enable: true,
  package: 'egg-response',
};

响应类型

egg-response 提供了以下响应类型：

json

返回 JSON 格式响应，示例代码如下：

ctx.body = {
  code: 0,
  message: 'success',
  data: {
    name: '张三',
    age: 18,
  },
};

html

返回 HTML 格式响应，示例代码如下：

ctx.body = `
  <html>
    <head>
      <title>Hello</title>
    </head>
    <body>
      <h1>Hello, world!</h1>
    </body>
  </html>
`;

text

返回纯文本响应，示例代码如下：

ctx.body = 'Hello, world!';

status

返回指定状态码响应，示例代码如下：

ctx.status = 403;
ctx.body = '您无权访问此页面！';

使用方法

在控制器中，可以通过 ctx.response.api 对象调用响应方法。例如，返回 JSON 格式响应可以这样写：

async someAction() {
  ctx.response.api.json({
    code: 0,
    message: 'success',
    data: {
      name: '张三',
      age: 18,
    },
  });
}

egg-response 也提供了多种其它响应类型的方法，如 ctx.response.api.html()、ctx.response.api.text()、ctx.response.api.status() 等。这些方法的使用与 json() 方法类似，只需根据需要传递不同的参数即可。

结语

本教程介绍了 egg-response 的安装与使用方法，以及提供的多种常用响应类型的示例代码。希望对 Egg.js 开发者提供帮助，也欢迎大家在评论区留言交流。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/600673e2fb81d47349e53d88