当前位置: 首页 > news >正文

Spring框架获取用户真实IP(注解式)

文章目录

  • 一、最终使用效果(@ClientIp 注解获取)
  • 二、实现代码
    • 1.注解
    • 2.方法参数解析器(Resolver)
    • 3.全局增加Resolver配置

Spring 框架没有现成工具可以方便提取客户端的IP地址,普遍做法就是通过 HttpServletRequest 的 getRemoteAddr 方法获取IP地址。

存在以下问题:
1.proxy:部分客户端使用代理后此方法返回的是代理网络的IP地址,非用户真实 IP
2.SLB:后台经过负载均衡,如阿里云的SLB实例 3,方法返回地址是SLB实例 IP,并非用户真实 IP
3.环回地址:在本地测试时获取到的是ipv4:127.0.0.1 或者 ipv6:0:0:0:0:0:0:0:1,并非本机分配地址
4.代码简洁与耦合:每次获取地址都需要注入 HttpServletRequest 再提取,使用 Spring WebFlux 1 而不是Spring MVC,没有此对象可用
5.获取地址可能是IPv6 地址,长度不同,数据库需要兼容处理,适配以后 IPv6需求

问题解决:
1.proxy :经过代理后通常可用通过 http header 的 Proxy-Client-IP 获取用户真实 IP地址
2.SLB:经过SLB实例后可通过 http header 的 X-Forwarded-For 获取用户真实IP
3.环回地址:如果是环回地址,则根据网卡取本机配置的IP,如192.168.199.123 等
4.代码简洁与耦合:实现参数解析器,使用注解方式获取IP,如 @ClientIp
5.不同版本 IP 长度不同,取最长作为数据库存储长度(47最长)

一、最终使用效果(@ClientIp 注解获取)

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.*;@Slf4j
@RestController
@RequestMapping("/test")
@EnableAutoConfiguration
public class OrderController {@GetMapping("/hello")@ResponseBody@ResponseStatus(HttpStatus.OK)public String hello(@ClientIp String ip) {return "hello, ip = " + ip;}
}

二、实现代码

注:下面为 Spring MVC 下的实现代码,如需在Spring webFlux 下使用,同理实现下面方法、配置即可
org.springframework.web.reactive.result.method.HandlerMethodArgumentResolver
org.springframework.web.reactive.config.WebFluxConfigurer

1.注解

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface ClientIp {}

2.方法参数解析器(Resolver)

import lombok.extern.slf4j.Slf4j;
import org.springframework.core.MethodParameter;
import org.springframework.web.bind.support.WebDataBinderFactory;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.ModelAndViewContainer;import javax.servlet.ServletRequest;
import java.net.InetAddress;
import java.net.UnknownHostException;public class ClientIpResolver implements HandlerMethodArgumentResolver {private static final String[] IP_HEADER_CANDIDATES = {"X-Forwarded-For","Proxy-Client-IP","WL-Proxy-Client-IP","HTTP_X_FORWARDED_FOR","HTTP_X_FORWARDED","HTTP_X_CLUSTER_CLIENT_IP","HTTP_CLIENT_IP","HTTP_FORWARDED_FOR","HTTP_FORWARDED","HTTP_VIA","REMOTE_ADDR"};@Overridepublic boolean supportsParameter(MethodParameter param) {return param.getParameterType().equals(String.class) &&param.hasParameterAnnotation(ClientIp.class);}@Overridepublic Object resolveArgument(MethodParameter parameter,ModelAndViewContainer mavContainer,NativeWebRequest webRequest,WebDataBinderFactory binderFactory) {// 提取header得到IP地址列表(多重代理场景),取第一个IPfor (String header : IP_HEADER_CANDIDATES) {String ipList = webRequest.getHeader(header);if (ipList != null && ipList.length() != 0 &&!"unknown".equalsIgnoreCase(ipList)) {return ipList.split(",")[0];}}// 没有经过代理或者SLB,直接 getRemoteAddr 方法获取IPString ip = ((ServletRequest) webRequest.getNativeRequest()).getRemoteAddr();// 如果是本地环回IP,则根据网卡取本机配置的IPif ("127.0.0.1".equals(ip) || "0:0:0:0:0:0:0:1".equals(ip)) {try {InetAddress inetAddress = InetAddress.getLocalHost();return inetAddress.getHostAddress();} catch (UnknownHostException e) {e.printStackTrace();return ip;}}return ip;}
}

3.全局增加Resolver配置

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;import java.util.List;@Configuration
public class NetWebMvcConfigurer implements WebMvcConfigurer {@Overridepublic void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {resolvers.add(clientIpResolver());}@Beanpublic ClientIpResolver clientIpResolver() {return new ClientIpResolver();}
}
http://www.lryc.cn/news/146895.html

相关文章:

  • 利用 IDEA IDE 的轻量编辑模式快速查看和编辑工程外的文本文件
  • MyBatisx代码生成
  • 【日记】文章更新计划
  • UML用例图三种关系(重点)-架构真题(十七)
  • 分层解耦介绍
  • Nginx百科之gzip压缩、黑白名单、防盗链、零拷贝、跨域、双机热备
  • git通过fork-merge request实现多人协同
  • 元素居中的方法总结
  • 后端面试话术集锦第一篇:spring面试话术
  • elasticsearch8.9.1集群搭建
  • 前端调用电脑摄像头
  • 网络编程day1——进程间通信-socket套接字
  • Android-关于页面卡顿的排查工具与监测方案
  • VueX 与Pinia 一篇搞懂
  • 指针与空间按钮的交互
  • java八股文面试[数据库]——慢查询优化
  • 《Flink学习笔记》——第十章 容错机制
  • 【LeetCode-中等题】230. 二叉搜索树中第K小的元素
  • DQL语句的用法(MySQL)
  • 【Navicat Premium 16】使用Navicat将excel的数据进行单表的导入,详细操作
  • 学习笔记230810--vue项目中get请求的两种传参方式
  • 分享一种针对uni-app相对通用的抓包方案
  • 【2023百度之星备赛】码蹄集 BD202301 公园(BFS求最短路)
  • 2022年下半年系统架构设计师真题(下午带答案)
  • 26、ADS瞬时波形仿真-TRANSIENT仿真(以共射放大器为例)
  • 【微服务部署】02-配置管理
  • NTP时钟同步服务器
  • webassembly003 ggml GGML Tensor Library part-2 官方使用说明
  • ES主集群的优化参考点
  • 全国范围内-二手房小区数据-2023-8月更新