美文网首页
JHipster一知半解- 3.2Logback-日志切点

JHipster一知半解- 3.2Logback-日志切点

作者: 沉寂之舟 | 来源:发表于2018-06-13 16:13 被阅读197次

    回目录:JHipster一知半解

    Logback配置

    Logback是由log4j创始人设计的另一个开源日志组件,是log4j的一个改良版本。
    主要分为logback-core,logback-classic,logback-access三个模块

    1. 引入与生效过程

    作为spring-boot项目,Pom.xml中增加了对spring-boot-starter-logging的依赖。

    <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-logging</artifactId>
    </dependency>
    

    在spring-boot-starter-logging*.jar中,也就说引入了logback的几个依赖包

    <dependencies>
            <dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-classic</artifactId>
            </dependency>
            <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>jcl-over-slf4j</artifactId>
            </dependency>
            <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>jul-to-slf4j</artifactId>
            </dependency>
            <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>log4j-over-slf4j</artifactId>
            </dependency>
        </dependencies>
    

    那么在spring-boot的启动中,slf4j的LoggerFactory就能自动识别到用了logback进行日志初始化(具体在findPossibleStaticLoggerBinderPathSet())函数中,用ClassLoader动态查找LOGGER_BINDER路径,从而发现logback,有兴趣可以自行断点查看。

    2. 配置

    spring-boot本身对几个主流的日志系统都做了基础的配置,也就是说,即使什么也不做,只需要上面引入的strater-logging,也能获得基本的配置能力。
    具体代码在org.springframework.boot.logging.LoggingApplicationListener中,这个监听器,监听到应用程序启动(main()函数里面的run()方法),调用

    this.loggingSystem.beforeInitialize();
    

    实际上是org.springframework.boot.logging.logback.LogbackLoggingSystem就进行了对应的初始化工作,这里配置了logback默认的配置文件base.xml,另外Spring Boot 提供了两个输出端的配置文件console-appender.xml和file-appender.xml,base.xml引用了这两个配置文件。

    当然JHipster不会仅仅采用默认的配置,在src/main/resources目录里面,定义了logback-spring.xml作为项目logback的配置。

    2.1. 首先,include了默认的base.xml,作为基础。

    2.2. 由于默认的root level="INFO",那么这里面就针对需要修改的类,进行对应等级调整,如com.ryantenney设置为WARN,io.undertow.websockets.jsr就设置为ERROR,org.apache.catalina.startup.DigesterFactory设置为OFF

    2.3. 默认生成的appender,只配置生效了CONSOLE,但同时也很贴心地写好并注释了FILE的appender,需要的话,取消注释,即可生效。(微服务架构目标是动态伸缩,如果还是每个服务都保存自己的日志文件,有点低效,推荐整合ELK,统一收集日志信息)

    3. aop.logging的LoggingAspect

    这个配置是基于spring的AOP,对需要debug的类,进行额外的日志打印功能。

    3.1. 构造函数

    public LoggingAspect(Environment env) {
            this.env = env;
        }
    

    用来把spring启动的环境变量传递进来,可以在logAfterThrowing()看到,根据生效的profile不同,打印的日志也是不同的。

    3.2. 切点
    springBeanPointcut()是从类注解的角度,有加上@Repository,@Service,@RestController的。
    applicationPackagePointcut()是从类位置的角度,位于项目中repository,service,web.rest包中的。

    3.3. 统一的异常打印logAfterThrowing
    如果业务处理出现异常,这里统一捕捉,并根据激活的profile不同,日志格式有所不同

    3.4 统一的日志登记logAround
    针对需要扩展的业务处理部分,如果log.isDebugEnabled(),则在方法的处理之前,和之后都打印出对应的日志,方便调试。

    4. 动态改变log日志等级web.rest.LogsResource

    spring-boot是1.5版本后才在actuator增加了loggers端点了,JHipster在spring还没有此功能前就自定义了一个rest端点完成对应的工作。
    代码相对简单,两个方法,一个get,一个put。都是获取LoggerContext,然后进行相应的操作。

    web.rest.vm。LoggerVM
    JHipster使用了VM作为前后端传递对象视图模型,LoggerVM只有2个属性,name和level,这样就简化了前后端的数据传递,毕竟我们的目标只是显示和修改日志的等级设置,传递整个Logger对象显然不适合。

    资源和书籍推荐

    logback的使用和logback.xml详解 (https://www.cnblogs.com/warking/p/5710303.html)

    http://blog.csdn.net/sun_t89/article/details/52130839

    https://springframework.guru/using-logback-spring-boot/

    Logback用户手册中文版(链接:http://pan.baidu.com/s/1hsH0JaO 密码:pq1z)

    相关文章

      网友评论

          本文标题:JHipster一知半解- 3.2Logback-日志切点

          本文链接:https://www.haomeiwen.com/subject/lbnjeftx.html