一、前言
作为一个开发人员大家对日志框架肯定多少有些了解,在我们刚刚开始学习java的时候大家都是通过System.out.println()来进行语句输出。但是出来工作后发现项目中几乎没有使用此方法来进行日志输出的,而都是通过日志框架来进行日志输出的,那为什么我们不用System.out.println()的方式来输出而是要专门弄一个日志框架来进行日志输出呢?我们先看下System.out.println()输出方式的源码:
public void println(String x) {
synchronized (this) {
print(x);
newLine();
}
}
synchronized关键字,大家都熟悉吧,同步锁,如果项目中都用这种方式打印日志,那么我们服务器性能将会大大下降。因此我们可以得出结论:
- System.out.println是一个同步方法,在高并发的情况下,会严重影响性能
- System.out.println方式输出日志不方便采集
所以,在我们项目的生产环境中是禁止使用System.out.println()进行日志输出的,因此就诞生了专门用于解决此问题的日志框架。
二、日志框架介绍
1.常见日志框架
目前我们常见的日志框架为Log4j、Log4j2、Logback这3种,并且现在很多的工具包里面都会自带日志框架,因此我们使用的使用要格外小心日志框架的冲突
2. 三种日志框架之间的关系
最先有Log4j,然后因为Log4j有很大的性能问题因此该作者又重写了一个Logback,并且抽象出一个日志门面slf4j。由于之前Log4j的问世,Apache公司就借鉴了Log4j的部分原理,自己重新写了一个日志框架Log4j2并且也实现了slf4j日志门面。
3. SpringBoot默认的日志框架 Logback
SpringBoot种采用Logback作为默认的日志框架,至于为何会选择Logback而不是Apache开发的Log4j2,理由如下:
在SpringBoot中,底层是Spring框架,Spring框架默认使用JCL,而SpringBoot默认集成的日志框架需要的是SLF4j+Logback组合。因为spring-boot-starter-logging是Logback的日志实现,而SpringBoot启动项spring-boot-starter又依赖了spring-boot-starter-logging,所以Spring Boot就默认集成了Logback,因此SpringBoot默认集成了Logback。
默认情况下,SpringBoot内部使用logback作为系统日志实现的框架,将日志输出到控制台,不会写到日志文件。如果在application.properties或application.yml配置,这样只能配置简单的场景,保存路径、日志格式等。复杂的场景(区分 info 和 error 的日志、每天产生一个日志文件等)满足不了,只能自定义配置文件logback-spring.xml。
三、SpringBoot整合日志框架
搭建最基础的SpringBoot框架:pom文件内容如下:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.1.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.zbl</groupId>
<artifactId>springboot-logback</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>springboot-logback</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
1.使用默认的Logback框架
根据上图查看包结构我们可以发现,SpringBoot默认集成的日志框架确实是Logback,因此我们使用Logback框架就变得很简单了,使用步骤如下:
①项目资源路径下新建配置文件logback.xml(和application.properties平级)
配置文件内容需自己定义,我此处给一个全面的,可参考我的进行配置
<?xml version="1.0" encoding="utf-8"?>
<!--
根节点<configuration>,包含下面三个属性:
scan: 当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
scanPeriod: 设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug: 当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
-->
<configuration>
<!--
子节点<property> :用来定义变量值,它有两个属性name和value,通过<property>定义的值会被插入到logger上下文中,可以使“${}”来使用变量。
-->
<property name="APP_NAME" value="jobmd-extra-service"/>
<property name="LOG_HOME" value="logs"/>
<!--
子节点<timestamp>:获取时间戳字符串,他有两个属性key和datePattern
key: 标识此<timestamp> 的名字;
datePattern: 设置将当前时间(解析配置文件的时间)转换为字符串的模式,遵循java.txt.SimpleDateFormat的格式。
-->
<timestamp key="TIMESTAMP" datePattern="yyyyMMddHHmmss"/>
<!--
子节点<contextName>:用来设置上下文名称,每个logger都关联到logger上下文,默认上下文名称为default。
但可以使用<contextName>设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改。
-->
<contextName>${APP_NAME}-${TIMESTAMP}</contextName>
<!-- 日志输入到命令行的appender定义
子节点<appender>:负责写日志的组件,它有两个必要属性name和class; name指定appender名称,class指定appender的全限定名
ConsoleAppender 把日志输出到控制台,有以下子节点:
<encoder>:对日志进行格式化。
<target>:字符串System.out(默认)或者System.err
-->
<appender name="CONSOLE-LOG" class="ch.qos.logback.core.ConsoleAppender">
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>[%d{yyyy-MM-dd' 'HH:mm:ss.sss}] [%C] [%t] [%L] [%-5p] %m%n</pattern>
</layout>
</appender>
<!--获取比info级别高(包括info级别)但除error级别的日志
RollingFileAppender:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。有以下子节点:
<file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
<append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
<rollingPolicy>:当发生滚动时,决定RollingFileAppender的行为,涉及文件移动和重命名。属性class定义具体的滚动策略类
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy": 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。有以下子节点:
<fileNamePattern>:必要节点,包含文件名及“%d”转换符,“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式,
如:%d{yyyy-MM}。如果直接使用 %d,默认格式是 yyyy-MM-dd。RollingFileAppender的file字节点可有可无,
通过设置file,可以为活动文件和归档文件指定不同位置,当前日志总是记录到file指定的文件(活动文件),活动文件的
名字不会改变;如果没设置file,活动文件的名字会根据fileNamePattern 的值,每隔一段时间改变一次。“/”或者“\”
会被当做目录分隔符。
<maxHistory>: 可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,
且<maxHistory>是6,则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除。
class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy": 查看当前活动文件的大小,
如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点:
<maxFileSize>:这是活动文件的大小,默认值是10MB。
<prudent>:当为true时,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有两个限制,
1不支持也不允许文件压缩,2不能设置file属性,必须留空。
<triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动。
class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根据固定窗口算法重命名文件的滚动策略。有以下子节点:
<minIndex>:窗口索引最小值
<maxIndex>:窗口索引最大值,当用户指定的窗口过大时,会自动将窗口设置为12。
<fileNamePattern>:必须包含“%i”例如,假设最小值和最大值分别为1和2,命名模式为 mylog%i.log,会产生
归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项,例如,mylog%i.log.gz 或者 没有log%i.log.zip
-->
<appender name="INFO-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 过滤掉error级别日志,其他级别的日志策略为ACCEPT -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>DENY</onMatch>
<onMismatch>ACCEPT</onMismatch>
</filter>
<encoder>
<pattern>[%d{yyyy-MM-dd' 'HH:mm:ss.sss}] [%C] [%t] [%L] [%-5p] %m%n</pattern>
</encoder>
<!--滚动策略-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_HOME}//%d-info.log</fileNamePattern>
<maxHistory>30</maxHistory>
</rollingPolicy>
</appender>
<!-- 输出error级别的日志 -->
<appender name="ERROR-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 只接受error级别日志 -->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
<encoder>
<pattern>[%d{yyyy-MM-dd' 'HH:mm:ss.sss}] [%C] [%t] [%L] [%-5p] %m%n</pattern>
</encoder>
<!--滚动策略-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_HOME}//%d-error.log</fileNamePattern>
<maxHistory>30</maxHistory>
</rollingPolicy>
</appender>
<!--
FileAppender:把日志添加到文件,有以下子节点:
<file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
<append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
<encoder>:对记录事件进行格式化。(具体参数稍后讲解 )
<prudent>:如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。
-->
<appender name="File" class="ch.qos.logback.core.FileAppender">
<file>${LOG_HOME}/${appName}.file.log</file>
<append>true</append>
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</encoder>
</appender>
<!-- 异步输出 -->
<appender name="ASYNC-INFO" class="ch.qos.logback.classic.AsyncAppender">
<!-- 不丢失日志.默认的,如果队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 -->
<discardingThreshold>0</discardingThreshold>
<!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
<queueSize>256</queueSize>
<!-- 添加附加的appender,最多只能添加一个 -->
<appender-ref ref="INFO-LOG"/>
</appender>
<appender name="ASYNC-ERROR" class="ch.qos.logback.classic.AsyncAppender">
<!-- 不丢失日志.默认的,如果队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 -->
<discardingThreshold>0</discardingThreshold>
<!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
<queueSize>256</queueSize>
<!-- 添加附加的appender,最多只能添加一个 -->
<appender-ref ref="ERROR-LOG"/>
</appender>
<!--
子节点<loger>:用来设置某一个包或具体的某一个类的日志打印级别、以及指定<appender>。<loger>仅有一个name属性,一个可选的level和一个可选的addtivity属性。可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个loger
name: 用来指定受此loger约束的某一个包或者具体的某一个类。
level: 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。 如果未设置此属性,那么当前loger将会继承上级的级别。
addtivity: 是否向上级loger传递打印信息。默认是true。同<loger>一样,可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个loger。
-->
<!--<logger name="com.zjw" level="INFO" addtivity="false"/>-->
<!--
子节点<root>:它也是<loger>元素,但是它是根loger,是所有<loger>的上级。只有一个level属性,因为name已经被命名为"root",且已经是最上级了。
level: 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,不能设置为INHERITED或者同义词NULL。 默认是DEBUG。
-->
<root level="info">
<appender-ref ref="CONSOLE-LOG"/>
<appender-ref ref="ASYNC-INFO"/>
<appender-ref ref="ASYNC-ERROR"/>
</root>
</configuration>
②添加测试代码进行测试
@RestController
public class LogController {
private Logger log = LoggerFactory.getLogger(LogController.class);
@RequestMapping("/testLog")
public String testLog(String msg) {
log.info("这是info信息:{}", msg);
log.debug("这是debug信息:{}", msg);
log.warn("这是warn信息:{}", msg);
log.error("这是error信息:{}", msg);
return "success";
}
}
可修改logback.xml中的的日志级别查看日志输出状态。在外面开发或生产时需要设置合适的日志查看级别。
提示:如果不需要自定义日志格式及其它信息,也可以不用添加logback.xml文件,直接使用默认的也可以哟!
2.整合使用Log4j2框架
看了上面我们知道Springboot默认支持的是Logback框架,但是如果我们要使用Log4j2可以不呢,其实也是可以的,不过我们使用Log4j2框架之前需要先将SpringBoot框架中Logback的所有实现和spring中自带的日志框架全部去掉,然后替换成Log4j2即可,操作步骤如下:
①.修改pom.xml文件,移除多余的Jar包并添加新的jar包
- 移除springboot中的默认日志框架:spring-boot-starter-logging
- 引入log4j2框架jar包:spring-boot-starter-log4j2
- 移除spring中的jar包:commons-logging
修改pom文件之前:
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
修改pom文件之后:
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<artifactId>spring-boot-starter-logging</artifactId>
<groupId>org.springframework.boot</groupId>
</exclusion>
</exclusions>
</dependency>
<!--引入log4j2框架jar包-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
</dependencies>
②添加log4j2.xml配置文件(和application.properties平级)
<?xml version="1.0" encoding="UTF-8"?>
<!-- <configuration status="OFF" packages="com.xyebank.hzx.core.log4j2"> -->
<configuration status="OFF">
<properties>
<!-- 当前日志文件路径 -->
<property name="fileSavePath" value="/home/logs/sweep/sweep(${hostName}).log"/>
<property name="errorFileSavePath" value="/home/logs/sweep/sweep(${hostName})-error.log"/>
<!-- 历史日志文件路径 -->
<property name="fileBackSavePath" value="/home/backlogs/sweep"/>
<!-- 日志级别 -->
<property name="logLevel" value="debug"/>
<property name="layoutPattern"
value="%d{yyyy-MM-dd HH:mm:ss.SSS}---[%-5level]---[%-32X{traceId}]---[%-16.16thread]---[%c{64}] : %msg%n"/>
</properties>
<!-- 日志主配置 -->
<appenders>
<!-- 控制台 -->
<Console name="Console" target="SYSTEM_OUT">
<!-- <SensitiveDataPatternLayout pattern="${layoutPattern}" /> -->
<PatternLayout pattern="${layoutPattern}"/>
</Console>
<!-- 文件 -->
<RollingRandomAccessFile name="RollingRandomAccessFile" fileName="${fileSavePath}"
filePattern="${fileBackSavePath}-%d{yyyy-MM-dd}.%i.log.zip">
<!-- <SensitiveDataPatternLayout pattern="${layoutPattern}" /> -->
<PatternLayout pattern="${layoutPattern}"/>
<Policies>
<SizeBasedTriggeringPolicy size="200MB"/>
</Policies>
<DefaultRolloverStrategy max="30"/>
</RollingRandomAccessFile>
<!-- 错误日志 -->
<RollingRandomAccessFile name="ERROR" fileName="${errorFileSavePath}"
filePattern="${fileBackSavePath}-error-%d{yyyy-MM-dd}.%i.log.zip">
<!-- <SensitiveDataPatternLayout pattern="${layoutPattern}" /> -->
<PatternLayout pattern="${layoutPattern}"/>
<Filters>
<ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
</Filters>
<Policies>
<SizeBasedTriggeringPolicy size="200MB"/>
</Policies>
<DefaultRolloverStrategy max="30"/>
</RollingRandomAccessFile>
</appenders>
<!--过滤掉部分组件的其余错误信息-->
<loggers>
<!-- <AsyncLogger name="org.apache.zookeeper" level="error" additivity="false">-->
<!-- <appender-ref ref="RollingRandomAccessFile" />-->
<!-- <appender-ref ref="ERROR" />-->
<!-- <appender-ref ref="Console" />-->
<!-- </AsyncLogger>-->
<!-- <AsyncLogger name="com.alibaba.dubbo" level="error" additivity="false">-->
<!-- <appender-ref ref="RollingRandomAccessFile" />-->
<!-- <appender-ref ref="ERROR" />-->
<!-- <appender-ref ref="Console" />-->
<!-- </AsyncLogger>-->
<!-- <AsyncLogger name="org.I0Itec.zkclient" level="error" additivity="false">-->
<!-- <appender-ref ref="RollingRandomAccessFile" />-->
<!-- <appender-ref ref="ERROR" />-->
<!-- <appender-ref ref="Console" />-->
<!-- </AsyncLogger>-->
<!-- <AsyncLogger name="org.mongodb.driver.cluster" level="error" additivity="false">-->
<!-- <appender-ref ref="RollingRandomAccessFile" />-->
<!-- <appender-ref ref="ERROR" />-->
<!-- <appender-ref ref="Console" />-->
<!-- </AsyncLogger>-->
<!-- <AsyncRoot level="${logLevel}">-->
<!-- <appender-ref ref="RollingRandomAccessFile" />-->
<!-- <appender-ref ref="ERROR" />-->
<!-- <appender-ref ref="Console" />-->
<!-- </AsyncRoot>-->
<Root level="${logLevel}">
<appender-ref ref="RollingRandomAccessFile"/>
<appender-ref ref="ERROR"/>
<appender-ref ref="Console"/>
</Root>
</loggers>
</configuration>
③添加测试代码进行测试
@RestController
public class LogController {
private Logger log = LoggerFactory.getLogger(LogController.class);
@RequestMapping("/testLog")
public String testLog(String msg) {
log.info("这是info信息:{}", msg);
log.debug("这是debug信息:{}", msg);
log.warn("这是warn信息:{}", msg);
log.error("这是error信息:{}", msg);
return "success";
}
}
3.项目中日志框架需要注意事项
- 我们整个项目的日志框架应该统一,不允许多个模块出现不同的日志框架
- 如果采用非默认的LogBack框架,必须先删除之前的默认框架相关信息
- 日志输出格式以及我们开发中日志的输出尽量规范,不可以过多的打印无效日志又或者不打日志
- 日志输出级别总共分为8种,不同的环境应该选择合适的日志级别进行输出,框架只会输出比选择级别高的日志。
所有日志级别顺序为:ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF
比如:选择级别为info,则只会显示 INFO、WARN、ERROR、FATAL、OFF这几个级别的日志,小于该级别的日志都不会进行显示。
4.代码优化之Lombok的使用
随着现在的工具包层出不穷,大家项目中肯定也又使用Lombok的吧,Lombok工具包可以帮我们简化代码,其中也包括日志框架的代码简化,具体如下:
①不使用Lombok情况下使用日志框架:
②使用Lombok情况下使用日志框架:
pom文件中引入jar包:
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
使用日志的类上添加@Slf4j注解:
我们不需要再定义成员变量log,而是直接使用@Slf4j注解就可以使用log变量进行日志输出了,lombok只是对代码进行了简化,底层的日志框架还是用的我们自己选择的日志框架。
源码地址:https://gitee.com/zhaobolan/myspringboot