返回顶部
首页 > 资讯 > 后端开发 > Python >SpringCloud Gateway读取Request Body方式
  • 318
分享到

SpringCloud Gateway读取Request Body方式

2024-04-02 19:04:59 318人浏览 独家记忆

Python 官方文档:入门教程 => 点击学习

摘要

目录Gateway读取Request Body分析ReadBodyPredicateFactory配置ReadBodyPredicateFactory编写自定义GatewayFilt

Gateway读取Request Body

我们使用SpringCloud Gateway做微服务网关的时候,经常需要在过滤器Filter中读取到Post请求中的Body内容进行日志记录、签名验证、权限验证等操作。我们知道,Request的Body是只能读取一次的,如果直接通过在Filter中读取,而不封装回去回导致后面的服务无法读取数据。

springCloud Gateway内部提供了一个断言工厂类ReadBodyPredicateFactory,这个类实现了读取Request的Body内容并放入缓存,我们可以通过从缓存中获取body内容来实现我们的目的。

分析ReadBodyPredicateFactory

public AsyncPredicate<ServerWEBExchange> applyAsync(ReadBodyPredicateFactory.Config config) {
        return (exchange) -> {
            Class inClass = config.getInClass();
            Object cachedBody = exchange.getAttribute("cachedRequestBodyObject");
            if (cachedBody != null) {
                try {
                    boolean test = config.predicate.test(cachedBody);
                    exchange.getAttributes().put("read_body_predicate_test_attribute", test);
                    return Mono.just(test);
                } catch (ClassCastException var7) {
                    if (LOGGER.isDebugEnabled()) {
                        LOGGER.debug("Predicate test failed because class in predicate does not match the cached body object", var7);
                    }
                    return Mono.just(false);
                }
            } else {
                return DataBufferUtils.join(exchange.getRequest().getBody()).flatMap((dataBuffer) -> {
                    DataBufferUtils.retain(dataBuffer);
                    final Flux<DataBuffer> cachedFlux = Flux.defer(() -> {
                        return Flux.just(dataBuffer.slice(0, dataBuffer.readableByteCount()));
                    });
                    ServerHttpRequest mutatedRequest = new ServerHttpRequestDecorator(exchange.getRequest()) {
                        public Flux<DataBuffer> getBody() {
                            return cachedFlux;
                        }
                    };
                    return ServerRequest.create(exchange.mutate().request(mutatedRequest).build(), messageReaders).bodyToMono(inClass).doOnNext((objectValue) -> {
                        exchange.getAttributes().put("cachedRequestBodyObject", objectValue);
                        exchange.getAttributes().put("cachedRequestBody", cachedFlux);
                    }).map((objectValue) -> {
                        return config.predicate.test(objectValue);
                    });
                });
            }
        };
    }

通过查看ReadBodyPredicateFactory内部实现,我们可以看到,该工厂类将request body内容读取后存放在 exchange的cachedRequestBodyObject中。

那么我们可以通过代码:

exchange.getAttribute(“cachedRequestBodyObject”); //将body内容取出来

知道如何取body内容后,我们只需将该工厂类注册到yml配置文件中的predicates,然后从Filter中获取即可。

配置ReadBodyPredicateFactory

查看ReadBodyPredicateFactory关于配置的代码:

public <T> ReadBodyPredicateFactory.Config setPredicate(Class<T> inClass, Predicate<T> predicate) {
            this.setInClass(inClass);
            this.predicate = predicate;
            return this;
        }

配置该工厂类需要两个参数:

  • inClass:接收body内容的对象Class,我们用字符串接收,配置String即可。
  • Predicate:Predicate的接口实现类,我们自定义一个Predicate的实现类即可。

自定义Predicate实现,并注册Bean。

    
    @Bean
    public Predicate bodyPredicate(){
        return new Predicate() {
            @Override
            public boolean test(Object o) {
                return true;
            }
        };
    }

两个参数都有了,直接在yml中配置:

        predicates:
        - Path=/card/api
    @Bean
    public ReadBodyGatewayFilterFactory readBodyGatewayFilterFactory() {
        return new ReadBodyGatewayFilterFactory();
    }

到此,我们的Filter类也可以在yml配置文件中直接配置使用了。

完整的yml配置

      - id: body_route #读取post中的body路由
        order: 5
        uri: lb://API-CARD
        filters:
        - ReadBody=true #使用自定义的过滤器工厂类,读取request body内容
        predicates:
        - Path=/card/api
@Slf4j
@Component
public class CacheBodyGlobalFilter implements Ordered, GlobalFilter {
    //  public static final String CACHE_REQUEST_BODY_OBJECT_KEY = "cachedRequestBodyObject";
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        if (exchange.getRequest().getHeaders().getContentType() == null) {
            return chain.filter(exchange);
        } else {
            return DataBufferUtils.join(exchange.getRequest().getBody())
                    .flatMap(dataBuffer -> {
                        DataBufferUtils.retain(dataBuffer);
                        Flux<DataBuffer> cachedFlux = Flux
                                .defer(() -> Flux.just(dataBuffer.slice(0, dataBuffer.readableByteCount())));
                        ServerHttpRequest mutatedRequest = new ServerHttpRequestDecorator(
                                exchange.getRequest()) {
                            @Override
                            public Flux<DataBuffer> getBody() {
                                return cachedFlux;
                            }
                        };
                        //exchange.getAttributes().put(CACHE_REQUEST_BODY_OBJECT_KEY, cachedFlux);
                        return chain.filter(exchange.mutate().request(mutatedRequest).build());
                    });
        }
    }
    @Override
    public int getOrder() {
        return Ordered.HIGHEST_PRECEDENCE;
    }
}

CacheBodyGlobalFilter这个全局过滤器的目的就是把原有的request请求中的body内容读出来,并且使用ServerHttpRequestDecorator这个请求装饰器对request进行包装,重写getBody方法,并把包装后的请求放到过滤器链中传递下去。这样后面的过滤器中再使用exchange.getRequest().getBody()来获取body时,实际上就是调用的重载后的getBody方法,获取的最先已经缓存了的body数据。这样就能够实现body的多次读取了。

值得一提的是,这个过滤器的order设置的是Ordered.HIGHEST_PRECEDENCE,即最高优先级的过滤器。优先级设置这么高的原因是某些系统内置的过滤器可能也会去读body,这样就会导致我们自定义过滤器中获取body的时候报body只能读取一次这样的错误如下:

java.lang.IllegalStateException: Only one connection receive subscriber allowed.
    at Reactor.ipc.Netty.channel.FluxReceive.startReceiver(FluxReceive.java:279)
    at reactor.ipc.netty.channel.FluxReceive.lambda$subscribe$2(FluxReceive.java:129)
    at 

所以,必须把CacheBodyGlobalFilter的优先级设到最高。

在自定义的过滤器中尝试获取body中的数据

package com.cloudpath.iam.gateway.customerfilter;
import com.cloudpath.iam.gateway.utils.FilterRequestResponseUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import reactor.core.publisher.Flux;
import java.util.Arrays;
import java.util.List;

@Component
@Slf4j
public class TestGatewayFilterFactory extends AbstractGatewayFilterFactory<TestGatewayFilterFactory.Config> {
    @Override
    public List<String> shortcutFieldOrder() {
        return Arrays.asList("enabled");
    }
    public TestGatewayFilterFactory() {
        super(Config.class);
        log.info("Loaded TestGatewayFilterFactory");
    }
    @Override
    public GatewayFilter apply(Config config) {
        return (exchange, chain) -> {
            if (!config.isEnabled()) {
                return chain.filter(exchange);
            }
            if (null != exchange) {
                ServerHttpRequest httpRequest = exchange.getRequest();
                    try {
                        Flux<DataBuffer> dataBufferFlux = httpRequest.getBody();
                        //获取body中的数据
                        String body = FilterRequestResponseUtil.resolveBodyFromRequest(dataBufferFlux);
                        log.info("body:{}",body);
                    } catch (Exception e) {
                        log.error("异常:",e);
                        return chain.filter(exchange);
                    }
            }
            return chain.filter(exchange);
        };
    }
    public static class Config {
        
        private boolean enabled;
        public Config() {
        }
        public boolean isEnabled() {
            return enabled;
        }
        public void setEnabled(boolean enabled) {
            this.enabled = enabled;
        }
    }
}

解析body的工具类

package com.cloudpath.iam.gateway.utils;
import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.core.io.buffer.DataBufferUtils;
import reactor.core.publisher.Flux;
import java.NIO.CharBuffer;
import java.nio.charset.StandardCharsets;
import java.util.concurrent.atomic.AtomicReference;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

public final class FilterRequestResponseUtil {
    
    public static String resolveBodyFromRequest( Flux<DataBuffer> body){
        AtomicReference<String> bodyRef = new AtomicReference<>();
        // 缓存读取的request body信息
        body.subscribe(dataBuffer -> {
            CharBuffer charBuffer = StandardCharsets.UTF_8.decode(dataBuffer.asByteBuffer());
            DataBufferUtils.release(dataBuffer);
            bodyRef.set(charBuffer.toString());
        });
        //获取request body
        return bodyRef.get();
    }
    
    public static String resolveBodyFromRequest2( Flux<DataBuffer> body){
        StringBuilder sb = new StringBuilder();
        body.subscribe(buffer -> {
            byte[] bytes = new byte[buffer.readableByteCount()];
            buffer.read(bytes);
            DataBufferUtils.release(buffer);
            String bodyString = new String(bytes, StandardCharsets.UTF_8);
            sb.append(bodyString);
        });
        return fORMatStr(sb.toString());
    }
    
    private static String formatStr(String str){
        if (str != null && str.length() > 0) {
            Pattern p = Pattern.compile("\\s*|\t|\r|\n");
            Matcher m = p.matcher(str);
            return m.replaceAll("");
        }
        return str;
    }
}

解析body的内容,网上普遍是上面的两种方式,亲测resolveBodyFromRequest方法解析body中的数据,没有1024字节的限制。

ps:我传的参数有1万多字节。。。。。。。

大家可以按需所选。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持编程网。

--结束END--

本文标题: SpringCloud Gateway读取Request Body方式

本文链接: https://lsjlt.com/news/142494.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

猜你喜欢
  • SpringCloud Gateway读取Request Body方式
    目录Gateway读取Request Body分析ReadBodyPredicateFactory配置ReadBodyPredicateFactory编写自定义GatewayFilt...
    99+
    2024-04-02
  • SpringCloud gateway request的body验证或修改方式
    SpringCloud gateway request的body验证或修改 后续版本新增了以下过滤器 org.springframework.cloud.gateway.filt...
    99+
    2024-04-02
  • SpringCloud gateway request的body验证或修改方式是什么
    这篇文章主要介绍“SpringCloud gateway request的body验证或修改方式是什么”,在日常操作中,相信很多人在SpringCloud gateway request的body验证或修改方式是什么问题上存在疑惑,小编查阅...
    99+
    2023-06-20
  • SpringBoot v2.2以上重复读取Request Body内容的解决方案
    目录SpringBootv2.2以上重复读取RequestBody内容一、需求二、解决方案三、遇到问题四、问题排查解决方案SpringBoot读取Request参数的坑后端拿参数相关...
    99+
    2024-04-02
  • Springboot如何设置过滤器及重复读取request里的body
    目录HttpServletRequest的输入流只能读取一次的原因重复读取body中数据的方法springboot的过滤器上面的getBody的代码需求: request的conte...
    99+
    2024-04-02
  • SpringCloud gateway跨域配置的操作方式
    这篇文章主要介绍“SpringCloud gateway跨域配置的操作方式”,在日常操作中,相信很多人在SpringCloud gateway跨域配置的操作方式问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”S...
    99+
    2023-06-20
  • SpringBoot如何配置获取request中body的json格式参数
    目录背景获取请求中的参数(非json格式参数)获取方法结论获取POST请求json格式的参数经过检索推荐方法(参看后边完整方法)实现方法使用背景 最近开发项目,因为有第三方调用我们的...
    99+
    2024-04-02
  • SpringCloud Gateway之请求应答日志打印方式
    目录Gateway请求应答日志打印第一步第二步Gateway全局请求日志打印把请求体的数据存入exchange编写全局日志拦截器代码在代码中配置全局拦截器Gateway请求应答日志打...
    99+
    2024-04-02
  • Unity 读取文件 TextAsset读取配置文件方式
    1 支持文件类型 .txt .html .htm .xml .bytes .json .csv .yaml .fnt 2 寻找文件 1 //Load texture from d...
    99+
    2024-04-02
  • Springboot yml Map List读取方式
    目录SpringbootymlMapList读取1、配置类集中放置2、配置类单独放置3、List读取4、问题:配置类没有获取到值Springbootyml内list、map组合写法S...
    99+
    2024-04-02
  • 读取nacos文件的方式
    读取nacos的配置文件的方式 文章目录 读取nacos的配置文件的方式前言一、使用SDK的方式去读取二、使用Spring来读取配置文件三、使用SpringBoot来读取配置文件四、使用Spr...
    99+
    2023-09-07
    java spring
  • flask后端request获取参数的方式有哪些
    本文小编为大家详细介绍“flask后端request获取参数的方式有哪些”,内容详细,步骤清晰,细节处理妥当,希望这篇“flask后端request获取参数的方式有哪些”文章能帮助大家解决疑惑,下面跟着小编的思路慢慢深入,一起来学习新知识吧...
    99+
    2023-07-02
  • SpringCloud使用Nacos保存和读取变量的配置方法
    目录前提条件启动配置管理注入配置同步配置注意:在使用SpringCloud开发微服务时,经常会遇到一些比较小的后台参数配置,这些配置不足以单独开一张表去存储,而且其他服务会读取该参数...
    99+
    2024-04-02
  • flask后端request获取参数的几种方式整理
    最近用 flask 写后端,将获取访问参数的几种方式总结整理一下,仅供参考 从 postman 上来看,调用后端接口传参的方式有两种,一种是 params,参数...
    99+
    2024-04-02
  • MySQL读取JSON转换的方式
    目录存储存在什么问题?如何处理存储 mysql5.7+开始支持存储JSON,后续不断优化,应用也越来越广泛 你可以自己将数据转换成Json String后插入,也可以选择使用工具, ...
    99+
    2024-04-02
  • Spring Boot中获取request的三种方式及请求过程
    目录一、请求过程二、获取request的三种方式2.1、可以封装为静态方法2.2、controller的方法里面2.3、直接注入三、request常用API3.1、request路径...
    99+
    2024-04-02
  • Node.js读取文件的三种方式
    本篇内容介绍了“Node.js读取文件的三种方式”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!学习 Nod...
    99+
    2024-04-02
  • java 读取文件的几种方式
    在 Java 中有几种常用的方式来读取文件: 使用 FileInputStream 类以字节的方式读取文件。 使用 BufferedReader 在字符输入流上包装一个缓冲区,以行为单位读取文件。 使用 Scanner 类以分隔符为标志...
    99+
    2023-09-02
    java servlet 开发语言
  • Python读取文件的多种方式
    在Python编程中,读取文件是非常常见的操作。Python提供了多种读取文件的方式,本文将介绍其中的几种方式。 1. 使用open函数读取文件 使用Python内置函数open()可以打开一个文件,并返回一个文件对象。在文件对象上可以调用...
    99+
    2023-09-02
    python pandas 数据分析
  • Java读取文件的几种方式
    1. 使用流读取文件 public static void stream() { String fileName = "D:\\test.txt"; final String CHARSET_NAME = "UTF-8"; ...
    99+
    2023-09-09
    java 开发语言 servlet 前端
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作