Gateway之鉴权、日志

原文连接：https://blog.csdn.net/autfish/article/details/90637957

在引入网关后，一般会把每一个服务都要作的工做，诸如日志、安全验证等转移到网关处理以减小重复开发。

1 加入log4j2

这里使用log4j2做为日志组件，首先添加log4j2的依赖并排除SpringBoot默认日志组件的依赖

1.  
   <dependency>
2.  
   <groupId>org.springframework.boot</groupId>
3.  
   <artifactId>spring-boot-starter-log4j2</artifactId>
4.  
   </dependency>
5.  
    
6.  
   <dependency>
7.  
   <groupId>org.springframework.boot</groupId>
8.  
   <artifactId>spring-boot-starter-data-redis</artifactId>
9.  
   <exclusions>
10.  
    <exclusion>
11.  
    <groupId>org.springframework.boot</groupId>
12.  
    <artifactId>spring-boot-starter-logging</artifactId>
13.  
    </exclusion>
14.  
    </exclusions>
15.  
    </dependency>

在resources目录下建立log4j2-spring.xml

1.  
   <?xml version= "1.0" encoding="UTF-8"?>
2.  
   <Configuration status= "WARN" monitorInterval="1800">
3.  
   <properties>
4.  
   <property name= "LOG_HOME">D:/Logs/gateway</property>
5.  
   <property name= "REQUEST_FILE_NAME">request</property>
6.  
   <property name= "INFO_FILE_NAME">info</property>
7.  
   </properties>
8.  
    
9.  
   <Appenders>
10.  
    <Console name= "Console" target="SYSTEM_OUT">
11.  
    <PatternLayout pattern= "%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
12.  
    </Console>
13.  
     
14.  
    <RollingRandomAccessFile name= "info-log"
15.  
    fileName= "${LOG_HOME}/${INFO_FILE_NAME}.log"
16.  
    filePattern= "${LOG_HOME}/$${date:yyyy-MM}/${INFO_FILE_NAME}-%d{yyyy-MM-dd}-%i.log">
17.  
    <PatternLayout
18.  
    pattern= "%date{yyyy-MM-dd HH:mm:ss.SSS} %level [%thread][%file:%line] - %msg%n"/>
19.  
    <Policies>
20.  
    <TimeBasedTriggeringPolicy/>
21.  
    <SizeBasedTriggeringPolicy size= "100 MB"/>
22.  
    </Policies>
23.  
    <DefaultRolloverStrategy max= "100"/>
24.  
    </RollingRandomAccessFile>
25.  
     
26.  
    <RollingRandomAccessFile name= "request-log"
27.  
    fileName= "${LOG_HOME}/${REQUEST_FILE_NAME}.log"
28.  
    filePattern= "${LOG_HOME}/$${date:yyyy-MM}/${REQUEST_FILE_NAME}-%d{yyyy-MM-dd}-%i.log">
29.  
    <PatternLayout
30.  
    pattern= "%date{yyyy-MM-dd HH:mm:ss.SSS} %level [%thread][%file:%line] - %msg%n"/>
31.  
    <Policies>
32.  
    <TimeBasedTriggeringPolicy/>
33.  
    <SizeBasedTriggeringPolicy size= "200 MB"/>
34.  
    </Policies>
35.  
    <DefaultRolloverStrategy max= "200"/>
36.  
    </RollingRandomAccessFile>
37.  
    </Appenders>
38.  
     
39.  
    <Loggers>
40.  
    <Root level= "info">
41.  
    <AppenderRef ref= "info-log" />
42.  
    </Root>
43.  
    <Logger name= "request" level="info"
44.  
    additivity= "false">
45.  
    <AppenderRef ref= "request-log"/>
46.  
    </Logger>
47.  
    <Logger name= "org.springframework">
48.  
    <AppenderRef ref= "Console" />
49.  
    </Logger>
50.  
    </Loggers>
51.  
    </Configuration>

在application.yml中增长配置告知log4j2文件路径

1.  
   logging:
2.  
   config: classpath:log4j2-spring.xml

2 获取POST的Body

记录日志时一般关注请求URI、Method、QueryString、POST请求的Body、响应信息和来源IP等。对于Spring Cloud Gateway这其中的POST请求的Body获取比较复杂，这里添加一个全局过滤器预先获取并存入请求的Attributes中。

CachePostBodyFilter

@Component
public class CachePostBodyFilter implements GlobalFilter, Ordered {
 
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        ServerHttpRequest serverHttpRequest = exchange.getRequest();
        String method = serverHttpRequest.getMethodValue();
        if("POST".equalsIgnoreCase(method)) {
            ServerRequest serverRequest = new DefaultServerRequest(exchange);
            Mono<String> bodyToMono = serverRequest.bodyToMono(String.class);
            return bodyToMono.flatMap(body -> {
                exchange.getAttributes().put("cachedRequestBody", body);
                ServerHttpRequest newRequest = new ServerHttpRequestDecorator(serverHttpRequest) {
                    @Override
                    public HttpHeaders getHeaders() {
                        HttpHeaders httpHeaders = new HttpHeaders();
                        httpHeaders.putAll(super.getHeaders());
                        httpHeaders.set(HttpHeaders.TRANSFER_ENCODING, "chunked");
                        return httpHeaders;
                    }
 
                    @Override
                    public Flux<DataBuffer> getBody() {
                        NettyDataBufferFactory nettyDataBufferFactory = new NettyDataBufferFactory(new UnpooledByteBufAllocator(false));
                        DataBuffer bodyDataBuffer = nettyDataBufferFactory.wrap(body.getBytes());
                        return Flux.just(bodyDataBuffer);
                    }
                };
                return chain.filter(exchange.mutate().request(newRequest).build());
            });
        }
        return chain.filter(exchange);
    }
 
    @Override
    public int getOrder() {
        return -21;
    }
}

 

3 记录日志

接下来再建立一个过滤器用于记录日志

 

1.  
   @Component
2.  
   public class LogFilter implements GlobalFilter, Ordered {
3.  
    
4.  
   static final Logger logger = LogManager.getLogger("request");
5.  
    
6.  
   @Override
7.  
   public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
8.  
    
9.  
   StringBuilder logBuilder = new StringBuilder();
10.  
    ServerHttpRequest serverHttpRequest = exchange.getRequest();
11.  
    String method = serverHttpRequest.getMethodValue().toUpperCase();
12.  
    logBuilder.append(method).append( ",").append(serverHttpRequest.getURI());
13.  
    if("POST".equals(method)) {
14.  
    String body = exchange.getAttributeOrDefault( "cachedRequestBody", "");
15.  
    if(StringUtils.isNotBlank(body)) {
16.  
    logBuilder.append( ",body=").append(body);
17.  
    }
18.  
    }
19.  
     
20.  
    ServerHttpResponse serverHttpResponse = exchange.getResponse();
21.  
    DataBufferFactory bufferFactory = serverHttpResponse.bufferFactory();
22.  
    ServerHttpResponseDecorator decoratedResponse = new ServerHttpResponseDecorator(serverHttpResponse) {
23.  
    @Override
24.  
    public Mono<Void> writeWith(Publisher<? extends DataBuffer> body) {
25.  
    if (body instanceof Flux) {
26.  
    Flux<? extends DataBuffer> fluxBody = (Flux<? extends DataBuffer>) body;
27.  
    return super.writeWith(fluxBody.map(dataBuffer -> {
28.  
    byte[] content = new byte[dataBuffer.readableByteCount()];
29.  
    dataBuffer.read(content);
30.  
    DataBufferUtils.release(dataBuffer);
31.  
    String resp = new String(content, Charset.forName("UTF-8"));
32.  
    logBuilder.append( ",resp=").append(resp);
33.  
    logger.info(logBuilder.toString());
34.  
    byte[] uppedContent = new String(content, Charset.forName("UTF-8")).getBytes();
35.  
    return bufferFactory.wrap(uppedContent);
36.  
    }));
37.  
    }
38.  
    return super.writeWith(body);
39.  
    }
40.  
    };
41.  
    return chain.filter(exchange.mutate().response(decoratedResponse).build());
42.  
    }
43.  
     
44.  
    @Override
45.  
    public int getOrder() {
46.  
    return -20;
47.  
    }
48.  
    }

4 鉴权

对请求的安全验证方案视各自项目需求而定，没有固定的作法，这里仅演示检查签名的处理。规则是：对除sign外全部请求参数按字典顺序排序后组成key1=value1&key2=value2的字符串，而后计算MD5码并与sign参数值比较，一致即认为经过。

这里面一样要处理QueryString和POST方法的Body，所以和日志过滤器合并为在一块儿。

@Component
public class AuthAndLogFilter implements GlobalFilter, Ordered {
 
    static final Logger logger = LogManager.getLogger("request");
 
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
 
        ServerHttpRequest serverHttpRequest = exchange.getRequest();
        ServerHttpResponse serverHttpResponse = exchange.getResponse();
 
        StringBuilder logBuilder = new StringBuilder();
        Map<String, String> params = parseRequest(exchange, logBuilder);
        boolean r = checkSignature(params, serverHttpRequest);
        if(!r) {
            Map map = new HashMap<>();
            map.put("code", 2);
            map.put("message", "签名验证失败");
            String resp = JSON.toJSONString(map);
            logBuilder.append(",resp=").append(resp);
            logger.info(logBuilder.toString());
            DataBuffer bodyDataBuffer = serverHttpResponse.bufferFactory().wrap(resp.getBytes());
            serverHttpResponse.getHeaders().add("Content-Type", "text/plain;charset=UTF-8");
            return serverHttpResponse.writeWith(Mono.just(bodyDataBuffer));
        }
 
        DataBufferFactory bufferFactory = serverHttpResponse.bufferFactory();
        ServerHttpResponseDecorator decoratedResponse = new ServerHttpResponseDecorator(serverHttpResponse) {
            @Override
            public Mono<Void> writeWith(Publisher<? extends DataBuffer> body) {
                if (body instanceof Flux) {
                    Flux<? extends DataBuffer> fluxBody = (Flux<? extends DataBuffer>) body;
                    return super.writeWith(fluxBody.map(dataBuffer -> {
                        byte[] content = new byte[dataBuffer.readableByteCount()];
                        dataBuffer.read(content);
                        DataBufferUtils.release(dataBuffer);
                        String resp = new String(content, Charset.forName("UTF-8"));
                        logBuilder.append(",resp=").append(resp);
                        logger.info(logBuilder.toString());
                        byte[] uppedContent = new String(content, Charset.forName("UTF-8")).getBytes();
                        return bufferFactory.wrap(uppedContent);
                    }));
                }
                return super.writeWith(body);
            }
        };
        return chain.filter(exchange.mutate().response(decoratedResponse).build());
    }
 
    private Map<String, String> parseRequest(ServerWebExchange exchange, StringBuilder logBuilder) {
        ServerHttpRequest serverHttpRequest = exchange.getRequest();
        String method = serverHttpRequest.getMethodValue().toUpperCase();
        logBuilder.append(method).append(",").append(serverHttpRequest.getURI());
        MultiValueMap<String, String> query = serverHttpRequest.getQueryParams();
        Map<String, String> params = new HashMap<>();
        query.forEach((k, v) -> {
            params.put(k, v.get(0));
        });
        if("POST".equals(method)) {
            String body = exchange.getAttributeOrDefault("cachedRequestBody", "");
            if(StringUtils.isNotBlank(body)) {
                logBuilder.append(",body=").append(body);
                String[] kvArray = body.split("&");
                for (String kv : kvArray) {
                    if (kv.indexOf("=") >= 0) {
                        String k = kv.split("=")[0];
                        String v = kv.split("=")[1];
                        if(!params.containsKey(k)) {
                            try {
                                params.put(k, URLDecoder.decode(v, "UTF-8"));
                            } catch (UnsupportedEncodingException e) {
                            }
                        }
                    }
                }
            }
        }
        return params;
    }
 
    private boolean checkSignature(Map<String, String> params, ServerHttpRequest serverHttpRequest) {
 
        String sign = params.get("sign");
        if(StringUtils.isBlank(sign)) {
            return false;
        }
        //检查签名
        Map<String, String> sorted = new TreeMap<>();
        params.forEach( (k, v) -> {
            if(!"sign".equals(k)) {
                sorted.put(k, v);
            }
        });
        StringBuilder builder = new StringBuilder();
        sorted.forEach((k, v) -> {
            builder.append(k).append("=").append(v).append("&");
        });
        String value = builder.toString();
        value = value.substring(0, value.length() - 1);
        if(!sign.equalsIgnoreCase(MD5Utils.MD5(value))) {
            return false;
        }
 
        return true;
    }
 
    @Override
    public int getOrder() {
        return -20;
    }
}

 

测试

A：无签名

B：带签名GET请求

C：POST请求

本期源码

连接：https://pan.baidu.com/s/1Vfg9Apnl1OgL8pzeBqHYmw 提取码：jfkl