springboot實現獲取客戶端IP地址的示例代碼

更新時間：2024年11月18日 09:38:28 作者：這個名字應該沒人用吧

本文介紹了在SpringBoot中獲取客戶端IP地址的幾種方法,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧

引言

在Web開發(fā)中，獲取客戶端的IP地址是一項常見需求，無論是用于日志記錄、安全策略實施還是個性化服務。在Spring Boot應用程序中，有多種方法可以實現這一功能。本文將介紹在Spring Boot中如何獲取請求頭和客戶端IP地址的不同方法。

在Controller組件中

在Spring Boot的Controller組件中，可以通過自動注入HttpServletRequest對象來獲取客戶端的IP地址。

直接通過HttpServletRequest獲取

最直接的方法是使用HttpServletRequest對象的getRemoteAddr()方法來獲取IP地址。

@GetMapping
public String getIpAddress(HttpServletRequest request) {
    String ip = request.getRemoteAddr();
    return ip;
}

這種方法是最簡單的，但是如果應用部署在代理服務器，就無法獲取真實的客戶端IP。

使用X-Forwarded-For

如果應用部署在代理服務器上，可以通過檢查X-Forwarded-For請求頭來獲取真實的客戶端IP地址。

@GetMapping
public 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.getRemoteAddr();
    }
    return ipAddress.split(",")[0];
}

X-Forwarded-For頭可以包含一個或多個IP地址，第一個通常是客戶端的真實IP。

在非Controller組件中

在非Controller組件中，可以通過RequestContextHolder獲取當前請求的HttpServletRequest對象。

使用RequestContextHolder

public String getIpAddress() {
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        // 上面兩個獲取Ip的邏輯都可以
    }

這種方法可以在任何Spring管理的Bean中使用，提供了一種靈活的方式來獲取客戶端IP地址。