Spring Cloud Gateway 如何修改HTTP响应信息
作者：帷幄庸者 发布时间：2021-07-20 13:33:40
标签：SpringCloud,Gateway,HTTP,响应
Gateway 修改HTTP响应信息
实践Spring Cloud的过程中，使用Gateway作为路由组件，并且基于Gateway实现权限的验证、拦截、过滤，对于下游微服务的响应结果，我们总会有需要修改以统一数据格式，或者修改过滤用户没有权限看到的数据信息，这时候就需要有一个能够修改响应体的Filter。
Spring Cloud Gateway 版本为2.1.0
在当前版本，ModifyRequestBodyGatewayFilterFactory是官方提供的修改响应体的参考类，This filter is BETA and may be subject to change in a future release.，类的注释中说明这个类在以后版本中会改进，实际使用可以参考实现功能，但是性能影响较大，不过没有别的选择还是得选择这个。
官方文档：
实现
最终代码
先贴最终代码
public class ResponseDecryptionGlobalFilter implements GlobalFilter, Ordered {
private static Logger log = LoggerFactory.getLogger(ResponseDecryptionGlobalFilter.class);
@Override
public int getOrder() {
// 控制在NettyWriteResponseFilter后执行
return NettyWriteResponseFilter.WRITE_RESPONSE_FILTER_ORDER - 1;
}
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
return processResponse(exchange, chain);
}
private Mono<Void> processResponse(ServerWebExchange exchange, GatewayFilterChain chain) {
// 路由中如果不需要过滤则不进行过滤
if (!BooleanUtils.isTrue()) {
return chain.filter(exchange);
}
ServerHttpResponseDecorator responseDecorator = new ServerHttpResponseDecorator(exchange.getResponse()) {
@Override
public Mono<Void> writeWith(Publisher<? extends DataBuffer> body) {
String originalResponseContentType = exchange.getAttribute(ORIGINAL_RESPONSE_CONTENT_TYPE_ATTR);
HttpHeaders httpHeaders = new HttpHeaders();
httpHeaders.add(HttpHeaders.CONTENT_TYPE, originalResponseContentType);
ResponseAdapter responseAdapter = new ResponseAdapter(body, httpHeaders);
DefaultClientResponse clientResponse = new DefaultClientResponse(responseAdapter, ExchangeStrategies.withDefaults());
Mono<String> rawBody = clientResponse.bodyToMono(String.class).map(s -> s);
BodyInserter<Mono<String>, ReactiveHttpOutputMessage> bodyInserter = BodyInserters.fromPublisher(rawBody, String.class);
CachedBodyOutputMessage outputMessage = new CachedBodyOutputMessage(exchange, exchange.getResponse().getHeaders());
return bodyInserter.insert(outputMessage, new BodyInserterContext())
.then(Mono.defer(() -> {
Flux<DataBuffer> messageBody = outputMessage.getBody();
Flux<DataBuffer> flux = messageBody.map(buffer -> {
CharBuffer charBuffer = StandardCharsets.UTF_8.decode(buffer.asByteBuffer());
DataBufferUtils.release(buffer);
// 将响应信息转化为字符串
String responseStr = charBuffer.toString();
if (StringUtils.isNotBlank(responseStr)) {
try {
JSONObject result = JSONObject.parseObject(responseStr);
System.out.println(dataFilter(result));
if (result.containsKey("data")) {
responseStr = dataFilter(result);
} else {
log.error("响应结果序列化异常:{}", responseStr);
}
} catch (JSONException e) {
log.error("响应结果序列化异常:{}", responseStr);
}
}
return getDelegate().bufferFactory().wrap(responseStr.getBytes(StandardCharsets.UTF_8));
});
HttpHeaders headers = getDelegate().getHeaders();
// 修改响应包的大小，不修改会因为包大小不同被浏览器丢掉
flux = flux.doOnNext(data -> headers.setContentLength(data.readableByteCount()));
return getDelegate().writeWith(flux);
}));
}
};
return chain.filter(exchange.mutate().response(responseDecorator).build());
}
/**
* 权限数据过滤
*
* @param result
* @return
*/
private String dataFilter(JSONObject result) {
Object data = result.get("data");
return result.toJSONString();
}
private class ResponseAdapter implements ClientHttpResponse {
private final Flux<DataBuffer> flux;
private final HttpHeaders headers;
@SuppressWarnings("unchecked")
private ResponseAdapter(Publisher<? extends DataBuffer> body, HttpHeaders headers) {
this.headers = headers;
if (body instanceof Flux) {
flux = (Flux) body;
} else {
flux = ((Mono) body).flux();
}
}
@Override
public Flux<DataBuffer> getBody() {
return flux;
}
@Override
public HttpHeaders getHeaders() {
return headers;
}
@Override
public HttpStatus getStatusCode() {
return null;
}
@Override
public int getRawStatusCode() {
return 0;
}
@Override
public MultiValueMap<String, ResponseCookie> getCookies() {
return null;
}
}
}
踩过的坑
响应体报文过大: 起初直接读取buffer的响应信息，包小的情况没有问题，但是包大了会抛出json无法转换异常，因为没能读取完整的响应内容，参考ModifyRequestBodyGatewayFilter，等待buffer全部读完再转为数组，然后执行处理。本质原因是底层的Reactor-Netty的数据块读取大小限制导致获取到的DataBuffer实例里面的数据是不完整的。
修改响应信息后，响应的ContentLength会发生变化，忘记修改response中的Content-Length长度，导致前端请求无法获取修改后的响应结果。
flux = flux.doOnNext(data -> headers.setContentLength(data.readableByteCount()));
order值必须小于-1，因为覆盖返回响应体，自定义的GlobalFilter必须比NettyWriteResponseFilter处理完后执行。order越小越早进行处理，越晚处理响应结果。
理解ServerWebExchange
先看ServerWebExchange的注释：
Contract for an HTTP request-response interaction. Provides access to the HTTP request and response and also exposes additional server-side processing related properties and features such as request attributes.
翻译一下大概是：
ServerWebExchange是一个**HTTP请求-响应交互的契约。**提供对HTTP请求和响应的访问，并公开额外的服务器端处理相关属性和特性，如请求属性。
ServerWebExchange有点像Context的角色，我把它理解为http请求信息在Filter透传的容器，之所以称之为容器，因为它可以存储我们像放进去的数据。
注意：
ServerHttpRequest是一个只读类，因此需要通过下面例子的方法来进行修改，对于读多写少的场景，这种设计模式是值得借鉴的
ServerHttpRequest newRequest = request.mutate().headers("key","value").path("/myPath").build();
ServerWebExchange newExchange = exchange.mutate().response(responseDecorator).build();
Gateway 修改返回的响应体
问题描述：
在gateway中修改返回的响应体，在全局Filter中添加如下代码：
import org.springframework.core.Ordered;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
@Component
public class RequestGlobalFilter implements GlobalFilter, Ordered {
//...
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
//...
ResponseDecorator decorator = new ResponseDecorator(exchange.getResponse());
return chain.filter(exchange.mutate().response(decorator).build());
}
@Override
public int getOrder() {
return -1000;
}
}
通过.response(decorator)设置一个响应装饰器（自定义），以下是装饰器具体实现：
import cn.hutool.json.JSONObject;
import org.reactivestreams.Publisher;
import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.core.io.buffer.DataBufferFactory;
import org.springframework.core.io.buffer.DataBufferUtils;
import org.springframework.core.io.buffer.DefaultDataBufferFactory;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.http.server.reactive.ServerHttpResponseDecorator;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import java.nio.charset.Charset;
/**
* @author visy.wang
* @desc 响应装饰器（重构响应体）
*/
public class ResponseDecorator extends ServerHttpResponseDecorator{
public ResponseDecorator(ServerHttpResponse delegate){
super(delegate);
}
@Override
@SuppressWarnings(value = "unchecked")
public Mono<Void> writeWith(Publisher<? extends DataBuffer> body) {
if(body instanceof Flux) {
Flux<DataBuffer> fluxBody = (Flux<DataBuffer>) body;
return super.writeWith(fluxBody.buffer().map(dataBuffers -> {
DataBufferFactory dataBufferFactory = new DefaultDataBufferFactory();
DataBuffer join = dataBufferFactory.join(dataBuffers);
byte[] content = new byte[join.readableByteCount()];
join.read(content);
DataBufferUtils.release(join);// 释放掉内存
String bodyStr = new String(content, Charset.forName("UTF-8"));
//修改响应体
bodyStr = modifyBody(bodyStr);
getDelegate().getHeaders().setContentLength(bodyStr.getBytes().length);
return bufferFactory().wrap(bodyStr.getBytes());
}));
}
return super.writeWith(body);
}
//重写这个函数即可
private String modifyBody(String jsonStr){
JSONObject json = new JSONObject(jsonStr);
//TODO...修改响应体
return json.toString();
}
}
来源：https://blog.csdn.net/weiwoyonzhe/article/details/90814680
0
投稿猜你喜欢
前言Object object = new Object();世间万物的本质都可看作类的对象，面向对象(OOP)的模式让程序易维护、易复用、- 1. 简单工厂介绍简单工厂有一个具体的工厂类，可以生产不同的产品，属于创建型设计模式。注意：简单工厂模式 不属于23种设计模式之列2. 简单
- 运算符重载一直是一个很诡异事情，因为在写代码的时候，不知道某个运算符有没有被重载过。在 C++ 里面，运算符重载可以写在类的外面，当 int
- 一：简述如果我们想要生成一个随机数，通常会使用Random类。但是在并 * 况下Random生成随机数的性能并不是很理想，今天给大家介绍一下J
- 今天提交代码的时候突然发现IDEA的SVN面板Version Control下面多出来这么一句话：顿时心里咯噔一下，这肯定不是好事啊。果然，
- Servlet：当然，在servlet中，一般跳转都发生在doGet, doPost等方法里面。1) redirect 方式response
- 本文实现的功能有：1、 初始化游戏窗口2、初始化游戏的界面3、初始化游戏的说明面板4、随机生成下落方块5、方块下落速度变化6、判断方块是否可
- 背景近期在调研一个开源仓库，于是将 代码 从github下载后，当IDEA sync依赖时出现Cannot resolve org.four
- 前言在【Android】线程间通信 - Handler之使用篇主要讲了 Handler 的创建，发送消息，处理消息 三个步骤。那么接下来，我
- 简介：本文将帮助您使用 Spring Boot 创建简单的 REST 服务。你将学习什么是 REST 服务？如何使用 Spring Init
- 当遇到以下场景：其他人写的单元测试影响统计结果一些需要调用外部接口的测试暂不运行需要在非本机环境上运行一些不回滚的单元测试则有必要选择以下方
- 线程（英语：thread）是操作系统能够进行运算调度的最小单位。它被包含在进程之中，是进程中的实际运作单位。一条线程指的是进程中一个单一顺序
- 一. break1. 作用break关键字可以用于for、while、do-while及switch语句中，用来跳出整个语句块，结束当前循环
- 开发过程中，如果使用mybatis做为ORM框架，经常需要打印出完整的sql语句以及执行的结果做为参考。虽然mybatis结合日志框架可以做
- 方法的覆盖在类继承中，子类可以修改从父类继承来的方法，也就是说子类能创建一个与父类方法有不同功能的方法，但具有相同的名称、返回值类型、参数列
- 下面对Java反射的基础知识进行说明和总结：首先定义一个MyBase类，其中有私有字段，也有公有字段。同时也有公有方法和私有方法。MyBas
- 前言在SpringBoot中，对于JavaBean的属性一般都绑定在配置文件中，比如application.properties/appli
- 前言在之前的文章我们复习了 ViewGroup 的测量与布局，那么我们这一篇效果就可以在之前的基础上实现一个灵活的九宫格布局。那么一个九宫格
- 一、前言最近接到一个任务,需要爬取五级行政区划的所有数据(大概71万条数据在),需要爬取的网站:行政区划 - 行政区划代码查询 发
- 0 写在前面在实际工作中有一些地方需要用到截取字符串的方法，所以在此记录下截取字符串的几种方法。.substring()StringUtil
