SpringBoot如何獲取客戶端的IP地址

更新時(shí)間：2024年05月06日 14:51:45 作者：沙漠真有魚

這篇文章主要介紹了SpringBoot如何獲取客戶端的IP地址問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

前言

在Web應(yīng)用程序中，獲取客戶端的IP地址是一項(xiàng)非常常見(jiàn)的需求，例如記錄訪問(wèn)日志、過(guò)濾惡意IP等。

在本文中，我們將介紹如何使用Spring Boot框架獲取客戶端的IP地址。

方法一

使用ServletRequest對(duì)象獲取IP地址

Spring Boot應(yīng)用程序可以使用HttpServletRequest對(duì)象獲取客戶端的IP地址。

在Spring Boot中，可以通過(guò)注入HttpServletRequest作為一個(gè)參數(shù)來(lái)獲取該對(duì)象。

@GetMapping("/getIp")
public String getIp(HttpServletRequest request) {
    String ipAddress = request.getRemoteAddr();
    return "Client IP address: " + ipAddress;
}

上述代碼中，我們通過(guò)調(diào)用 request.getRemoteAddr() 方法獲取客戶端的IP地址。

方法二

使用ServletRequestAttributes對(duì)象獲取IP地址

除了使用HttpServletRequest對(duì)象外，Spring Boot還提供了另一種獲取客戶端IP地址的方法。

這種方法是使用ServletRequestAttributes對(duì)象，在方法中注入該對(duì)象即可。

代碼如下：

@GetMapping("/getIp2")
public String getIp2(ServletRequest request) {
    String ipAddress = ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest().getRemoteAddr();
    return "Client IP address: " + ipAddress;
}

在上面的代碼中，我們通過(guò) RequestContextHolder.currentRequestAttributes()方法獲取當(dāng)前的HttpServletRequest對(duì)象

再通過(guò) getRequest().getRemoteAddr() 方法獲取客戶端的IP地址。

注意事項(xiàng)

雖然以上兩種方法可以獲取客戶端的IP地址，但需要注意以下幾個(gè)問(wèn)題：

如果應(yīng)用程序部署在反向代理服務(wù)器后面，使用上述方法獲取的IP地址可能是反向代理服務(wù)器的IP地址，而不是客戶端真正的IP地址。
有些客戶端可能使用了匿名代理服務(wù)器，例如TOR等，此時(shí)獲取到的IP地址不是客戶端真正的IP地址。

解決方案

使用X-Forwarded-For頭

為了解決上述問(wèn)題，我們可以使用X-Forwarded-For頭。

該頭字段是一個(gè)逗號(hào)分隔的IP地址列表，最左邊的IP地址是客戶端的真實(shí)IP地址。

以下是使用X-Forwarded-For頭獲取客戶端IP地址的示例代碼。

@GetMapping("/getIp3")
public String getIp3(HttpServletRequest request) {
    String 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 || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
        ipAddress = request.getRemoteAddr();
    }
    return "Client IP address: " + ipAddress.split(",")[0];
}

上述代碼中，我們首先使用 request.getHeader("X-Forwarded-For") 方法獲取X-Forwarded-For頭字段的值，如果獲取失敗，則嘗試使用其他頭字段。

最后，我們通過(guò)逗號(hào)對(duì)IP地址進(jìn)行分割，獲取最左邊的IP地址，即客戶端的真實(shí)IP地址。