2023nodejs 请求封装借口

随着前后端分离的流行，前端工程师越来越需要与后端进行接口通信。在此过程中，很多工程师发现，直接使用原生的 XMLHttpRequest 或 fetch 进行网络请求会存在很多问题。因此，现在很多前端团队都会使用第三方的请求库来进行接口请求。其中，Node.js 开发的 request 请求库也是非常受欢迎的。

在本文中，将介绍如何使用 Node.js 的 request 请求库进行接口请求封装，让前端工程师在进行接口通信时更加方便快捷。

安装 Request 库

在使用 Request 库之前，需要首先安装它。可以在命令行中使用 npm 指令进行安装：

npm install request --save

发送 GET 请求

接下来，我们将使用 Request 库发送一些常见的请求。首先，我们需要使用 request.get() 方法发送一个 GET 请求。

const request = require('request');

request.get('https://api.github.com/', function(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
});

在这段代码中，我们通过访问 GitHub 的 API，获取了它的主页内容。首先，我们使用 request.get() 方法发送了一个 GET 请求，将 GitHub 的 API 地址作为参数传递进去。它会将该请求发送给服务器，等待服务器的响应。

当服务器响应时，Request 库会将响应信息传递到回调函数中。参数 error 表示请求过程中是否出错，response 表示服务器的响应 Header 信息，body 则表示服务器响应的具体内容。

在这段代码中，我们首先通过 if (!error && response.statusCode == 200) 来判断是否有错误发生，如果没有错误，则将响应内容打印出来。

发送 POST 请求

接下来我们来发送一个 POST 请求。

const request = require('request');

request.post({
    url: 'https://httpbin.org/post',
    form: {
        name: '张三',
        age: 18
    }
}, function(error, response, body) {
    if(!error) {
        console.log(body);
    }
});

在这段代码中，我们通过 request.post() 方法发送了一个 POST 请求，将请求地址和请求参数以对象形式传递进去。form 参数表示 POST 请求的表单数据，在这里我们传递了一个 name 和 age 字段。

同样的，当服务器响应时，Request 库会将响应信息传递到回调函数中，我们同样可以通过判断 error 和 response.statusCode 来确认请求是否成功，并打印出响应内容。

发送 JSON 数据

在现在的前后端分离开发中，非常常见的一种请求方式是发送 JSON 数据。下面是一个发送 JSON 数据的示例代码：

const request = require('request');

const data = {
    name: '李四',
    age: 20
};

const options = {
    method: 'POST',
    url: 'https://httpbin.org/post',
    json: true,
    body: data
};

request(options, function(error, response, body) {
    if(!error) {
        console.log(body);
    }
});

在这段代码中，我们首先定义了一个 data 对象，表示要发送的 JSON 数据。然后，我们通过 options 参数配置了该请求的一些参数：

• method 表示请求方法，这里我们设置为 POST。
• url 表示请求地址，同样是 https://httpbin.org/post。
• json 表示我们要发送的是 JSON 格式的数据。
• body 则是我们要发送的具体数据。

在 request() 方法中，我们将 options 参数传递进去，和之前的示例代码一样，当服务器响应时，Request 库会将响应信息传递到回调函数中。

发送请求时的错误处理

在进行接口请求的过程中，难免会遇到许多错误，比如网络连接超时、请求地址不存在等等。下面是一个错误处理的示例代码：

const request = require('request');

const data = {
    name: '李四',
    age: 20
};

const options = {
    method: 'POST',
    url: 'https://httpbin.org/post',
    json: true,
    body: data,
    timeout: 5000 // 设置请求超时时间
};

request(options, function(error, response, body) {
    if(error) {
        console.log('请求发生错误：', error);
    } else {
        if(response.statusCode == 200) {
            console.log('响应内容：', body);
        } else {
            console.log('请求失败，状态码：', response.statusCode);
        }
    }
});

在这段代码中，我们首先设置了 options.timeout 参数表示请求的超时时间，避免请求太久没有响应导致页面卡死。如果发生错误，我们就在回调函数中使用 console.log() 输出错误信息。如果没有错误，则判断响应状态码，如果状态码为 200，则将响应内容打印出来。否则，打印请求失败的状态码。

封装请求接口函数

在使用 Request 库进行接口请求时，我们可以将常见的请求方法进行封装，避免过多的重复代码。下面是一个封装请求接口函数的示例代码：

const request = require('request');

function requestApi(url, method, data) {
    const options = {
        method: method,
        url: url,
        json: true,
        timeout: 5000
    };

    if(method == 'GET') {
        options.method = 'GET';
    } else if(method == 'POST') {
        options.method = 'POST';
        options.body = data;
    } else if(method == 'PUT') {
        options.method = 'PUT';
        options.body = data;
    } else if(method == 'DELETE') {
        options.method = 'DELETE';
        options.body = data;
    }

    return new Promise(function(resolve, reject) {
        request(options, function(error, response, body) {
            if(error) {
                reject(error);
            } else {
                if(response.statusCode == 200) {
                    resolve(body);
                } else {
                    reject(response.statusCode);
                }
            }
        });
    });
}

在这段代码中，我们首先定义了一个 requestApi() 函数。它包含三个参数：

• url 表示请求的地址。
• method 表示请求的方法。
• data 表示请求的数据。

在函数中，我们定义了 options 对象，用来存储请求的一些配置参数。根据不同的请求方法，我们设置 options.method 的值以及 options.body 的值。

然后，我们使用 Promise 来进行异步处理。在 request() 方法的回调函数中，我们使用 resolve() 来传递响应内容，使用 reject() 来传递错误信息和状态码。使用 Promise 对象的 then() 和 catch() 方法，我们可以在请求到数据之后进行相应的处理。

小结

使用 Node.js 的 Request 库进行接口请求是一种非常方便快捷的方式。它可以避免因直接使用原生的 XMLHttpRequest 或 fetch 导致的一些问题，同时也可以进行一些常见的错误处理。我们可以根据实际的需求，将常见的请求封装成函数，在项目中进行调用，使代码更加简洁易懂。

以上就是nodejs 请求封装借口的详细内容，更多请关注zzsucai.com其它相关文章！