新来了个技术总监，居然要我做一个 IP 属地功能。。不服就干！ ...

作者：ThinkingKeep
链接：https://juejin.cn/post/7118954784853327903
细心的朋友应该会发现，最近，继新浪微博之后，头条、腾讯、抖音、知乎、快手、小红书等各大平台陆陆续续都上线了“网络用户IP地址显示功能”，境外用户显示的是国家，国内的用户显示的省份，而且此项显示无法关闭，归属地强制显示。
作为技术人，那！这个功能要怎么实现呢？
下面，我就来讲讲，Java中是如何获取IP属地的，主要分为以下几步：

• 通过 HttpServletRequest 对象，获取用户的 IP 地址
  
• 通过 IP 地址，获取对应的省份、城市
  

首先需要写一个 IP 获取的工具类，因为每一次用户的 Request 请求，都会携带上请求的 IP 地址放到请求头中

通过此方法，从请求Header中获取到用户的IP地址

目前本人在做的项目中，也有获取IP地址归属地省份、城市的需求，用的是：淘宝IP库
地址：ip.taobao.com/

原来的请求源码如下：


可以看到日志log文件中，大量的the request over max qps for user问题

下面，给大家介绍下之前在Github冲浪时发现的今天的主角：

目前最新已更新到了v2.0版本，ip2region v2.0是一个离线IP地址定位库和IP定位数据管理框架，10微秒级别的查询效率，准提供了众多主流编程语言的 xdb 数据生成和查询客户端实现。

99.9%准确率：

数据聚合了一些知名ip到地名查询提供商的数据，这些是他们官方的的准确率，经测试着实比经典的纯真IP定位准确一些。

多查询客户端的支持

已经集成的客户端有：java、C#、php、c、python、nodejs、php扩展(php5和php7)、golang、rust、lua、lua_c, nginx。
binding描述开发状态binary查询耗时b-tree查询耗时memory查询耗时cANSC c binding已完成0.0x毫秒0.0x毫秒0.00x毫秒c#c# binding已完成0.x毫秒0.x毫秒0.1x毫秒golanggolang binding已完成0.x毫秒0.x毫秒0.1x毫秒javajava binding已完成0.x毫秒0.x毫秒0.1x毫秒lualua实现的binding已完成0.x毫秒0.x毫秒0.x毫秒lua_clua的c扩展已完成0.0x毫秒0.0x毫秒0.00x毫秒nginxnginx的c扩展已完成0.0x毫秒0.0x毫秒0.00x毫秒nodejsnodejs已完成0.x毫秒0.x毫秒0.1x毫秒phpphp实现的binding已完成0.x毫秒0.1x毫秒0.1x毫秒php5_extphp5的c扩展已完成0.0x毫秒0.0x毫秒0.00x毫秒php7_extphp7的c扩展已完成0.0毫秒0.0x毫秒0.00x毫秒pythonpython bindng已完成0.x毫秒0.x毫秒0.x毫秒rustrust binding已完成0.x毫秒0.x毫秒0.x毫秒Ip2region V2.0 特性

1、标准化的数据格式
每个 ip 数据段的 region 信息都固定了格式：国家|区域|省份|城市|ISP，只有中国的数据绝大部分精确到了城市，其他国家部分数据只能定位到国家，后前的选项全部是0。
2、数据去重和压缩
xdb 格式生成程序会自动去重和压缩部分数据，默认的全部 IP 数据，生成的 ip2region.xdb 数据库是 11MiB，随着数据的详细度增加数据库的大小也慢慢增大。
3、极速查询响应
即使是完全基于 xdb 文件的查询，单次查询响应时间在十微秒级别，可通过如下两种方式开启内存加速查询：

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

4、极速查询响应
v2.0 格式的 xdb 支持亿级别的 IP 数据段行数，region 信息也可以完全自定义，例如：你可以在 region 中追加特定业务需求的数据，例如：GPS信息/国际统一地域信息编码/邮编等。也就是你完全可以使用 ip2region 来管理你自己的 IP 定位数据。
ip2region xdb java 查询客户端实现

• 使用方式
  

引入maven仓库：

1. <dependency>
2.     <groupId>org.lionsoul</groupId>
3.     <artifactId>ip2region</artifactId>
4.     <version>2.6.4</version>
5. </dependency>

复制代码

• 完全基于文件的查询
  

1. import org.lionsoul.ip2region.xdb.Searcher;
2. import java.io.*;
3. import java.util.concurrent.TimeUnit;
5. public class SearcherTest {
6.     public static void main(String[] args) {
7.         // 1、创建 searcher 对象
8.         String dbPath = "ip2region.xdb file path";
9.         Searcher searcher = null;
10.         try {
11.             searcher = Searcher.newWithFileOnly(dbPath);
12.         } catch (IOException e) {
13.             System.out.printf("failed to create searcher with `%s`: %s\n", dbPath, e);
14.             return;
15.         }
17.         // 2、查询
18.         try {
19.             String ip = "1.2.3.4";
20.             long sTime = System.nanoTime();
21.             String region = searcher.search(ip);
22.             long cost = TimeUnit.NANOSECONDS.toMicros((long) (System.nanoTime() - sTime));
23.             System.out.printf("{region: %s, ioCount: %d, took: %d μs}\n", region, searcher.getIOCount(), cost);
24.         } catch (Exception e) {
25.             System.out.printf("failed to search(%s): %s\n", ip, e);
26.         }
28.         // 3、备注：并发使用，每个线程需要创建一个独立的 searcher 对象单独使用。
29.     }
30. }

复制代码

• 缓存VectorIndex索引
  

我们可以提前从 xdb 文件中加载出来 VectorIndex 数据，然后全局缓存，每次创建 Searcher 对象的时候使用全局的 VectorIndex 缓存可以减少一次固定的 IO 操作，从而加速查询，减少 IO 压力。

1. import org.lionsoul.ip2region.xdb.Searcher;
2. import java.io.*;
3. import java.util.concurrent.TimeUnit;
5. public class SearcherTest {
6.     public static void main(String[] args) {
7.         String dbPath = "ip2region.xdb file path";
9.         // 1、从 dbPath 中预先加载 VectorIndex 缓存，并且把这个得到的数据作为全局变量，后续反复使用。
10.         byte[] vIndex;
11.         try {
12.             vIndex = Searcher.loadVectorIndexFromFile(dbPath);
13.         } catch (Exception e) {
14.             System.out.printf("failed to load vector index from `%s`: %s\n", dbPath, e);
15.             return;
16.         }
18.         // 2、使用全局的 vIndex 创建带 VectorIndex 缓存的查询对象。
19.         Searcher searcher;
20.         try {
21.             searcher = Searcher.newWithVectorIndex(dbPath, vIndex);
22.         } catch (Exception e) {
23.             System.out.printf("failed to create vectorIndex cached searcher with `%s`: %s\n", dbPath, e);
24.             return;
25.         }
27.         // 3、查询
28.         try {
29.             String ip = "1.2.3.4";
30.             long sTime = System.nanoTime();
31.             String region = searcher.search(ip);
32.             long cost = TimeUnit.NANOSECONDS.toMicros((long) (System.nanoTime() - sTime));
33.             System.out.printf("{region: %s, ioCount: %d, took: %d μs}\n", region, searcher.getIOCount(), cost);
34.         } catch (Exception e) {
35.             System.out.printf("failed to search(%s): %s\n", ip, e);
36.         }
38.         // 备注：每个线程需要单独创建一个独立的 Searcher 对象，但是都共享全局的制度 vIndex 缓存。
39.     }
40. }

复制代码

• 缓存整个xdb数据
  

我们也可以预先加载整个 ip2region.xdb 的数据到内存，然后基于这个数据创建查询对象来实现完全基于文件的查询，类似之前的 memory search。

1. import org.lionsoul.ip2region.xdb.Searcher;
2. import java.io.*;
3. import java.util.concurrent.TimeUnit;
5. public class SearcherTest {
6.     public static void main(String[] args) {
7.         String dbPath = "ip2region.xdb file path";
9.         // 1、从 dbPath 加载整个 xdb 到内存。
10.         byte[] cBuff;
11.         try {
12.             cBuff = Searcher.loadContentFromFile(dbPath);
13.         } catch (Exception e) {
14.             System.out.printf("failed to load content from `%s`: %s\n", dbPath, e);
15.             return;
16.         }
18.         // 2、使用上述的 cBuff 创建一个完全基于内存的查询对象。
19.         Searcher searcher;
20.         try {
21.             searcher = Searcher.newWithBuffer(cBuff);
22.         } catch (Exception e) {
23.             System.out.printf("failed to create content cached searcher: %s\n", e);
24.             return;
25.         }
27.         // 3、查询
28.         try {
29.             String ip = "1.2.3.4";
30.             long sTime = System.nanoTime();
31.             String region = searcher.search(ip);
32.             long cost = TimeUnit.NANOSECONDS.toMicros((long) (System.nanoTime() - sTime));
33.             System.out.printf("{region: %s, ioCount: %d, took: %d μs}\n", region, searcher.getIOCount(), cost);
34.         } catch (Exception e) {
35.             System.out.printf("failed to search(%s): %s\n", ip, e);
36.         }
38.         // 备注：并发使用，用整个 xdb 数据缓存创建的查询对象可以安全的用于并发，也就是你可以把这个 searcher 对象做成全局对象去跨线程访问。
39.     }
40. }

复制代码

IDEA中做个测试


完全基于文件的查询
ip属地国内的话，会展示省份，国外的话，只会展示国家。可以通过如下图这个方法进行进一步封装，得到获取IP属地的信息。

下面是官网给出的命令运行jar方式给出的测试demo，可以理解下

编译测试程序

通过 maven 来编译测试程序。

1. # cd 到 java binding 的根目录
2. cd binding/java/
3. mvn compile package

复制代码

然后会在当前目录的 target 目录下得到一个 ip2region-{version}.jar 的打包文件。
查询测试

可以通过 java -jar ip2region-{version}.jar search 命令来测试查询：

1. ➜  java git:(v2.0_xdb) ✗ java -jar target/ip2region-2.6.0.jar search
2. java -jar ip2region-{version}.jar search [command options]
3. options:
4. --db string              ip2region binary xdb file path
5. --cache-policy string    cache policy: file/vectorIndex/content

复制代码

例如：使用默认的 data/ip2region.xdb 文件进行查询测试：

1. ➜  java git:(v2.0_xdb) ✗ java -jar target/ip2region-2.6.0.jar search --db=../../data/ip2region.xdb
2. ip2region xdb searcher test program, cachePolicy: vectorIndex
3. type 'quit' to exit
4. ip2region>> 1.2.3.4
5. {region: 美国|0|华盛顿|0|谷歌, ioCount: 7, took: 82 μs}
6. ip2region>>

复制代码

输入 ip 即可进行查询测试，也可以分别设置 cache-policy 为 file/vectorIndex/content 来测试三种不同缓存实现的查询效果。
bench 测试

可以通过 java -jar ip2region-{version}.jar bench 命令来进行 bench 测试，一方面确保 xdb 文件没有错误，一方面可以评估查询性能：

1. ➜  java git:(v2.0_xdb) ✗ java -jar target/ip2region-2.6.0.jar bench
2. java -jar ip2region-{version}.jar bench [command options]
3. options:
4. --db string              ip2region binary xdb file path
5. --src string             source ip text file path
6. --cache-policy string    cache policy: file/vectorIndex/content

复制代码

例如：通过默认的 data/ip2region.xdb 和 data/ip.merge.txt 文件进行 bench 测试：

1. ➜  java git:(v2.0_xdb) ✗ java -jar target/ip2region-2.6.0.jar bench --db=../../data/ip2region.xdb --src=../../data/ip.merge.txt
2. Bench finished, {cachePolicy: vectorIndex, total: 3417955, took: 8s, cost: 2 μs/op}

复制代码

可以通过分别设置 cache-policy 为 file/vectorIndex/content 来测试三种不同缓存实现的效果。 @Note: 注意 bench 使用的 src 文件要是生成对应 xdb 文件相同的源文件。

到这里获取用户IP属地已经完成啦，这篇文章介绍的v2.0版本，有兴趣的小伙伴可以登录上门的github地址了解下v1.0版本

如若觉得有用，欢迎收藏+点赞，如遇到什么问题，欢迎留言讨论
近期热文推荐：
1.1,000+ 道 Java面试题及答案整理(2022最新版)
2.劲爆！Java 协程要来了。。。
3.Spring Boot 2.x 教程，太全了！
4.别再写满屏的爆爆爆炸类了，试试装饰器模式，这才是优雅的方式！！
5.《Java开发手册（嵩山版）》最新发布，速速下载！
觉得不错，别忘了随手点赞+转发哦！

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！