springboot实现获取客户端IP地址

引言

        在Web开发中，获取客户端的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地址。

误区

        Spring Boot中的bean，那不是可以使用@Autowired 注解自动注入吗？

        直接使用 @Autowired 注解通常不能自动注入 HttpServletRequest 对象，因为 HttpServletRequest 是与单个 HTTP 请求关联的，它的作用域是请求级别的，而不是整个应用程序。

---

总结

        本文介绍了在Spring Boot中获取客户端IP地址的几种方法，包括在Controller中直接获取、使用X-Forwarded-For头、以及在非Controller组件中通过RequestContextHolder获取。在实际应用中，可能需要根据具体情况选择最合适的方法。