ip2region

README

:globe_with_meridians: [中文简体](https://gitee.com/lionsoul/ip2region/blob/master/README_zh.md) | [English](https://gitee.com/lionsoul/ip2region/blob/master/README.md)

# ip2region

[ip2region](https://ip2region.net) - 是一个离线IP地址定位库和IP定位数据管理框架，同时支持 `IPv4` 和 `IPv6` ，10微秒级别的查询效率，提供了众多主流编程语言的 `xdb` 数据生成和查询客户端实现。


# 项目特性

### 1、离线定位库

项目本身同时了提供了一份 IPv4 (`data/ipv4_source.txt`) 和 IPv6 (`data/ipv6_source.txt`) 的原始数据和对应的 xdb 文件(`data/ip2region_v4.xdb` 和 `data/ip2region_v6.xdb`) 用于实现精确到城市的查询定位功能，字段格式为：`国家|省份|城市|ISP|iso-alpha2-code(国家两字母简称)`，中国的定位信息全部为中文，非中国地区的地域信息全部为英文。

### 2、数据管理框架

`xdb` 支持亿级别的 IP 数据段行数，region 信息支持完全自定义，自带数据的 region 信息固定了格式为：`国家|省份|城市|ISP|iso-alpha2-Code`，你可以在 region 中追加特定业务需求的数据，例如：GPS信息/国际统一地域信息编码/邮编等。也就是你完全可以使用 ip2region 来管理你自己的 IP 定位数据。

### 3、数据去重和压缩

`xdb` 格式生成程序会自动处理输入的原始数据，检查并且完成相连 IP 段的的合并以及相同地域信息的去重和压缩。

### 4、极速查询响应

即使是完全基于 `xdb` 文件的查询，单次查询响应时间在十微秒级别，可通过如下两种方式开启内存加速查询：

1. `vIndex` 索引缓存 ：使用固定的 `512KiB` 的内存空间缓存 vector index 数据，减少一次 IO 磁盘操作，保持平均查询效率稳定在100微秒之内。
2. `xdb` 整个文件缓存：将整个 `xdb` 文件全部加载到内存，内存占用等同于 `xdb` 文件大小，无磁盘 IO 操作，保持10微秒级别的查询效率。

### 5、统一的查询接口

`xdb` 提供了版本兼容的查询实现，一个统一的 API 可以同时提供对 IPv4 和 IPv6 数据的查询并且返回统一的数据。


# `xdb` 查询

API 介绍，使用文档和测试程序请参考对应 `searcher` 查询客户端下的 README 介绍，全部查询 binding 实现情况如下：
| 编程语言 | 描述 | IPv4 支持 | IPv6 支持 |
| --- | --- | --- | --- |
| [Golang](https://gitee.com/lionsoul/ip2region/blob/master/binding/golang/README_zh.md)         | golang 查询客户端       | :white_check_mark: | :white_check_mark: |
| [PHP](https://gitee.com/lionsoul/ip2region/blob/master/binding/php/README_zh.md)               | php 查询客户端          | :white_check_mark: | :white_check_mark: |
| [Java](https://gitee.com/lionsoul/ip2region/blob/master/binding/java/README_zh.md)             | java 查询客户端         | :white_check_mark: | :white_check_mark: |
| [C](https://gitee.com/lionsoul/ip2region/blob/master/binding/c/README_zh.md)                   | C[std=c99] 查询客户端   | :white_check_mark: | :white_check_mark: |
| [Lua_c](https://gitee.com/lionsoul/ip2region/blob/master/binding/lua_c/README_zh.md)           | lua c 扩展查询客户端    | :white_check_mark: | :white_check_mark: |
| [Lua](https://gitee.com/lionsoul/ip2region/blob/master/binding/lua/README_zh.md)               | lua 查询客户端          | :white_check_mark: | :white_check_mark: |
| [Rust](https://gitee.com/lionsoul/ip2region/blob/master/binding/rust/README_zh.md)             | rust 查询客户端         | :white_check_mark: | :white_check_mark: |
| [Python](https://gitee.com/lionsoul/ip2region/blob/master/binding/python/README_zh.md)         | python 查询客户端       | :white_check_mark: | :white_check_mark: |
| [Javascript](https://gitee.com/lionsoul/ip2region/blob/master/binding/javascript/README_zh.md) | javascript 查询客户端   | :white_check_mark: | :white_check_mark: |
| [Csharp](https://gitee.com/lionsoul/ip2region/blob/master/binding/csharp)                      | csharp 查询客户端       | :white_check_mark: | :white_check_mark: |
| [Erlang](https://gitee.com/lionsoul/ip2region/blob/master/binding/erlang/README_zh.md)         | erlang 查询客户端       | :white_check_mark: | :white_check_mark: |
| [Nginx](https://gitee.com/lionsoul/ip2region/blob/master/binding/nginx)                        | nginx 扩展查询客户端    | :white_check_mark: | :white_check_mark: |
| [Logstash](https://gitee.com/lionsoul/ip2region/blob/master/binding/logstash/README_zh.md)     | logstash 过滤器插件     | :white_check_mark: | :white_check_mark: |
| [C++](https://gitee.com/lionsoul/ip2region/blob/master/binding/cpp/README_zh.md)               | C++ 查询客户端          | :white_check_mark: | :white_check_mark: |
| [Cangjie](https://gitee.com/lionsoul/ip2region/blob/master/binding/cangjie/README.md)          | 仓颉 查询客户端         | :white_check_mark: | :white_check_mark: |
| [Logstash](https://gitee.com/lionsoul/ip2region/blob/master/binding/logstash/README_zh.md)     | Logstash 过滤插件       | :white_check_mark: | :white_check_mark: |


以下工具链实现由社区开发者通过第三方仓库贡献：
| 编程语言 | 描述 |
| --- | --- |
| [ip2region-composer](https://github.com/zoujingli/ip2region)    | php composer 管理客户端 |
| [ip2region-ts](https://github.com/Steven-Qiang/ts-ip2region2)   | node.js addon 管理客户端|
| [ruby-ip2region](https://github.com/jicheng1014/ruby-ip2region) | ruby xdb 查询客户端实现 |
| [Ip2regionTool](https://github.com/orestonce/Ip2regionTool)     | ip2region 数据转换工具  |


# `xdb` 生成

API 介绍，使用文档和测试程序请参考如下 `maker` 生成程序下的 README 文档：

| 编程语言 | 描述 | IPv4 支持 | IPv6 支持 |
| --- | --- | --- | --- |
| [Golang](https://gitee.com/lionsoul/ip2region/blob/master/maker/golang/README_zh.md) | golang xdb 生成程序  | :white_check_mark: | :white_check_mark: |
| [Java](https://gitee.com/lionsoul/ip2region/blob/master/maker/java/README_zh.md)     | java xdb 生成程序    | :white_check_mark: | :white_check_mark: |
| [Python](https://gitee.com/lionsoul/ip2region/blob/master/maker/python/README_zh.md) | python xdb 生成程序  | :white_check_mark: | :x:                |
| [Csharp](https://gitee.com/lionsoul/ip2region/blob/master/maker/csharp/README_zh.md) | csharp xdb 生成程序  | :white_check_mark: | :x:                |
| [Rust](https://gitee.com/lionsoul/ip2region/blob/master/maker/rust/README_zh.md)     | rust xdb 生成程序    | :white_check_mark: | :white_check_mark: |
| [C++](https://gitee.com/lionsoul/ip2region/blob/master/maker/cpp)                    | C++ xdb 生成程序     | :white_check_mark: | :white_check_mark: |


# `xdb` 更新

ip2region 项目的核心在于 <b>研究 IP 数据的存储和快速查询的设计和实现</b>， 项目自带的 `./data/ipv4_source.txt` 和 `./data/ipv6_source.txt` 原始数据不定期更新，对于数据精度和更新频率要求很高的使用场景建议到 [Ip2Region社区](https://ip2region.net/products/offline) 或者第三方购买商用离线数据，你可以使用如下几种方式来尝试自己更新数据：

### 手动编辑更新
你可以基于 ip2region 自带的 `./data/ipv4_source.txt` 和 `./data/ipv6_source.txt` 原始 IP 数据用 ip2region 提供的编辑工具来自己修改，目前数据源有如下几种方式：
1. ip2region 社区提供的数据（请参考地底部的公众号关注社区通知）
2. ip2region Github/Gitee 中带有 `[数据源补充]` 标签的 Issue
3. 其他自定义数据：例如客户提供的数据，或者通过 GPS 和 WIFI 定位得到的数据，或者来自其他平台的合法合规的数据

原始 IP 数据编辑工具使用方法请参考如下的 `maker` 生成程序下的 README 文档：
| 编程语言 | 描述 | IPv4 支持 | IPv6 支持 |
| --- | --- | --- | --- |
| [Golang](https://gitee.com/lionsoul/ip2regi