Spring Boot快速實現 IP地址解析的示例詳解

Posted on by

大傢好！ 我是慕歌，一隻想教你學習 Spring Boot的野生coder！ 歡迎來到慕歌的 Sping boot系列教程，希望通過這個教程帶大傢搭建基礎的 Spring Boot項目，該教程所有知識點均來源於本人的真實開發！

前言

在前一節的學習中，慕歌分享瞭如何構建自己的小型日志用於記錄一些關鍵性的信息，監測用戶的登錄狀態等… 在這一節中慕歌將就上一節中關於ip 的點進行詳細的講解，帶大傢在spring boot 項目中獲取請求的ip與詳細地址，我們的很多網站app 中都已經新增瞭ip 地址顯示，大傢也可以用在自己的開發中，顯得更高級。

引入：

如果使用本地ip 解析的話，我們將會借助ip2region，該項目維護瞭一份較為詳細的本地ip 地址對應表，如果為瞭離線環境的使用，需要導入該項目依賴，並指定版本，不同版本的方法可能存在差異。

<!--    ip庫-->
<dependency>
	<groupId>org.lionsoul</groupId>
	<artifactId>ip2region</artifactId>
	<version>2.6.3</version>
        </dependency>

官方gitee：gitee.com/lionsoul/ip…

開發：

在使用時需要將 xdb 文件下載到工程文件目錄下，使用ip2region即使是完全基於 xdb 文件的查詢，單次查詢響應時間在十微秒級別，可通過如下兩種方式開啟內存加速查詢：

  • vIndex 索引緩存 ：使用固定的 512KiB 的內存空間緩存 vector index 數據，減少一次 IO 磁盤操作，保持平均查詢效率穩定在10-20微秒之間。
  • xdb 整個文件緩存：將整個 xdb 文件全部加載到內存，內存占用等同於 xdb 文件大小，無磁盤 IO 操作，保持微秒級別的查詢效率。
/**
 * ip查詢
 */
@Slf4j
public class IPUtil {
    private static final String UNKNOWN = "unknown";
    protected IPUtil(){ }
    /**
     * 獲取 IP地址
     * 使用 Nginx等反向代理軟件， 則不能通過 request.getRemoteAddr()獲取 IP地址
     * 如果使用瞭多級反向代理的話，X-Forwarded-For的值並不止一個，而是一串IP地址，
     * X-Forwarded-For中第一個非 unknown的有效IP字符串，則為真實IP地址
     */
    public static String getIpAddr(HttpServletRequest request) {
        String ip = request.getHeader("x-forwarded-for");
        if (ip == null || ip.length() == 0 || UNKNOWN.equalsIgnoreCase(ip)) {
            ip = request.getHeader("Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || UNKNOWN.equalsIgnoreCase(ip)) {
            ip = request.getHeader("WL-Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || UNKNOWN.equalsIgnoreCase(ip)) {
            ip = request.getRemoteAddr();
        }
        return "0:0:0:0:0:0:0:1".equals(ip) ? "127.0.0.1" : ip;
    }
    public static  String getAddr(String ip){
        String dbPath = "src/main/resources/ip2region/ip2region.xdb";
        // 1、從 dbPath 加載整個 xdb 到內存。
        byte[] cBuff;
        try {
            cBuff = Searcher.loadContentFromFile(dbPath);
        } catch (Exception e) {
            log.info("failed to load content from `%s`: %s\n", dbPath, e);
            return null;
        }
        // 2、使用上述的 cBuff 創建一個完全基於內存的查詢對象。
        Searcher searcher;
        try {
            searcher = Searcher.newWithBuffer(cBuff);
        } catch (Exception e) {
           log.info("failed to create content cached searcher: %s\n", e);
            return null;
        }
        // 3、查詢
        try {
            String region = searcher.searchByStr(ip);
            return region;
        } catch (Exception e) {
            log.info("failed to search(%s): %s\n", ip, e);
        }
        return null;
    }

這裡我們將ip 解析封裝成一個工具類，包含獲取IP和ip 地址解析兩個方法，ip 的解析可以在請求中獲取。獲取到ip後，需要根據ip ，在xdb 中查找對應的IP地址的解析，由於是本地數據庫可能存在一定的缺失，部分ip 存在無法解析的情況。

在線解析:

如果想要獲取更加全面的ip 地址信息，可使用在線數據庫，這裡提供的是 whois.pconline.com 的IP解析，該IP解析在我的使用過程中表現非常流暢，而且隻有少數的ip 存在無法解析的情況。

@Slf4j
public class AddressUtils {
    // IP地址查詢
    public static final String IP_URL = "http://whois.pconline.com.cn/ipJson.jsp";

    // 未知地址
    public static final String UNKNOWN = "XX XX";

    public static String getRealAddressByIP(String ip) {
        String address = UNKNOWN;
        // 內網不查詢
        if (IpUtils.internalIp(ip)) {
            return "內網IP";
        }
        if (true) {
            try {
                String rspStr = sendGet(IP_URL, "ip=" + ip + "&json=true" ,"GBK");
                if (StrUtil.isEmpty(rspStr)) {
                    log.error("獲取地理位置異常 {}" , ip);
                    return UNKNOWN;
                }
                JSONObject obj = JSONObject.parseObject(rspStr);
                String region = obj.getString("pro");
                String city = obj.getString("city");
                return String.format("%s %s" , region, city);
            } catch (Exception e) {
                log.error("獲取地理位置異常 {}" , ip);
            }
        }
        return address;
    }
    public static String sendGet(String url, String param, String contentType) {
        StringBuilder result = new StringBuilder();
        BufferedReader in = null;
        try {
            String urlNameString = url + "?" + param;
            log.info("sendGet - {}" , urlNameString);
            URL realUrl = new URL(urlNameString);
            URLConnection connection = realUrl.openConnection();
            connection.setRequestProperty("accept" , "*/*");
            connection.setRequestProperty("connection" , "Keep-Alive");
            connection.setRequestProperty("user-agent" , "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1;SV1)");
            connection.connect();
            in = new BufferedReader(new InputStreamReader(connection.getInputStream(), contentType));
            String line;
            while ((line = in.readLine()) != null) {
                result.append(line);
            }
            log.info("recv - {}" , result);
        } catch (ConnectException e) {
            log.error("調用HttpUtils.sendGet ConnectException, url=" + url + ",param=" + param, e);
        } catch (SocketTimeoutException e) {
            log.error("調用HttpUtils.sendGet SocketTimeoutException, url=" + url + ",param=" + param, e);
        } catch (IOException e) {
            log.error("調用HttpUtils.sendGet IOException, url=" + url + ",param=" + param, e);
        } catch (Exception e) {
            log.error("調用HttpsUtil.sendGet Exception, url=" + url + ",param=" + param, e);
        } finally {
            try {
                if (in != null) {
                    in.close();
                }
            } catch (Exception ex) {
                log.error("調用in.close Exception, url=" + url + ",param=" + param, ex);
            }
        }
        return result.toString();
    }
}

場景：

那麼在開發的什麼流程獲取ip 地址是比較合適的，這裡就要用到我們的攔截器瞭。攔截進入服務的每個請求，進行前置操作，在進入時就完成請求頭的解析，ip 獲取以及ip 地址解析，這樣在後續流程的全環節，都可以復用ip 地址等信息。

/**
 * 對ip 進行限制，防止IP大量請求
 */
@Slf4j
@Configuration
public class IpUrlLimitInterceptor implements HandlerInterceptor{

    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) {

        //更新全局變量
        Constant.IP = IPUtil.getIpAddr(httpServletRequest);
        Constant.IP_ADDR = AddressUtils.getRealAddressByIP(Constant.IP);
        Constant.URL = httpServletRequest.getRequestURI();
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) {
        //通過本地獲取
//        獲得ip
//        String ip = IPUtil.getIpAddr(httpServletRequest);
        //解析具體地址
//        String addr = IPUtil.getAddr(ip);

        //通過在線庫獲取
//        String ip = IpUtils.getIpAddr(httpServletRequest);
//        String ipaddr = AddressUtils.getRealAddressByIP(ipAddr);
//        log.info("IP >> {},Address >> {}",ip,ipaddr);
    }

    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) {

    }
}
如果想要執行我們的ip 解析攔截器，需要在spring boot的視圖層進行攔截才會觸發我們的攔截器。
@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Autowired
    IpUrlLimitInterceptor ipUrlLimitInterceptor;
	
	    //執行ip攔截器
    @Override
    public void addInterceptors(InterceptorRegistry registry){
        registry.addInterceptor(ipUrlLimitInterceptor)
                // 攔截所有請求
                .addPathPatterns("/**");
    }
}
通過這樣的一套流程下來，我們就能實現對每一個請求進行ip 獲取、ip解析，為每個請求帶上具體ip地址的小尾巴。

到此這篇關於Spring Boot快速實現 IP地址解析的文章就介紹到這瞭,更多相關Spring Boot IP地址內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：