log4j2+springBoot

首先介绍下常见的开源日志组件:
log4j是apache实现的一个开源日志组件
logback同样是由log4j的作者设计完成的,拥有更好的特性,用来取代log4j的一个日志框架,是slf4j的原生实现
Log4j2是log4j 1.x和logback的改进版,据说采用了一些新技术(无锁异步、等等),使得日志的吞吐量、性能比log4j 1.x提高10倍,并解决了一些死锁的bug,而且配置更加简单灵活

然后了解下slf4j:
slf4j是对所有日志框架制定的一种规范、标准、接口,并不是一个框架的具体的实现,因此slf4j接口并不能独立使用,需要和具体的日志框架实现配合使用(如log4j、logback),使用接口的好处是当项目需要更换日志框架的时候,只需要更换jar和配置,不需要更改相关java代码。



一、项目中添加maven依赖
若项目中有导入spring-boot-starter-web依赖包记得去掉spring自带的日志依赖spring-boot-starter-logging


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

二、在resources目录下新建log4j2.xml配置文件

配置文件的格式:log4j2j配置文件可以是xml格式的,也可以是json格式的,
配置文件的位置:log4j2默认会在classpath目录下寻找log4j2.xml、log4j.json、log4j.jsn等名称的文件,如果配置文件名或者位置比较特殊,你也可以主动在项目配置文件中指定文件:

## log4j2配置文件 ##
logging.config: classpath:config/testLog.xml

如果配置文件名或者位置特殊,又不主动声明,那系统就会认为没有,则会按默认配置输出,也就是输出到控制台

log4j2.xml文件的配置大致如下:
节点的具体意义在文章最下面有解释

下面是我觉得不错的一个配置,四个日志级别文件和druid的日志文件放入logs文件夹中,控制台只输出INFO级别及以上的日志,还有第三方日志系统,可以对第三方日志进行过滤配置。





    
    
        logs
        
        
        %highlight{[ %p ] [%-d{yyyy-MM-dd HH:mm:ss}] [ LOGID:%X{logid} ] [%l] %m%n}
    

    
    
        
            
            
            
                ${pattern}
            
        

        
        
        
        
            
                
                
            
            
            
                ${pattern}
            
            
                
                
            
        

        
        
            
                
                
                
            
            
                ${pattern}
            
            
                
                
            
        

        
        
            
                
                
            
            
                ${pattern}
            
            
                
                
            
        

        
        
            
            
                ${pattern}
            
            
                
                
            
        

        
        
            
                ${pattern}
            
            
                
                
            
        
    
    
    
        
        
        
            
            
            
            
            
        

        
        
            
        

        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        
    

这个日志配置模板也很好(完整,可直接拷贝使用)



    

        
            
            
            
        

        
        
        
            
                
                
            
            
            
                
                
            
        

        
        
            
                
                
                
            
            
            
                
                
            
        

        
        
            
                
                
            
            
            
                
                
            
        

        
        
            
            
            
                
                
            
        

        
        
            
            
                
                
            
        
    

    
        
            
            
            
            
            
        

        
        
            
        
        
            
        

        
        
        
        
        
        
        
        
        
        
        
        
        
    

3.使用log4j2

@RestController
public class HelloController {
    private  final Logger log = LoggerFactory.getLogger(getClass());

    @GetMapping("/get")
    public String  get() {
        log.trace("trace查询了学生信息");
        log.info("info查询了学生信息");
        log.warn("warn查询了学生信息");
        log.error("erro查询了学生信息");
        log.debug("debug查询了学生信息");
        return "get";
    }
}

输出:

[ INFO ] [2019-07-31 11:19:27] [ LOGID: ] [com.sun.demo.controller.HelloController.get(HelloController.java:28)] info查询了学生信息
[ WARN ] [2019-07-31 11:19:27] [ LOGID: ] [com.sun.demo.controller.HelloController.get(HelloController.java:29)] warn查询了学生信息
[ ERROR ] [2019-07-31 11:19:27] [ LOGID: ] [com.sun.demo.controller.HelloController.get(HelloController.java:30)] erro查询了学生信息


4.@Log4j2 注解(暂时看来不常用此方式)
上面打印日志需要加private final Logger logger = LoggerFactory.getLogger(XXX.class); ,然后通过logger变量去使用logger.info,logger.debug.....,其实我们可以使用@Log4j2注解就很简单

@RestController
@Log4j2
public class HelloController {
    //和@Log4j2不能同时出现
    //private  final Logger log = LoggerFactory.getLogger(getClass());

    @GetMapping("/get")
    public String  get() {
        log.trace("trace查询了学生信息");
        log.info("info查询了学生信息");
        log.warn("warn查询了学生信息");
        log.error("erro查询了学生信息");
        log.debug("debug查询了学生信息");
        return "get";
    }
}

需要添加新的依赖,而且还需要手动安装lombok插件,这样移植代码时,可能不能完美移植
安装示例:https://jingyan.baidu.com/article/ce09321ba930ca2bff858fcb.html



  1. Configuration:为根节点,有status和monitorInterval等多个属性
    • status :status的值有 [ OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL],用于控制显示log4j2日志框架本身,内部加载运行软件时的日志级别。如果设置为WARN,则低于WARN的信息都不会输出。对于Loggers中level的定义同样适用。如果把status改为TRACE再执行测试代码,可以看到控制台中打印了一些log4j加载插件、组装logger等调试信息
    • monitorInterval:含义是每隔多少秒重新读取配置文件,可以不重启应用的情况下修改配置
  2. Appenders:输出源,用于定义日志输出的地方。log4j2支持的输出源有很多,有控制台Console、文件File、RollingRandomAccessFile、MongoDB、Flume 等
    • Console:控制台输出源是将日志打印到控制台上,开发的时候一般都会配置,以便调试
    • File:文件输出源,用于将日志写入到指定的文件,需要配置输入到哪个位置(例如:D:/logs/mylog.log)
    • RollingRandomAccessFile: 该输出源也是写入到文件,不同的是比File更加强大,可以指定当文件达到一定大小(如20MB)时,另起一个文件继续写入日志,另起一个文件就涉及到新文件的名字命名规则,因此需要配置文件命名规则
      这种方式更加实用,因为你不可能一直往一个文件中写,如果一直写,文件过大,打开就会卡死,也不便于查找日志。
      • fileName 指定当前日志文件的位置和文件名称
      • filePattern 指定当发生Rolling时,文件的转移和重命名规则
      • append 每次运行程序会自动清空日志文件,由append属性决定,false为清空,这个也挺有用的,适合临时测试用
      • SizeBasedTriggeringPolicy 指定当文件体积大于size指定的值时,触发Rolling
      • DefaultRolloverStrategy 指定最多保存的文件个数
      • TimeBasedTriggeringPolicy 这个配置需要和filePattern结合使用,注意filePattern中配置的文件重命名规则是${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i,最小的时间粒度是mm,即分钟
      • TimeBasedTriggeringPolicy指定的size是1,结合起来就是每1分钟生成一个新文件。如果改成%d{yyyy-MM-dd HH},最小粒度为小时,则每一个小时生成一个文件
    • NoSql:MongoDb, 输出到MongDb数据库中
    • Flume:输出到Apache Flume(Flume是Cloudera提供的一个高可用的,高可靠的,分布式的海量日志采集、聚合和传输的系统,Flume支持在日志系统中定制各类数据发送方,用于收集数据;同时,Flume提供对数据进行简单处理,并写到各种数据接受方(可定制)的能力。)
    • Async:异步,需要通过AppenderRef来指定要对哪种输出源进行异步(一般用于配置RollingRandomAccessFile)
    • PatternLayout:控制台或文件输出源(Console、File、RollingRandomAccessFile)都必须包含一个PatternLayout节点,用于指定输出文件的格式(如 日志输出的时间 文件 方法 行数 等格式),例如 pattern=”%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n”
%d{HH:mm:ss.SSS} 表示输出到毫秒的时间
%t 输出当前线程名称
%-5level 输出日志级别,-5表示左对齐并且固定输出5个字符,如果不足在右边补0
%logger 输出logger名称,因为Root Logger没有名称,所以没有输出
%msg 日志文本
%n 换行
 
其他常用的占位符有:
%F 输出所在的类文件名,如Log4j2Test.java
%L 输出行号
%M 输出所在方法名
%l 输出语句所在的行数, 包括类名、方法名、文件名、行数
  1. Loggers:日志器
    日志器分根日志器Root和自定义logger日志器,当根据日志名字获取不到指定的日志器时就使用Root作为默认的日志器,它是第一层过滤的基础,root的level状态等级越高,其它Logger可过滤的细节就越少! 一般都设成”TRACE”或者“DEBUG”。
    自定义时需要指定每个Logger的名称name(对于命名可以以包名作为日志的名字,不同的包配置不同的级别等),日志级别level,相加性additivity(是否继承下面配置的日志器), 对于一般的日志器一般需要配置一个或多个输出源AppenderRef(如Console、File、RollingRandomAccessFile);
  
      

4.properties: 属性
使用来定义常量,以便在其他配置的时候引用,该配置是可选的,例如定义日志的存放位置



参考文档:
https://code.skyheng.com/post/34603.html
https://blog.csdn.net/weixin_33982670/article/details/91872395
https://blog.csdn.net/u013269532/article/details/53186526
https://blog.csdn.net/RyanDon/article/details/82589989

你可能感兴趣的:(log4j2+springBoot)