Follow Redirects 技术文档

Follow Redirects 技术文档

---

Follow Redirects 是一个为 Node.js 设计的库，它无缝替代标准的 http 和 https 模块，自动处理HTTP(S)重定向，极大简化了需要处理多次跳转的请求场景。

安装指南

安装 Follow Redirects 非常简单，只需在你的项目目录下运行以下命令：

npm install --save follow-redirects

这将把模块添加到你的项目依赖中。

项目的使用说明

一旦安装完成，你可以按照以下方式快速集成到你的代码里：

// 引入 follow-redirects 提供的 http 和 https 方法
const { http, https } = require('follow-redirects');

// 发起一个会自动跟随重定向的 GET 请求
http.get('http://bit.ly/900913', response => {
  // 打印响应数据
  response.on('data', chunk => {
    console.log(chunk.toString());
  });

  // 输出最终被重定向到的URL
  console.log('最终URL:', response.responseUrl);
}).on('error', err => {
  // 错误处理
  console.error('请求发生错误:', err);
});

项目API使用文档

全局选项配置

对于全局设置，可以直接修改 follow-redirects 模块的属性来控制默认行为：

const followRedirects = require('follow-redirects');
followRedirects.maxRedirects = 10; // 设置最大允许的重定向次数
followRedirects.maxBodyLength = 20 * 1024 * 1024; // 设置最大请求体长度，单位字节

请求时的选项

你可以在每次请求时通过 options 对象传递特定的选项：

const options = {
  hostname: 'bit.ly',
  path: '/900913',
  maxRedirects: 5, // 该请求特有的最大重定向次数
};

// 使用 beforeRedirect 来处理重定向前的逻辑
options.beforeRedirect = function(options, response) {
  // 可以根据需要调整options，例如增加认证信息等
};

https.request(options, response => {
  console.log(response.responseUrl);
}).end();

支持的请求选项扩展：

• followRedirects: 控制是否启用重定向，默认为 true。
• maxRedirects: 单次请求允许的最大重定向次数。
• maxBodyLength: 请求或响应的最大长度限制。
• beforeRedirect: 重定向之前执行的回调函数，可用来调整请求选项或取消重定向。
• agents: 自定义HTTP和HTTPS代理。

浏览器环境的使用

在浏览器环境中，由于原生就支持重定向，直接使用 follow-redirects 的目的通常是为了统一Node.js和浏览器端的代码逻辑。为了在打包工具（如webpack）中正确处理，你需要：

const http = require('follow-redirects/http');
const https = require('follow-redirects/https');

并且，在构建配置中做适当的映射，确保生产环境下使用的是原生的HTTP模块：

{
  "browser": {
    "follow-redirects/http": "http",
    "follow-redirects/https": "https"
  }
}

贡献与发展

鼓励贡献代码或报告问题。在进行任何重大改动之前，先在GitHub上开一个issue讨论。记得测试你的代码，并且可以通过运行 npm test 来验证。

---

这个文档覆盖了 Follow Redirects 的基本安装、使用方法以及一些高级设定，希望能帮助你轻松地处理HTTP重定向任务。如果你在使用过程中遇到任何问题，欢迎查阅官方文档或直接向社区寻求帮助。