Spring Boot獲取請求IP的多個方面闡述

在web應用開發中，獲取請求的IP地址是非常常見的需求。在Spring Boot中，同樣也提供了多種獲取請求IP的方式。本文將從多個方面對Spring Boot獲取請求IP進行詳細的闡述。

一、HttpServletRequest

Spring Boot中獲取請求IP最常見的方式就是通過HttpServletRequest對象來獲取IP地址。在HttpServletRequest對象中，有一個getRemoteAddr()方法可以獲取請求的IP地址，示例代碼如下：

@GetMapping("/")
public String index(HttpServletRequest request) {
    String remoteAddr = request.getRemoteAddr();
    // do something with remoteAddr
    return "index";
}

這種方式簡單直接，但是在使用代理伺服器等網路代理技術時，可能無法正確獲取真實的客戶端IP地址。此外，在一些特殊場景下（如通過TCP連接獲取HTTP請求的情況下），此方式也可能無法正確獲取IP地址。

二、X-Forwarded-For

在遇到網路代理的情況下，如果直接使用HttpServletRequest中的getRemoteAddr()方法獲取IP地址，可能會獲取到網路代理的IP地址，而無法獲取真實的客戶端IP地址。這時可以使用X-Forwarded-For頭部來獲取客戶端真實IP地址。該頭部記錄了請求從客戶端開始，經過每個代理伺服器的IP地址列表，示例代碼如下：

@GetMapping("/")
public String index(HttpServletRequest request) {
    String xForwardedForHeader = request.getHeader("X-Forwarded-For");
    String[] ipAddresses = xForwardedForHeader.split(",");
    String firstIpAddress = ipAddresses[0].trim();
    // do something with firstIpAddress
    return "index";
}

注意：X-Forwarded-For是一個可偽造的頭部，因此需要進行安全防範。

三、使用Spring AOP統一處理請求IP

可以通過Spring AOP的方式，在請求進入Controller之前，統一對請求的IP地址進行處理，並將處理後的IP地址傳遞給Controller。示例代碼如下：

@Aspect
@Component
public class IpAspect {

    @Before("execution(* com.example.controller..*(..)) && args(request,..)")
    public void beforeController(JoinPoint joinPoint, HttpServletRequest request) throws Throwable {
        String ipAddress = ... // 獲取IP地址的代碼
        IpHolder.set(ipAddress); // 將IP地址設置到線程變數中
    }

    @AfterReturning(returning = "result", pointcut = "execution(* com.example.controller..*(..))")
    public void afterController(Object result) throws Throwable {
        IpHolder.remove(); // 清除線程變數
    }

}

public class IpHolder {

    private static final ThreadLocal THREAD_LOCAL_IP = new ThreadLocal();

    public static void set(String ip) {
        THREAD_LOCAL_IP.set(ip);
    }

    public static String get() {
        return THREAD_LOCAL_IP.get();
    }

    public static void remove() {
        THREAD_LOCAL_IP.remove();
    }

}

@RestController
public class ExampleController {

    @GetMapping("/")
    public String index() {
        String ipAddress = IpHolder.get();
        // do something with ipAddress
        return "index";
    }

}

使用Spring AOP統一處理請求IP的好處是可以將處理過程放到一個地方集中管理，便於統一修改、優化和監控。

四、使用第三方庫

除了Spring Boot自帶的HttpServletRequest對象外，還有一些第三方庫可以用來獲取請求IP地址。例如：

• spring-boot-remote-address
• addressing
• http-requests-utils

使用第三方庫的好處是可以避免重複造輪子，簡化開發流程。但是需要注意第三方庫的質量和安全性，並進行必要的測試和驗證。

總結

本文從HttpServletRequest、X-Forwarded-For、Spring AOP和第三方庫等多個方面對Spring Boot獲取請求IP進行了詳細的闡述。在具體開發中，可以根據實際需求選擇合適的方式。