Spring Cloud 微服务实践 (7) - 日志

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.http.server.reactive.ServerHttpResponse;
@Configuration
public class 




    
GatewayGlobalFilterConfig {
    private final Logger logger = LoggerFactory.getLogger(this.getClass());
    private final ObjectMapper objectMapper = new ObjectMapper();
    @Bean
    @Order(0)
    public GlobalFilter accessLogGlobalFilter() {
        return (exchange, chain) -> {
            long startTime = System.currentTimeMillis();
            return chain.filter(exchange).doFinally((signalType) -> {
                long endTime = System.currentTimeMillis();
                ServerHttpRequest request = exchange.getRequest();
                try {
                    ObjectNode node = objectMapper.createObjectNode();
                    node.put("path", request.getPath().value());
                    node.put("queryParams", objectMapper.writeValueAsString(request.getQueryParams()));
                    node.put("remoteAddress", request.getRemoteAddress().getHostString());
                    
                    HttpStatus httpStatus = exchange.getResponse().getStatusCode();
                    node.put("statusName", httpStatus.name());
                    node.put("statusValue", httpStatus.value());
                    node.put("elapsedMillisecond", endTime - startTime);
                    logger.info(node.toString());
                } catch (Exception ex) {
                    ex.printStackTrace();
                }




    
            });
        };
    }
}

• doFinally：在整个链式处理的最后执行，记录返回的状态和消耗的时间；

• 这里的日志信息是用logger.info进行输出，从前面日志框架（SLF4J+logback）的学习我们知道：通过在logback-spring.xml里进行配置，日志信息最后可以保存到控制台、文件或者数据库。



从上面这个Filter实现的日志记录来看，我们也可以自定义日志的记录，直接往文件或者数据库写日志数据。但是要考虑性能问题，比如写数据库的话，数据库会成为瓶颈，特别是并发访问量大的时候。logback是进行的异步处理，logger.info()这样的日志输出的耗时很少，只是把日志缓存起来，具体怎么格式化、输出到哪里，都由另外的模块来异步完成。（logback的名称原来是这么来的吗？^_^）



4、业务操作日志（Operation Log）

前面讲的都是访问日志（access log），可以记录访问了哪个URL带了什么参数。比如访问/user/delete，携带参数userId=123，结果（response）里的HttpStatus是200。这样的日志对运维等专业技术人员来说，在熟悉系统的情况下，知道是什么意思。但这样的日志如果给非专业的人看会怎么样？那肯定是看不懂的，一脸懵逼，对你这个系统的使用体验会变得极差。



所以这里提一个业务操作日志的说法，用更易懂的描述来记录日志。比如刚才那个/user/delete的例子，业务日志就记录为“删除了编号为123的用户”。记录业务操作日志比记录访问日志要麻烦，访问日志（Access Log）我们在Gateway上统一记录就可以了，业务操作日志记录的内容则是跟具体的业务有关，所以要在业务实现的地方去记录。



业务日志的记录分散到了系统的各个地方，但是跟具体的业务实现又无关，所以非常适合用AOP来实现。AOP（Aspect Oriented Programming，面向切面编程）在不改变程序原有逻辑的基础上，增加一些额外的功能，是对OOP（Object Oriented Programming，面向对象编程）的补充和完善。OOP的封装、继承、多态建立了对象的层次机构，AOP则是“横切”对象，把一些分散到各处的公共调用逻辑封装起来，减少了重复代码，降低了模块之间的耦合度，方便开发和维护。



AOP是Spring的主要特性之一，我们平常的Spring开发中也大量用到了用AOP开发的功能，比如数据库事务管理，可以在类上添加注解@Transactional来声明式地管理事务，而具体的事务处理则是统一由Spring框架去完成。所以说AOP只是一种编程思想，具体到Java语言最后还是落在注解(Annotation)和反射(Reflection)上来实现AOP的思想。



现在我们就用AOP的思想来实现业务操作日志的记录，先实现一个自定义注解：

package com.example.serviceone.log;
import java.lang.annotation.*;
@Target(ElementType.METHOD) //注解位置，METHOD表示注解在方法上
@Retention(RetentionPolicy.RUNTIME)  //运行时执行
@Documented
public @interface OperationLog {
    String module() default "";
    String operation() default "";
    String details() default "";
}