0

0

nodejs 请求封装借口

WBOY

WBOY

发布时间:2023-05-11 13:07:38

|

639人浏览过

|

来源于php中文网

原创

随着前后端分离的流行,前端工程师越来越需要与后端进行接口通信。在此过程中,很多工程师发现,直接使用原生的 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 数据的示例代码:

ZBLibrary
ZBLibrary

ZBLibrary是一款Android快速开发框架。MVP 架构,提供一套开发标准(View,Data,Event)以及模板和工具类并规范代码。封装层级少,简单高效兼容性好。OKHttp 网络请求、Glide 图片加载、ZXing 二维码、沉浸状态栏、下载安装、自动缓存以及各种 Base、Demo、UI、Util 直接用。全新的手势,侧滑返回、全局右滑返回都 OUT 啦!用 BaseView,自

下载
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 导致的一些问题,同时也可以进行一些常见的错误处理。我们可以根据实际的需求,将常见的请求封装成函数,在项目中进行调用,使代码更加简洁易懂。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
node.js调试
node.js调试

node.js调试可以使用console.log()输出调试信息、断点调试和第三方调试工具。详细介绍:1、console.log()输出调试信息,通过在代码中插入console.log()语句,开发人员可以在控制台输出变量的值、函数的执行结果等信息,以便观察代码的执行流程和状态;2、断点调试,可以在代码中设置断点,以便在特定位置暂停代码的执行,观察变量的值和执行流程等。

347

2023.09.19

JavaScript 全栈开发基础(Node.js + 前端)
JavaScript 全栈开发基础(Node.js + 前端)

本专题系统介绍 JavaScript 在全栈开发中的核心知识结构,涵盖 Node.js 基础、Express/Koa 接口构建、前端交互设计、模块化与包管理、数据库连接、前后端数据通信与部署流程。通过完整项目示例,帮助学习者掌握从浏览器到服务器的一体化开发能力,实现真正意义上的全栈入门。

93

2025.11.26

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

411

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

533

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

309

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

74

2025.09.10

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

738

2023.08.22

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

187

2023.10.18

Golang gRPC 服务开发与Protobuf实战
Golang gRPC 服务开发与Protobuf实战

本专题系统讲解 Golang 在 gRPC 服务开发中的完整实践,涵盖 Protobuf 定义与代码生成、gRPC 服务端与客户端实现、流式 RPC(Unary/Server/Client/Bidirectional)、错误处理、拦截器、中间件以及与 HTTP/REST 的对接方案。通过实际案例,帮助学习者掌握 使用 Go 构建高性能、强类型、可扩展的 RPC 服务体系,适用于微服务与内部系统通信场景。

8

2026.01.15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

相关下载

更多

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号