Spring Cloud Alibaba微服务实战三十一 - 业务日志组件

概述

在单体项目中如果我们需要记录操作日志一般会通过如下手段实现：

建立一个自定义注解，标注业务操作类型
通过AOP组装日志实体，完成日志的收集工作

具体实现可以参考如下的文章链接：
http://javadaily.cn/articles/2020/05/13/1589330750429.html

但是在微服务架构中我们不可能每个服务都写一个自定义注解，再写一个AOP，这很明显违反了 Don’t repeat yourself 精神。所以这时候我们一般都会建立一个公共的组件，在公共组件中完成日志的收集，后端服务只需要引入这个公共的组件即可。

这就是今天文章的内容，独立的业务日志收集组件。

SpringBoot Starter

要实现上述的功能我们需要借助SringBoot Starter来实现，SpringBoot 的一大优势就是Starter，通过Starter我们可以封装公共的业务逻辑以及参数的初始化，如果你在进行微服务开发，Starter的编写是一定要掌握的。

这里我们简单提一下SpringBoot Starter实现自动化配置的流程

spring-boot启动的时候会找到starterjar包中的resources/META-INF/spring.factories文件，根据spring.factories文件中的配置，找到需要自动配置的类，xxxAutoConfigure
通过xxxAutoConfigure上的注解@EnableConfigurationProperties将当前模块的属性绑定到 「Environment」 上（若有）。
通过xxxAutoConfigure中定义的bean自动装配到IOC容器中。

实战

过程如下：

首先我们在项目中建立一个starter的module，如cloud-component-logging-starter
编写配置类SysLogAutoConfigure

    @Configuration
    public class SysLogAutoConfigure {
    
        @Bean
        public SysLogAspect controllerLogAspect(){
            return new SysLogAspect();
        }
    
    }

在SysLogAutoConfigure中我们注入了一个日志切面SysLogAspect，由于日志收集工具不需要额外配置属性，所以我们也就不需要定义属性配置类了。

自定义日志注解 SysLog

    @Target(ElementType.METHOD)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface SysLog {
     /**
      * 日志内容
      * @return {String}
      */
     String value();
    }

定义日志切面 SysLogAspect

    @Aspect
    public class SysLogAspect {
    
        private final Logger log = LoggerFactory.getLogger(this.getClass());
    
        @Pointcut("@annotation(com.javadaily.component.logging.annotation.SysLog)")
        public void logPointCut() {
    
        }
    
        @Around("logPointCut()")
        public Object around(ProceedingJoinPoint pjp) throws Throwable {
            MethodSignature signature = (MethodSignature) pjp.getSignature();
            Method method = signature.getMethod();
           //类名
            String className = pjp.getTarget().getClass().getName();
            //方法名
            String methodName = signature.getName();
        
            SysLog syslog = method.getAnnotation(SysLog.class);
            //操作
            String operator =syslog.value();
    
            long beginTime = System.currentTimeMillis();
    
            Object returnValue = null;
            Exception ex = null;
            try {
                returnValue = pjp.proceed();
                return returnValue;
            } catch (Exception e) {
                ex = e;
                throw e;
            } finally {
                long cost = System.currentTimeMillis() - beginTime;
                if (ex != null) {
                    log.error("[class: {}][method: {}][operator: {}][cost: {}ms][args: {}][发生异常]",
                            className, methodName, operator, pjp.getArgs(), ex);
                } else {
                    log.info("[class: {}][method: {}][operator: {}][cost: {}ms][args: {}][return: {}]",
                            className, methodName, operator, cost, pjp.getArgs(), returnValue);
                }
            }
    
        }
    }

上面的切面表示，对于使用了@SysLog注解的方法自动进行日志收集，将日志输入到日志文件。

在resource/META-INF目录下建立spring.factories文件，加载配置类SysLogAutoConfigure

    org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    com.javadaily.component.logging.configure.SysLogAutoConfigure

在微服务中引入日志组件

    <dependency>
        <groupId>com.jianzh5.cloud</groupId>
        <artifactId>cloud-component-logging-starter</artifactId>
        <version>1.0.0</version>
    </dependency>

在需要进行日志收集的方法上添加@SysLog注解

    @SysLog("查找用户")
    public ResultData<AccountDTO> getByCode(@PathVariable(value = "accountCode") String accountCode){
        log.warn("get account detail,accountCode is :{}",accountCode);
    
        SecurityUser securityUser = SecurityUtils.getUser();
        log.info(securityUser);
    
        AccountDTO accountDTO = accountService.selectByCode(accountCode);
        return ResultData.success(accountDTO);
    }

小结

通过上面7步我们完成了日志收集组件的自定义Starter编写，这里可能有的同学会问，在 SysLogAutoConfigure类中不是有了 @Configuration和 @Bean注解，这两个注解不是可以自动加载定义的Bean到IOC容器吗？为什么还需要通过在spring.factories文件中导入 SysLogAutoConfigure呢？

这是因为springboot项目默认只会扫描本项目下的带@Configuration注解的类，如果自定义starter，不在本工程中，是无法加载的，所以要配置META-INF/spring.factories配置文件，通过spring.factories来装载配置类。

阅读全文