Node.js Express 中的 HTTP GET 请求答案

【问题标题】：HTTP GET Request in Node.js ExpressNode.js Express 中的 HTTP GET 请求
【发布时间】：2012-03-23 13:43:44
【问题描述】：

如何从 Node.js 或 Express.js 中发出 HTTP 请求？我需要连接到另一个服务。我希望调用是异步的，并且回调包含远程服务器的响应。

【问题讨论】：

标签： javascript node.js express httprequest

【解决方案1】：

这是我的一个示例中的一些代码的 sn-p。它是异步的并返回一个 JSON 对象。它可以做任何形式的GET请求。

请注意，还有更优化的方法（只是一个示例） - 例如，不是将您放入数组中的块连接起来并加入它等等......希望它能让您朝着正确的方向开始：

const http = require('http');
const https = require('https');

/**
 * getJSON:  RESTful GET request returning JSON object(s)
 * @param options: http options object
 * @param callback: callback to pass the results JSON object(s) back
 */

module.exports.getJSON = (options, onResult) => {
  console.log('rest::getJSON');
  const port = options.port == 443 ? https : http;

  let output = '';

  const req = port.request(options, (res) => {
    console.log(`${options.host} : ${res.statusCode}`);
    res.setEncoding('utf8');

    res.on('data', (chunk) => {
      output += chunk;
    });

    res.on('end', () => {
      let obj = JSON.parse(output);

      onResult(res.statusCode, obj);
    });
  });

  req.on('error', (err) => {
    // res.send('error: ' + err.message);
  });

  req.end();
};

它是通过创建一个选项对象来调用的：

const options = {
  host: 'somesite.com',
  port: 443,
  path: '/some/path',
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  }
};

并提供回调函数。

例如，在一个服务中，我需要上面的 REST 模块，然后这样做：

rest.getJSON(options, (statusCode, result) => {
  // I could work with the resulting HTML/JSON here. I could also just return it
  console.log(`onResult: (${statusCode})\n\n${JSON.stringify(result)}`);

  res.statusCode = statusCode;

  res.send(result);
});

更新

如果您正在寻找 async/await（线性，无回调）、承诺、编译时支持和智能感知，我们创建了一个轻量级的 HTTP 和 REST 客户端来满足该要求：

Microsoft typed-rest-client

【讨论】：

@bryanmac 你能发送/添加完整的样本吗？
@bryanmac 征得您的许可，我想使用我目前正在构建的这个代码咕噜插件。不知道什么时候，但它会在完成后开源。
尝试请求模块.. 更简单sitepoint.com/making-http-requests-in-node-js
是的 - 请求模块很简单，但这是显示请求模块之类的库在做什么的较低级别。如果您需要较低级别的控制或 http 请求（显示大型下载的进度等...），这将显示它是如何完成的。
@KrIsHnA - 节点有一个查询字符串对象：nodejs.org/api/querystring.html 和 url 对象nodejs.org/docs/latest/api/url.html

【解决方案2】：

尝试在 node.js 中使用简单的http.get(options, callback) function：

var http = require('http');
var options = {
  host: 'www.google.com',
  path: '/index.html'
};

var req = http.get(options, function(res) {
  console.log('STATUS: ' + res.statusCode);
  console.log('HEADERS: ' + JSON.stringify(res.headers));

  // Buffer the body entirely for processing as a whole.
  var bodyChunks = [];
  res.on('data', function(chunk) {
    // You can process streamed parts here...
    bodyChunks.push(chunk);
  }).on('end', function() {
    var body = Buffer.concat(bodyChunks);
    console.log('BODY: ' + body);
    // ...and/or process the entire body here.
  })
});

req.on('error', function(e) {
  console.log('ERROR: ' + e.message);
});

还有一个通用的http.request(options, callback) function，允许你指定请求方法和其他请求细节。

【讨论】：

OP 要求的服务器响应内容在哪里？
感谢您的更新。看起来需要一个“结束”处理程序来连接块。这基本上相当于@bryanmac 的答案？
@DanDascalescu：是的，如果您想将主体作为一个整体进行处理（这很可能），那么您可能希望对其进行缓冲并在“结束”时进行处理。为了完整起见，我也会更新我的答案。
抱歉，我不知道调用了哪些参数回调...如何获取正文以及该参数的参数和属性的引用在哪里。
@maerics 如果我有这个网址，我该如何使用这个GET 请求？ graph.facebook.com/debug_token? input_token={token-to-inspect} &access_token={app-token-or-admin-token} ?

【解决方案3】：

Request 和 Superagent 是相当不错的库。

注意：请求是deprecated，使用风险自负！

使用request：

var request=require('request');

request.get('https://someplace',options,function(err,res,body){
  if(err) //TODO: handle err
  if(res.statusCode === 200 ) //etc
  //TODO Do something with response
});

【讨论】：

如果第二个应该是 res.statusCode === 200 吗？ )
options 变量是什么？只是通过未定义的一个？我怀疑它

【解决方案4】：

你也可以使用Requestify，我为nodeJS编写的一个非常酷且非常简单的HTTP客户端+它支持缓存。

只需对 GET 方法请求执行以下操作：

var requestify = require('requestify');

requestify.get('http://example.com/api/resource')
  .then(function(response) {
      // Get the response body (JSON parsed or jQuery object for XMLs)
      response.getBody();
  }
);

【讨论】：

如果现有工具集足够，“试试这个其他工具”不是可接受的响应。
当然可以，另一种解决方案总是一件好事

【解决方案5】：

这个版本是基于bryanmac最初提出的函数，它使用了promise，更好的错误处理，并用ES6重写。

let http = require("http"),
    https = require("https");

/**
* getJSON:  REST get request returning JSON object(s)
* @param options: http options object
*/
exports.getJSON = function (options) {
    console.log('rest::getJSON');
    let reqHandler = +options.port === 443 ? https : http;

    return new Promise((resolve, reject) => {
        let req = reqHandler.request(options, (res) => {
            let output = '';
            console.log('rest::', options.host + ':' + res.statusCode);
            res.setEncoding('utf8');

            res.on('data', function (chunk) {
                output += chunk;
            });

            res.on('end', () => {
                try {
                    let obj = JSON.parse(output);
                    // console.log('rest::', obj);
                    resolve({
                        statusCode: res.statusCode,
                        data: obj
                    });
                }
                catch (err) {
                    console.error('rest::end', err);
                    reject(err);
                }
            });
        });

        req.on('error', (err) => {
            console.error('rest::request', err);
            reject(err);
        });

        req.end();
    });
};

因此，您不必传入回调函数，而是 getJSON() 返回一个承诺。在以下示例中，该函数在 ExpressJS 路由处理程序中使用

router.get('/:id', (req, res, next) => {
    rest.getJSON({
        host: host,
        path: `/posts/${req.params.id}`,
        method: 'GET'
    }).then(({ statusCode, data }) => {
        res.json(data);
    }, (error) => {
        next(error);
    });
});

发生错误时，它将错误委托给服务器错误处理中间件。

【讨论】：

是的，这个例子展示了如何在 Express get 路由定义中做到这一点，这里的许多帖子都缺乏。
在您关于此express example 的第二个代码中，它似乎是服务器代码，而第一个代码是客户端代码。第二个代码中的rest.getJSON 是什么？是不是错字，应该是res.getJSON？
rest 是在第一个代码块中导出的对象。因此，为了访问getJSON()，您可以导入整个rest 对象或仅从第一个文件导入getJSON。它们都是服务器端的摘录。

【解决方案6】：

Unirest 是我遇到的用于从 Node.js 发出 HTTP 请求的最佳库。它的目标是成为一个多平台框架，因此如果您还需要在 Ruby、PHP、Java、Python、Objective C、.Net 或 Windows 8 上使用 HTTP 客户端，那么学习它在 Node 上的工作方式将非常有用。据我所知，unirest 库主要由现有的 HTTP 客户端支持（例如，在 Java 上，Apache HTTP 客户端，在 Node 上，Mikeal's Request libary）——Unirest 只是在顶部放置了一个更好的 API。

这里有几个 Node.js 的代码示例：

var unirest = require('unirest')

// GET a resource
unirest.get('http://httpbin.org/get')
  .query({'foo': 'bar'})
  .query({'stack': 'overflow'})
  .end(function(res) {
    if (res.error) {
      console.log('GET error', res.error)
    } else {
      console.log('GET response', res.body)
    }
  })

// POST a form with an attached file
unirest.post('http://httpbin.org/post')
  .field('foo', 'bar')
  .field('stack', 'overflow')
  .attach('myfile', 'examples.js')
  .end(function(res) {
    if (res.error) {
      console.log('POST error', res.error)
    } else {
      console.log('POST response', res.body)
    }
  })

您可以直接跳转到 Node 文档 here

【讨论】：

【解决方案7】：

查看shred。它是由spire.io 创建和维护的节点 HTTP 客户端，用于处理重定向、会话和 JSON 响应。它非常适合与其他 API 交互。详情请见this blog post。

【讨论】：

【解决方案8】：

查看httpreq：这是我创建的一个节点库，因为我很沮丧那里没有简单的 http GET 或 POST 模块；-)

【讨论】：

【解决方案9】：

对于正在寻找在 NodeJS 中发送 HTTP 请求的库的任何人，axios 也是一个不错的选择。它支持 Promises :)

安装 (npm)：npm install axios

GET 请求示例：

const axios = require('axios');

axios.get('https://google.com')
  .then(function (response) {
    // handle success
    console.log(response);
  })
  .catch(function (error) {
    // handle error
    console.log(error);
  })

Github page

2022 年 10 月 2 日更新

Node.js integrates fetch in v17.5.0 in experimental mode。现在，您可以像在客户端一样使用 fetch 来发送请求。目前，它是一个实验性功能，所以要小心。

【讨论】：

【解决方案10】：

如果您只需要发出简单的 get 请求并且不需要支持任何其他 HTTP 方法，请查看：simple-get:

var get = require('simple-get');

get('http://example.com', function (err, res) {
  if (err) throw err;
  console.log(res.statusCode); // 200
  res.pipe(process.stdout); // `res` is a stream
});

【讨论】：

【解决方案11】：

使用reqclient：不是为脚本目的而设计的像request 或许多其他库。 Reqclient 允许在构造函数中当您需要重用相同的配置时，指定许多有用的配置一次又一次的配置：基本 URL，标头，身份验证选项，日志记录选项、缓存等。还具有有用的功能，例如查询与URL解析、查询自动编码与JSON解析等

使用库的最好方法是创建一个模块来导出对象指向 API 和连接所需的配置：

模块client.js:

let RequestClient = require("reqclient").RequestClient

let client = new RequestClient({
  baseUrl: "https://myapp.com/api/v1",
  cache: true,
  auth: {user: "admin", pass: "secret"}
})

module.exports = client

在您需要使用 API 的控制器中，如下所示：

let client = require('client')
//let router = ...

router.get('/dashboard', (req, res) => {
  // Simple GET with Promise handling to https://myapp.com/api/v1/reports/clients
  client.get("reports/clients")
    .then(response => {
       console.log("Report for client", response.userId)  // REST responses are parsed as JSON objects
       res.render('clients/dashboard', {title: 'Customer Report', report: response})
    })
    .catch(err => {
      console.error("Ups!", err)
      res.status(400).render('error', {error: err})
    })
})

router.get('/orders', (req, res, next) => {
  // GET with query (https://myapp.com/api/v1/orders?state=open&limit=10)
  client.get({"uri": "orders", "query": {"state": "open", "limit": 10}})
    .then(orders => {
      res.render('clients/orders', {title: 'Customer Orders', orders: orders})
    })
    .catch(err => someErrorHandler(req, res, next))
})

router.delete('/orders', (req, res, next) => {
  // DELETE with params (https://myapp.com/api/v1/orders/1234/A987)
  client.delete({
    "uri": "orders/{client}/{id}",
    "params": {"client": "A987", "id": 1234}
  })
  .then(resp => res.status(204))
  .catch(err => someErrorHandler(req, res, next))
})

reqclient 支持许多功能，但它有一些其他功能不支持库：OAuth2 integration 和记录器集成使用cURL syntax，并始终返回本机 Promise 对象。

【讨论】：

【解决方案12】：

如果您需要向IP 和Domain 发送GET 请求（其他答案未提及您可以指定port 变量），您可以使用此功能：

function getCode(host, port, path, queryString) {
    console.log("(" + host + ":" + port + path + ")" + "Running httpHelper.getCode()")

    // Construct url and query string
    const requestUrl = url.parse(url.format({
        protocol: 'http',
        hostname: host,
        pathname: path,
        port: port,
        query: queryString
    }));

    console.log("(" + host + path + ")" + "Sending GET request")
    // Send request
    console.log(url.format(requestUrl))
    http.get(url.format(requestUrl), (resp) => {
        let data = '';

        // A chunk of data has been received.
        resp.on('data', (chunk) => {
            console.log("GET chunk: " + chunk);
            data += chunk;
        });

        // The whole response has been received. Print out the result.
        resp.on('end', () => {
            console.log("GET end of response: " + data);
        });

    }).on("error", (err) => {
        console.log("GET Error: " + err);
    });
}

不要错过文件顶部的要求模块：

http = require("http");
url = require('url')

另外请记住，您可以使用https 模块通过安全网络进行通信。所以这两行会改变：

https = require("https");
...
https.get(url.format(requestUrl), (resp) => { ......

【讨论】：

【解决方案13】：

## you can use request module and promise in express to make any request ##
const promise                       = require('promise');
const requestModule                 = require('request');

const curlRequest =(requestOption) =>{
    return new Promise((resolve, reject)=> {
        requestModule(requestOption, (error, response, body) => {
            try {
                if (error) {
                    throw error;
                }
                if (body) {

                    try {
                        body = (body) ? JSON.parse(body) : body;
                        resolve(body);
                    }catch(error){
                        resolve(body);
                    }

                } else {

                    throw new Error('something wrong');
                }
            } catch (error) {

                reject(error);
            }
        })
    })
};

const option = {
    url : uri,
    method : "GET",
    headers : {

    }
};


curlRequest(option).then((data)=>{
}).catch((err)=>{
})

【讨论】：

（碰巧，它不会解决问题。这段代码将监听请求，但问题是询问如何发送请求 i>)
已经修复了，你可以试试。 @昆汀