spring 学习笔记:1.springboot使用slf4j集成log4j2构建项目日志系统

    最近开始学习spring了,我是个比较懒的人,但是觉得不能再这么堕落下去了,接下来把自己学习过程中的内容和一些常用配置记录下来,如果能整理成一个系列,那最好不过了,也算是加深对自己学到的东西的理解吧。

    参考链接:

    聊一聊log4j2配置文件log4j2.xml
    使用slf4j集成log4j2构建项目日志系统的完美解决方案
    Log4j,Log4j2,logback,slf4j日志学习
    markdown教程

    主要是参考了这两篇文章,网上有很多都是spring mvc如何配置Slf4j集成Log4j2,没有找到比较好的关于springboot下如何配置的文章,我是个新手,注解也是最近才接触到,maven也不太熟,所以还是用文字和图片记录下来,方便自己,也能给后来的提供一点参考。
    好了闲话少说了,进入正题。

一、log4f2配置

1.关于配置文件的名称以及在项目中的存放位置

log4j 2.x版本配置文件后缀名只能为".xml",".json"或者".jsn",其实1.x我也没用过.
系统选择配置文件的优先级(从先到后)如下:
    (1).classpath下的名为log4j2-test.json 或者log4j2-test.jsn的文件.
    (2).classpath下的名为log4j2-test.xml的文件.
    (3).classpath下名为log4j2.json 或者log4j2.jsn的文件.
    (4).classpath下名为log4j2.xml的文件.
    我们一般默认使用log4j2.xml进行命名。如果本地要测试,可以把log4j2-test.xml放到classpath(src\main\resources),而正式环境使用log4j2.xml,则在打包部署的时候不要打包log4j2-test.xml即可。

2.缺省默认配置文件

如果没有我们写配置文件,log4j2在spring启动时会给系统添加默认配置,如下:


 
   
     
       
     
   
   
  
    
  
  

3.配置文件节点解析

(1).根节点Configuration有两个属性:status和monitorinterval,有两个子节点:Appenders和Loggers(表明可以定义多个Appender和Logger).
    status用来指定log4j本身的打印日志的级别.
    monitorinterval用于指定log4j自动重新配置的监测间隔时间,单位是s,最小是5s.

(2).Appenders节点,常见的有三种子节点:Console、RollingFile、File.
    Console节点用来定义输出到控制台的Appender.
        name:指定Appender的名字.
        target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.
        PatternLayout:输出格式,不设置默认为:%m%n.
    File节点用来定义输出到指定位置的文件的Appender.
        name:指定Appender的名字.
        fileName:指定输出日志的目的文件带全路径的文件名.
        PatternLayout:输出格式,不设置默认为:%m%n.
    RollingFile节点用来定义超过指定大小自动删除旧的创建新的的Appender.
        name:指定Appender的名字.
        fileName:指定输出日志的目的文件带全路径的文件名.
        PatternLayout:输出格式,不设置默认为:%m%n.
        filePattern:指定新建日志文件的名称格式.
        Policies:指定滚动日志的策略,就是什么时候进行新建日志文件输出日志.
        TimeBasedTriggeringPolicy:Policies子节点,基于时间的滚动策略,interval属性用来指定多久滚动一次,默认是1 hour。modulate=true用来调整时间:比如现在是早上3am,interval是4,那么第一次滚动是在4am,接着是8am,12am...而不是7am.
        SizeBasedTriggeringPolicy:Policies子节点,基于指定文件大小的滚动策略,size属性用来定义每个日志文件的大小.
        DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的,创建新的(通过max属性)。

(3).Loggers节点,常见的有两种:Root和Logger.
    Root节点用来指定项目的根日志,如果没有单独指定Logger,那么就会默认使用该Root日志输出
        level:日志输出级别,共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
        AppenderRef:Root的子节点,用来指定该日志输出到哪个Appender.
    Logger节点用来单独指定日志的形式,比如要为指定包下的class指定不同的日志级别等。
        level:日志输出级别,共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
        name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点.
        AppenderRef:Logger的子节点,用来指定该日志输出到哪个Appender,如果没有指定,就会默认继承自Root.如果指定了,那么会在指定的这个Appender和Root的Appender中都会输出,此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。

(4).关于日志level.
    共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
        All:最低等级的,用于打开所有日志记录.
        Trace:是追踪,就是程序推进以下,你就可以写个trace输出,所以trace应该会特别多,不过没关系,我们可以设置最低日志级别不让他输出.
        Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.
        Info:消息在粗粒度级别上突出强调应用程序的运行过程.
        Warn:输出警告及warn以下级别的日志.
        Error:输出错误信息日志.
        Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.
        OFF:最高等级的,用于关闭所有日志记录.
\color{red}{程序会打印高于或等于所设置级别的日志,设置的日志等级越高,打印出来的日志就越少。}

4.比较完整的log4j2.xml配置模板






    
    
    
        
        
            
        
    
    
       
    
    
        
                    
            
            
            
                
                
            
        
        
            
            
            
                
                
            
        
            
        
        
            
            
            
                
                
            
        
    
    
    
        
        
        
        
            
            
            
            
        
    

二、maven配置

1.在pom.xml文件中添加以下slf4j和log4j2的依赖.

  
  
    org.slf4j  
    slf4j-api  
    1.7.25  
  
  
    org.slf4j  
    jcl-over-slf4j  
    1.7.25  
    runtime  
  

  
  
    org.apache.logging.log4j  
    log4j-api  
    2.11.1  
  
  
    org.apache.logging.log4j  
    log4j-core  
    2.11.1  
  
  
  
    org.apache.logging.log4j  
    log4j-slf4j-impl  
    2.11.1  
  

  

    com.lmax
    disruptor
    3.4.2
 

注意:在JVM启动参数中增加
-DLog4jContextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector 开启异步日志.Log4j2.0基于LMAX Disruptor的异步日志在多线程环境下性能会远远优于Log4j 1.x和logback(官方数据是10倍以上)。

2.删除spring-boot-starter的依赖spring-boot-starter-logging.

spring-boot-starter默认会依赖spring-boot-starter-logging,spring-boot-starter-logging依赖内容就是Spring Boot默认的日志框架Logback,如果没有排除spring-boot-starter-logging依赖,启动springboot会输入如下错误:

SLF4J: Class path contains multiple SLF4J bindings.
SLF4J: Found binding in [jar:file:/C:/Users/Administrator/.m2/repository/ch/qos/logback/logback-classic/1.2.3/logback-classic-1.2.3.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: Found binding in [jar:file:/C:/Users/Administrator/.m2/repository/org/apache/logging/log4j/log4j-slf4j-impl/2.11.1/log4j-slf4j-impl-2.11.1.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.
SLF4J: Actual binding is of type [ch.qos.logback.classic.util.ContextSelectorStaticBinder]

提示Class path包含多个SLF4J的bindings,所以这里需要排除spring-boot-starter-logging依赖,将pom.xml中spring-boot-starter节点下新增exclusions节点,内容如下:


  org.springframework.boot
  spring-boot-starter
  
    
      org.springframework.boot
      spring-boot-starter-logging
    
  

当然也可以Dependency Hierarchy排除依赖,如下图:


spring 学习笔记:1.springboot使用slf4j集成log4j2构建项目日志系统_第1张图片
打开Dependency Hierarchy

spring 学习笔记:1.springboot使用slf4j集成log4j2构建项目日志系统_第2张图片
选择排除

接下来直接点ok,就会生成排除节点。

好了,到此springboot使用slf4j集成log4j2就结束了,文中如有错误,请指出,谢谢。

你可能感兴趣的:(spring 学习笔记:1.springboot使用slf4j集成log4j2构建项目日志系统)