SpringBoot整合Ip2region獲取IP地址和定位的詳細過程

更新時間：2023年06月12日 09:54:05 作者：曉風殘月Lx

ip2region v2.0 - 是一個離線IP地址定位庫和IP定位數(shù)據(jù)管理框架，10微秒級別的查詢效率，提供了眾多主流編程語言的 xdb 數(shù)據(jù)生成和查詢客戶端實現(xiàn) ，這篇文章主要介紹了SpringBoot整合Ip2region獲取IP地址和定位,需要的朋友可以參考下

1.Ip2region的介紹

1.1.Ip2region 是什么

ip2region v2.0 - 是一個離線IP地址定位庫和IP定位數(shù)據(jù)管理框架，10微秒級別的查詢效率，提供了眾多主流編程語言的 xdb 數(shù)據(jù)生成和查詢客戶端實現(xiàn) 。

1.2.Ip2region 特性

1.2.1 標準化的數(shù)據(jù)格式

每個 ip 數(shù)據(jù)段的 region 信息都固定了格式：國家|區(qū)域|省份|城市|ISP，只有中國的數(shù)據(jù)絕大部分精確到了城市，其他國家部分數(shù)據(jù)只能定位到國家，后前的選項全部是0。

1.2.2.數(shù)據(jù)去重和壓縮

xdb 格式生成程序會自動去重和壓縮部分數(shù)據(jù)，默認的全部 IP 數(shù)據(jù)，生成的 ip2region.xdb 數(shù)據(jù)庫是 11MiB，隨著數(shù)據(jù)的詳細度增加數(shù)據(jù)庫的大小也慢慢增大。

1.2.3.極速查詢響應

即使是完全基于 xdb 文件的查詢，單次查詢響應時間在十微秒級別，可通過如下兩種方式開啟內(nèi)存加速查詢：

vIndex 索引緩存：使用固定的 512KiB 的內(nèi)存空間緩存 vector index 數(shù)據(jù)，減少一次 IO 磁盤操作，保持平均查詢效率穩(wěn)定在10-20微秒之間。
xdb 整個文件緩存：將整個 xdb 文件全部加載到內(nèi)存，內(nèi)存占用等同于 xdb 文件大小，無磁盤 IO 操作，保持微秒級別的查詢效率。

1.2.4.IP 數(shù)據(jù)管理框架

v2.0 格式的 xdb 支持億級別的 IP 數(shù)據(jù)段行數(shù)，region 信息也可以完全自定義，例如：你可以在 region 中追加特定業(yè)務需求的數(shù)據(jù)，例如：GPS信息/國際統(tǒng)一地域信息編碼/郵編等。也就是你完全可以使用 ip2region 來管理你自己的 IP 定位數(shù)據(jù)。

2.Java方式

2.1.下載ip2region.xdb

獅子的魂 / ip2region
下載完后放到工程的resources目錄下

2.2.maven倉庫

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

2.3.代碼

import eu.bitwalker.useragentutils.UserAgent;
import org.apache.commons.lang3.StringUtils;
import org.lionsoul.ip2region.xdb.Searcher;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.FileCopyUtils;
import javax.servlet.http.HttpServletRequest;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.HashMap;
import java.util.Map;
/**
 * @author 曉風殘月Lx
 * @date 2023/4/11 19:25
 */
public class IpUtils {
    private static final Logger logger = LoggerFactory.getLogger(IpUtils.class);
    private final static String localIp = "127.0.0.1";
    private static Searcher searcher = null;
    /**
     *   在服務啟動時加載 ip2region.db 到內(nèi)存中
     *   解決打包jar后找不到 ip2region.db 的問題
     */
    static {
        try {
            InputStream ris = IpUtils.class.getResourceAsStream("/ip2region/ip2region.xdb");
            byte[] dbBinStr = FileCopyUtils.copyToByteArray(ris);
            searcher = Searcher.newWithBuffer(dbBinStr);
            //注意：不能使用文件類型，打成jar包后，會找不到文件
            logger.debug("緩存成功！?。?！");
        } catch (IOException e) {
            logger.error("解析ip地址失敗,無法創(chuàng)建搜索器: {}", e);
            throw new RuntimeException(e);
        }
    }
    /**
     * 獲取用戶真實IP地址，不使用request.getRemoteAddr();的原因是有可能用戶使用了代理軟件方式避免真實IP地址,
     * 參考文章： http://developer.51cto.com/art/201111/305181.htm
     *
     * 可是，如果通過了多級反向代理的話，X-Forwarded-For的值并不止一個，而是一串IP值，究竟哪個才是真正的用戶端的真實IP呢？
     * 答案是取X-Forwarded-For中第一個非unknown的有效IP字符串。
     *
     * 如：X-Forwarded-For：192.168.1.110, 192.168.1.120, 192.168.1.130,
     * 192.168.1.100
     *
     * 用戶真實IP為： 192.168.1.110
     *
     * @param request
     * @return
     */
    public static String getIp(HttpServletRequest request) {
        String ipAddress;
        try {
            // 以下兩個獲取在k8s中，將真實的客戶端IP，放到了x-Original-Forwarded-For。而將WAF的回源地址放到了 x-Forwarded-For了。
            ipAddress = request.getHeader("X-Original-Forwarded-For");
            if (ipAddress == null || "unknown".equalsIgnoreCase(ipAddress)) {
                ipAddress = request.getHeader("X-Forwarded-For");
            }
            //獲取nginx等代理的ip
            if (ipAddress == null || "unknown".equalsIgnoreCase(ipAddress)) {
                ipAddress = request.getHeader("x-forwarded-for");
            }
            if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
                ipAddress = request.getHeader("Proxy-Client-IP");
            }
            if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
                ipAddress = request.getHeader("WL-Proxy-Client-IP");
            }
            if (ipAddress == null || "unknown".equalsIgnoreCase(ipAddress)) {
                ipAddress = request.getHeader("HTTP_CLIENT_IP");
            }
            if (ipAddress == null || "unknown".equalsIgnoreCase(ipAddress)) {
                ipAddress = request.getHeader("HTTP_X_FORWARDED_FOR");
            }
            // 2.如果沒有轉(zhuǎn)發(fā)的ip，則取當前通信的請求端的ip(兼容k8s集群獲取ip)
            if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
                ipAddress = request.getRemoteAddr();
                // 如果是127.0.0.1，則取本地真實ip
                if (localIp.equals(ipAddress)) {
                    // 根據(jù)網(wǎng)卡取本機配置的IP
                    InetAddress inet = null;
                    try {
                        inet = InetAddress.getLocalHost();
                        ipAddress = inet.getHostAddress();
                    } catch (UnknownHostException e) {
                        e.printStackTrace();
                    }
                }
            }
            // 對于通過多個代理的情況，第一個IP為客戶端真實IP,多個IP按照','分割
            if (ipAddress != null && ipAddress.length() > 15) {
                // = 15
                if (ipAddress.indexOf(",") > 0) {
                    ipAddress = ipAddress.substring(0, ipAddress.indexOf(","));
                }
            }
        } catch (Exception e) {
            logger.error("解析請求IP失敗", e);
            ipAddress = "";
        }
        return "0:0:0:0:0:0:0:1".equals(ipAddress) ? localIp : ipAddress;
    }
    /**
     * 獲取訪問設備
     * @param request
     * @return
     */
    public static UserAgent getUserAgent(HttpServletRequest request) {
        return UserAgent.parseUserAgentString(request.getHeader("User-Agent"));
    }
    /**
     * 根據(jù)ip獲取 城市信息
     * @param ipAddress
     * @return
     */
    public static String getCityInfo(String ipAddress) {
        String cityInfo = null;
        try {
            return searcher.search(ipAddress);
        } catch (Exception e) {
            logger.error("搜索:{} 失敗: {}",ipAddress, e);
        }
        return null;
    }
    /**
     * 根據(jù)ip2region解析ip地址
     * @param ip ip地址
     * @return 解析后的ip地址信息
     */
    public static String getIp2region(String ip)  {
        if(searcher == null){
            logger.error("Error: DbSearcher is null");
            return null;
        }
        try {
            String ipInfo = searcher.search(ip);
            if (!StringUtils.isEmpty(ipInfo)) {
                ipInfo = ipInfo.replace("|0", "");
                ipInfo = ipInfo.replace("0|", "");
            }
            return ipInfo;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }
    /**
     * 獲取IP地址
     *
     * @return 本地IP地址
     */
    public static String getHostIp(){
        try{
            return InetAddress.getLocalHost().getHostAddress();
        }catch (UnknownHostException e){
        }
        return localIp;
    }
    /**
     * 獲取主機名
     *
     * @return 本地主機名
     */
    public static String getHostName(){
        try{
            return InetAddress.getLocalHost().getHostName();
        } catch (UnknownHostException e) {
        }
        return "未知";
    }
}

測試類

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
class XfcyBlogApplicationTests {
    @Test
    void ipTest() {
        String cityInfo = IpUtils.getCityInfo("120.36.213.176");
        String cityInfo1 = IpUtils.getCityInfo("10.6.152.27");
        System.out.println(cityInfo);
        System.out.println(cityInfo1);
    }
}

第一個IP是網(wǎng)上找的IP進行測試
第二個IP是自己本機IP進行測試