文章目录
- 1 摘要
- 2 核心 Maven 依赖
- 3 离线数据 db 保存
- 4 核心代码
- 5 测试
- 6 推荐参考资料
1 摘要
在实际项目中可能会用到统计用户地理位置的需求,这时可以通过客户端的 ip 地址来获取所属城市信息,ip2region 项目就是为解决这个需求而来的。ip2region 是一个开源、免费、可离线运行的通过 ip 获取全球城市信息的第三方库。本文将介绍在 Java 中使用 ip2region 库将 ip 转化为城市信息。
ip2region github: https://github.com/lionsoul2014/ip2region
2 核心 Maven 依赖
<!-- ip to region -->
<dependency>
<groupId>org.lionsoul</groupId>
<artifactId>ip2region</artifactId>
<version>${ip2region.version}</version>
</dependency>
其中 ${ip2region.version}
的版本信息为: <ip2region.version>1.7.2</ip2region.version>
3 离线数据 db 保存
ip2region 是将已知的所有 ip 和城市信息的对应关系保存在数据库中,数据库文件为 ip2region.db
,在 ip2region 项目的 data
目录下。
将离线数据(ip2region.db)添加到项目的 resource
目录下,或者放到固定的网络存储位置。
4 核心代码
LocationUtil.java
package com.ljq.demo.util;
import cn.hutool.core.io.IoUtil;
import lombok.extern.slf4j.Slf4j;
import org.lionsoul.ip2region.*;
import java.io.IOException;
/**
* @Description: 位置定位工具类
* @Author: junqiang.lu
* @Date: 2021/9/18
*/
@Slf4j
public class LocationUtil {
private static final String dbRelativePath = "/ip2region.db";
private static byte[] dbData = null;
static {
dbData = IoUtil.readBytes(LocationUtil.class.getResourceAsStream(dbRelativePath));
}
/**
* 根据 ip 获取地里位置
* @param ip
* @return
* @throws DbMakerConfigException
* @throws IOException
*/
public static String getRegionFromIp(String ip) throws DbMakerConfigException, IOException {
DbSearcher searcher = new DbSearcher(new DbConfig(), dbData);
String region = null;
if (Util.isIpAddress(ip)) {
DataBlock dataBlock = searcher.memorySearch(ip);
region = dataBlock.getRegion();
return region;
}
return null;
}
}
5 测试
LocationUtilTest.java
package com.ljq.demo.util;
import org.junit.Test;
import org.lionsoul.ip2region.DbMakerConfigException;
import java.io.IOException;
public class LocationUtilTest {
@Test
public void getRegionFromIp() throws IOException, DbMakerConfigException {
String[] ipArr = {"58.250.250.254", "204.124.181.253", "192.168.11.12", "127.0.0.1"};
for (int i = 0; i < ipArr.length; i++) {
System.out.println("------------------" + ipArr[i] + "----------------------------");
System.out.println(LocationUtil.getRegionFromIp(ipArr[i]));
}
}
}
测试输出结果:
------------------58.250.250.254----------------------------
中国|0|广东|深圳|联通
------------------204.124.181.253----------------------------
日本|0|大阪府|大阪|0
------------------192.168.11.12----------------------------
0|0|0|内网IP|内网IP
------------------127.0.0.1----------------------------
0|0|0|内网IP|内网IP
6 推荐参考资料
使用ip2region来完成城市定位(java)