npm 包 router-ips 使用教程

前言

在开发前端应用程序时，常常需要获取用户访问网站时使用的 IP 地址。而如今的互联网已经被广泛的应用在各种物联网设备中，这些设备访问网站时使用的 IP 地址可能并不是传统的 IPv4 地址，而是新型的 IPv6 地址。本文我们将介绍一种方便快捷的 npm 包 router-ips，帮助前端开发者获取用户 IP 地址。

前置知识

在使用 router-ips 之前需要了解以下知识：

• Node.js
• npm
• JavaScript

安装

在安装 router-ips 之前，请先确保您已经安装了 Node.js 和 npm。然后，您可以通过以下命令进行安装：

npm install router-ips

使用

使用 router-ips 可以轻松地获取用户 IP 地址，而不必针对不同的 IP 地址类型进行特殊处理。下面是一个简单的示例代码：

const routerIps = require('router-ips');

routerIps.getIp().then(ip => {
    console.log('用户的 IP 地址为：', ip);
}).catch(err => {
    console.error('获取用户 IP 地址失败：', err);
});

在上面的示例中，我们使用了 routerIps.getIp() 方法来获取用户的 IP 地址。该方法返回一个 Promise，当 Promise 被解决时，会将用户 IP 地址传递给 resolve() 方法。如果获取 IP 地址时发生错误，Promise 将会解决为 reject() 方法并传递错误信息。

深入学习

router-ips 提供了多种方法来获取用户的 IP 地址。下面是一些示例：

getIp()

该方法返回一个 Promise 对象，当 Promise 被解决时，会将用户的 IP 地址传递给 resolve() 方法。如果获取 IP 地址时发生错误，Promise 将会解决为 reject() 方法并传递错误信息。

routerIps.getIp().then(ip => {
    console.log('用户的 IP 地址为：', ip);
}).catch(err => {
    console.error('获取用户 IP 地址失败：', err);
});

该方法还接受一个可选的参数，用于指定排除 IP 地址列表（黑名单）。例如，您可以使用以下命令来排除本地 IP 地址：

routerIps.getIp(['127.0.0.1', '::1']).then(ip => {
    console.log('用户的 IP 地址为：', ip);
}).catch(err => {
    console.error('获取用户 IP 地址失败：', err);
});

getAllIps()

该方法返回一个 Promise 对象，当 Promise 被解决时，会将所有可用的 IP 地址传递给 resolve() 方法。如果获取 IP 地址时发生错误，Promise 将会解决为 reject() 方法并传递错误信息。

routerIps.getAllIps().then(ips => {
    console.log('所有可用的 IP 地址为：', ips);
}).catch(err => {
    console.error('获取 IP 地址列表失败：', err);
});

findIp()

该方法接受一个 IP 地址作为参数，并返回一个 Promise 对象，当用户的 IP 地址与传递的 IP 地址匹配时，Promise 被解决。如果未找到匹配的 IP 地址，Promise 将会解决为 reject() 方法并传递错误信息。

routerIps.findIp('192.168.1.1').then(ip => {
    console.log('找到匹配的 IP 地址：', ip);
}).catch(err => {
    console.error('未找到匹配的 IP 地址：', err);
});

总结

router-ips 提供了一种方便快捷的方法来获取用户的 IP 地址，不必进行特定的 IPv4 或 IPv6 地址处理。在实际开发中，我们可以根据需要选择使用不同的方法，以满足我们的应用需求。

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