Rust随机端口生成库random-port的使用，高效获取可用网络端口并避免冲突

安装

cargo add random-port

基本用法

use random_port::PortPicker;

let port: u16 = PortPicker::new().pick().unwrap();

API说明

PortPicker

pick()

返回一个Result<u16, Error>，表示可用的端口号

port_range(RangeInclusive)

指定要检查的端口范围，必须在1024..=65535范围内。例如port_range(1024..=65535)

execlude(HashSet<u16>)/execlude_add(u16)

指定要排除的端口

protocol(Protocol)

指定要检查的协议，默认为Protocol::All。可以是Protocol::Tcp、Protocol::Udp或Protocol::All

host(String)

指定要检查的主机，可以是IPv4或IPv6地址。如果未指定，将检查系统定义的所有本地地址的可用性

random(bool)

指定是否从范围内随机选择一个端口。如果未指定，将从范围内选择第一个可用端口

完整示例

use random_port::PortPicker;
use std::collections::HashSet;

fn main() {
    // 基本用法：获取一个随机可用端口
    let port = PortPicker::new().pick().unwrap();
    println!("Random available port: {}", port);

    // 高级用法：指定参数获取端口
    let mut excluded_ports = HashSet::new();
    excluded_ports.insert(8080);
    excluded_ports.insert(3000);
    
    let port = PortPicker::new()
        .port_range(8000..=9000)  // 只在8000-9000范围内查找
        .execlude(excluded_ports)  // 排除8080和3000端口
        .protocol(random_port::Protocol::Tcp)  // 只检查TCP端口
        .random(true)  // 随机选择而不是第一个可用
        .pick()
        .unwrap();
        
    println!("Custom available port: {}", port);
}

这个示例展示了：

1. 基本用法：简单获取一个随机可用端口
2. 高级用法：通过多种参数组合精确控制端口选择行为
   • 限制端口范围
   • 排除已知使用中的端口
   • 指定协议类型
   • 启用随机选择模式

使用这个库可以高效地在Rust应用程序中获取可用的网络端口，避免端口冲突问题。

完整示例代码

use random_port::{PortPicker, Protocol};
use std::collections::HashSet;

fn main() {
    // 示例1: 获取单个随机端口
    let port1 = PortPicker::new().pick().unwrap();
    println!("获取到的随机端口1: {}", port1);

    // 示例2: 获取指定范围内的端口
    let port2 = PortPicker::new()
        .port_range(5000..=6000)  // 限定在5000-6000范围内
        .pick()
        .unwrap();
    println!("5000-6000范围内的随机端口: {}", port2);

    // 示例3: 排除特定端口
    let mut excluded = HashSet::new();
    excluded.insert(5432);  // 排除PostgreSQL默认端口
    excluded.insert(6379);  // 排除Redis默认端口
    
    let port3 = PortPicker::new()
        .execlude(excluded)
        .pick()
        .unwrap();
    println!("排除常用服务端口后的随机端口: {}", port3);

    // 示例4: 完整参数组合
    let port4 = PortPicker::new()
        .port_range(8000..=9000)
        .execlude_add(8080)  // 单独排除8080
        .protocol(Protocol::Udp)  // 只检查UDP端口
        .host("127.0.0.1".to_string())  // 只检查本地回环地址
        .random(true)  // 启用随机选择
        .pick()
        .unwrap();
    
    println!("自定义参数获取的UDP端口: {}", port4);

    // 示例5: 批量获取多个端口
    let mut ports = Vec::new();
    let mut picker = PortPicker::new()
        .port_range(30000..=40000)
        .random(true);
    
    for _ in 0..5 {
        let p = picker.pick().unwrap();
        ports.push(p);
        picker.execlude_add(p);  // 将已选端口加入排除列表
    }
    
    println!("批量获取的不重复端口: {:?}", ports);
}

这个完整示例展示了：

1. 基础随机端口获取
2. 限定端口范围
3. 排除特定端口
4. 完整参数组合使用
5. 批量获取多个不重复端口

每个示例都有详细的注释说明，展示了random-port库在实际应用中的各种用法。