常见的日志框架

常见的日志框架有log4j、logback和log4j2。三者作者都是Ceki Gülcü。slf4j是The Simple Logging Facade for Java的简称，是log4j、logback和log4j2的统一开发接口封装，作为日志门面，很大程度上提高了易用性和可维护性。最早为log4j（Log for Java），再后来基于log4j开发出一套统一的接口slf4j。并在log4j和slf4j的基础上开发了logback，在性能上也做了优化。log4j2虽然与log4j有很大的相似性，但是log4j2有极大地提升了性能，并有更高的并发性，并支持异步log。

所以，无论在性能上还是并发性上，log4j2都是目前最优的日志框架。

pom依赖

    org.springframework.boot
    spring-boot-starter-log4j2

springboot默认使用的日志框架为logback，要想使用log4j2，需要从spring-boot-starter-web中排除对spring-boot-starter-logging依赖。

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

然后，再引入log4j2的依赖，内部依赖了slf4j、log4j。

    org.springframework.boot
    spring-boot-starter-log4j2

log4j2配置

    
    
        
        ./logs
        
        ./logs/history
        
        100MB
        
        30
        
        %d{yyyy-MM-dd HH:mm:ss.SSS} => [%thread] => %-5level %logger{50}:(%line) - %msg%n
    
    
    
        
        
            
                
            
            
            
        
        
        
        
        
        
            
                
                
            
            
            
                
                
                
            
            
        
        
        
            
                
                
            
            
            
                
                
            
            
        
        
        
            
                
                
            
            
            
                
                
            
            
        
        
        
            
                
            
            
            
                
                
            
            
        
        
        
            
                
            
            
            
                
                
            
            
        
        
        
            
        
    
    
    
        
        
        
        
        
        
        
        
        
        
        
            
            
            
            
            
            
        
        
            
        
    

log4j2配置文件详解

要想使log4j2配置生效，需要在resources目录下新建log4j2.xml，springboot会自动找到配置文件，并加载。

日志级别

log4j2共分8个日志级别，按从低到高排列为：ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF：

• ALL：最低等级日志级别，输出所有日志；
• TRACE：追踪日志，如程序启动进程日志；
• DEBUG：程序调试信息；
• INFO：应用程序提示信息；
• WARN：告警信息；
• ERROR：程序报错信息；
• FATAL：程序出错，导致应用程序退出；
• OFF：关闭日志；

  设置应用程序的日志级别后，将输出该级别及以上的日志。如，设置日志级别为INFO，那么程序会输出INFO、WARN、ERROR及FATAL日志。

  monitorInterval

  监视配置文件变化间隔时间。如设置为30，表示每隔30s，程序会自动检测配置文件是否修改，如果修改，就更新配置文件。

  properties

  定义属性，方便在配置文件中引用。我们在这配置了logDir、historyLogDir、splitSize、fileCount及logPattern属性。

  • logDir：日志输出目录；
  • historyLogDir：日志输出历史目录；
  • splitSize：日志存档临界值，如果当天日志大于临界值，则存档，在这配置为100M；
  • fileCount：存档文件个数。在这里配置为30，相当于保留最近30天的日志记录；
  • logPattern：日志输出格式；

    appenders

    定义一系列的日志输出，可输出至控制台或者文件中。主要有三种日志输出方式：

    • Console：定义输出至控制台的方式；
    • File：定义输出至文件的方式；
    • RollingFile：定义输出至文件的方式，但会以一定的策略删除旧日志文件，并创建新的日志文件；

      三种方式有共同的子节点。

      filters

      定义日志输出等级。

      如果想输出某个等级及其以上的日志，可做如下配置：

      以上配置过滤INFO级别及其以上的日志。

      如果想单独输出某个等级的日志，可做如下配置：

      以上配置只过滤DEBUG日志，INFO及其以上等级的日志将被拒绝。

      Console日志输出

      定义日志输出至控制台。主要属性有name、target、filters和PatternLayout。

      • name：自己定义；
      • target：一般配置为SYSTEM_OUT，即将日志通过System.out输出；
      • filters：定义日志输出等级，这里配置等级为INFO，即INFO及以上等级的日志输出到控制台；
      • PatternLayout：定义日志输出格式；

        File日志输出

        定义日志输出至文件。示例配置如下：

        主要属性和子节点有name、fileName、append、filters和PatternLayout。

        • fileName：定义输出文件名；
        • append：当为true时，新增日志将被追加至文件末尾；如果为false，那么新日志将覆盖旧日志；

          RollingFile日志输出

          也是定义日志输出至文件，不同的是RollingFile可以定义日志文件存档策略。比如按照时间存档，每天备份一次，最大存档30天等等。

          主要属性和子节点有name、fileName、filePattern、filters、PatternLayout、Policies、TimeBasedTriggeringPolicy、SizeBasedTriggeringPolicy和DefaultRolloverStrategy。

          • fileName：定义现在日志输出文件名；
          • filePattern：定义历史日志文件名格式；
          • filters：以上只输出debug日志；
          • Policies：定义日志输出策略；
          • TimeBasedTriggeringPolicy：指定多长时间触发日志备份策略，这里默认为一天。还可以设置interval和modulate属性；
          • SizeBasedTriggeringPolicy：指定日志文件多大时触发日志备份策略，这里设置为100MB。即如果当天日志一次超过100MB，备份为debug-2023-05-02-1.log。如果再次超过100MB，则备份为debug-2023-05-02-2.log；
          • DefaultRolloverStrategy：设置日志文档存档个数，max指定能保存的文件个数。超过后，之前的文件将被删除；

            Socket日志输出

            定义日志输出至数据库或者其它日志管理系统，如elk等。

            以上定义日志输出至127.0.0.1:4560服务器，也就是我本地创建的elk日志管理系统。elk的搭建将在下一章讲解。

            loggers

            所有在appenders里定义的appender都需要在logger下引用，否则appender的配置就不会生效。

            如果要过滤掉一些debug信息，可以在logger中屏蔽掉，如下屏蔽掉org.springframework中error级别以下的日志：

            设置项目中的日志输出至指定的文件，并且不再在控制台中输出，配置如下：

            root节点为兜底操作，所有在appenders中配置的，但没有在其它logger中输出的，都会在root的logger中输出。