SpringBoot集成IP2Region實現(xiàn)獲取IP地域信息

更新時間：2026年03月11日 08:38:44 作者：VipSoft

IP2Region是一個高效的離線IP地域查詢庫,這篇文章主要為大家詳細介紹了SpringBoot如何集成IP2Region實現(xiàn)獲取IP地域信息,感興趣的小伙伴可以了解下

方案	優(yōu)點	缺點	適用場景
IP2Region	離線查詢，速度快，免費	數(shù)據(jù)更新需要下載新庫	高并發(fā)，離線環(huán)境
MaxMind GeoIP2	數(shù)據(jù)準確，功能豐富	商業(yè)版收費，需要更新數(shù)據(jù)庫	商業(yè)應用，需要精確數(shù)據(jù)
在線API服務	無需維護數(shù)據(jù)庫，使用簡單	依賴網(wǎng)絡，有速率限制	低頻次查詢，簡單應用

IP2Region是一個高效的離線IP地域查詢庫，具有以下特點：

極致性能：微秒級的查詢速度，單核可達1000萬次/天
零依賴：純Java實現(xiàn)，無需第三方依賴
離線查詢：不依賴網(wǎng)絡請求，數(shù)據(jù)存儲在本地
簡單易用：API設計簡潔，上手快速

一、添加 Maven 依賴

<dependency>
    <groupId>org.lionsoul</groupId>
    <artifactId>ip2region</artifactId>
    <version>3.3.6</version>
</dependency>

該依賴包含了 IP2Region 查詢庫，使得你能夠在 Spring Boot 項目中使用 Searcher 類進行高效的 IP 地址查詢。

二、配置數(shù)據(jù)庫文件路徑與版本

在 Spring Boot 的 application.properties 或 application.yml 中配置 IP2Region 數(shù)據(jù)庫文件的路徑和 IP 版本（IPv4 或 IPv6）。

application.yml

ip2region:
  db-path: ip2region_v4.xdb  # 可根據(jù)需要替換為 IPv6 文件路徑
  version: IPv4

ip2region_v4.xdb 是 IP2Region 的數(shù)據(jù)庫文件，你需要下載并將其放置在 src/main/resources 目錄下，確保 Spring Boot 能夠通過 classpath 讀取。

三、創(chuàng)建 IP 查詢服務

import org.lionsoul.ip2region.xdb.Searcher;
import org.lionsoul.ip2region.xdb.Version;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.stereotype.Service;

import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.concurrent.TimeUnit;

import javax.annotation.PostConstruct;


@Service
public class IpService {

    private Searcher searcher;

    // 從配置文件中加載數(shù)據(jù)庫路徑和版本
    @Value("${ip2region.db-path}")
    private String dbPath;

    @Value("${ip2region.version}")
    private String version;

    // 服務啟動時初始化 Searcher
    @PostConstruct
    public void init() throws IOException {
        // 根據(jù)配置選擇 IP 版本
        Version ipVersion = version.equalsIgnoreCase("IPv4") ? Version.IPv4 : Version.IPv6;

        try {
            // 使用 ClassPathResource 加載類路徑中的數(shù)據(jù)庫文件
            Resource resource = new ClassPathResource(dbPath);
            if (!resource.exists()) {
                throw new IOException("Unable to find " + dbPath + " in classpath");
            }

            // 獲取文件的輸入流
            InputStream inputStream = resource.getInputStream();

            // 將 InputStream 保存到臨時文件
            Path tempFile = Files.createTempFile("ip2region", ".xdb");
            try (OutputStream out = new FileOutputStream(tempFile.toFile())) {
                byte[] buffer = new byte[1024];
                int bytesRead;
                while ((bytesRead = inputStream.read(buffer)) != -1) {
                    out.write(buffer, 0, bytesRead);
                }
            }

            // 使用臨時文件創(chuàng)建 Searcher 對象
            searcher = Searcher.newWithFileOnly(ipVersion, tempFile.toString());

        } catch (IOException e) {
            System.out.printf("failed to create searcher with `%s`: %s\n", dbPath, e);
            throw new IOException("Failed to initialize IP2Region searcher", e);
        }
    }

    // 查詢 IP 地理位置
    public String getCityInfo(String ip) {
        try {
            long sTime = System.nanoTime();
            String region = searcher.search(ip);  // 查詢 IP 地址
            long cost = TimeUnit.NANOSECONDS.toMicros(System.nanoTime() - sTime);
            System.out.printf("{region: %s, ioCount: %d, took: %d μs}\n", region, searcher.getIOCount(), cost);
            return region;
        } catch (Exception e) {
            System.out.printf("failed to search(%s): %s\n", ip, e);
            return null;
        }
    }

    // 在 Spring Boot 中使用 @PreDestroy 優(yōu)雅地關(guān)閉 searcher
    public void close() throws IOException {
        if (searcher != null) {
            searcher.close();
        }
    }
}

@PostConstruct：這是 Spring 提供的生命周期注解，表示方法將在 Bean 初始化完成后執(zhí)行。我們在這里初始化 Searcher 實例，基于配置的數(shù)據(jù)庫文件路徑和 IP 版本。
getCityInfo：此方法用于查詢 IP 地址的地理位置信息。它會返回一個字符串，包含 IP 地址的地理位置（如國家、省份、城市等）。

四、創(chuàng)建控制器提供查詢 API

為了讓外部可以查詢 IP 地址，我們創(chuàng)建一個 REST 控制器類 IpController，通過 HTTP GET 請求提供查詢接口。

IpController.java

package com.example.ip2region.controller;

import com.example.ip2region.service.IpService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class IpController {

    private final IpService ipService;

    @Autowired
    public IpController(IpService ipService) {
        this.ipService = ipService;
    }

    // 查詢 IP 地址的地理信息
    @GetMapping("/get-ip-location")
    public String getIpLocation(@RequestParam String ip) {
        return ipService.getCityInfo(ip);
    }
}

解析：

@GetMapping("/get-ip-location")：此注解將 HTTP GET 請求映射到 getIpLocation 方法。通過 @RequestParam 獲取 IP 地址參數(shù)，并查詢該 IP 的地理位置。

該控制器提供了一個查詢接口，可以通過 http://localhost:8080/get-ip-location?ip=1.2.3.4 查詢 IP 地址 1.2.3.4 的地理位置。

五、優(yōu)化：使用緩存來加速查詢

IP2Region 支持使用緩存來優(yōu)化查詢性能。你可以通過預加載 VectorIndex 或整個 XDB 文件的內(nèi)容，將其存儲在內(nèi)存中，從而減少文件 IO 操作，提升查詢速度。

package com.donglin.service;

import jakarta.annotation.PostConstruct;
import org.lionsoul.ip2region.xdb.Searcher;
import org.lionsoul.ip2region.xdb.Version;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.stereotype.Service;

import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.concurrent.TimeUnit;

@Service
public class IpService {

    private Searcher searcher;

    @Value("${ip2region.db-path}")
    private String dbPath;

    @Value("${ip2region.version}")
    private String version;

    @PostConstruct
    public void init() throws IOException {
        Version ipVersion = version.equalsIgnoreCase("IPv4") ? Version.IPv4 : Version.IPv6;

        try {
            // ? 1. 從 classpath 讀取 XDB 文件（無論打包與否都兼容）
            Resource resource = new ClassPathResource(dbPath);
            if (!resource.exists()) {
                throw new IOException("無法在 classpath 中找到文件：" + dbPath);
            }

            // ? 2. 先把 XDB 文件寫入臨時文件（VectorIndex 只能基于文件加載）
            Path tempFile = Files.createTempFile("ip2region", ".xdb");
            try (InputStream is = resource.getInputStream()) {
                Files.copy(is, tempFile, java.nio.file.StandardCopyOption.REPLACE_EXISTING);
            }

            // ? 3. 預加載 VectorIndex（大幅減少 I/O）
            byte[] vIndex;
            try {
                vIndex = Searcher.loadVectorIndexFromFile(tempFile.toString());
                System.out.println("VectorIndex loaded, length = " + vIndex.length);
            } catch (Exception e) {
                throw new IOException("加載 VectorIndex 失敗: " + e.getMessage(), e);
            }

            // ? 4. 創(chuàng)建使用 VectorIndex 緩存的 Searcher
            searcher = Searcher.newWithVectorIndex(ipVersion, tempFile.toString(), vIndex);
            System.out.println("IP2Region searcher initialized with vector index cache.");

        } catch (IOException e) {
            System.err.printf("failed to create searcher with `%s`: %s%n", dbPath, e);
            throw new IOException("Failed to initialize IP2Region searcher", e);
        }
    }

    // 查詢 IP 地理位置
    public String getCityInfo(String ip) {
        try {
            long start = System.nanoTime();
            String region = searcher.search(ip);
            long cost = TimeUnit.NANOSECONDS.toMicros(System.nanoTime() - start);
            System.out.printf("{region: %s, ioCount: %d, took: %d μs}%n",
                    region, searcher.getIOCount(), cost);
            return region;
        } catch (Exception e) {
            System.err.printf("failed to search(%s): %s%n", ip, e);
            return null;
        }
    }

    public void close() throws IOException {
        if (searcher != null) {
            searcher.close();
        }
    }
}

通過將 ip2region 集成到 Spring Boot 中，我們可以非常高效地查詢 IP 地址的地理位置信息。通過預加載緩存（如 VectorIndex 或整個 XDB 文件），我們可以進一步提高查詢性能，減少 IO 壓力，尤其是在高并發(fā)場景下。