开源项目 `request-ip` 使用教程

开源项目 request-ip 使用教程

request-ipA Node.js module for retrieving a request's IP address on the server.项目地址:https://gitcode.com/gh_mirrors/re/request-ip

1. 项目的目录结构及介绍

request-ip 是一个用于从 HTTP 请求中获取客户端 IP 地址的 Node.js 库。以下是该项目的目录结构及其介绍：

request-ip/
├── src/
│   └── index.js
├── test/
│   └── index.test.js
├── .gitignore
├── .npmignore
├── LICENSE
├── package.json
├── README.md

• src/：包含项目的主要源代码。
  • index.js：项目的主文件，负责从请求头中提取客户端 IP 地址。
• test/：包含项目的测试文件。
  • index.test.js：用于测试 index.js 中的功能。
• .gitignore：指定 Git 版本控制系统忽略的文件和目录。
• .npmignore：指定 npm 发布时忽略的文件和目录。
• LICENSE：项目的开源许可证。
• package.json：项目的 npm 配置文件，包含项目的依赖、脚本等信息。
• README.md：项目的说明文档。

2. 项目的启动文件介绍

request-ip 的启动文件是 src/index.js。该文件主要负责从 HTTP 请求头中提取客户端 IP 地址。以下是该文件的主要内容：

// src/index.js

const getClientIp = (req) => {
  // 检查请求头中的特定字段，按顺序提取客户端 IP 地址
  const headers = ['x-client-ip', 'x-forwarded-for', 'cf-connecting-ip', 'fastly-client-ip', 'true-client-ip', 'x-real-ip', 'x-cluster-client-ip', 'x-forwarded', 'forwarded-for', 'forwarded', 'appengine-user-ip'];
  
  for (const header of headers) {
    const ip = req.headers[header];
    if (ip) {
      return ip.split(',')[0].trim();
    }
  }

  // 如果请求头中没有找到 IP 地址，则返回连接的远程地址
  return req.connection.remoteAddress || req.socket.remoteAddress || req.connection.socket.remoteAddress;
};

module.exports = getClientIp;

该文件定义了一个 getClientIp 函数，该函数会按照指定的顺序检查请求头中的特定字段，并返回第一个找到的 IP 地址。如果请求头中没有找到 IP 地址，则返回连接的远程地址。

3. 项目的配置文件介绍

request-ip 项目没有专门的配置文件，其功能主要通过代码实现。项目的依赖和脚本信息在 package.json 文件中定义。以下是 package.json 文件的主要内容：

{
  "name": "request-ip",
  "version": "2.1.1",
  "description": "A small node.js module to retrieve the request's IP address.",
  "main": "src/index.js",
  "scripts": {
    "test": "mocha test/index.test.js"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/pbojinov/request-ip.git"
  },
  "keywords": [
    "request",
    "ip",
    "address",
    "client",
    "user",
    "agent",
    "web",
    "tool",
    "x-client-ip",
    "x-forwarded-for",
    "cf-connecting-ip",
    "fastly-client-ip",
    "true-client-ip",
    "x-real-ip",
    "x-cluster-client-ip",
    "x-forwarded",
    "forwarded-for",
    "forwarded",
    "appengine-user-ip"
  ],
  "author": "Petar Bojinov <petarbojinov@gmail.com> (https://github.com/pbojinov)",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/pbojinov/request-ip/issues"
  },

request-ipA Node.js module for retrieving a request's IP address on the server.项目地址:https://gitcode.com/gh_mirrors/re/request-ip