IPAddress Ruby库技术文档

2024-12-23 18:02:14作者：魏献源Searcher

1. 安装指南

环境要求

Ruby 1.9.3 或更高版本

安装步骤

使用 gem 命令全局安装：
```
$ gem install ipaddress
```
或者将 ipaddress 添加到当前应用程序的 Gemfile 中：
```
$ bundle add ipaddress
```

2. 项目使用说明

简介

IPAddress 是一个 Ruby 库，旨在简化 IPv4 和 IPv6 地址的使用，提供了一套完整的方法来处理各种 IP 地址需求，从简单的脚本到完整的网络设计。

示例

以下是一些常见的使用示例：

IPv4 示例

# 创建一个新的 IPv4 地址对象
ip = IPAddress::IPv4.new "172.16.10.1/24"

# 或者使用 IPAddress 的 parse 方法
ip = IPAddress.parse "172.16.10.1/24"

# 使用快捷方法
ip = IPAddress "172.16.10.1/24"

IPv6 示例

（请参考项目 Wiki 获取更多 IPv6 示例）

3. 项目 API 使用文档

创建 IPv4 地址

使用 IPAddress::IPv4.new 方法：

ip = IPAddress::IPv4.new "172.16.10.1/24"

使用 IPAddress.parse 方法：
```
ip = IPAddress.parse "172.16.10.1/24"
```
使用快捷方法 IPAddress()：
```
ip = IPAddress "172.16.10.1/24"
```

获取地址属性

获取地址：
```
ip.address #=> "172.16.10.1"
```
获取前缀：
```
ip.prefix #=> 24
```
获取子网掩码：
```
ip.netmask #=> "255.255.255.0"
```
获取八位字节：
```
ip.octets #=> [172, 16, 10, 1]
```

修改子网掩码

设置新的前缀：

ip.prefix = 25
ip.to_s #=> "172.16.10.1/25"

设置新的子网掩码：

ip.netmask = "255.255.255.252"
ip.to_s #=> "172.16.10.1/30"

网络和广播地址

获取网络地址：

net = ip.network
net.to_s #=> "172.16.10.0/24"

获取广播地址：

bcast = ip.broadcast
bcast.to_s #=> "172.16.10.255/24"

迭代地址范围

遍历所有地址：
```
ip.each do |addr|
  puts addr
end
```
仅遍历主机地址：
```
ip.each_host do |host|
  puts host
end
```

特殊格式转换

获取二进制格式：

ip.bits #=> "10101100000100000000101000000001"

获取 32 位无符号整数格式：
```
ip.to_u32 #=> 2886732289
```
获取数据格式：
```
ip.data #=> "\254\020\n\001"
```
转换为 IPv6 格式：
```
ip.to_ipv6 #=> "ac10:0a01"
```

4. 项目安装方式

通过 Gem 安装

$ gem install ipaddress

通过 Bundler 安装

将以下内容添加到 Gemfile：

gem 'ipaddress'

然后运行：

$ bundle install

生成文档

使用 Rake 生成文档：

$ rake rdoc

通过以上步骤，您可以轻松安装并使用 IPAddress 库来处理 IPv4 和 IPv6 地址。

登录后查看全文