Springcloud Gateway网关日志这样打才完美

日志打印收集是开发中调试和定位线上问题的关键手段也是重中之重，gateway作为请求入口转发的核心模块，合理、规范的日志打印很重要。

• 这里只进行日志的打印输出，不做收集，收集汇总工作可以结合ELK，监控日志文件进行同步。
  
• 实现方式使用 gateway 的 GlobalFilter 过滤器。
  
• 请求日志打印的过滤器排序尽量低一些。
  
• 打印日志时，注意避免多次打印造成并发请求日志错乱，可以拼接一个大的日志串，一次打印输出。
  

RequestLogFilter

增加一个请求入参过滤器，用来打印入参信息。

1. @Slf4j
2. @Configuration
3. @ConditionalOnProperty(value = "log.request.enabled", havingValue = "true", matchIfMissing = true)
4. public class RequestLogFilter implements GlobalFilter, Ordered {
6.    @Override
7.    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
8.       ServerHttpRequest request = exchange.getRequest();
9.       // 打印请求路径
10.       String path = request.getPath().pathWithinApplication().value();
11.       // 打印请求url
12.       String requestUrl = this.getOriginalRequestUrl(exchange);
14.       // **构建成一条长 日志，避免并发下日志错乱**
15.       StringBuilder reqLog = new StringBuilder(200);
16.       // 日志参数
17.       List<Object> reqArgs = new ArrayList<>();
18.       reqLog.append("\n\n================ Gateway Request Start  ================\n");
19.       // 打印路由添加占位符
20.       reqLog.append("===> {}: {}\n");
21.       // 参数
22.       String requestMethod = request.getMethodValue();
23.       reqArgs.add(requestMethod);
24.       reqArgs.add(requestUrl);
26.       // 打印请求头
27.       HttpHeaders headers = request.getHeaders();
28.       headers.forEach((headerName, headerValue) -> {
29.          reqLog.append("===Headers===  {}: {}\n");
30.          reqArgs.add(headerName);
31.          //如果有token，可以先把token解析后打印出原始报文，JwtUtil替换成自己项目里工具类
32.          if (AUTH_KEY.toLowerCase().equals(headerName)) {
33.             String value = headerValue.get(0);
34.             String token = JwtUtil.getToken(value);
35.             Claims claims = JwtUtil.parseJWT(token);
36.             reqArgs.add((claims == null) ? "" : claims.toString());
37.             reqLog.append("===Headers===  {}: {}\n");
38.             reqArgs.add(headerName.concat("-original"));
39.             reqArgs.add(StringUtils.join(headerValue.toArray()));
40.          } else {
41.             reqArgs.add(StringUtils.join(headerValue.toArray()));
42.          }
43.       });
45.       reqLog.append("================  Gateway Request End  =================\n");
46.       // 打印执行时间
47.       log.info(reqLog.toString(), beforeReqArgs.toArray());
48.       return chain.filter(exchange);
49.    }
50.    
51.     private String getOriginalRequestUrl(ServerWebExchange exchange) {
52.             ServerHttpRequest request = exchange.getRequest();
53.             LinkedHashSet<URI> uris = exchange.getRequiredAttribute(ServerWebExchangeUtils.GATEWAY_ORIGINAL_REQUEST_URL_ATTR);
54.             URI requestUri = uris.stream().findFirst().orElse(request.getURI());
55.             MultiValueMap<String, String> queryParams = request.getQueryParams();
56.             return UriComponentsBuilder.fromPath(requestUri.getRawPath()).queryParams(queryParams).build().toUriString();
57.     }
59.    @Override
60.    public int getOrder() {
61.       return Ordered.LOWEST_PRECEDENCE;
62.    }

复制代码

ResponseLogFilter

网关请求的响应报文不在这里打印，post body 参数没有打印
[code]@Slf4j@Configuration@ConditionalOnProperty(value = "log.request.enabled", havingValue = "true", matchIfMissing = true)public class GlobalResponseLogFilter implements GlobalFilter, Ordered {   @Override   public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {      ServerHttpRequest request = exchange.getRequest();      // 打印请求路径      String path = request.getPath().pathWithinApplication().value();      return chain.filter(exchange).then(         Mono.fromRunnable(() -> {            MultiValueMap queryParams = request.getQueryParams();            String requestUrl = UriComponentsBuilder.fromPath(path).queryParams(queryParams).build().toUriString();            // 构建成一条长日志            StringBuilder responseLog = new StringBuilder(200);            // 日志参数            List responseArgs = new ArrayList();            responseLog.append("\n\n================ Gateway Response Start  ================\n");            ServerHttpResponse response = exchange.getResponse();            // 状态码个path占位符: 200 get: /xxx/xxx/xxx?a=b            responseLog.append("