ServerHttpRequest 和 HttpServletRequest区别以及获取IP

1区别

根据Spring Docs：

ServerHttpRequest接口实现基于HttpServletRequest接口。

一个名为ServletServerHttpRequest的类实现了ServerHttpRequest接口，它还有公共方法getServletRequest()来获取实际的HttpServletRequest

if(exchange.getRequest() instanceof ServletServerHttpRequest) {
   ServletServerHttpRequest request = (ServletServerHttpRequest) exchange.getRequest();
   HttpServletRequest httpServletRequest = request.getServletRequest();
}  

在使用springboot的websocket时，我们需要获取url中的参数往往需要装换:

public class HandShake extends HttpSessionHandshakeInterceptor {

    /**
     * 握手前参数和权限设置与校验
     */
    @Override
    public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response,
                                   WebSocketHandler wsHandler,
                                   Map<String, Object> attributes) {
        // 初始化Session信息
        ServletServerHttpRequest servletRequest = (ServletServerHttpRequest) request;
        // 获取参数 必填校验
        String xxx = servletRequest.getServletRequest().getParameter(xxx);

在网关接口中也需要获取先关request

由于gateway网关的controller接口中无法直接获取ServerHttpRequest，需要拿到ServerWebExchange后，再从ServerWebExchange对象中获取ServerHttpRequest，参考代码如下

// 获取当前请求对象
@PostMapping("/captch")
    public Mono<Result> getCaptch(ServerWebExchange exchange){
ServerHttpRequest request = exchange.getRequest();
}

2从request中获取真实IP

现在要做一个给websocket设置IP链接限制的功能，需要获取请求中的真实IP，注意，直接用req.getRemoteHost()可能是不准的，因为在多次代理之后，IP可能会有变化

ServerHttpRequest 获取 IP 地址

@Component
public class WhiteIpFilter implements GlobalFilter, Ordered {
	@Override
	public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
		// 请求
		ServerHttpRequest request = exchange.getRequest();
		// 获取 IP 地址
		String ip = getIP(request);
		log.info("========= 请求的IP地址： " + ip);
		return chain.filter(exchange);
	}
	@Override
	public int getOrder() {
		return 0;
	}

	// 多次反向代理后会有多个ip值 的分割符
	private final static String IP_UTILS_FLAG = ",";
	// 未知IP
	private final static String UNKNOWN = "unknown";
	// 本地 IP
	private final static String LOCALHOST_IP = "0:0:0:0:0:0:0:1";
	private final static String LOCALHOST_IP1 = "127.0.0.1";

	private static String getIP(ServerHttpRequest request){
		// 根据 HttpHeaders 获取 请求 IP地址
		String ip = request.getHeaders().getFirst("X-Forwarded-For");
		if (StringUtils.isEmpty(ip) || UNKNOWN.equalsIgnoreCase(ip)) {
			ip = request.getHeaders().getFirst("x-forwarded-for");
			if (ip != null && ip.length() != 0 && !UNKNOWN.equalsIgnoreCase(ip)) {
				// 多次反向代理后会有多个ip值，第一个ip才是真实ip
				if (ip.contains(IP_UTILS_FLAG)) {
					ip = ip.split(IP_UTILS_FLAG)[0];
				}
			}
		}
		if (ip == null || ip.length() == 0 || UNKNOWN.equalsIgnoreCase(ip)) {
			ip = request.getHeaders().getFirst("Proxy-Client-IP");
		}
		if (ip == null || ip.length() == 0 || UNKNOWN.equalsIgnoreCase(ip)) {
			ip = request.getHeaders().getFirst("WL-Proxy-Client-IP");
		}
		if (ip == null || ip.length() == 0 || UNKNOWN.equalsIgnoreCase(ip)) {
			ip = request.getHeaders().getFirst("HTTP_CLIENT_IP");
		}
		if (ip == null || ip.length() == 0 || UNKNOWN.equalsIgnoreCase(ip)) {
			ip = request.getHeaders().getFirst("HTTP_X_FORWARDED_FOR");
		}
		if (ip == null || ip.length() == 0 || UNKNOWN.equalsIgnoreCase(ip)) {
			ip = request.getHeaders().getFirst("X-Real-IP");
		}
		//兼容k8s集群获取ip
		if (StringUtils.isEmpty(ip) || UNKNOWN.equalsIgnoreCase(ip)) {
			ip = request.getRemoteAddress().getAddress().getHostAddress();
			if (LOCALHOST_IP1.equalsIgnoreCase(ip) || LOCALHOST_IP.equalsIgnoreCase(ip)) {
				//根据网卡取本机配置的IP
				InetAddress iNet = null;
				try {
					iNet = InetAddress.getLocalHost();
				} catch (UnknownHostException e) {
					log.error("getClientIp error: ", e);
				}
				ip = iNet.getHostAddress();
			}
		}
		return ip;
	}
}

如果都转换，可以统一使用HttpServletRequest 获取 IP 地址

	private static final String IP_UTILS_FLAG = ",";
	private static final String UNKNOWN = "unknown";
	private static final String LOCALHOST_IP = "0:0:0:0:0:0:0:1";
	private static final String LOCALHOST_IP1 = "127.0.0.1";
	
	public static String getIpAddr(HttpServletRequest request) {
		String ip = null;
		try {
			//以下两个获取在k8s中，将真实的客户端IP，放到了x-Original-Forwarded-For。而将WAF的回源地址放到了 x-Forwarded-For了。
			ip = request.getHeader("X-Original-Forwarded-For");
			if (StringUtils.isEmpty(ip) || UNKNOWN.equalsIgnoreCase(ip)) {
				ip = request.getHeader("X-Forwarded-For");
			}
			//获取nginx等代理的ip
			if (StringUtils.isEmpty(ip) || UNKNOWN.equalsIgnoreCase(ip)) {
				ip = request.getHeader("x-forwarded-for");
			}
			if (StringUtils.isEmpty(ip) || UNKNOWN.equalsIgnoreCase(ip)) {
				ip = request.getHeader("Proxy-Client-IP");
			}
			if (StringUtils.isEmpty(ip) || ip.length() == 0 || UNKNOWN.equalsIgnoreCase(ip)) {
				ip = request.getHeader("WL-Proxy-Client-IP");
			}
			if (StringUtils.isEmpty(ip) || UNKNOWN.equalsIgnoreCase(ip)) {
				ip = request.getHeader("HTTP_CLIENT_IP");
			}
			if (StringUtils.isEmpty(ip) || UNKNOWN.equalsIgnoreCase(ip)) {
				ip = request.getHeader("HTTP_X_FORWARDED_FOR");
			}
			//兼容k8s集群获取ip
			if (StringUtils.isEmpty(ip) || UNKNOWN.equalsIgnoreCase(ip)) {
				ip = request.getRemoteAddr();
				if (LOCALHOST_IP1.equalsIgnoreCase(ip) || LOCALHOST_IP.equalsIgnoreCase(ip)) {
					//根据网卡取本机配置的IP
					InetAddress iNet = null;
					try {
						iNet = InetAddress.getLocalHost();
					} catch (UnknownHostException e) {
						log.error("getClientIp error: ", e);
					}
					ip = iNet.getHostAddress();
				}
			}
		} catch (Exception e) {
			log.error("IPUtils ERROR ", e);
		}
		//使用代理，则获取第一个IP地址
		if (!StringUtils.isEmpty(ip) && ip.indexOf(IP_UTILS_FLAG) > 0) {
			ip = ip.substring(0, ip.indexOf(IP_UTILS_FLAG));
		}
		return ip;
	}