SpringCloudGateway获取body中的参数,最优雅的方式

前言

        项目需要在Gateway中获取请求参数,原生提供了request.getQueryParams()方法获取请求参数,但是只能获得url上的param,对于form body中的参数获取不到。找了很多方法,网上普遍都是通过自定义Filter缓存Body中的内容,然后再获取缓存的Body,此处的缓存实现方法各异,有些还存在内存泄漏问题。本文使用官方自带的缓存过滤器实现,然后整合url参数和body参数到同一对象进行查询。

配置官方过滤器

        在yml配置文件中设置CacheRequestBodyGatewayFilterFactory过滤器到请求链路上,此过滤器或帮我们缓存请求中的body,避免后文获取不到body。需要注意的是yml中的name对应的是CacheRequestBody,还需要提供一个bodyClass参数,具体配置看代码。

spring:
  cloud:
    gateway:
      routes:
        #user 模块
        - id: user-system
          uri: lb://user-system
          predicates:
            - Path=/user/**
          filters:
            - name: CacheRequestBody
              args:
                bodyClass: java.lang.String
            # token认证
            - TokenFilter

获取参数

        上文配置缓存后,我们就可以在自定义过滤器中获取body内容了,此处获取到的是String类型的数据,类似:name=123456&sex=1。我们使用自定义方法将body字符串进行解析,然后将原有的queryParams合并到一起方便后文查询。

public class TokenFilter extends AbstractGatewayFilterFactory {

	@Override
	public GatewayFilter apply(Object config) {
		return (exchange, chain) -> {
			ServerHttpRequest request = exchange.getRequest();
			//获取body内容,必须在yml中配置CacheRequestBody,让系统缓存body,不然此处无法获取
			String cachedRequestBody = exchange.getAttribute(ServerWebExchangeUtils.CACHED_REQUEST_BODY_ATTR);
			MultiValueMap<String, String> queryParams = formatUrlParam(cachedRequestBody, request.getQueryParams());
			// 获取参数
			String grantType = queryParams.getFirst("grant_type");
			// TODO 业务逻辑
			return chain.filter(exchange.mutate().request(request).build());
		};
	}

	/**
	 * 将body中的字符串格式化并合并url中的参数
	 * @param cachedRequestBody body字符串
	 * @return map
	 */
	private MultiValueMap<String, String> formatUrlParam(String cachedRequestBody, MultiValueMap<String, String> queryParams){
		if(cachedRequestBody == null || "".equals(cachedRequestBody.trim())){
			return queryParams;
		}
		//定义返回对象
		Map<String, List<String>> mapParam = new HashMap<>();
		//拷贝url中的参数
		queryParams.forEach(mapParam::put);
		//解析body中的参数
		String[] splitURL=cachedRequestBody.split("&");
		for(String s:splitURL){
			if(s.indexOf("=") > 0){
				s = s.replace("&", "");
				int index = s.indexOf("=");
				String key = s.substring(0, index);
				String value = s.substring(index+1);
				//适配系统逻辑
				List<String> list = mapParam.computeIfAbsent(key, k -> new ArrayList<>());
				list.add(value);
			}
		}
		return new MultiValueMapAdapter<>(mapParam);
	}
}

总结

  1. 配置yml中的CacheRequestBody
  2. 自定义过滤器中获取:
    exchange.getAttribute(ServerWebExchangeUtils.CACHED_REQUEST_BODY_ATTR)
  • 2
    点赞
  • 7
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
### 回答1: Spring Cloud Gateway 可以通过自定义过滤器来获取请求体(body)。具体步骤如下: 1. 创建一个自定义过滤器类,实现 GatewayFilter 接口。 2. 在过滤器类重写 filter 方法,在该方法获取请求体。 3. 在 Spring Cloud Gateway 配置文件配置该过滤器。 示例代码如下: ```java @Component public class MyFilter implements GatewayFilter { @Override public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { // 获取请求体 ServerHttpRequest request = exchange.getRequest(); Flux<DataBuffer> body = request.getBody(); // 处理请求体 // ... // 调用下一个过滤器 return chain.filter(exchange); } } ``` 在 Spring Cloud Gateway 配置文件配置该过滤器: ```yaml spring: cloud: gateway: routes: - id: my_route uri: http://localhost:8080 predicates: - Path=/my_path/** filters: - MyFilter ``` 其,MyFilter 是自定义过滤器类的名称。在 filters 配置指定该过滤器即可。 ### 回答2: Spring Cloud Gateway是一个基于Spring Boot的API网关,它允许开发者以统一的方式管理和路由HTTP请求到多个微服务。在实际开发,有时需要获取HTTP请求的body,在Spring Cloud Gateway获取HTTP请求的body需要注意以下几点: 1. 所有的Route Predicate都需要配置读取HTTP请求体,否则在路由到下游服务时,请求体会丢失。 2. 如果请求体是将JSON字符串作为参数传递,则需要使用JSON库将字符串转成JSON对象。Spring Cloud Gateway推荐使用与Spring Framework组件集成的Jackson JSON库。 3. HTTP请求的body只能读取一次,所以需要配置路由过滤器来实现将读取过的请求体保存在请求上下文,以便后续的路由过滤器和路由处理器获取请求体。 在Spring Cloud Gateway获取HTTP请求的body,可以通过自定义GatewayFilter来实现。下面给出获取HTTP请求体的代码示例: ```java public class BodyGatewayFilterFactory extends AbstractGatewayFilterFactory<BodyGatewayFilterFactory.Config> { public BodyGatewayFilterFactory() { super(Config.class); } @Override public GatewayFilter apply(Config config) { return (exchange, chain) -> { return DataBufferUtils.join(exchange.getRequest().getBody()) .flatMap(dataBuffer -> { byte[] bytes = new byte[dataBuffer.readableByteCount()]; dataBuffer.read(bytes); DataBufferUtils.release(dataBuffer); String requestBody = new String(bytes, Charset.forName("UTF-8")); exchange.getAttributes().put("requestBody", requestBody); return chain.filter(exchange); }); }; } public static class Config { } } ``` 在上面的代码,使用DataBufferUtils.join()函数将请求体存储在字节数组,并通过exchange的setAttribute()方法存储到请求上下文。这样,在后续的路由过滤器和路由处理器就可以通过读取exchange.getAttributes().get("requestBody")来获取HTTP请求的body,而无需重新读取请求体。 ### 回答3: Spring Cloud Gateway是一个基于Spring Boot的网关。它可以在微服务架构起到路由、负载均衡、API管理等多种作用。 在Spring Cloud Gateway获取请求体有两种方式获取单个请求体和获取多个请求体。 获取单个请求体: 在Spring Cloud Gateway获取单个请求体可以使用Exchange对象的getBody()方法。这个方法会返回一个Mono对象,需要使用subscribe()方法来订阅结果。 例如: ```java public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { Mono<String> requestBody = exchange.getRequest().getBodyToMono(String.class); requestBody.subscribe(content -> { // 对请求体进行操作 }); return chain.filter(exchange); } ``` 上面代码,我们使用getBodyToMono()获取请求体,然后使用subscribe()方法来订阅请求体的内容。订阅成功后,我们可以对请求体进行操作。 获取多个请求体: 在Spring Cloud Gateway获取多个请求体可以使用GlobalFilter。GlobalFilter是一种全局过滤器,可以对所有的请求进行处理。 我们可以创建一个自定义的GlobalFilter,然后在filter()方法获取请求体。 例如: ```java @Component public class MyGlobalFilter implements GlobalFilter { @Override public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { MediaType mediaType = exchange.getRequest().getHeaders().getContentType(); Flux<DataBuffer> body = exchange.getRequest().getBody(); return chain.filter(exchange.mutate().request( exchange.getRequest().mutate().body(Flux.just(body)).build()) .build()); } } ``` 上面代码,我们创建了一个MyGlobalFilter类,并实现了GlobalFilter接口。在filter()方法,我们使用getBody()获取请求体。获取请求体后,我们更改了请求体的数据,然后使用build()方法创建了一个新的Exchange对象,并返回chain.filter()。 总结: Spring Cloud Gateway可以通过Exchange对象来获取请求体。可以使用getBody()方法获取单个请求体,也可以使用GlobalFilter获取多个请求体。 注意:在Spring Cloud Gateway,请求体是一个Flux对象。如果需要将请求体转换成其他类型,请使用getBodyToMono()方法。由于Flux对象可能包含多个元素,因此在订阅操作时需要注意。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值