cidranger 项目使用教程

cidranger 项目使用教程

cidrangerFast IP to CIDR lookup in Golang项目地址:https://gitcode.com/gh_mirrors/ci/cidranger

1. 项目的目录结构及介绍

cidranger 是一个用于快速 IP 到 CIDR 查找的 Go 语言库。项目的目录结构如下：

cidranger/
├── example/
│   └── example.go
├── internal/
│   ├── brute.go
│   ├── cidranger.go
│   ├── trie.go
│   └── version.go
├── LICENSE
├── README.md
├── cidranger.go
└── go.mod

目录介绍

• example/: 包含示例代码，展示如何扩展和使用 cidranger 库。
• internal/: 包含库的内部实现文件。
  • brute.go: 暴力查找实现。
  • cidranger.go: 主要功能实现。
  • trie.go: 压缩路径 trie 实现。
  • version.go: 版本管理相关。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• cidranger.go: 库的主要接口和功能定义。
• go.mod: Go 模块定义文件。

2. 项目的启动文件介绍

cidranger 库主要通过 cidranger.go 文件提供接口和功能。以下是该文件的主要内容：

package cidranger

import (
	"net"
)

// RangerEntry 接口定义
type RangerEntry interface {
	Network() net.IPNet
}

// NewBasicRangerEntry 函数返回一个基本的 RangerEntry
func NewBasicRangerEntry(ipNet net.IPNet) RangerEntry {
	return &basicRangerEntry{ipNet: ipNet}
}

// NewPCTrieRanger 函数返回一个支持 IPv4 和 IPv6 的压缩路径 trie 实现
func NewPCTrieRanger() Ranger {
	return newPCTrieRanger()
}

主要功能

• RangerEntry 接口定义了插入到 Ranger 中的条目必须实现的方法。
• NewBasicRangerEntry 函数用于创建一个基本的 RangerEntry。
• NewPCTrieRanger 函数用于创建一个支持 IPv4 和 IPv6 的压缩路径 trie 实现。

3. 项目的配置文件介绍

cidranger 库没有传统的配置文件，其主要通过代码接口进行配置和使用。以下是一个简单的使用示例：

package main

import (
	"fmt"
	"net"
	"github.com/yl2chen/cidranger"
)

func main() {
	ranger := cidranger.NewPCTrieRanger()

	_, network, _ := net.ParseCIDR("192.168.0.0/24")
	ranger.Insert(cidranger.NewBasicRangerEntry(*network))

	ip := net.ParseIP("192.168.0.1")
	contains, _ := ranger.Contains(ip)
	fmt.Println("Contains:", contains)
}

使用说明

• 通过 NewPCTrieRanger 创建一个 Ranger 实例。
• 使用 net.ParseCIDR 解析 CIDR 网络。
• 通过 Insert 方法将 CIDR 网络插入到 Ranger 中。
• 使用 Contains 方法检查某个 IP 是否在插入的 CIDR 网络中。

以上是 cidranger 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助！

cidrangerFast IP to CIDR lookup in Golang项目地址:https://gitcode.com/gh_mirrors/ci/cidranger