前言
在互联网软件开发领域，我们常常会遇到需要获取客户端真实 IP 地址的场景。对于使用 Spring Boot 3 进行开发的我们而言，这一需求尤为常见。无论是出于安全监测、用户行为分析，还是个性化服务的目的，准确获取客户端的真实 IP 地址都至关重要。今天，就让我们深入探讨在 Spring Boot 3 中如何获取真实的 IP 地址。
为什么获取真实 IP 地址如此重要
在正式探讨技术实现之前，我们先来思考一下为什么获取真实 IP 地址在开发中意义重大。
1. 安全监测
在当今网络攻击手段层出不穷的环境下，准确识别请求的来源 IP 地址是防范恶意攻击的重要手段。通过分析 IP 地址，我们可以识别出异常的请求模式，比如短时间内大量来自同一 IP 的请求，这可能是恶意的爬虫或者 DDoS 攻击的前奏。借助真实 IP 地址，我们能够及时采取措施，如封禁恶意 IP，保障应用的安全稳定运行。
2. 用户行为分析
对于许多应用来说，了解用户的地域分布、使用习惯等信息对于产品优化和市场策略制定具有重要意义。而 IP 地址可以作为推断用户地理位置的重要依据。通过收集和分析不同 IP 地址对应的用户行为数据，我们可以洞察不同地区用户对应用功能的偏好，从而针对性地进行功能优化和推广活动。
3. 个性化服务
在追求极致用户体验的时代，个性化服务成为吸引用户的关键。根据用户的地理位置提供个性化的内容推荐、服务设置等，可以极大提升用户对应用的满意度和粘性。例如，为用户推荐其所在地区的热门活动、天气信息等。而这一切的前提，就是能够准确获取用户的真实 IP 地址。
面临的挑战：代理和负载均衡带来的困扰
在实际的网络环境中，事情往往不会那么简单。当应用部署在生产环境中时，常常会面临代理服务器和负载均衡器的介入。这就给我们获取真实 IP 地址带来了不小的挑战。
1. 代理服务器的影响
代理服务器位于客户端和应用服务器之间，它充当了中间人的角色。客户端的请求先发送到代理服务器，然后由代理服务器转发给应用服务器。在这种情况下，应用服务器直接获取到的 IP 地址是代理服务器的 IP，而非客户端的真实 IP。更为复杂的是，代理服务器可能不止一层，存在多级代理的情况。这就使得我们需要通过特定的方式，从请求头中提取出被层层代理隐藏起来的客户端真实 IP。
2. 负载均衡器的作用与问题
负载均衡器的主要作用是将大量的客户端请求均衡地分配到多个应用服务器实例上，以提高应用的处理能力和可用性。然而，这也导致了应用服务器获取到的 IP 地址通常是负载均衡器的 IP，而非客户端真实 IP。与代理服务器类似，负载均衡器也会对请求进行转发，我们需要从转发的请求中找到获取真实 IP 的方法。
Spring Boot 3 中获取真实 IP 地址的方法
了解了获取真实 IP 地址的重要性以及面临的挑战后，接下来我们就进入正题，看看在 Spring Boot 3 中如何实现这一关键功能。
使用 HttpServletRequest 对象获取 IP 地址
在 Spring Boot 3 的控制器中，我们可以通过自动注入 HttpServletRequest 对象来获取请求的相关信息，其中就包括 IP 地址。
import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import javax.servlet.http.HttpServletRequest; @RequestMapping("/api") @RestController public class IpController { @GetMapping("/getIp") public String getClientIp(HttpServletRequest request) { String ip = getIpAddress(request); return "Client IP Address: " + ip; } private String getIpAddress(HttpServletRequest request) { String ip = request.getHeader("X-Forwarded-For"); if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) { ip = request.getHeader("X-Real-IP"); } if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) { ip = request.getRemoteAddr(); } return ip; } }在这段代码中，我们首先尝试从请求头中的 “X-Forwarded-For” 字段获取 IP 地址。“X-Forwarded-For” 头字段通常用于记录经过代理服务器的请求的原始客户端 IP 地址，多个代理的情况下，该字段会包含多个 IP 地址，以逗号分隔。如果 “X-Forwarded-For” 字段为空或者值为 “unknown”，我们接着尝试从 “X-Real-IP” 头字段获取 IP 地址，“X-Real-IP” 头字段也常用于传递客户端的真实 IP 地址。如果这两个头字段都无法获取到有效 IP 地址，我们就使用request.getRemoteAddr()方法获取 IP 地址，该方法获取的是直接连接到服务器的客户端 IP 地址，在没有代理的情况下，这就是客户端的真实 IP。
处理代理链中的多个 IP 地址
如前所述，“X-Forwarded-For” 头字段可能包含多个 IP 地址，在这种情况下，我们需要获取第一个有效的 IP 地址作为客户端的真实 IP。以下是改进后的代码：
private String getIpAddress(HttpServletRequest request) { String ip = request.getHeader("X-Forwarded-For"); if (ip != null &&!ip.isEmpty() &&!"unknown".equalsIgnoreCase(ip)) { String[] ips = ip.split(","); for (String realIp : ips) { if (!"unknown".equalsIgnoreCase(realIp.trim())) { return realIp.trim(); } } } ip = request.getHeader("X-Real-IP"); if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) { ip = request.getRemoteAddr(); } return ip; }在这段代码中，当从 “X-Forwarded-For” 头字段获取到 IP 地址后，我们将其按逗号分隔成字符串数组，然后遍历数组，找到第一个非 “unknown” 的 IP 地址并返回。如果遍历完数组都没有找到有效 IP 地址，我们再按照之前的逻辑，从 “X-Real-IP” 头字段或者request.getRemoteAddr()方法获取 IP 地址。
使用 Spring 的 RemoteIpResolver
Spring Boot 3 提供了 RemoteIpResolver 接口的实现，用于解析远程 IP 地址。我们可以通过配置启用这个功能，让 Spring Boot 自动处理获取真实 IP 地址的逻辑。
首先，在application.properties或application.yml文件中启用 X-Forwarded-For 或 X-Real-IP 的支持：
在application.properties中
server.use-forward-headers=true在application.yml中
server: use-forward-headers: true启用该配置后，Spring Boot 会自动解析 “X-Forwarded-For” 或 “X-Real-IP” 请求头，并将真实的客户端 IP 地址设置为request.getRemoteAddr()的返回值。这样，我们在代码中获取 IP 地址时，直接使用request.getRemoteAddr()即可获取到客户端的真实 IP 地址，无需再手动处理复杂的请求头逻辑。例如：
import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import javax.servlet.http.HttpServletRequest; @RequestMapping("/api") @RestController public class IpController { @GetMapping("/getIp") public String getClientIp(HttpServletRequest request) { String ip = request.getRemoteAddr(); return "Client IP Address: " + ip; } }Nginx 配置与 Spring Boot 获取 IP 地址的关联
当 Spring Boot 应用部署在 Nginx 后面作为反向代理时，Nginx 的配置对于 Spring Boot 能否正确获取客户端真实 IP 地址起着关键作用。
确保 Nginx 配置正确地将客户端 IP 地址添加到请求头中，以下是一个 Nginx 配置示例：
server { listen 80; server_name your_domain.com; location / { proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_pass http://your-spring-boot-app/; } }在这个配置中，$remote_addr变量包含了原始客户端的 IP 地址，Nginx 通过proxy_set_header指令将其设置到 “X-Real-IP” 请求头中传递给后端的 Spring Boot 应用。$proxy_add_x_forwarded_for变量则包含了所有代理服务器的 IP 地址列表（包括原始客户端的 IP 地址），Nginx 将其设置到 “X-Forwarded-For” 请求头中。这样，Spring Boot 应用就可以从这两个请求头中获取到客户端的真实 IP 地址。
总结
通过以上的介绍，我们详细了解了在 Spring Boot 3 中获取真实 IP 地址的多种方法，以及在实际应用中可能遇到的问题和解决方案。
在实际项目开发中，我们建议遵循以下最佳实践：
- 优先使用 Spring 的 RemoteIpResolver：通过配置启用 Spring 的 RemoteIpResolver 功能，可以让 Spring Boot 自动处理复杂的 IP 地址解析逻辑，减少手动代码编写，降低出错的可能性。
- 考虑多种获取 IP 地址的方法：尽管使用 RemoteIpResolver 是一种便捷的方式，但在某些特殊场景下，可能需要结合手动从请求头中获取 IP 地址的方法进行补充。例如，在需要对获取到的 IP 地址进行更细粒度的处理时，手动获取 IP 地址的方式可以提供更大的灵活性。
- 确保代理和负载均衡器的正确配置：无论是使用 Nginx 还是其他代理服务器或负载均衡器，都要确保其配置正确，能够将客户端的真实 IP 地址正确地传递到 Spring Boot 应用的请求头中。这是准确获取真实 IP 地址的基础。
- 进行充分的测试：在开发过程中，要针对不同的网络环境（有无代理、不同类型的代理、负载均衡等）进行充分的测试，确保获取真实 IP 地址的功能在各种情况下都能正常工作。可以使用模拟工具或者在不同的测试环境中进行测试，及时发现并解决潜在的问题。
希望通过本文的介绍，能够帮助各位互联网软件开发人员在 Spring Boot 3 项目中顺利地实现获取真实 IP 地址的功能，为项目的安全、稳定和个性化发展提供有力支持。如果在实践过程中有任何疑问或心得，欢迎在评论区留言分享。让我们共同进步，打造更优质的互联网应用。
