写在前面:本文旨在代码中使用@Slf4j
注解实现日志处理,使用slf4j
作为门面api,使用slf4j-logback
作为日志绑定。
一、Slf4J介绍
SLF4J,即简单日志门面(Simple Logging Facade for Java),不是具体的日志解决方案,它只服务于各种各样的日志系统。
1、依赖
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.22</version>
</dependency>
2、使用
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class Main {
//定义日志对象
private static Logger logger = LoggerFactory.getLogger(Main.class);
public static void main(String... strings) {
//级别为debug的日志
logger.debug("Hello! debug!");
//级别为info的日志
logger.info("Hello! info!");
//级别为warn的日志
logger.warn("Hello! warn!");
//级别为error的日志
logger.error("Hello! error!");
}
}
以上两步即可记录日志了,不过在运行程序之后会出现如下问题:
SLF4J: Failed to load class “org.slf4j.impl.StaticLoggerBinder”.
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
说明光引入slf4j还不够,必须得挑选一个具体的日志组件实现来完成日志的记录,我们使用logback作为日志实现。
二、logback介绍
Logback是由log4j创始人设计的一个开源日志组件。logback当前分成三个模块:logback-core,logback-classic和logback-access。logback-core是其它两个模块的基础模块。logback-classic是log4j的一个改良版本。
1、依赖
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.22</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.1.6</version>
</dependency>
2、xml配置
classpath中编写logback的配置文件logback.xml, 以maven项目为例,logback.xml文件放在/src/main/resources/路径中。
<?xml version="1.0" encoding="UTF-8"?>
<!-- scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 -->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<!-- 上下文变量设置,用来定义变量值,其中name的值是变量的名称,value的值时变量定义的值。
通过<property>定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。 -->
<property name="CONTEXT_NAME" value="logback-test" />
<!-- 上下文名称:<contextName>, 每个logger都关联到logger上下文,
默认上下文名称为“default”。但可以使用<contextName>设置成其他名字,用于区分不同应用程序的记录。
一旦设置,不能修改。 -->
<contextName>${CONTEXT_NAME}</contextName>
<!-- <appender>是<configuration>的子节点,是负责写日志的组件。
有两个必要属性name和class。
name指定appender名称,
class指定appender的实现类。 -->
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<!-- 对日志进行格式化。 -->
<encoder>
<pattern>
%d{yyyy-MM-dd HH:mm:ss.SSS}|%level|%class|%thread|%method|%line|%msg%n
</pattern>
</encoder>
</appender>
<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。 -->
<file>${logs.dir}/logback-test.log</file>
<!-- 当发生滚动时的行为 -->
<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
<!-- 必须包含“%i”例如,假设最小值和最大值分别为1和2,命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项,例如,mylog%i.log.gz 或者 没有log%i.log.zip -->
<FileNamePattern>${logs.dir}/logback-test.%i.log</FileNamePattern>
<!-- 窗口索引最小值 -->
<minIndex>1</minIndex>
<!-- 窗口索引最大值 -->
<maxIndex>1</maxIndex>
</rollingPolicy>
<!-- 激活滚动的条件。 -->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<!-- 活动文件的大小,默认值是10MB -->
<maxFileSize>30MB</maxFileSize>
</triggeringPolicy>
<!-- 对记录事件进行格式化。 -->
<encoder>
<charset>UTF-8</charset>
<Pattern>
%d{yyyy-MM-dd HH:mm:ss.SSS}|%level|%class|%thread|%method|%line|%msg%n
</Pattern>
</encoder>
</appender>
<!-- 特殊的<logger>元素,是根logger。只有一个level属性,应为已经被命名为"root".
level:设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。默认是DEBUG。
<root>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个loger。 -->
<root>
<level value="WARN" />
<appender-ref ref="stdout" />
<appender-ref ref="file" />
</root>
<!-- 用来设置某一个 包 或者具体的某一个 类 的日志打印级别、以及指定<appender>,
name:用来指定受此logger约束的某一个包或者具体的某一个类。
level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前loger将会继承上级的级别。
additivity:是否向上级logger传递打印信息。默认是true。(这个logger的上级就是上面的root)
<logger>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个logger。-->
<logger name="hoaven.logback.test" level="DEBUG" additivity="true"></logger>
</configuration>
通过以上配置,在程序运行之后,slf4j会加载logback
的日志实现,然后logback
从类路径中读取logback.xml
文件中的日志配置信息,实现日志的记录等功能。重新运行后,正常打印日志。
三、使用@Slf4j
当引入lombok插件后,使用起来更加方便。
@Slf4j //相当于定义日志对象
public class Main {
public static void main(String... strings) {
//级别为debug的日志
logger.debug("Hello! debug!");
//级别为info的日志
logger.info("Hello! info!");
//级别为warn的日志
logger.warn("Hello! warn!");
//级别为error的日志
logger.error("Hello! error!");
}
}
如下情况需要打日志:
- 负面控制流:任何可能导致用户操作停顿或者卡住的
if/else/switch
等分支; - 耗时较长的第三方调用:如大批量数据读取;
- 错误或者特殊情况处理:如
catch/finally
;