利用Spring Boot实现客户端IP地理位置获取

228 阅读4分钟

在当今互联的世界中,了解客户端的地理位置对于提供个性化服务和增强用户体验至关重要。无论是根据地区偏好定制内容,还是确保符合本地法规,访问客户端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秒

致谢

该项目的功能要归功于狮子的魂(@lionsoul)的开源贡献,他的无私奉献精神使我们能够轻松地实现这一功能。正如俗话所说,我们都站在巨人的肩膀上。

这个基于Spring Boot的项目,结合强大的ip2region库,为获取客户端IP地理位置提供了强大的解决方案。无论是定制内容、确保地区合规性,还是分析用户人口统计信息,将IP地理位置集成到您的应用程序中都可以显著增强其功能。随时探索该项目,贡献代码,充分发挥IP地理位置在应用程序中的威力。

后续内容文章持续更新中...

近期发布。


关于我

👋🏻你好,我是Debug.c。微信公众号:种颗代码技术树 的维护者,一个跨专业自学Java,对技术保持热爱的bug猿,同样也是在某二线城市打拼四年余的Java Coder。

🏆在掘金、CSDN、公众号我将分享我最近学习的内容、踩过的坑以及自己对技术的理解。

📞如果您对我感兴趣,请联系我。

若有收获,就点个赞吧,喜欢原图请私信我。