Request - 简化HTTP客户端使用指南

1. 安装指南

由于request库已于2020年2月11日被弃用，不再推荐使用。建议用户参考此问题以了解弃用原因及替代方案。

如果你仍然需要使用request库，可以通过以下命令进行安装：

npm install request

2. 项目的使用说明

request库设计的目标是尽可能简化HTTP请求的调用。它默认支持HTTPS，并自动处理重定向。以下是一个简单的使用示例：

const request = require('request');
request('http://www.google.com', function (error, response, body) {
  console.error('error:', error); // 如果有错误，打印错误信息
  console.log('statusCode:', response && response.statusCode); // 打印响应状态码
  console.log('body:', body); // 打印Google首页的HTML内容
});

2.1 流式处理

request支持将响应流式传输到文件流中：

request('http://google.com/doodle.png').pipe(fs.createWriteStream('doodle.png'))

你也可以将文件流式传输到PUT或POST请求中：

fs.createReadStream('file.json').pipe(request.put('http://mysite.com/obj.json'))

2.2 使用Promise和Async/Await

request本身支持流式和回调接口。如果你更喜欢使用Promise或async/await，可以使用request的替代接口，如request-promise：

npm install request-promise

使用示例：

const request = require('request-promise');

async function getGoogle() {
  try {
    const response = await request('http://www.google.com');
    console.log(response);
  } catch (error) {
    console.error(error);
  }
}

getGoogle();

2.3 表单提交

request支持application/x-www-form-urlencoded和multipart/form-data表单上传。

URL编码表单

request.post('http://service.com/upload', {form:{key:'value'}})

多部分表单上传

const formData = {
  my_field: 'my_value',
  my_buffer: Buffer.from([1, 2, 3]),
  my_file: fs.createReadStream(__dirname + '/unicycle.jpg')
};

request.post({url:'http://service.com/upload', formData: formData}, function (err, httpResponse, body) {
  if (err) {
    return console.error('upload failed:', err);
  }
  console.log('Upload successful!  Server responded with:', body);
});

3. 项目API使用文档

3.1 基本请求

request(url, callback)

• url：请求的URL地址。
• callback：回调函数，接收三个参数：error, response, body。

3.2 流式请求

request(url).pipe(destination)

• destination：目标流，可以是文件流或其他流。

3.3 表单提交

request.post(url, {form: formData}, callback)

• formData：表单数据。

3.4 自定义HTTP头

request({
  url: 'http://example.com',
  headers: {
    'User-Agent': 'request'
  }
}, callback)

4. 项目安装方式

由于request库已被弃用，建议用户使用其他替代方案。如果你仍然需要使用request，可以通过以下命令进行安装：

npm install request

安装完成后，你可以在项目中通过require('request')引入并使用该库。

---

注意：由于request库已被弃用，建议用户考虑使用其他HTTP客户端库，如axios或node-fetch。