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

 更新时间:2024年08月28日 09:10:40   作者:Micro麦可乐  
在我们日常WEB开发工作中,经常会有需要获取客户端地理位置的需求,本文主要介绍了SpringBoot整合ip2region获取客户端IP地理位置信息,具有一定的参考价值,感兴趣的可以了解一下

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>hutool-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.InputStream;

@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.RequestParam;
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", required = 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地址,则默认使用客户端的IP地址

❺ 测试与运行

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

相关文章

  • Springboot hibernate envers使用过程详解

    Springboot hibernate envers使用过程详解

    这篇文章主要介绍了Springboot hibernate envers使用过程详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-06-06
  • SpringMvc MultipartFile实现图片文件上传示例

    SpringMvc MultipartFile实现图片文件上传示例

    本篇文章主要介绍了SpringMvc MultipartFile实现图片文件上传示例,具有一定的参考价值,感兴趣的小伙伴们可以参考一下。
    2017-02-02
  • spring boot配置MySQL数据库连接、Hikari连接池和Mybatis的简单配置方法

    spring boot配置MySQL数据库连接、Hikari连接池和Mybatis的简单配置方法

    这篇文章主要介绍了spring boot配置MySQL数据库连接、Hikari连接池和Mybatis的简单配置方法,需要的朋友可以参考下
    2018-03-03
  • Java实现整数分解质因数的方法示例

    Java实现整数分解质因数的方法示例

    这篇文章主要介绍了Java实现整数分解质因数的方法,结合实力形式分析了质因数分解的原理与实现方法,涉及java数值运算相关操作技巧,需要的朋友可以参考下
    2017-12-12
  • Java实战之王者荣耀的英雄是怎么产生的?

    Java实战之王者荣耀的英雄是怎么产生的?

    这篇文章主要介绍了Java实战之王者荣耀的英雄是怎么产生的?文中有非常详细的代码示例,对正在学习java的小伙伴们有很好地帮助,需要的朋友可以参考下
    2021-05-05
  • LeetCode -- Path Sum III分析及实现方法

    LeetCode -- Path Sum III分析及实现方法

    这篇文章主要介绍了LeetCode -- Path Sum III分析及实现方法的相关资料,希望通过本文能帮助到大家,需要的朋友可以参考下
    2017-10-10
  • java如何获取实体类的属性名和属性值

    java如何获取实体类的属性名和属性值

    这篇文章主要介绍了java如何获取实体类的属性名和属性值问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-11-11
  • JAVA CyclicBarrier 示例源码解析

    JAVA CyclicBarrier 示例源码解析

    CyclicBarrier是一个强大的同步工具,可以帮助我们实现复杂的多线程协同任务,这篇文章主要介绍了JAVA CyclicBarrier 示例源码解析,通过本文,我们深入了解了CyclicBarrier的源码实现,并通过一个简单的示例演示了它的用法,需要的朋友可以参考下
    2023-12-12
  • IDEA创建Java Web项目的超详细图文教学

    IDEA创建Java Web项目的超详细图文教学

    IDEA是程序员们常用的java集成开发环境,也是被公认为最好用的java开发工具,下面这篇文章主要给大家介绍了关于IDEA创建Java Web项目的相关资料,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2022-12-12
  • Netty中最简单的粘包解析方法分享

    Netty中最简单的粘包解析方法分享

    黏包 是指网络上有多条数据发送给服务端, 但是由于某种原因这些数据在被接受的时候进行了重新组合,本文分享了一种最简单的黏包解析方法, 非常适用于初初初级选手
    2023-05-05

最新评论