SpringBoot实现获取客户端IP地理位置

 更新时间:2023年11月29日 13:59:54   作者:FirstMrRight  
在当今互联的世界中,了解客户端的地理位置对于提供个性化服务和增强用户体验至关重要,使用本文为大家介绍了SpringBoot获取客户端IP地理位置的相关方法,需要的小伙伴可以参考下

在当今互联的世界中,了解客户端的地理位置对于提供个性化服务和增强用户体验至关重要。无论是根据地区偏好定制内容,还是确保符合本地法规,访问客户端IP位置都是一项宝贵的资产。如抖音评论区、用户页都会展示用户的IP属地信息。

在本文中,我们将探讨一个Spring Boot项目,它能够高效地获取客户端IP地址的地理位置,并讨论其应用场景和实现方式。

项目开源地址

home_place

我已开源,点击即可查看完整代码实现。

项目概览

该项目的结构如下:

  • 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获取地理位置内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Spring @async方法如何添加注解实现异步调用

    Spring @async方法如何添加注解实现异步调用

    这篇文章主要介绍了Spring @async方法如何添加注解实现异步调用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-01-01
  • MyBatis框架简介及入门案例详解

    MyBatis框架简介及入门案例详解

    MyBatis是一个优秀的持久层框架,它对jdbc的操作数据库的过程进行封装,使开发者只需要关注SQL本身,而不需要花费精力去处理例如注册驱动、创建connection、创建statement、手动设置参数、结果集检索等jdbc繁杂的过程代码,本文将作为最终篇为大家介绍MyBatis的使用
    2022-08-08
  • IDEA 格式化SQL代码技巧分享

    IDEA 格式化SQL代码技巧分享

    这篇文章主要介绍了IDEA 格式化SQL代码技巧分享,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-02-02
  • Maven和IntelliJ IDEA搭建多模块微服务的实现

    Maven和IntelliJ IDEA搭建多模块微服务的实现

    本文主要介绍了Maven和IntelliJ IDEA搭建多模块微服务的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-05-05
  • log4j2 项目日志组件的实例代码

    log4j2 项目日志组件的实例代码

    下面小编就为大家分享一篇log4j2 项目日志组件的实例代码,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2017-12-12
  • Java Socket编程心跳包创建实例解析

    Java Socket编程心跳包创建实例解析

    这篇文章主要介绍了Java Socket编程心跳包创建实例解析,具有一定借鉴价值,需要的朋友可以参考下
    2017-12-12
  • Java在PDF中替换文字详解及可能遇到的问题

    Java在PDF中替换文字详解及可能遇到的问题

    本文详细介绍了如何使用Java和Spire.PDF for Java库在PDF文档中批量替换文字,包括替换特定文字的所有实例、第一个实例以及使用正则表达式,同时,探讨了可能遇到的问题及其解决方案,需要的朋友可以参考下
    2024-09-09
  • SpringBoot使用jasypt加解密密码的实现方法(二)

    SpringBoot使用jasypt加解密密码的实现方法(二)

    这篇文章主要介绍了SpringBoot使用jasypt加解密密码的实现方法(二),本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-10-10
  • idea启动Tomcat时控制台乱码的解决方法(亲测有效)

    idea启动Tomcat时控制台乱码的解决方法(亲测有效)

    最近在idea中启动tomcat出现控制台乱码问题,尝试了很多方法,最后终于解决了,所以下面这篇文章主要给大家介绍了关于idea启动Tomcat时控制台乱码的解决方法,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2022-07-07
  • Java遍历并删除Map的四种方法对比

    Java遍历并删除Map的四种方法对比

    在Java中,遍历并删除 Map 中的元素有四种常见的方法,每种方法都有其适用场景和优缺点,下面小编就来和大家详细介绍一下这几种方法的具体实现吧
    2024-10-10

最新评论