SpringBoot实现获取客户端IP地理位置
更新时间：2023年11月29日 13:59:54 作者：FirstMrRight
在当今互联的世界中,了解客户端的地理位置对于提供个性化服务和增强用户体验至关重要,使用本文为大家介绍了SpringBoot获取客户端IP地理位置的相关方法,需要的小伙伴可以参考下
在当今互联的世界中，了解客户端的地理位置对于提供个性化服务和增强用户体验至关重要。无论是根据地区偏好定制内容，还是确保符合本地法规，访问客户端IP位置都是一项宝贵的资产。如抖音评论区、用户页都会展示用户的IP属地信息。
在本文中，我们将探讨一个Spring Boot项目，它能够高效地获取客户端IP地址的地理位置，并讨论其应用场景和实现方式。
项目开源地址
我已开源，点击即可查看完整代码实现。
项目概览
该项目的结构如下：
- common：包含一个ResultResponse类，用于统一处理响应。
- rest：负责处理客户端请求以获取IP地理位置的控制层。
- service：实现业务逻辑，利用ip2region库获取IP位置信息。
- util：包含主要工具类IPUtils，用于从客户端请求中获取IP地理位置。
项目依赖
该项目利用了开源的ip2region库，该库提供了离线IP地址定位和数据管理的高效API。该库具有微秒级的查询效率，支持多种编程语言。您可以在这里找到ip2region库的GitHub仓库。
<dependency> <groupId>org.lionsoul</groupId> <artifactId>ip2region</artifactId> <version>2.6.5</version> </dependency>
使用方法
为了使用该项目，需下载ip2region.xdb文件并将其放置在服务器或本地机器上的合适位置。文件路径在项目中配置如下：
private static final String DB_PATH = "/root/home_place/ip2region.xdb";
配置灵活，可使用YAML或其他配置文件进行修改。
请求处理
要获取IP地理位置，使用javax.servlet.http.HttpServletRequest作为请求参数。调用IPUtils类的getIPRegion方法即可获取IP位置信息：
String ipRegion = IPUtils.getIPRegion(request);
ThreadLocal的作用
ThreadLocal是Java中一个强大的工具，它提供了线程局部变量的支持。对于需要在多线程环境中保持独立状态的对象，ThreadLocal是一个理想的选择。每个线程都可以通过ThreadLocal获得自己的独立副本，而不受其他线程的影响。
工具类
/**
* @author Liutx
* @since 2023-11-28 10:05
*/
public class IPUtils {
private static final Logger log = LogManager.getLogger(IPUtils.class);
private static final String DB_PATH = "/root/home_place/ip2region.xdb";
private static final ThreadLocal<Searcher> searcherThreadLocal = ThreadLocal.withInitial(() -> {
try {
return Searcher.newWithFileOnly(DB_PATH);
} catch (Exception e) {
log.error("初始化 IP 归属地查询失败: {}", e.getMessage());
return null;
}
});
public static String getIPRegion(HttpServletRequest request) {
String ip = getIPAddress(request);
Searcher searcher = searcherThreadLocal.get();
if (searcher == null) {
log.error("IP 归属地查询失败，返回空");
return null;
}
try {
long startTime = System.nanoTime();
String region = searcher.search(ip);
long cost = TimeUnit.NANOSECONDS.toMicros(System.nanoTime() - startTime);
log.info("IP: {}, Region: {}, IO Count: {}, Took: {} μs", ip, region, searcher.getIOCount(), cost);
return region;
} catch (Exception e) {
log.error("IP: {} 获取 IP 归属地错误，错误原因: {}", ip, e.getMessage());
return null;
} finally {
closeSearcher();
}
}
private static String getIPAddress(HttpServletRequest request) {
String ipAddress = request.getHeader("X-Forwarded-For");
if (ipAddress == null || ipAddress.isEmpty() || "unknown".equalsIgnoreCase(ipAddress)) {
ipAddress = request.getHeader("Proxy-Client-IP");
}
if (ipAddress == null || ipAddress.isEmpty() || "unknown".equalsIgnoreCase(ipAddress)) {
ipAddress = request.getHeader("WL-Proxy-Client-IP");
}
if (ipAddress == null || ipAddress.isEmpty() || "unknown".equalsIgnoreCase(ipAddress)) {
ipAddress = request.getHeader("HTTP_CLIENT_IP");
}
if (ipAddress == null || ipAddress.isEmpty() || "unknown".equalsIgnoreCase(ipAddress)) {
ipAddress = request.getHeader("HTTP_X_FORWARDED_FOR");
}
if (ipAddress == null || ipAddress.isEmpty() || "unknown".equalsIgnoreCase(ipAddress)) {
ipAddress = request.getRemoteAddr();
}
return ipAddress;
}
public static void closeSearcher() {
try {
Searcher searcher = searcherThreadLocal.get();
if (Objects.nonNull(searcher)) {
searcher.close();
searcherThreadLocal.remove();
}
} catch (Exception e) {
log.error("关闭异常", e);
}
}
}
Searcher在不同的线程中需要创建单独的对象，因此我们使用ThreadLocal存储，保证不同线程间的独立性。
测试类
public static void main(String[] args) {
String ip = "192.168.31.1";
try {
// 1、创建 searcher 对象
String dbPath = "src/main/resources/ipdata/ip2region.xdb";
Searcher searcher = null;
searcher = Searcher.newWithFileOnly(dbPath);
// 2、查询
long sTime = System.nanoTime();
String region = searcher.search(ip);
long cost = TimeUnit.NANOSECONDS.toMicros((long) (System.nanoTime() - sTime));
log.info("{region: {}, ioCount: {}, took: {} μs}", region, searcher.getIOCount(), cost);
// 3、关闭资源
searcher.close();
// 备注：并发使用，每个线程需要创建一个独立的 searcher 对象单独使用。
} catch (Exception e) {
log.error("IP:{}获取IP归属地错误，错误原因:", ip, e);
}
}
响应格式
API响应和方法返回值的格式保持一致：
API响应：
{
"success": true,
"trace": "023c71f9-f483-466d-b650-a30fa097b64c",
"code": "OK",
"message": "获取成功",
"data": "中国|0|山东省|青岛市|移动"
}
方法返回值：
中国|0|山东省|青岛市|移动
性能测试
该项目在以下条件下进行了性能评估：
- CPU：2核
- RAM：2GB
- 存储：3MB
测试工具：ApiPost 7
并发数：100
时长：10秒
总结
这个基于Spring Boot的项目，结合强大的ip2region库，为获取客户端IP地理位置提供了强大的解决方案。无论是定制内容、确保地区合规性，还是分析用户人口统计信息，将IP地理位置集成到您的应用程序中都可以显著增强其功能。随时探索该项目，贡献代码，充分发挥IP地理位置在应用程序中的威力。
到此这篇关于SpringBoot实现获取客户端IP地理位置的文章就介绍到这了,更多相关SpringBoot获取地理位置内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
这篇文章主要介绍了SpringBoot配置及使用Schedule过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2020-04-04
ArrayList是一个实现List接口的类,底层是动态类型顺序表,本质也就是数组,动态主要体现在它的扩容机制,下面这篇文章主要给大家介绍了关于Java中ArrayList与顺序表的定义与实现的相关资料,需要的朋友可以参考下2022-07-07
在MyBatis中，自定义映射resultMap可以让你精确控制如何将数据库返回的结果集映射到Java对象上，本文给介绍了Mybatis之自定义映射resultMap,需要的朋友可以参考下2024-03-03
这篇文章主要介绍了spring-boot中的SPI机制实例讲解，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2021-07-07
这篇文章主要介绍了java到底是值传递还是引用传递的相关知识，本文通过几个例子给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下2020-06-06
Spring的@PreAuthorize注解自定义权限校验详解
这篇文章主要介绍了Spring的@PreAuthorize注解自定义权限校验详解,由于项目中,需要对外开放接口,要求做请求头校验,不做其他权限控制,所以准备对开放的接口全部放行,不做登录校验,需要的朋友可以参考下2023-11-11
本篇文章主要介绍了Spring学习之开发环境搭建的详细步骤，具有一定的参考价值，有兴趣的可以了解一下2017-07-07
这篇文章主要给大家分享了分享Java常用开发编辑器工具，文章内容介绍非常详细，具有很大的参考价值，需要的小伙伴可以参考一下，希望对你的工作或学习有一定的帮助2022-03-03
下面小编就为大家带来一篇有关Java常见的误解小结(来看一看)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-05-05
对象进行对象的转换是一个操作重复且繁琐的工作，于是市面上就有许多的对象转换工具来解决这个问题，下面我们就来看看几个比较常用的工具（mapstruct，Spring BeanUtils，Apache BeanUtils）使用方式及其性能2023-04-04
最新评论