背景
实现出入参的打印，主要时post请求的body入参，以及出参，get请求入参好实现
实现思路
使用新的request以及response替换掉原本的请求相应对象
request对象对于body数据的保存时以流的形式，只能读一遍，所以使用一个新的request替换掉原来的，实现多次读，但是，这种方法是又缺陷的，但是可以避免
代码
替换请求相应对象
import lombok.extern.slf4j.Slf4j;
import org.reactivestreams.Publisher;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
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.ContentDisposition;
import org.springframework.http.HttpHeaders;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.http.server.reactive.ServerHttpRequestDecorator;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.http.server.reactive.ServerHttpResponseDecorator;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import java.nio.charset.Charset;
/**
* @author chs
* @date 2023/3/31
* 替换请求相应实体
*/
@Slf4j
@Component
public class ReplaceReqAndRes implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
String path = exchange.getRequest().getURI().getPath();
// 新的相应实体对象
ServerHttpResponse response = exchange.getResponse();
ServerHttpResponseDecorator decoratedResponse = new ServerHttpResponseDecorator(response) {
@Override
public Mono<Void> writeWith(Publisher<? extends DataBuffer> body) {
HttpHeaders headers=getHeaders();
ContentDisposition contentDisposition=headers.getContentDisposition();
// 为附件的响应头 不打印响应日志
if (body instanceof Flux && !contentDisposition.isAttachment()) {
Flux<? extends DataBuffer> fluxBody = Flux.from(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);
String responseData = new String(content, Charset.forName("UTF-8"));
log.info("请求地址: {}, 出参: {}", path, responseData);
DataBufferUtils.release(join);
return this.bufferFactory().wrap(content);
}));
}
return super.writeWith(body);
}
};
// 新的请求实体对象
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;
}
};
Mono<Void> filter = chain.filter(exchange.mutate().request(mutatedRequest).response(decoratedResponse).build());
return filter;
});
}
/**
* 数值越小，越靠前执行
*/
@Override
public int getOrder() {
return Ordered.HIGHEST_PRECEDENCE;
}
}
打印入参
import cn.hutool.core.collection.CollectionUtil;
import cn.hutool.json.JSONUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.core.io.buffer.DataBufferUtils;
import org.springframework.http.MediaType;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import java.nio.CharBuffer;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.concurrent.atomic.AtomicReference;
/**
* @author chs
* @date 2023/3/31
* 打印请求参数
*/
@Slf4j
@Component
public class RequestResponseLog implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
ServerHttpRequest request = exchange.getRequest();
String contentType = request.getHeaders().getContentType().toString();
List<String> tokenList = request.getHeaders().get("Authorization");
String path = request.getURI().getPath();
MultiValueMap<String, String> queryParams = request.getQueryParams();
String bodyStr = null;
String token = null;
if (!contentType.startsWith(MediaType.MULTIPART_FORM_DATA_VALUE)) {
// 如果是表单类型，有可能是文件数据，会导致日志特别长，文件之外的其他字段，只要顺序在文件字段之前就会在param中获取到
bodyStr = getBodyStr(request);
}
if (!CollectionUtil.isEmpty(tokenList)) {
token = tokenList.get(0);
}
log.info("请求地址: {}, token: {}, 入参params: {}, 入参body: {}", path, token, JSONUtil.toJsonStr(queryParams), bodyStr);
return chain.filter(exchange);
}
/**
* 获取请求体字符串
*
* @param request
* @return
*/
private String getBodyStr(ServerHttpRequest request) {
Flux<DataBuffer> body = request.getBody();
AtomicReference<String> bodyRef = new AtomicReference<>();
body.subscribe(buffer -> {
CharBuffer charBuffer = StandardCharsets.UTF_8.decode(buffer.asByteBuffer());
DataBufferUtils.release(buffer);
bodyRef.set(charBuffer.toString());
});
String result = bodyRef.get();
return result;
}
/**
* 数值越小，越靠前执行
*/
@Override
public int getOrder() {
return Ordered.HIGHEST_PRECEDENCE + 1;
}
}
注意
这个实现方法是有缺陷的，当一个接口没有入参时，会导致前端请求超时
image.png
推荐在服务中通过AOP实现参数打印，简单又方便
