# 前言

今天来介绍下 Spring Boot 如何配置日志 logback, 我刚学习的时候，是带着下面几个问题来查资料的，你呢

如何引入日志？
日志输出格式以及输出方式如何配置？
代码中如何使用？

# 正文

Spring Boot 在所有内部日志中使用 Commons Logging，但是默认配置也提供了对常用日志的支持，如：Java Util Logging，Log4J, Log4J2 和 Logback。每种 Logger 都可以通过配置使用控制台或者文件输出日志内容。

# 默认日志 Logback

SLF4J——Simple Logging Facade For Java，它是一个针对于各类 Java 日志框架的统一 Facade 抽象。Java 日志框架众多 —— 常用的有 java.util.logging , log4j , logback ， commons-logging , Spring 框架使用的是 Jakarta Commons Logging API (JCL)。而 SLF4J 定义了统一的日志抽象接口，而真正的日志实现则是在运行时决定的 —— 它提供了各类日志框架的 binding。

Logback 是 log4j 框架的作者开发的新一代日志框架，它效率更高、能够适应诸多的运行环境，同时天然支持 SLF4J。

默认情况下，Spring Boot 会用 Logback 来记录日志，并用 INFO 级别输出到控制台。在运行应用程序和其他例子时，你应该已经看到很多 INFO 级别的日志了。

从上图可以看到，日志输出内容元素具体如下：

时间日期：精确到毫秒
日志级别：ERROR, WARN, INFO, DEBUG or TRACE
进程 ID
分隔符：--- 标识实际日志的开始
线程名：方括号括起来（可能会截断控制台输出）
Logger 名：通常使用源代码的类名
日志内容

# 添加日志依赖

假如 maven 依赖中添加了 spring-boot-starter-logging：

	<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-logging</artifactId>
	</dependency>

那么，我们的 Spring Boot 应用将自动使用 logback 作为应用日志框架，Spring Boot 启动的时候，由 org.springframework.boot.logging.Logging-Application-Listener 根据情况初始化并使用。

但是呢，实际开发中我们不需要直接添加该依赖，你会发现 spring-boot-starter 其中包含了 spring-boot-starter-logging，该依赖内容就是 Spring Boot 默认的日志框架 logback。而博主这次项目的例子是基于上一篇的，工程中有用到了 Thymeleaf，而 Thymeleaf 依赖包含了 spring-boot-starter，最终我只要引入 Thymeleaf 即可。

	<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-thymeleaf</artifactId>
	</dependency>

具体可以看该图

# 默认配置属性支持

Spring Boot 为我们提供了很多默认的日志配置，所以，只要将 spring-boot-starter-logging 作为依赖加入到当前应用的 classpath，则 “开箱即用”。
下面介绍几种在 application.properties 就可以配置的日志相关属性。

# 控制台输出

日志级别从低到高分为 TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为 WARN，则低于 WARN 的信息都不会输出。
Spring Boot 中默认配置 ERROR 、 WARN 和 INFO 级别的日志输出到控制台。您还可以通过启动您的应用程序–debug 标志来启用 “调试” 模式（开发的时候推荐开启）, 以下两种方式皆可：

在运行命令后加入 --debug 标志，如： $ java -jar springTest.jar --debug
在 application.properties 中配置 debug=true ，该属性置为 true 的时候，核心 Logger（包含嵌入式容器、hibernate、spring）会输出更多内容，但是你自己应用的日志并不会输出为 DEBUG 级别。

# 文件输出

默认情况下，Spring Boot 将日志输出到控制台，不会写到日志文件。如果要编写除控制台输出之外的日志文件，则需在 application.properties 中设置 logging.file 或 logging.path 属性。

logging.file，设置文件，可以是绝对路径，也可以是相对路径。如： logging.file=my.log
logging.path，设置目录，会在该目录下创建 spring.log 文件，并写入日志内容，如： logging.path=/var/log

如果只配置 logging.file，会在项目的当前路径下生成一个 xxx.log 日志文件。
如果只配置 logging.path，在 /var/log 文件夹生成一个日志文件为 spring.log

注：二者不能同时使用，如若同时使用，则只有 logging.file 生效

默认情况下，日志文件的大小达到 10MB 时会切分一次，产生新的日志文件，默认级别为：ERROR、WARN、INFO

# 级别控制

所有支持的日志记录系统都可以在 Spring 环境中设置记录级别（例如在 application.properties 中）
格式为：’logging.level.* = LEVEL’

logging.level ：日志级别控制前缀， * 为包名或 Logger 名
LEVEL ：选项 TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF

举例：

logging.level.com.dudu=DEBUG ： com.dudu 包下所有 class 以 DEBUG 级别输出
logging.level.root=WARN ：root 日志以 WARN 级别输出

# 自定义日志配置

由于日志服务一般都在 ApplicationContext 创建前就初始化了，它并不是必须通过 Spring 的配置文件控制。因此通过系统属性和传统的 Spring Boot 外部配置文件依然可以很好的支持日志控制和管理。

根据不同的日志系统，你可以按如下规则组织配置文件名，就能被正确加载：

Logback： logback-spring.xml , logback-spring.groovy , logback.xml , logback.groovy
Log4j： log4j-spring.properties , log4j-spring.xml , log4j.properties , log4j.xml
Log4j2： log4j2-spring.xml , log4j2.xml
JDK (Java Util Logging)： logging.properties

Spring Boot 官方推荐优先使用带有 -spring 的文件名作为你的日志配置（如使用 logback-spring.xml ，而不是 logback.xml ），命名为 logback-spring.xml 的日志配置文件，spring boot 可以为它添加一些 spring boot 特有的配置项（下面会提到）。

上面是默认的命名规则，并且放在 src/main/resources 下面即可。

如果你即想完全掌控日志配置，但又不想用 logback.xml 作为 Logback 配置的名字，可以在 application.properties 配置文件里面通过 logging.config 属性指定自定义的名字：

logging.config=classpath:logging-config.xml

虽然一般并不需要改变配置文件的名字，但是如果你想针对不同运行时 Profile 使用不同的日
志配置，这个功能会很有用。

下面我们来看看一个普通的 logback-spring.xml 例子

	<?xml version="1.0" encoding="UTF-8"?>
	<configuration scan="true" scanPeriod="60 seconds" debug="false">
	<contextName>logback</contextName>
	<property name="log.path" value="/Users/tengjun/Documents/log" />
	<!--输出到控制台-->
	<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
	<!-- <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
	<level>ERROR</level>
	</filter>-->
	<encoder>
	<pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
	</encoder>
	</appender>

	<!--输出到文件-->
	<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
	<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
	<fileNamePattern>${log.path}/logback.%d{yyyy-MM-dd}.log</fileNamePattern>
	</rollingPolicy>
	<encoder>
	<pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
	</encoder>
	</appender>

	<root level="info">
	<appender-ref ref="console" />
	<appender-ref ref="file" />
	</root>

	<!-- logback为java中的包 -->
	<logger name="com.dudu.controller"/>
	<!--logback.LogbackDemo：类的全路径 -->
	<logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">
	<appender-ref ref="console"/>
	</logger>
	</configuration>

根节点 <configuration> 包含的属性

scan: 当此属性设置为 true 时，配置文件如果发生改变，将会被重新加载，默认值为 true。
scanPeriod: 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当 scan 为 true 时，此属性生效。默认的时间间隔为 1 分钟。
debug: 当此属性设置为 true 时，将打印出 logback 内部日志信息，实时查看 logback 运行状态。默认值为 false。

根节点 <configuration> 的子节点：
<configuration> 下面一共有 2 个属性，3 个子节点，分别是：

属性一：设置上下文名称 <contextName>
每个 logger 都关联到 logger 上下文，默认上下文名称为 “default”。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改，可以通过 % contextName 来打印日志上下文名称。

<contextName>logback</contextName>

属性二：设置变量 <property>
用来定义变量值的标签，有两个属性，name 和 value；其中 name 的值是变量的名称，value 的值时变量定义的值。通过定义的值会被插入到 logger 上下文中。定义变量后，可以使 “${}” 来使用变量。

<property name="log.path" value="/Users/tengjun/Documents/log" />

子节点一 <appender>
appender 用来格式化日志输出节点，有俩个属性 name 和 class，class 用来指定哪种输出策略，常用就是控制台输出策略和文件输出策略。

##### 控制台输出 ConsoleAppender：

	<!--输出到控制台-->
	<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
	<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
	<level>ERROR</level>
	</filter>
	<encoder>
	<pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
	</encoder>
	</appender>

<encoder> 表示对日志进行编码：

%d{HH: mm:ss.SSS} —— 日志输出时间
%thread —— 输出日志的进程名字，这在 Web 应用以及异步任务处理中很有用
%-5level —— 日志级别，并且使用 5 个字符靠左对齐
%logger{36} —— 日志输出者的名字
%msg —— 日志消息
%n —— 平台的换行符

ThresholdFilter 为系统定义的拦截器，例如我们用 ThresholdFilter 来过滤掉 ERROR 级别以下的日志不输出到文件中。如果不用记得注释掉，不然你控制台会发现没日志～

输出到文件 RollingFileAppender
另一种常见的日志输出到文件，随着应用的运行时间越来越长，日志也会增长的越来越多，将他们输出到同一个文件并非一个好办法。 RollingFileAppender 用于切分文件日志：

	<!--输出到文件-->
	<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
	<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
	<fileNamePattern>${log.path}/logback.%d{yyyy-MM-dd}.log</fileNamePattern>
	<maxHistory>30</maxHistory>
	<totalSizeCap>1GB</totalSizeCap>
	</rollingPolicy>
	<encoder>
	<pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
	</encoder>
	</appender>

其中重要的是 rollingPolicy 的定义，上例中 <fileNamePattern>${log.path}/logback.%d{yyyy-MM-dd}.log</fileNamePattern> 定义了日志的切分方式 —— 把每一天的日志归档到一个文件中， <maxHistory>30</maxHistory> 表示只保留最近 30 天的日志，以防止日志填满整个磁盘空间。同理，可以使用 %d{yyyy-MM-dd_HH-mm} 来定义精确到分的日志切分方式。 <totalSizeCap>1GB</totalSizeCap> 用来指定日志文件的上限大小，例如设置为 1GB 的话，那么到了这个值，就会删除旧的日志。

补：如果你想把日志直接放到当前项目下，把 ${log.path}/ 去掉即可。

logback 每天生成和大小生成冲突的问题可以看这个解答：传送门

子节点二 <root>
root 节点是必选节点，用来指定最基础的日志输出级别，只有一个 level 属性。

level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为 INHERITED 或者同义词 NULL。
默认是 DEBUG。
可以包含零个或多个元素，标识这个 appender 将会添加到这个 logger。

	<root level="debug">
	<appender-ref ref="console" />
	<appender-ref ref="file" />
	</root>

子节点三 <logger>
<logger> 用来设置某一个包或者具体的某一个类的日志打印级别、以及指定 <appender> 。 <logger> 仅有一个 name 属性，一个可选的 level 和一个可选的 addtivity 属性。

name : 用来指定受此 logger 约束的某一个包或者具体的某一个类。
level : 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值 INHERITED 或者同义词 NULL，代表强制执行上级的级别。如果未设置此属性，那么当前 logger 将会继承上级的级别。
addtivity : 是否向上级 logger 传递打印信息。默认是 true。

logger 在实际使用的时候有两种情况
先来看一看代码中如何使用

	package com.dudu.controller;
	@Controller
	public class LearnController {
	private Logger logger = LoggerFactory.getLogger(this.getClass());

	@RequestMapping(value = "/login",method = RequestMethod.POST)
	@ResponseBody
	public Map<String,Object> login(HttpServletRequest request, HttpServletResponse response){
	// 日志级别从低到高分为 TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为 WARN，则低于 WARN 的信息都不会输出。
	logger.trace("日志输出 trace");
	logger.debug("日志输出 debug");
	logger.info("日志输出 info");
	logger.warn("日志输出 warn");
	logger.error("日志输出 error");
	Map<String,Object> map =new HashMap<String,Object>();
	String userName=request.getParameter("userName");
	String password=request.getParameter("password");
	if(!userName.equals("") && password!=""){
	User user =new User(userName,password);
	request.getSession().setAttribute("user",user);
	map.put("result","1");
	}else{
	map.put("result","0");
	}
	return map;
	}
	}

这是一个登录的判断的方法，我们引入日志，并且打印不同级别的日志，然后根据 logback-spring.xml 中的配置来看看打印了哪几种级别日志。

第一种：带有 logger 的配置，不指定级别，不指定 appender

<logger name="com.dudu.controller"/>

<logger name="com.dudu.controller" /> 将控制 controller 包下的所有类的日志的打印，但是并没用设置打印级别，所以继承他的上级的日志级别 “info”；
没有设置 addtivity，默认为 true，将此 logger 的打印信息向上级传递；
没有设置 appender，此 logger 本身不打印任何信息。
<root level="info"> 将 root 的打印级别设置为 “info”，指定了名字为 “console” 的 appender。

当执行 com.dudu.controller.LearnController 类的 login 方法时，LearnController 在包 com.dudu.controller 中，所以首先执行 <logger name="com.dudu.controller"/> ，将级别为 “info” 及大于 “info” 的日志信息传递给 root，本身并不打印；
root 接到下级传递的信息，交给已经配置好的名为 “console” 的 appender 处理，“console” appender 将信息打印到控制台；

打印结果如下：

16:00:17.407 logback [http-nio-8080-exec-8] INFO  com.dudu.controller.LearnController - 日志输出 info

16:00:17.408 logback [http-nio-8080-exec-8] WARN  com.dudu.controller.LearnController - 日志输出 warn

16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.dudu.controller.LearnController - 日志输出 error

第二种：带有多个 logger 的配置，指定级别，指定 appender

	<!--logback.LogbackDemo：类的全路径 -->
	<logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">
	<appender-ref ref="console"/>
	</logger>

控制 com.dudu.controller.LearnController 类的日志打印，打印级别为 “WARN”;
additivity 属性为 false，表示此 logger 的打印信息不再向上级传递；
指定了名字为 “console” 的 appender;

这时候执行 com.dudu.controller.LearnController 类的 login 方法时，先执行 <logger name="com.dudu.controller.LearnController" level="WARN" additivity="false"> ,
将级别为 “WARN” 及大于 “WARN” 的日志信息交给此 logger 指定的名为 “console” 的 appender 处理，在控制台中打出日志，不再向上级 root 传递打印信息。
打印结果如下：

16:00:17.408 logback [http-nio-8080-exec-8] WARN  com.dudu.controller.LearnController - 日志输出 warn

16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.dudu.controller.LearnController - 日志输出 error

当然如果你把 additivity=”false” 改成 additivity=”true” 的话，就会打印两次，因为打印信息向上级传递，logger 本身打印一次，root 接到后又打印一次。

注：使用 mybatis 的时候，sql 语句是 debug 下才会打印，而这里我们只配置了 info，所以想要查看 sql 语句的话，有以下两种操作：

第一种把 <root level="info"> 改成 <root level="DEBUG"> 这样就会打印 sql，不过这样日志那边会出现很多其他消息。
第二种就是单独给 dao 下目录配置 debug 模式，代码如下，这样配置 sql 语句会打印，其他还是正常 info 级别：

	<logger name="com.dudu.dao" level="DEBUG" additivity="false">
	<appender-ref ref="console" />
	</logger>

# 多环境日志输出

据不同环境（prod: 生产环境，test: 测试环境，dev: 开发环境）来定义不同的日志输出，在 logback-spring.xml 中使用 springProfile 节点来定义，方法如下：

文件名称不是 logback.xml，想使用 spring 扩展 profile 支持，要以 logback-spring.xml 命名

	<!-- 测试环境+开发环境. 多个使用逗号隔开. -->
	<springProfile name="test,dev">
	<logger name="com.dudu.controller" level="info" />
	</springProfile>
	<!-- 生产环境. -->
	<springProfile name="prod">
	<logger name="com.dudu.controller" level="ERROR" />
	</springProfile>

可以启动服务的时候指定 profile （如不指定使用默认），如指定 prod 的方式为：
java -jar xxx.jar –spring.profiles.active=prod
关于多环境配置可以参考
Post not found: Spring Boot干货系列：（二）配置文件解析

# 总结

到此为止终于介绍完日志框架了，平时使用的时候推荐用自定义 logback-spring.xml 来配置，代码中使用日志也很简单，类里面添加 private Logger logger = LoggerFactory.getLogger(this.getClass()); 即可。

想要查看更多 Spring Boot 干货教程，可前往：Post not found: Spring Boot干货系列总纲

# 源码下载

(￣︶￣)↗[相关示例完整代码]

spring-boot