NodejsHTTP请求模拟与拦截插件nock的使用

NodejsHTTP请求模拟与拦截插件nock的使用
Nock 是一个 Node.js 模块，用于模拟 HTTP 请求。它主要用于测试场景中，可以让你在不依赖于实际网络连接的情况下模拟 HTTP 请求和响应。

安装

首先，你需要安装 Nock：

npm install nock

基本用法

1. 模拟 GET 请求

const nock = require('nock');

// 模拟一个 GET 请求
nock('http://example.com')
  .get('/api/data')
  .reply(200, { key: 'value' });

// 发送请求
require('request')('http://example.com/api/data', (error, response, body) => {
  if (!error && response.statusCode == 200) {
    console.log(body); // 输出：{"key":"value"}
  }
});

2. 模拟 POST 请求

const nock = require('nock');
const request = require('request');

// 模拟一个 POST 请求
nock('http://example.com')
  .post('/api/login', { username: 'test', password: 'secret' })
  .reply(200, { token: 'abc123' });

// 发送请求
request.post({
  url: 'http://example.com/api/login',
  form: { username: 'test', password: 'secret' }
}, (error, response, body) => {
  if (!error && response.statusCode == 200) {
    console.log(body); // 输出：{"token":"abc123"}
  }
});

3. 模拟多个请求

const nock = require('nock');
const request = require('request');

// 模拟多个请求
nock('http://example.com')
  .get('/api/data')
  .reply(200, { key: 'value' })
  .get('/api/other-data')
  .reply(200, { anotherKey: 'anotherValue' });

// 发送请求
request.get('http://example.com/api/data', (error, response, body) => {
  console.log(body); // 输出：{"key":"value"}
});

request.get('http://example.com/api/other-data', (error, response, body) => {
  console.log(body); // 输出：{"anotherKey":"anotherValue"}
});

注意事项

使用 nock.disableNetConnect() 可以防止任何未被 Nock 拦截的请求通过网络发送。
在测试结束后，记得调用 nock.cleanAll() 或 nock.restore() 来清理所有已设置的拦截器。

示例

下面是一个完整的示例，展示了如何使用 Nock 进行单元测试：

const nock = require('nock');
const request = require('request');
const assert = require('assert');

describe('API Client', () => {
  before(() => {
    nock.disableNetConnect();
  });

  after(() => {
    nock.cleanAll();
  });

  it('should return data from API', done => {
    nock('http://example.com')
      .get('/api/data')
      .reply(200, { key: 'value' });

    request.get('http://example.com/api/data', (error, response, body) => {
      assert.strictEqual(response.statusCode, 200);
      assert.deepStrictEqual(JSON.parse(body), { key: 'value' });
      done();
    });
  });
});

这个示例中，我们使用了 Mocha 和 Chai 作为测试框架和断言库，但你可以根据自己的需要选择其他工具。

h691938207 1楼

Nock 是一个超级棒的 Node.js 插件，用来模拟和拦截 HTTP 请求，非常适合测试API。首先，你需要安装它：

npm install nock --save-dev

然后，在你的测试文件中，你可以这样用：

const nock = require('nock');

// 模拟一个GET请求
nock('https://api.example.com')
  .get('/resource')
  .reply(200, { key: 'value' });

// 现在，当你运行代码时，任何到 `https://api.example.com/resource` 的 GET 请求都会返回 `{ key: 'value' }`

如果你想拦截并修改请求，可以这样做：

nock('https://api.example.com')
  .get('/resource')
  .reply(function(uri, requestBody) {
    // 这里你可以根据请求的内容来决定返回什么
    return [200, { modifiedKey: 'modifiedValue' }];
});

这样，你就有了一个自定义响应！试试吧，记得在测试结束后重置 Nock 状态，避免影响其他测试。

bupafengyu 2楼

nock 是一个用于 Node.js 的库，它可以帮助你模拟 HTTP 请求，非常适合在开发和测试时使用。通过 nock，你可以拦截和预定义 HTTP 响应，从而隔离依赖服务，使得测试更加可控和可靠。

下面是 nock 的基本使用方法：

安装

首先你需要安装 nock 库。可以通过 npm 进行安装：

npm install nock

基本使用

下面是一个简单的例子，展示如何使用 nock 模拟 HTTP GET 请求。

创建一个简单的 HTTP 请求

假设我们有一个简单的函数，用来发送 HTTP GET 请求到 httpbin.org 获取数据：

const axios = require('axios');

async function fetchData() {
    const response = await axios.get('https://httpbin.org/get');
    return response.data;
}

使用 nock 模拟该请求

接下来我们将使用 nock 来模拟这个请求，并返回我们预定义的数据：

const nock = require('nock');
const axios = require('axios');

describe('Nock Test', () => {
    beforeAll(() => {
        // 设置 nock 以拦截对 httpbin.org 的 GET 请求
        nock('https://httpbin.org')
            .get('/get')
            .reply(200, { mocked: 'response' });
    });

    test('Should fetch data from mocked API', async () => {
        const result = await fetchData();
        expect(result).toEqual({ mocked: 'response' });
    });
});

在这个例子中：

我们首先设置了 nock 来拦截对 httpbin.org/get 的 GET 请求。
使用 .reply(200, { mocked: 'response' }) 来定义当这个请求被触发时，将返回一个带有 mocked: 'response' 数据的响应。
在测试中调用了 fetchData 函数，并断言返回的数据是 { mocked: 'response' }。