ipaddr.js 使用教程

项目介绍

ipaddr.js 是一个用于处理 IPv4 和 IPv6 地址的 JavaScript 库。它提供了丰富的 API，支持 IP 地址的解析、验证、比较、分类和转换等功能。该库兼容所有现代浏览器及 Node.js 环境，并且对 IE8+ 浏览器也有良好的支持。ipaddr.js 由知名开发者 whitequark 维护，拥有活跃的开源社区，不断优化和扩展功能。

项目快速启动

安装

你可以通过 npm 安装 ipaddr.js：

npm install ipaddr.js

基本使用

以下是一些简单的示例，展示了如何使用 ipaddr.js 处理 IP 地址：

const ipaddr = require('ipaddr.js');

// 解析 IP 地址
const ip = ipaddr.parse('192.168.0.1');
console.log(ip.kind()); // 输出 "ipv4"
console.log(ip.octets()); // 输出 [192, 168, 0, 1]

// 验证 IP 地址有效性
const isValid = ipaddr.isValid('2001:0db8:85a3:0000:0000:8a2e:0370:7334');
console.log(isValid); // 输出 true

// 检查 IP 地址范围
const network = ipaddr.IPv6.parseCIDR('2001:0db8:85a3::/48');
const inRange = network.contains(ipaddr.IPv6.parse('2001:0db8:85a3:0000:0000:8a2e:0370:7334'));
console.log(inRange); // 输出 true

应用案例和最佳实践

案例一：IP 地址验证

在网络编程中，经常需要验证用户输入的 IP 地址是否有效。ipaddr.js 提供了 isValid 方法来快速验证 IP 地址：

const ipaddr = require('ipaddr.js');

function validateIP(ip) {
  return ipaddr.isValid(ip);
}

console.log(validateIP('192.168.0.1')); // 输出 true
console.log(validateIP('256.256.256.256')); // 输出 false

案例二：IP 地址分类

ipaddr.js 可以轻松地对 IP 地址进行分类，例如判断一个 IP 地址是否为私有地址：

const ipaddr = require('ipaddr.js');

function isPrivateIP(ip) {
  const addr = ipaddr.parse(ip);
  return addr.range() === 'private';
}

console.log(isPrivateIP('192.168.0.1')); // 输出 true
console.log(isPrivateIP('8.8.8.8')); // 输出 false

典型生态项目

ipaddr.js 可以与其他网络相关的库和工具结合使用，例如：

• Express.js: 在构建 Web 应用时，可以使用 ipaddr.js 来处理客户端的 IP 地址。
• Socket.IO: 在实时通信应用中，可以使用 ipaddr.js 来验证连接的 IP 地址。
• PM2: 在部署 Node.js 应用时，可以使用 ipaddr.js 来管理服务器的 IP 地址。

通过这些结合使用，可以进一步提升应用的网络处理能力和安全性。