npm 包 whitelistip 使用教程-JavaScript中文网-JavaScript教程资源分享门户

前言

在进行 Web 开发时，我们有时需要限制某些功能只能在特定 IP 地址的情况下才能执行，比如防止敏感接口被非法用户访问。为了实现这一目标，有一个方便实用的 npm 包，它就是 whitelistip。本篇文章将详细介绍 whitelistip 的使用方法，以及如何在你的项目中使用它。

whitelistip

whitelistip 是一个基于 Node.js 的 npm 包，它可以帮助我们轻松地实现 IP 白名单功能。其核心模块是 ip-range-check，该模块允许我们使用一个 IP 地址范围字符串，并检查是否匹配一个给定的 IP 地址。whitelistip 通过读取配置文件，检查客户端的 IP 地址是否在白名单范围内，从而完成 IP 白名单的功能。

安装

要使用 whitelistip，我们需要首先在项目中安装它。可以通过下面的命令来安装：

npm install whitelistip --save

这样就会在你的项目中安装 whitelistip 包，并在 package.json 文件中添加依赖。使用过程中，只要在文件的头部引入 whitelistip，就可以直接调用它提供的 API。

const whitelistip = require('whitelistip');

配置文件

接下来需要创建一个 JSON 格式的配置文件 white.json，用于存放白名单 IP 地址范围。在配置文件中需指定每一个 IP 地址范围时的 IP 起始地址和结束地址，如下：

{
    "whitelist":[
        {"start":"192.168.1.0", "end":"192.168.1.255"},
        {"start":"172.16.0.0", "end":"172.31.255.255"},
        {"start":"10.0.0.0", "end":"10.255.255.255"}
    ]
}

使用

要使用 whitelistip，我们可以使用 middleware 中间件的形式。在 Express 应用程序中使用它非常简单，只需要在路由的管道中使用 middleware 就可以了。

const express = require('express');
const app = express();
const whitelistip = require('whitelistip');

app.use(whitelistip.middleware({
  whitelistFile: './white.json'
}));

其中，middleware 方法就是 whitelistip 提供的中间件方法。传入的参数是一个对象，其中 whitelistFile 指定配置文件的路径。

示例

最后，我们来看一个使用 whitelistip 的示例。在下面的例子中，我们使用 whitelistip 来验证仅当客户端的 IP 地址在白名单中才能访问该 GET 接口。在验证通过后，返回一个 JSON 格式的响应。

-- -------------------- ---- -------
----- ------- - -------------------
----- --- - ----------
----- ----------- - -----------------------

--------------------------------
  -------------- --------------
----

---------------- -------- ----- ---- -
  ----------
    ------- ----- -- -- ------------ ---------
  ---
---

以上就是 whitelistip 的基本使用方法。在实际的开发中，我们可以根据自己的需要自定义配置文件和中间件方法，实现更加细粒度的白名单控制。

结语

通过本文的介绍，我们可以看出 whitelistip 在实现 IP 白名单方面非常方便实用。如果你也需要在自己的项目中实现 IP 白名单控制，那么 whitelistip 将是一个很好的选择。希望这篇文章能够对你有所帮助，并在你的开发过程中有所启发。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/600671088dd3466f61ffdf17