抄自:https://blog.csdn.net/liujun03/article/details/82684209
Java应用中,日志一般分为以下5个级别(从高到低):
- ERROR 错误信息
- WARN 警告信息
- INFO 一般信息
- DEBUG 调试信息
- TRACE 跟踪信息
Spring Boot使用Apache的Commons Logging作为内部的日志框架,其仅仅是一个日志接口,在实际应用中需要为该接口来指定相应的日志实现。
Spring Boot从1.4版本开始内置的日志框架就是Logback;Spring Boot 2.x 默认采用了slf4j+logback的形式,slf4j也是个通用的日志门面。
但是默认配置也提供了对常用日志的支持,如:Java Util Logging,Log4J等,它的内部逻辑就是通过特定的JAR包去适配各个不同的日志框架。
注:SpringBoot能自动适配所有的日志,其底层使用slf4j+logback的方式记录日志,引入其他框架的时候,只需要把这个框架依赖的日志框架排除掉即可,因为Spring Boot会通过自己的jar去替代。
一、Logback的使用
在resources下创建logback-spring.xml:
xml version="1.0" encoding="UTF-8" ?> <configuration debug="true" scan="true"> <springProperty scope="context" name="LOG_ROOT_LEVEL" source="logging.level.root" defaultValue="DEBUG"/> <springProperty scope="context" name="STDOUT" source="log.stdout" defaultValue="STDOUT"/> <property name="LOG_PATTERN" value="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" /> <property name="${LOG_ROOT_LEVEL}" value="DEBUG" /> <property name="LOG_HOME" value="data/logs" /> <property name="LOG_DIR" value="${LOG_HOME}/%d{yyyyMMdd}" /> <property name="LOG_PREFIX" value="portal" /> <property name="LOG_CHARSET" value="utf-8" /> <property name="MAX_HISTORY" value="15" /> <property name="MAX_FILE_SIZE" value="10" /> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>${LOG_PATTERN}pattern> encoder> appender> <appender name="FILE_ALL" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${LOG_HOME}/all_${LOG_PREFIX}.logfile> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${LOG_DIR}/all_${LOG_PREFIX}%d{yyyy-MM-dd}.%i.logfileNamePattern> <maxHistory>${MAX_HISTORY}maxHistory> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>${MAX_FILE_SIZE}maxFileSize> timeBasedFileNamingAndTriggeringPolicy> rollingPolicy> <layout class="ch.qos.logback.classic.PatternLayout"> <pattern>${LOG_PATTERN}pattern> layout> appender> <appender name="FILE_ERR" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${LOG_HOME}/err_${LOG_PREFIX}.logfile> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${LOG_DIR}/err_${LOG_PREFIX}%d{yyyy-MM-dd}.%i.logfileNamePattern> <maxHistory>${MAX_HISTORY}maxHistory> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>${MAX_FILE_SIZE}maxFileSize> timeBasedFileNamingAndTriggeringPolicy> rollingPolicy> <layout class="ch.qos.logback.classic.PatternLayout"> <pattern>${LOG_PATTERN}pattern> layout> appender> <springProfile name="dev"> <logger name="com.linhw.demo" level="DEBUG" /> springProfile> <root leve="${LOG_ROOT_LEVEL}"> <appender-ref ref="STDOUT" /> <appender-ref ref="FILE_ALL" /> <appender-ref ref="FILE_ERR" /> root> configuration>
1. 根节点包含的属性
<configuration>configuration>
- scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
- scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
- debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false
2. 设置上下文名称
<contextName>spring-boot-loggingcontextName>
每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改,可以通过%contextName来打印日志上下文名称。
3. 设置变量
用来定义变量值的标签, 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。
<property name="LOG_HOME" value="data/logs" />
4. 子节点appender
appender用来格式化日志输出节点,有俩个属性name和class,class用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。
(1) 控制台输出策略ConsoleAppender
<appender name="console" class="ch.qos.logback.core.ConsoleAppender"> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>ERRORlevel> <onMatch>ACCEPTonMatch> <onMismatch>DENYonMismatch> filter> <encoder> <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%npattern> encoder> appender>
filter是一个过滤器,表示对输出到控制台的日记进行过滤。有两种过滤器,分别为LevelFilter 和ThresholdFilter。执行一个过滤器会有返回个枚举值,即DENY,NEUTRAL,ACCEPT其中之一。返回DENY,日志将立即被抛弃不再经过其他过滤器;返回NEUTRAL,由序列表里的下个过滤器接着处理日志;返回ACCEPT,日志会被立即处理,不再经过剩余过滤器。
其中LevelFilter 为级别过滤器,根据日志级别进行过滤。其下有三个子节点,level表示过滤的级别,用于配置符合过滤条件的操作,ACCEPT符合级别的输出到控制台,用于配置不符合过滤条件的操作,DENY不符合的拒绝输出到控制台。
ThresholdFilter为临界值过滤器,过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时,过滤器返回NEUTRAL;当日志级别低于临界值时,日志会被拒绝。
日志格式化:
- %d{HH:mm:ss.SSS} :日志的输出时间
- %contextName : 上下文名称
- %thread : 输出日志的进程名字,这在Web应用以及异步任务处理中很有用
- %-5level : 日志级别,并且使用5个字符靠左对齐
- %logger{36} : 日志输出者的名字(一般为类名),名字最长36个字符,否则按照句点分割
- %msg : 具体的日志消息
- %n :换行符
(2) 输出到文件RollingFileAppender
<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${log.path}/spring-boot-logging.logfile> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${log.path}/spring-boot-logging.%d{yyyy-MM-dd}.log.zipfileNamePattern> <maxHistory>30maxHistory> <totalSizeCap>1GBtotalSizeCap> rollingPolicy> <encoder> <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%npattern> encoder> appender>
常见的日志输出到文件,随着应用的运行时间越来越长,日志也会增长的越来越多,将他们输出到同一个文件并非一个好办法。RollingFileAppender用于切分文件日志。
其中file
属性定义文件的带全路径的文件名,重要的是rollingPolicy
的定义。
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"
是最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责触发滚动。
5. 子节点root
<root level="info"> <appender-ref ref="console" /> <appender-ref ref="file" /> root>
root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性,默认是DEBUG。
其中可以包含零个或多个元素,表示我们定义的appender将会添加到我们定义的loger子节点中。
6. 子节点loger
- name:用来指定受此loger约束的某一个包或者具体的某一个类。
- level:用来设置打印级别,如果未设置此属性,那么当前loger将会继承上级的级别。
- addtivity:是否向上级loger传递打印信息。默认是true。
第一种是不指定level,不指定appender
<root level="info"> <appender-ref ref="console" /> <appender-ref ref="file" /> root> <logger name="com.baiding.logging.SpringBootLoggingApplicationTests"/>
这时候的处理流程是:当SpringBootLoggingApplicationTests执行日志方法时,首先交给
第二种是指定了level,指定了appender
<root level="info"> <appender-ref ref="console" /> <appender-ref ref="file" /> root> <logger name="com.baiding" level="warn" addtivity="false"> <appender-ref ref="console" /> logger>
此logger指定了level为warn,addtivity为false,不再向上级传递打印信息,若设置了
Spring Boot在使用logback记录日志时,推荐使用logback-spring.xml的格式,这样的话,日志框架就不直接加载日志的配置项,而是由SpringBoot解析日志配置,就可以使用SpringBoot 的高级Profile功能。
<springProfile name="dev"> <logger name="com.baiding" level="info"/> springProfile> <springProfile name="prod"> <logger name="com.baiding" level="warn"/> springProfile>
可以在不同的节点中使用springProfile功能,用于指定某段配置只在某个环境下生效 。当然使用前,要激活profile。
二、切换Log4j2框架
Spring Boot虽然默认使用Logback日志框架,但其内部也集成了Log4j2框架。要知道的是,在Java中,Log4j2框架的性能是最强的,所以我们一般在程序中使用Log4j2框架。
首先,要在Spring Boot使用Log4j2的话,那么第一件事就是去除Logback的jar包,并引入Log4j2的jar。
<dependency> <groupId>org.springframework.bootgroupId> <artifactId>spring-boot-starter-webartifactId> <exclusions> <exclusion> <groupId>org.springframework.bootgroupId> <artifactId>spring-boot-starter-loggingartifactId> exclusion> exclusions> dependency> <dependency> <groupId>org.springframework.bootgroupId> <artifactId>spring-boot-starter-log4j2artifactId> dependency>
上面就是在依赖Web模块的时候去除引用spring-boot-starter-logging.jar,之后依赖spring-boot-starter-log4j2.jar包。
之后在类路径下新建一个log4j2.xml, 其具体内容如下:
xml version="1.0" encoding="UTF-8"?> <configuration status="WARN" monitorInterval="30"> <Properties> <Property name="log.path">logProperty> Properties> <appenders> <console name="Console" target="SYSTEM_OUT"> <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/> console> <File name="log" fileName="${log.path}/test.log" append="false"> <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/> File> <RollingFile name="RollingFileInfo" fileName="${log.path}/info.log" filePattern="${log.path}/logs/${date:yyyy-MM}/info-%d{yyyy-MM-dd}.log.zip"> <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/> <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/> <Policies> <TimeBasedTriggeringPolicy modulate="true" interval="1"/> Policies> RollingFile> appenders> <loggers> <logger name="org.springframework" level="INFO"/> <logger name="org.mybatis" level="INFO"/> <logger name="com.baiding" level="INFO"/> <root level="info"> <appender-ref ref="Console"/> <appender-ref ref="RollingFileInfo"/> root> loggers> configuration>
1. 根节点属性
根节点Configuration有两个属性,status和monitorinterval
status : status用来指定log4j2本身的日志的级别
monitorinterval : monitorinterval用于指定log4j自动重新配置的监测间隔时间,单位是s,最小是5s
2. Properties 标签
在xml文件中,可以使用Properties
标签来自定义变量,方便其他地方的引用。
<Properties> <Property name="log.path">logProperty> Properties>
这里的log.path是定义日志存放的地方,此处是存放于项目根路径下的log文件夹中
3. appenders节点
和logback一样,Appender是用来定义日志输出点的,一般常用有三个子节点,分别为Console、RollingFile、File。
(1) Console节点用来定义输出到控制台的Appender
name : 指定Appender的名字,用于Logger节点引用
target : SYSTEM_OUT 或 SYSTEM_ERR,一般设置为:SYSTEM_OUT
PatternLayout : 指定日志输出格式,默认为%m%n
<console name="Console" target="SYSTEM_OUT"> <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/> console>
(2) File节点用来定义输出到指定位置的文件的Appender
name : 指定Appender的名字,用于Logger节点引用
fileName : 指定输出日志的目的文件带全路径的文件名
append : 是否追加,默认为ture。ture是将新日志追加到原日志文件尾部,false则是删除已有文件,重建新文件
PatternLayout : 指定日志输出格式,默认为%m%n
<File name="log" fileName="log/test.log" append="false"> <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/> File>
(3) RollingFile节点用来定义输出到指定位置的文件的Appender,但其记录的内容可拆分
File对文件的约束很简单,而RollingFile则比较灵活,其可根据文件大小来分拆,还可以根据时间来分拆。
name : 指定Appender的名字,用于Logger节点引用
fileName : 指定输出日志的目的文件带全路径的文件名
filePattern:指定拆分出去的日志文件的全路径的文件名以及格式
PatternLayout : 指定日志输出格式,默认为%m%n
Policies : 指定滚动日志的策略,就是什么时候进行新建日志文件输出日志.
TimeBasedTriggeringPolicy : 基于时间进行日志的滚动
SizeBasedTriggeringPolicy : 基于文件大小进行日志的滚动
ThresholdFilter : 日志过滤器
<RollingFile name="RollingFileInfo" fileName="${log.path}/info.log" filePattern="${log.path}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log.zip"> <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/> <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/> <Policies> <TimeBasedTriggeringPolicy modulate="true" interval="1"/> Policies> RollingFile>
这里说一下TimeBasedTriggeringPolicy这个滚动策略的属性interval,它是指日志进行滚动的间隔,那么它的单位具体是什么呢?关键点在于filePattern的日志文件名所含有的日期格式%d{yyyy-MM-dd},这里日期格式具体到了天,那么以天为单位,若是日期具体到%d{yyyy-MM-dd-HH-mm}分钟的话,那么就是以分钟为单位。
这里还提到了日志过滤器,Log4j提供了许多的日志过滤器,但我们一般采用ThresholdFilter,这个过滤器一般用来过滤掉所有级别低于它定义的级别的日志。
4. loggers
Loggers节点下一般有root和logger节点。
root节点用来指定项目的根日志,如果没有单独指定logger,那么就会默认使用该root日志输出。
level :日志输出级别,共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
appender-ref :root的子节点,用来指定该日志输出到哪个Appender
<root level="info"> <appender-ref ref="Console"/> <appender-ref ref="RollingFileInfo"/> root>
logger节点用来单独指定日志的形式,比如要为某个包下所有的class或者某个具体的class指定不同的日志级别等。
level : 日志输出级别
name : 用来指定该Logger所适用的类或者包.
AppenderRef :Logger的子节点,用来指定该日志输出到哪个Appender,如果没有指定,就会默认继承自Root
additivity :是否向上级传递日志 true(默认)或false
<logger name="org.springframework" level="INFO"/> <logger name="org.mybatis" level="INFO"/> <logger name="com.baiding" level="INFO"/>
若我们为logger指定了AppenderRef ,别忘了将logger的additivity 属性设置为false,要不然日志可能会在指定的Appender中输出两遍。
5. Log4j2异步输出日志
Log4j2有个突出的功能就是支持高效低延迟的异步化写日志。日志异步输出的好处在于,使用单独的进程来执行日志打印的功能,可以提高日志执行效率,减少日志功能对正常业务的影响。
日志的异步输出使用了disruptor这个开源的并发框架,所以首先得导入disruptor.jar包
<dependency> <groupId>com.lmaxgroupId> <artifactId>disruptorartifactId> <version>3.4.2version> dependency>
异步输出分为两种情况,一种为全异步模式,一种为异步和非异步混合输出模式。通过官方的性能对比,一般线程数在2-16之间的话,混合使用同步和异步的logger来打印日志,性能是最好的。这种模式的启用,主要在于两个节点的使用,分别为AsyncRoot和AsyncLogger,这两个节点可以和Root 或 Logger节点混合使用。
修改一下上述的log4j2.xml文件中loggers节点就可以了:
<loggers> <asyncRoot level="info"> <appender-ref ref="Console"/> <appender-ref ref="RollingFileInfo"/> asyncRoot > <asyncRoot name="com.baiding" level="INFO" /> <asyncRoot name="org.mybatis" level="INFO" /> <asyncRoot name="org.springframework" level="INFO" /> loggers>