SpringBoot整合ip2region获取客户端IP地理位置信息

目录

• 1、前言
• 2、IP2Region简介
• 主要特点
• 3、项目初始化
• ❶ 配置依赖
• ❷ 配置数据文件
• ❸ 创建服务类
• ❹ 创建控制器
• ❺ 测试与运行
• 4、优化与扩展
• 5、总结

1、前言

在我们日常WEB开发工作中，经常会有需要获取客户端地理位置的需求，如：发布内容显示城市名、系统统计监控用户访问城市等等，获取客户端IP的地理位置信息有助于提供个性化服务、提高用户体验，以及进行数据分析和安全防护。今天博主就给大家介绍一个高效的IP地理位置库 - ip2region

目前该库拥有16K的Srar，开源地址如下：https://github.com/lionsoul2014/ip2region

2、IP2Region简介

ip2region - 是一个离线IP地址定位库和IP定位数据管理框架，10微秒级别的查询效率，提供了众多主流编程语言的 xdb 数据生成和查询客户端实现。ip2region使用一个预编译的数据库文件，能够以极低的内存和CPU消耗实现高速查询。与基于在线API的IP查询相比，IP2Region的优势在于无需依赖外部服务，响应速度更快

主要特点

IP 数据管理框架

xdb 支持亿级别的 IP 数据段行数，默认的 region 信息都固定了格式：国家|区域|省份|城市|ISP，缺省的地域信息默认是0。

region 信息支持完全自定义，例如：你可以在 region 中追加特定业务需求的数据，例如：GPS信息/国际统一地域信息编码/邮编等。也就是你完全可以使用 ip2region 来管理你自己的 IP 定位数据。

数据去重和压缩

xdb 格式生成程序会自动去重和压缩部分数据，默认的全部 IP 数据，生成的 ip2region.xdb 数据库是11MiB，随着数据的详细度增加数据库的大小也慢慢增大。

极速查询响应

即使是完全基于 xdb 文件的查询，单次查询响应时间在十微秒级别，可通过如下两种方式开启内存加速查询：

1、vIndex 索引缓存 ：使用固定的 512KiB 的内存空间缓存 vector index 数据，减少一次 IO磁盘操作，保持平均查询效率稳定在10-20微秒之间。

2、xdb 整个文件缓存：将整个 xdb 文件全部加载到内存，内存占用等同于 xdb 文件大小，无磁盘 IO 操作，保持微秒级别的查询效率。

3、项目初始化

❶ 配置依赖

创建一个新的 Spring Boot 项目，在我们的 pom.XML 文件中添加 ip2region 的依赖

	<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- ip2region Starter -->
   <dependency>
	    <groupId>org.lionsoul</groupId>
	    <artifactId>ip2region</artifactId>
	    <version>2.7.0</version>
	</dependency>
	<!-- hutool工具类 -->
    <dependency>
        <groupId>cn.hutool</groupId>
        <artifactId>hutoolhttp://www.devze.com-all</artifactId>
        <version>5.8.16</version>
    </dependency>

❷ 配置数据文件

在ip2region项目中的data文件夹中下载ip2region.xdb数据库文件，并将其放置在项目的resources目录下，如图：

❸ 创建服务类

创建一个服务类 IpService，用于查询客户端IP的地理位置。

import cn.hutool.core.io.IoUtil;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import org.lionsoul.ip2region.xdb.Searcher;
import org.springframework.core.io.ClassPathResource;
import org.springframework.stereotype.Service;

import Java.io.IOException;
import java.io.jsInputStream;

@Slf4j
@Service
public class IpService {

    private Searcher searcher;

    public IpService(){
        // 加载IP数据库
        ClassPathResource resource = new ClassPathResource("ip2region/ip2region.xdb");
        try {
            InputStream inputStream = resource.getInputStream();
            searcher =  Searcher.newWithBuffer(IoUtil.readBytes(inputStream));
        } catch (IOException e) {
            log.error("解析ip地址失败,无法创建搜索器: {}", e);
            throw new RuntimeException(e);
        }
    }

    @SneakyThrows
    public String getRegion(String ip) {
        String search = searcher.search(ip);
        return search;
    }
}

在这里，IpService类初始化时加载IP2Region的数据库文件，并提供了一个getRegion方法，用于根据IP查询地理位置信息

❹ 创建控制器

创建一个控制器 IpController，暴露一个API接口，用于获取客户端的IP地理位置信息

import jakarta.servlet.http.HttpServletRequest;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParamhttp://www.devze.com;
import org.springframework.web.bind.annotation.RestController;

/**
 * @Author 李怀明
 * @Date 2024/8/12 11:38 AM
 * @Version 1.0
 */
@RestController
@RequestMapping("/api/ip")
public class IpController {

    @Autowired
    private IpService ipService;

    @GetMapping("/location")
    public String getLocation(@RequestParam(value = "ip", requirpythoned = false) String ip, HttpServletRequest request) {
        if (ip == null || ip.isEmpty()) {
            ip = getIPAddress(request);
        }
        return ipService.getRegion(ip);
    }

    /**
     * IP获取处理 （可以抽离出来成为自己的工具类）
     * @param request
     * @return
     */
    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 "0:0:0:0:0:0:0:1".equals(ipAddress) ? "127.0.0.1" : ipAddress;
    }
}

在这个控制器中，/api/ip/location接口允许用户传入IP地址查询其地理位置。如果没有提供IP地址，则默认使用客户端的javascriptIP地址

❺ 测试与运行

启动Spring Boot应用程序后，可以通过浏览器或Postman访问以下URL来测试：

http://localhost:8080/api/ip/location?ip=124.240.3.206

这个接口将返回IP地址124.240.3.206的地理位置信息。

如果不传入任何IP参数，系统将自动检测并返回客户端IP地址的地理位置

效果如下：

响应内容中包含了国家、省份、城市和运营商等信息

4、优化与扩展

封装返回的查询结果：博主本文主要介绍整合ip2region的简单使用，对于ip查询结果并未进行处理，小伙伴需要根据自己的情况合理进行扩展

自定义IP2Region数据库路径：默认情况下，数据库文件存储在资源目录中。你也可以将其存储在其他目录中，并通过配置文件或环境变量加载路径。

缓存查询结果：为了提高查询效率，特别是在高并发环境中，可以考虑将查询结果缓存。Spring Boot提供了多种缓存机制，如Redis或Guava Cache，可以方便地集成到IpService中。

处理IPv6地址：IP2Region主要支持IPv4地址。对于IPv6地址，可以考虑使用其他支持IPv6的地理位置查询库，或者对IPv4和IPv6地址分别处理。

5、总结

通过整合IP2Region，Spring Boot应用可以快速实现客户端IP地理位置的查询功能。IP2Region的高效和稳定性使得它非常适合在各种场景下使用，如用户行为分析、安全防护和个性化推荐等。

到此这篇关于SpringBoot整合ip2region获取客户端IP地理位置信息的文章就介绍到这了,更多相关SpringBoot获取客户端IP地理位置信息内容请搜索编程客栈(www.devze.com)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程客栈(www.devze.com)！