对于一个web项目来说，日志框架是必不可少的，日志的记录可以帮助我们在开发以及维护过程中快速的定位错误。相信很多人听说过slf4j,log4j,logback,JDK Logging等跟日志框架有关的词语，所以这里也简单介绍下他们之间的关系。
首先slf4j可以理解为规则的制定者，是一个抽象层，定义了日志相关的接口。log4j,logback,JDK Logging都是slf4j的实现层，只是出处不同，当然使用起来也就各有千秋，这里放一张网上的图更明了的解释了他们之间的关系：
我使用这个框架是因为一开始接触的时候就用的这个，后来在网上了解到slf4j+logback也确实当下最流行的日志框架，并且自己用着也确实很顺手，也就一直用了下来。
在Spring boot使用是非常方便的，不需要我们有什么额外的配置，因为Spring boot默认支持的就是slf4j+logback的日志框架，想要灵活的定制日志策略，只需要我们在src/mAIn/resources下添加配置文件即可，只是默认情况下配置文件的命名需要符合以下规则：
其中logback-spring.xml是官方推荐的，并且只有使用这种命名规则，才可以配置不同环境使用不同的日志策略这一功能。
首先介绍配置文件的关键节点：
框架介绍
<configuration>：根节点,有三个属性：
根节点<configuration>有三个重要的子节点,正是这三个子节点的不同组合构成配置文件的基本框架，使得logback.xml配置文件具备很强的灵活性:
在该节点内可以添加子节点<appender-ref>,该节点有一个必填的属性ref,值为我们定义的<appender>节点的name属性的值。
介绍了根节点的三个主要的子节点，下面再介绍两个不那么重要但可以了解的子节点：
好了，介绍了上边的节点我们就已经可以搭建一个简单的配置文件框架了，如下：
<?xml version="1.0" encoding="UTF-8"?>
<!-- 一般根节点不需要写属性了，使用默认的就好 -->
<configuration>
<contextName>demo</contextName>
<!-- 该变量代表日志文件存放的目录名 -->
<property name="log.dir" value="logs"/>
<!-- 该变量代表日志文件名 -->
<property name="log.appname" value="eran"/>
<!--定义一个将日志输出到控制台的appender，名称为STDOUT -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<!-- 内容待定 -->
</appender>
<!--定义一个将日志输出到文件的appender，名称为FILE_LOG -->
<appender name="FILE_LOG" class="ch.qos.logback.core.FileAppender">
<!-- 内容待定 -->
</appender>
<!-- 指定com.demo包下的日志打印级别为INFO，但是由于没有引用appender，所以该logger不会打印日志信息，日志信息向上传递 -->
<logger name="com.demo" level="INFO"/>
<!-- 指定最基础的日志输出级别为DEBUG，并且绑定了名为STDOUT的appender，表示将日志信息输出到控制台 -->
<root level="debug">
<appender-ref ref="STDOUT" />
</root>
</configuration>
上面搭建了框架，定义了一个输出到控制台的ConsoleAppender以及输出到文件的FileAppender，下面来细说这两个最基本的日志策略，并介绍最常用的滚动文件策略的RollingFileAppender，这三种类型的日志策略足够我们的日常使用。
输出到控制台的ConsoleAppender的介绍：
先给出一个demo：
<!--定义一个将日志输出到控制台的appender，名称为STDOUT -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>[Eran]%date [%thread %line] %level >> %msg >> %logger{10}%n</pattern>
</encoder>
</appender>
ConsoleAppender的功能是将日志输出到控制台，有一个<encoder>节点用来指定日志的输出格式，在较早以前的版本还有一个<layout>节点也是相同的作用，但是官方推荐使用encoder节点，所以这里我们介绍encoder节点即可。
<encoder>节点介绍
该节点主要做两件事：
该节点的子节点<pattern>作用就是定义日志的格式，即定义一条日志信息包含哪些内容，例如当前时间，在代码中的行数线程名等。需要哪些内容由我们自己定义，按照%+转换符的格式定义，下面列出常用的转换符：
介绍了常用的转换符，我们再看看上边的例子中我们定义的格式：
<pattern>[Eran]%date [%thread %line] %level >> %msg >> %logger{10}%n</pattern>
日志的格式一目了然，可以看出我们在最前面加了[eran]的字符串，这里是我个人的使用习惯，一般将项目名统一展现在日志前边，而且在每个转换符之间加了空格，这更便于我们查看日志，并且使用了>>字符串来将%msg分割开来，更便于我们找到日志信息中我们关注的内容，这些东西大家可以自己按照自己的喜好来。
输出到文件的FileAppender
先给出一个demo：
<!--定义一个将日志输出到文件的appender，名称为FILE_LOG -->
<appender name="FILE_LOG" class="ch.qos.logback.core.FileAppender">
<file>D:/test.log</file>
<append>true</append>
<encoder>
<pattern>[Eran]%date [%thread %line] %level >> %msg >> %logger{10}%n</pattern>
</encoder>
</appender>
FileAppender表示将日志输出到文件，常用几个子节点：
显而易见，样例中我们的日志策略表示，每次将日志信息追加到D:/test.log的文件中。
滚动文件策略RollingFileAppender介绍
按时间滚动TimeBasedRollingPolicy
demo如下：
<appender name="ROL-FILE-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!--滚动策略，按照时间滚动 TimeBasedRollingPolicy-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>D:/logs/test.%d{yyyy-MM-dd}.log</fileNamePattern>
<!-- 只保留近七天的日志 -->
<maxHistory>7</maxHistory>
<!-- 用来指定日志文件的上限大小，那么到了这个值，就会删除旧的日志 -->
<totalSizeCap>1GB</totalSizeCap>
</rollingPolicy>
<encoder>
<pattern>[Eran]%date [%thread %line] %level >> %msg >> %logger{10}%n</pattern>
</encoder>
</appender>
RollingFileAppender是非常常用的一种日志类型，表示滚动纪录文件，先将日志记录到指定文件，当符合某种条件时，将日志记录到其他文件,常用的子节点：
以上就是关于RollingFileAppender的常用介绍，上面的demo的配置也基本满足了我们按照时间滚动TimeBasedRollingPolicy生成日志的要求，下面再介绍一种常用的滚动类型
SizeAndTimeBasedRollingPolicy,即按照时间和大小来滚动。
按时间和大小滚动
SizeAndTimeBasedRollingPolicy
demo如下：
<appender name="ROL-SIZE-FILE-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>D:/logs/test.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<!-- 单个文件的最大内存 -->
<maxFileSize>100MB</maxFileSize>
<!-- 只保留近七天的日志 -->
<maxHistory>7</maxHistory>
<!-- 用来指定日志文件的上限大小，那么到了这个值，就会删除旧的日志 -->
<totalSizeCap>1GB</totalSizeCap>
</rollingPolicy>
<encoder>
<pattern>[Eran]%date [%thread %line] %level >> %msg >> %logger{10}%n</pattern>
</encoder>
</appender>
仔细观察上边demo中的<fileNamePattern>会发现比TimeBasedRollingPolicy中定义的<fileNamePattern>多了.%i的字符，这个很关键，在
SizeAndTimeBasedRollingPolicy中是必不可少的。
上边的demo中多了一个<maxFileSize>节点，这里介绍下，其他的节点上边已经解释过，这里就不再赘述。
<maxFileSize>：表示单个文件占用的最大内存大小，当某个文件超过这个值，就会触发滚动策略，产生一个新的日志文件。
日志过滤
级别介绍
在说级别过滤之前，先介绍一下日志的级别信息：
上述级别从上到下由低到高，我们开发测试一般输出DEBUG级别的日志，生产环境配置只输出INFO级别甚至只输出ERROR级别的日志，这个根据情况而定，很灵活。
过滤节点<filter>介绍
过滤器通常配置在Appender中，一个Appender可以配置一个或者多个过滤器，有多个过滤器时按照配置顺序依次执行，当然也可以不配置，其实大多数情况下我们都不需要配置，但是有的情况下又必须配置，所以这里也介绍下常用的也是笔者曾经使用过的两种过率机制：级别过滤器LevelFilter和临界值过滤器ThresholdFilter。
在此之前先说下<filter>的概念，首先一个过滤器<filter>的所有返回值有三个，每个过滤器都只返回下面中的某一个值：
级别过滤器LevelFilter
过滤条件：只处理INFO级别的日志，格式如下：
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
就如上边的demo中的配置一样，设置了级别为INFO,满足的日志返回ACCEPT即立即处理，不满足条件的日志则返回DENY即丢弃掉，这样经过这一个过滤器就只有INFO级别的日志会被打印出输出。
临界值过滤器ThresholdFilter
过滤条件：只处理INFO级别之上的日志，格式如下：
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>INFO</level>
</filter>
当日志级别等于或高于临界值时，过滤器返回NEUTRAL,当日志级别低于临界值时，返回DENY。
带过滤器的<Appender>
下面给出一个带过滤器的<Appender>:
<appender name="ROL-SIZE-FILE-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>D:/logs/test.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<!-- 单个文件的最大内存 -->
<maxFileSize>100MB</maxFileSize>
<!-- 只保留近七天的日志 -->
<maxHistory>7</maxHistory>
<!-- 用来指定日志文件的上限大小，那么到了这个值，就会删除旧的日志 -->
<totalSizeCap>1GB</totalSizeCap>
</rollingPolicy>
<encoder>
<pattern>[Eran]%date [%thread %line] %level >> %msg >> %logger{10}%n</pattern>
</encoder>
<!-- 只处理INFO级别以及之上的日志 -->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>INFO</level>
</filter>
<!-- 只处理INFO级别的日志 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
上边的demo中,我们给按时间和大小滚动
SizeAndTimeBasedRollingPolicy的滚动类型加上了过滤条件。
异步写入日志AsyncAppender
都知道，我们的日志语句是嵌入在程序内部，如果写入日志以及程序执行的处于一个串行的状态，那么日志的记录就必然会阻碍程序的执行，加长程序的响应时间，无疑是一种极为损耗效率的方式，所以实际的项目中我们的日志记录一般都用异步的方式来记录，这样就和主程序形成一种并行的状态，不会影响我们程序的运行，这也是我们性能调优需要注意的一个点。
AsyncAppender并不处理日志，只是将日志缓冲到一个BlockingQueue里面去，并在内部创建一个工作线程从队列头部获取日志，之后将获取的日志循环记录到附加的其他appender上去，从而达到不阻塞主线程的效果。因此AsynAppender仅仅充当事件转发器，必须引用另一个appender来写日志。
<appender name ="ASYNC" class= "ch.qos.logback.classic.AsyncAppender">
<!-- 不丢失日志.默认的,如果队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 -->
<discardingThreshold >0</discardingThreshold>
<!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
<queueSize>512</queueSize>
<!-- 添加附加的appender,最多只能添加一个 -->
<appender-ref ref ="FILE_LOG"/>
</appender>
常用节点：
<logger>和<root>节点介绍
上边花费了很长的篇幅介绍了<appender>的相关内容，现在来详细介绍下<logger>节点以及<root>节点的相关内容。
上文已经简单介绍了<logger>节点的属性以及子节点，这里我们就举例来说明在logback-spring.xml文件中，该节点到底扮演怎样的角色，以及他的运行原理，看下边的demo：
首先在这里给出项目结构：
下面定义两个<logger>以及<root>：
<!-- logger1 -->
<logger name="com.example" level="ERROR">
<appender-ref ref="STDOUT" />
</logger>
<!-- logger2 -->
<logger name="com.example.demo.controller" level="debug">
<appender-ref ref="STDOUT" />
</logger>
<!-- 指定最基础的日志输出级别为DEBUG，并且绑定了名为STDOUT的appender，表示将日志信息输出到控制台 -->
<root level="INFO">
<appender-ref ref="STDOUT" />
</root>
当存在多个<logger>时，会有父级子级的概念，日志的处理流程是先子级再父级，当然<root>是最高级别，怎样区分级别大小呢，根据name属性指定的包名来判断，包名级别越高则<logger>的级别越高，跟我们定义<logger>的顺序无关。
上边我们定义了logger1和logger2，很明显看出logger1是logger2的父级，以本例给出多个<logger>与<root>之间的执行流程图：
流程图看着一目了然，这里就不再赘述，只是在实际的项目中我们一般都不让<logger>输出日志，统一放在<root>节点中输出，所以一般不给<logger>节点添加<appender>，当然这个按实际需要可以灵活配置。
配置profile
profile即根据不同的环境使用不同的日志策略，这里举例开发和生产环境：
<!-- 开发环境输出到控制台 -->
<springProfile name="dev">
<root level="INFO">
<appender-ref ref="STDOUT" />
</root>
</springProfile>
<!-- 生产环境输出到文件 -->
<springProfile name="prod">
<root level="INFO">
<appender-ref ref="FILE_LOG" />
</root>
</springProfile>
可以看到我们只需要在<root>节点的外边再套一层<springProfile>就可以了，并且指定name属性的值，在配置文件里边配置好之后,怎么启用，这里介绍两种方式：
java -jar xxx.jar --spring.profiles.active=prod
spring.profiles.active=prod
整合
最后将所有的模块整合在一起形成一个完整的配置文件：
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!--定义一个将日志输出到控制台的appender，名称为STDOUT -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>[%contextName]%date [%thread %line] %level >> %msg >> %logger{10}%n</pattern>
</encoder>
</appender>
<!--定义一个将日志输出到文件的appender，名称为FILE_LOG -->
<appender name="FILE_LOG" class="ch.qos.logback.core.FileAppender">
<file>D:/test.log</file>
<append>true</append>
<encoder>
<pattern>[Eran]%date [%thread %line] %level >> %msg >> %logger{10}%n</pattern>
</encoder>
</appender>
<!-- 按时间滚动产生日志文件 -->
<appender name="ROL-FILE-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!--滚动策略，按照时间滚动 TimeBasedRollingPolicy-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>D:/logs/test.%d{yyyy-MM-dd}.log</fileNamePattern>
<!-- 只保留近七天的日志 -->
<maxHistory>7</maxHistory>
<!-- 用来指定日志文件的上限大小，那么到了这个值，就会删除旧的日志 -->
<totalSizeCap>1GB</totalSizeCap>
</rollingPolicy>
<encoder>
<pattern>[Eran]%date [%thread %line] %level >> %msg >> %logger{10}%n</pattern>
</encoder>
</appender>
<!-- 按时间和文件大小滚动产生日志文件 -->
<appender name="ROL-SIZE-FILE-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>D:/logs/test.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<!-- 单个文件的最大内存 -->
<maxFileSize>100MB</maxFileSize>
<!-- 只保留近七天的日志 -->
<maxHistory>7</maxHistory>
<!-- 用来指定日志文件的上限大小，那么到了这个值，就会删除旧的日志 -->
<totalSizeCap>1GB</totalSizeCap>
</rollingPolicy>
<encoder>
<pattern>[Eran]%date [%thread %line] %level >> %msg >> %logger{10}%n</pattern>
</encoder>
<!-- 只处理INFO级别以及之上的日志 -->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>INFO</level>
</filter>
<!-- 只处理INFO级别的日志 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 异步写入日志 -->
<appender name ="ASYNC" class= "ch.qos.logback.classic.AsyncAppender">
<!-- 不丢失日志.默认的,如果队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 -->
<discardingThreshold >0</discardingThreshold>
<!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
<queueSize>512</queueSize>
<!-- 添加附加的appender,最多只能添加一个 -->
<appender-ref ref ="FILE_LOG"/>
</appender>
<!-- 指定com.demo包下的日志打印级别为DEBUG，但是由于没有引用appender，所以该logger不会打印日志信息，日志信息向上传递 -->
<logger name="com.example" level="DEBUG"></logger>
<!-- 这里的logger根据需要自己灵活配置 ，我这里只是给出一个demo-->
<!-- 指定开发环境基础的日志输出级别为DEBUG，并且绑定了名为STDOUT的appender，表示将日志信息输出到控制台 -->
<springProfile name="dev">
<root level="DEBUG">
<appender-ref ref="STDOUT" />
</root>
</springProfile>
<!-- 指定生产环境基础的日志输出级别为INFO，并且绑定了名为ASYNC的appender，表示将日志信息异步输出到文件 -->
<springProfile name="prod">
<root level="INFO">
<appender-ref ref="ASYNC" />
</root>
</springProfile>
</configuration>
终于到最后一步了，上边介绍了怎么配置logback-spring.xml配置文件，下面介绍怎么在项目中引入日志对象，以及怎么使用它输出日志，直接上代码：
package com.example.demo.controller;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class TestLog {
private final static Logger log = LoggerFactory.getLogger(TestLog.class);
@RequestMapping(value="/log",method=RequestMethod.GET)
public void testLog() {
log.trace("trace级别的日志");
log.debug("debug级别日志");
log.info("info级别日志");
log.warn("warn级别的日志");
log.error("error级别日志");
}
}
在每一个需要使用日志对象的方法里边都要定义一次private final static Logger log = LoggerFactory.getLogger(xxx.class);其中xxx代指当前类名，如果觉得这样很麻烦，也可以通过@Slf4j注解的方式注入，但是这种方式需要添加pom依赖并且需要安装lombok插件，这里就不概述了，需要了解的朋友可以自己google。
京公网安备 11010802035086号