SpringBoot日志框架
1. 日志框架
日志框架的出现是为了更好的控制软件运行记录的信息，如果使用大量的System.out.println("")将无法有效的控制输出，市面上常见的日志框架有：
JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j…
| 日志门面(日志的抽象层) | 日志实现 |
|---|---|
SLF4j(Simple Logging Facade for Java) |
Log4j logback JUL(java.util.loggin) log4j2 |
JCL和jboss-logging的目前使用场景很少见，因此日志的门面框架基本上使用的都是slf4j，门面框架的作用类似于Java中的接口，我们无需关心使用哪种实现，只需要知道该接口的作用即可。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* SpringBoot单元测试：
* 可以在测试期间很方便的类似编码一样进行自动注入等容器的功能
*/
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBootQuickApplicationTests {
public static Logger logger = LoggerFactory.getLogger(SpringBootQuickApplicationTests.class);
@Test
public void contextLoads() {
//级别由低到高,SpringBoot默认使用INFO级别
logger.trace("I love three things in the world");
logger.debug("sun,moon,and you");
logger.info("sun for morning");
logger.warn("moon for night");
logger.error("and you forever");
}
}1.1 日志框架依赖
门面日志框架slf4j与实现框架的依赖见上图，其中由于log4j和java.util.logging日志框架比slf4j更早出现，没有根据slf4j定义的规范实现，因此需要一个适配器jar包。
1.1.1 存在多个日志实现的解决
当我们开发Web项目时，会集成SpringBoot（slf4j）、Spring（commons-logging）、Hibernate（jboss-logging）等多种框架，由于它们使用的日志框架都不同，会导致要写多个日志框架的配置文件：logback.xml、log4j.properties…，那么我们能不能把所有的日志框架使用统一的框架进行输入呢？如下图解决方案：
如上图若要将slf4j、commons-logging、log4j、java.util.logging统一使用slf4j+logback方式输出，可以使用jcl-over.slf4j.jar、log4j-over-slf4j.jar、jul-to-slf4j.jar将替换需要导入的commons-logging.jar、log4j.jar，这些jar包与被替换的jar包结构与类名一模一样，实现了“狸猫换太子”
1.1.2 SpringBoot的日志框架
SpringBoot使用关于日志的starter
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-loggingartifactId>
<version>2.0.0.RELEASEversion>
dependency>
由此可见，SpringBoot默认使用的日志框架是slf4j+logback ，且使用转换包将其他的日志都替换成了slf4j。引入的其他框架的默认日志依赖也被移除了，如：
<dependency>
<groupId>org.apache.commonsgroupId>
<artifactId>commons-dbcp2artifactId>
<version>${commons-dbcp2.version}version>
<exclusions>
<exclusion>
<artifactId>commons-loggingartifactId>
<groupId>commons-logginggroupId>
exclusion>
exclusions>
dependency>1.2 日志的配置
| logging.file | logging.path | example | Description |
|---|---|---|---|
| (none) | (none) | 只在控制台输出 | |
| 指定文件名 | (none) | spring.log | 未指定完整路径则输出到当前项目路径下spring.log文件中 |
| (none) | 指定目录 | /var/log | 输出到/var/log/spring.log文件中 |
logging.file与logging.path同时存在时，以logging.file为准
#指定com.yt包下的类日志都使用debug级别，未被指定的仍使用INFO级别
logging:
level:
com:
yt: debug
file: spring.log
path: ./config/
pattern:
console: "%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{50} - %msg%n"SpringBoot的日志默认配置在org.springframework.boot:spring-boot:2.0.0.RELEASE.jar的org.springframework.boot.logging包下，该包下有java.util.logging、log4j2和logback的默认配置，SpringBoot在未被指定配置的情况下使用的是logback。
我们还可以自定义日志配置文件，SpringBoot会加载classpath路径下的以下日志配置：
| Logging System | Customization |
|---|---|
| Logback | logback-spring.xml logback-spring.groovy logback.xml logback.groovy |
| Log4j2 | log4j2-spring.xml log4j2.xml |
| JDK (Java Util Logging) | logging.properties |
SpringBoot推荐是用*-spring.xml的命名方式进行日志配置，因为logback.xml和log4j2.xml会直接被日志框架所识别，而logback-spring.xml、log4j2-spring.xml日志框架就不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能。
为了帮助定制，yml配置文件中也会配置一些属性作为系统属性：
| Spring Environment | System Property | Comments |
|---|---|---|
| logging.exception-conversion-word | LOG_EXCEPTION_CONVERSION_WORD | 记录异常时使用的转换字 |
| logging.file | LOG_FILE | 如果已定义，则用于默认的日志配置 |
| logging.file.max-size | LOG_FILE_MAX_SIZE | 最大日志文件大小（如果启用LOG_FILE）（仅支持默认的Logback设置） |
| logging.file.max-history | LOG_FILE_MAX_HISTORY | 保留的归档日志文件的最大数量（如果启用LOG_FILE）（仅支持默认的Logback设置） |
| logging.path | LOG_PATH | 如果已定义，则用于默认的日志配置 |
| logging.pattern.console | CONSOLE_LOG_PATTERN | 在控制台上使用的日志模式（stdout）（仅支持默认的Logback设置） |
| logging.pattern.dateformat | LOG_DATEFORMAT_PATTERN | 日志日期格式的Appender模式（仅支持默认的Logback设置） |
| logging.pattern.file | FILE_LOG_PATTERN | 在文件中使用的日志模式（如果LOG_FILE已启用）（仅支持默认的Logback设置） |
| logging.pattern.level | LOG_LEVEL_PATTERN | 呈现日志级别时使用的格式（默认%5p）（仅支持默认的Logback设置） |
| PID | PID | 当前进程ID（如果可能，还没有定义为OS环境变量时发现） |
1.2.1 logback
logback日志框架默认会从类路径下试图查找logback-test.xml，如果找不到查找logback.groovy，如果找不到再查找logback.xml，如果没有查找的到配置文件，则logback将使用自动配置BasicConfiguration把日志记录输出到控制台
logback-spring.xml
<configuration scan="false" scanPeriod="60 seconds" debug="false">
<timestamp key="time" datePattern="yyyyMMdd'T'HHmmss"/>
<contextNmae>${time}contextName>
<property name="LOG_HOME" value="/var/log"/>
<property name="appName" value="spring">property>
<springProperty scope = "context" name = "hostName" source = "host.name" defaultValue = "localhost"/>
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%npattern>
layout>
appender>
<appender name="fileLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_HOME}/${appName}.logfile>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.logfileNamePattern>
<MaxHistory>365MaxHistory>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MBmaxFileSize>
timeBasedFileNamingAndTriggeringPolicy>
rollingPolicy>
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%npattern>
layout>
appender>
<logger name="com.yt" level="debug" />
<logger name="org.springframework" level="debug" additivity="false">
<appender-ref ref="stdout" />
logger>
<springProfile name="prod,!dev">
<root level="info">
<appender-ref ref="stdout" />
<appender-ref ref="fileLogAppender" />
root>
springProfile>
<springProfile name="dev">
<root level="debug">
<appender-ref ref="stdout" />
<appender-ref ref="fileLogAppender" />
root>
springProfile>
configuration>appender
1.ConsoleAppender
将日志输出到控制台，有以下子节点：
：对日志进行格式化 ：字符串 System.out 或者 System.err ，默认 System.out
2.FileAppender
将日志输出到文件中，有以下子节点：
：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值 ：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true ：对记录事件进行格式化 ：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false
3.RollingFileAppender
滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。有以下子节点：
：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值 ：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true ：对记录事件进行格式化 :当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名 : 告知 RollingFileAppender 合适激活滚动 ：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制：1.不允许文件压缩；2.不能设置file属性，必须留空。
rollingPolicy：
ch.qos.logback.core.rolling.TimeBasedRollingPolicy是最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责触发滚动。有以下子节点：
：必要节点，包含文件名及“%d”转换符，%d默认格式是 yyyy-MM-dd：按天滚动，加上%i，可以在当天滚动文件大小超过maxFileSize时，按照i进行文件滚动。RollingFileAppender 的file字节点可有可无：可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件
ch.qos.logback.core.rolling.FixedWindowRollingPolicy： 根据固定窗口算法重命名文件的滚动策略。有以下子节点：
：窗口索引最小值 ：窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12 ：必须包含“%i”，例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如，mylog%i.log.gz 或者log%i.log.zip
triggeringPolicy：
SizeBasedTriggeringPolicy：查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点：
：活动文件的大小，默认值是10MB
1.2.2 日志输出格式
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
日志输出格式：
| 转换符 | 作用 | 示例 |
|---|---|---|
| %{length} %lo{length} %logger{length} |
输出日志的logger名，可有一个整形参数，功能是缩短logger名，设置为0表示只输入logger最右边点符号之后的字符串 | %logger{50} |
| %C{length} %class{length} |
输出执行记录请求的调用者的全限定名。参数与上面的一样。尽量避免使用，除非执行速度不造成任何问题 | %C{10} |
| %contextName %cn |
输出上下文名称 | %contextName |
| %d{pattern} %date{pattern} |
输出日志打印的日期与时间，模式语法与java.text.SimpleDateFormat 兼容 | %date{yyyy-MM-dd HH:mm:ss.SSS} |
| %F %file |
输出执行记录请求的java源文件名。尽量避免使用，除非执行速度不造成任何问题 | %file |
| %L %line |
输出执行日志请求的行号尽量避免使用。除非执行速度不造成任何问题 | %line |
| %m %msg %message |
输出应用程序提供的信息 | %msg |
| %M %method |
输出执行日志请求的方法名。尽量避免使用，除非执行速度不造成任何问题 | %method |
| %n | 输出与平台无关的分行符“\n”或者“\r\n” | %n |
| %r %relative |
输出从程序启动到创建日志记录的时间，单位是毫秒 | %r |
| %t %thread |
输出产生日志的线程名 | %thread |
| %replace(p){r,t} | p 为日志内容，r 是正则表达式，将p 中符合r 的内容替换为t 例如， “%replace(%msg){‘\s’, ”}” |