如何在 Jest 中使用 nock 模拟 HTTP 请求的应用-JavaScript中文网-JavaScript教程资源分享门户

在前端开发中，我们经常需要使用 HTTP 协议与后端进行数据交互。而在进行单元测试时，我们往往需要模拟 HTTP 请求，以避免对后端进行过多的依赖。在这种情况下，我们可以使用 nock 库来模拟 HTTP 请求。本文将介绍如何在 Jest 中使用 nock 库进行 HTTP 请求的模拟。

nock 简介

nock 是一个 Node.js 库，用于模拟 HTTP 请求。它可以拦截 Node.js 中的 HTTP 请求，并返回我们预先定义的响应。使用 nock 的好处是，我们可以在测试中模拟 HTTP 请求，而不需要实际向后端发出请求。这样可以使测试更快、更可靠，同时减少对后端的依赖。

安装 nock

在使用 nock 之前，我们需要先安装它。我们可以使用 npm 命令来安装 nock：

npm install nock --save-dev

使用 nock 模拟 HTTP 请求

在 Jest 中使用 nock 进行 HTTP 请求的模拟非常简单。我们只需要在测试前调用 nock 的 intercept 方法，然后定义我们希望拦截的请求和响应即可。

以下是一个使用 nock 模拟 HTTP 请求的简单示例：

// javascriptcn.com 代码示例
const nock = require('nock');

test('test with nock', async () => {
  const scope = nock('https://api.example.com')
    .get('/data')
    .reply(200, { data: 'hello world' });

  const response = await fetch('https://api.example.com/data');
  const data = await response.json();

  expect(data).toEqual({ data: 'hello world' });
  expect(scope.isDone()).toBe(true);
});

在这个示例中，我们使用 nock 拦截了 https://api.example.com/data 的 GET 请求，并返回了一个状态码为 200 的响应，响应内容为 { data: 'hello world' }。然后我们使用 fetch 方法来发起这个请求，并将响应转换为 JSON 格式的数据。最后，我们使用 Jest 的 expect 方法来断言返回的数据是否符合预期，并使用 isDone 方法来断言我们定义的拦截器是否被触发。

模拟错误响应

除了模拟成功的响应之外，我们还可以使用 nock 模拟错误的响应。以下是一个模拟错误响应的示例：

// javascriptcn.com 代码示例
const nock = require('nock');

test('test with nock error', async () => {
  const scope = nock('https://api.example.com')
    .get('/data')
    .replyWithError('something went wrong');

  try {
    const response = await fetch('https://api.example.com/data');
    const data = await response.json();
    fail('should have thrown an error');
  } catch (error) {
    expect(error.message).toEqual('something went wrong');
    expect(scope.isDone()).toBe(true);
  }
});

在这个示例中，我们使用 nock 拦截了 https://api.example.com/data 的 GET 请求，并返回了一个错误响应，错误消息为 something went wrong。然后我们使用 fetch 方法来发起这个请求，并使用 Jest 的 expect 方法来断言是否抛出了预期的错误，并使用 isDone 方法来断言我们定义的拦截器是否被触发。

模拟超时响应

有时候我们需要模拟超时响应。以下是一个模拟超时响应的示例：

// javascriptcn.com 代码示例
const nock = require('nock');

test('test with nock timeout', async () => {
  const scope = nock('https://api.example.com')
    .get('/data')
    .delay(200)
    .reply(200, { data: 'hello world' });

  try {
    const response = await fetch('https://api.example.com/data');
    const data = await response.json();
    fail('should have thrown a timeout error');
  } catch (error) {
    expect(error.type).toEqual('request-timeout');
    expect(scope.isDone()).toBe(true);
  }
});

在这个示例中，我们使用 nock 拦截了 https://api.example.com/data 的 GET 请求，并设置了一个 200 毫秒的延迟。然后我们使用 fetch 方法来发起这个请求，并使用 Jest 的 expect 方法来断言是否抛出了预期的超时错误，并使用 isDone 方法来断言我们定义的拦截器是否被触发。

总结

在本文中，我们介绍了如何在 Jest 中使用 nock 库来模拟 HTTP 请求。我们看到，使用 nock 可以使测试更快、更可靠，同时减少对后端的依赖。我们还演示了如何模拟成功响应、错误响应和超时响应。希望这篇文章能够帮助你更好地使用 nock 进行 HTTP 请求的模拟。

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