Spring Boot在所有内部日志中使用 [Commons Logging](http://commons.apache.org/proper/commons-logging/)，但是默认配置也提供了对常用日志的支持，如：[Java Util Logging](http://docs.oracle.com/javase/7/docs/api/java/util/logging/package-summary.html)，[Log4J](http://logging.apache.org/log4j/), [Log4J2](http://logging.apache.org/log4j/) 和 [Logback](http://logback.qos.ch/)。每种 Logger 都可以通过配置使用控制台或者文件输出日志内容。
> 默认情况下，SpringBoot使用Logback作为日志框架。
# 日志打印出内存地址解决
使用logback/log4j等原生的日志框架，在日志输出的时候可能会遇到一个问题：
如果被打印参数未重写 toString 方法，则打印出来的都是 XXX@xx。
一般简单的解决办法是，可以通过 JSON 把对象转成 String，如：
```java
log.info("obj = {}", JSON.toJSONString(obj));
```
这种方式显然不够优雅，而且笨拙，有一个好办法：
借助logback(log4j也有类似的功能)的MessageConverter。无侵入性的解决这个问题
1、自定义一个Layout
```java
/**
* 参数JSON格式化类
*
* @author Hollis
*/
public class ArgumentJsonFormatLayout extends MessageConverter {
@Override
public String convert(ILoggingEvent event) {
try {
return MessageFormatter.arrayFormat(event.getMessage(), Stream.of(event.getArgumentArray())
.map(JSON::toJSONString).toArray()).getMessage();
} catch (Exception e) {
return event.getMessage();
}
}
}
```
2、在logback中配置上这个Layout
```xml
<configuration>
<conversionRule conversionWord="m" converterClass="com.xx.ArgumentJsonFormatLayout"/>
</configuration>
```
然后，就可以直接使用``log.info("obj = {}",obj)``这样的形式记录日志了。
# 格式化日志
默认的日志输出如下：
```bash
2017-05-08 08:23:50.120 INFO 37397 --- [ main] org.hibernate.Version : HHH000412: Hibernate Core {4.3.11.Final}
```
输出内容元素具体如下：
* 时间日期 — 精确到毫秒
* 日志级别 — ERROR, WARN, INFO, DEBUG or TRACE
* 进程ID
* 分隔符 — --- 标识实际日志的开始
* 线程名 — 方括号括起来（可能会截断控制台输出）
* Logger名 — 通常使用源代码的类名
* 日志内容
# 控制台输出
在 Spring Boot 中默认配置了 `ERROR`、`WARN` 和 `INFO` 级别的日志输出到控制台。
我们可以通过两种方式切换至 `DEBUG` 级别：
在运行命令后加入 `--debug` 标志，如：`java -jar myapp.jar --debug`
在 `application.properties` 中配置 `debug=true`，该属性置为 `true` 的时候，核心 Logger（包含嵌入式容器、hibernate、spring）会输出更多内容，但是你自己应用的日志并不会输出为 `DEBUG` 级别。
#多彩输出
如果你的终端支持 `ANSI`，设置彩色输出会让日志更具可读性。通过在 `application.properties` 中设置 `spring.output.ansi.enabled` 参数来支持。
* NEVER：禁用ANSI-colored输出（默认项）
* DETECT：会检查终端是否支持ANSI，是的话就采用彩色输出（==推荐项==）
* ALWAYS：总是使用ANSI-colored格式输出，若终端不支持的时候，会有很多干扰信息，不推荐使用
#文件输出
Spring Boot 默认配置只会输出到控制台，并不会记录到文件中，但是我们通常生产环境使用时都需要以文件方式记录。
若要增加文件输出，需要在 `application.properties` 中配置 `logging.file` 或 `logging.path` 属性。
* logging.file，设置文件，可以是绝对路径，也可以是相对路径。如：`logging.file=my.log`
* logging.path，设置目录，会在该目录下创建spring.log文件，并写入日志内容，如：`logging.path=/var/log`
**日志文件会在10Mb大小的时候被截断，产生新的日志文件，默认级别为：ERROR、WARN、INFO**
#级别控制
在Spring Boot中只需要在 `application.properties` 中进行配置完成日志记录的级别控制。
配置格式：`logging.level.*=LEVEL`
* `logging.level`：日志级别控制前缀，`*` 为包名或Logger名
* `LEVEL`：选项TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF
举例：
* `logging.level.com.didispace=DEBUG`：则`com.didispace` 包下所有class以DEBUG级别输出
* `logging.level.root=WARN`：root日志以WARN级别输出
#自定义日志配置
由于日志服务一般都在 `ApplicationContext` 创建前就初始化了，它并不是必须通过 Spring 的配置文件控制。因此通过系统属性和传统的 Spring Boot 外部配置文件依然可以很好的支持日志控制和管理。
根据不同的日志系统，你可以按如下规则组织配置文件名，就能被正确加载：
* Logback：`logback-spring.xm`, `logback-spring.groovy`, `logback.xml`, `logback.groovy`
* Log4j：`log4j-spring.properties`, `log4j-spring.xml`, `log4j.properties`, `og4j.xml`
* Log4j2：`log4j2-spring.xml`, `log4j2.xml`
* JDK (Java Util Logging)：`logging.properties`
Spring Boot官方推荐优先使用带有 **`-spring`** 的文件名作为你的日志配置（如使用 **`logback-spring.xml`**，而不是 **`logback.xml`**）
#自定义输出格式
在 Spring Boot 中可以通过在 `application.properties` 配置如下参数控制输出格式：
* logging.pattern.console：定义输出到控制台的样式（不支持JDK Logger）
* logging.pattern.file：定义输出到文件的样式（不支持JDK Logger）
# 使用 logback 出现``LOG_PATH_IS_UNDEFINED``的问题解决
- 1、将``logback.xml``改成``logback-spring.xml``。
- 2、在``application.xxx``配置文件中增加：``logging.path``或``logging.file``日志文件路径配置。
- 3、修改``logback-spring.xml``文件，将``logPath``的``value``中改成``${LOG_PATH:-.}``，例如：
```xml
<property name="logPath" value="${LOG_PATH:-.}"></property>
```
这样 logback 会读取到 springboot application 配置文件中指定的日志目录位置。
# 贴一个目前使用的``logback-spring.xml``
```xml
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<!-- 日志地址 -->
<property name="logPath" value="${LOG_PATH:-.}"></property>
<!--配置console打印的log-->
<appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>[%date{yyyy-MM-dd HH:mm:ss}] [%-5level] [%logger:%line] --%mdc{client} %msg%n</pattern>
</layout>
</appender>
<!--自定义配置-->
<appender name="fileInfoLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<encoder>
<!--日志内容格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
<!--<pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] [%-5level] %logger{50} - %msg%n</pattern>-->
<pattern>[%date{yyyy-MM-dd HH:mm:ss}] [%-5level] [%logger:%line] --%mdc{client} %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<!--滚动策略，按天输出日志-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--设置文件保存路径，timeBasedFileNamingAndTriggeringPolicy标签时，这里的%i要加上，不然会导致运行报错-->
<fileNamePattern>${logPath}/info.%d-%i.log</fileNamePattern>
<!-- 配置日志文件不能超过2M，若超过2M，日志文件会以索引0开始，命名日志文件，例如info.2018-12-21-0.log -->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>10MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文件保留天数-->
<maxHistory>5</maxHistory>
</rollingPolicy>
</appender>
<appender name="fileErrorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
<encoder>
<pattern>[%date{yyyy-MM-dd HH:mm:ss}] [%-5level] [%logger:%line] --%mdc{client} %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<!--滚动策略 按天生成日志-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--路径-->
<fileNamePattern>${logPath}/error.%d.log</fileNamePattern>
</rollingPolicy>
</appender>
<root level="info">
<appender-ref ref="consoleLog" />
<appender-ref ref="fileInfoLog" />
<appender-ref ref="fileErrorLog" />
</root>
<!--日志指定包路径-->
<logger name="com.sherlocky" level = "INFO">
<appender-ref ref="consoleLog" />
<appender-ref ref="fileInfoLog" />
<appender-ref ref="fileErrorLog" />
</logger>
</configuration>
```
# 改良版
```xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!-- 读取系统环境属性 -->
<property name="log_path" value="${LOG_PATH:-./logs}"></property>
<!-- 读取当前应用Environment中的属性 -->
<!--
<springProperty scope="context" name="log_path" source="logging.path" defaultValue="./demo-logs"/>
-->
<springProperty scope="context" name="app_name" source="spring.application.name" defaultValue="demo"/>
<!-- 日志文件保留天数 -->
<springProperty scope="context" name="logger_max_history" source="logging.file.max-history" defaultValue="7"/>
<!-- 日志文件大小：默认50MB -->
<springProperty scope="context" name="max_file_size" source="logging.file.max-size" defaultValue="10MB"/>
<contextName>${app_name}</contextName>
<!-- Log Appender Begin -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--日志内容格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
<!--<pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] [%-5level] %logger{50} - %msg%n</pattern>-->
<pattern>#${app_name}# [%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] [%-5level] [%logger:%line] --%mdc{client} %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<springProfile name="prod">
<!--输出到文件-->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${log_path}/${app_name}/${app_name}-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<maxFileSize>${max_file_size}</maxFileSize>
<maxHistory>${logger_max_history}</maxHistory>
<totalSizeCap>1GB</totalSizeCap>
</rollingPolicy>
<encoder>
<pattern>#${app_name}# [%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] [%-5level] [%logger:%line] --%mdc{client} %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
</springProfile>
<springProfile name="test">
<!--输出到文件-->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${log_path}/${app_name}/${app_name}-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<maxFileSize>${max_file_size}</maxFileSize>
<maxHistory>${logger_max_history}</maxHistory>
<totalSizeCap>1GB</totalSizeCap>
</rollingPolicy>
<encoder>
<pattern>#${app_name}# [%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] [%-5level] [%logger:%line] --%mdc{client} %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
</springProfile>
<springProfile name="prod">
<root level="INFO">
<appender-ref ref="FILE"/>
</root>
</springProfile>
<springProfile name="test">
<root level="DEBUG">
<appender-ref ref="FILE"/>
</root>
</springProfile>
<springProfile name="dev">
<root level="DEBUG">
<appender-ref ref="STDOUT"/>
</root>
</springProfile>
</configuration>
```
# 彩色日志版
```xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!-- 读取系统环境属性 -->
<property name="log_path" value="${LOG_PATH:-./logs}"></property>
<!-- 读取当前应用Environment中的属性 -->
<!--
<springProperty scope="context" name="log_path" source="logging.path" defaultValue="./demo-logs"/>
-->
<springProperty scope="context" name="app_name" source="spring.application.name" defaultValue="demo"/>
<!-- 日志文件保留天数 -->
<springProperty scope="context" name="logger_max_history" source="logging.file.max-history" defaultValue="7"/>
<!-- 日志文件大小：默认50MB -->
<springProperty scope="context" name="max_file_size" source="logging.file.max-size" defaultValue="10MB"/>
<contextName>${app_name}</contextName>
<property name="log_pattern_old" value="#${app_name}# [%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] [%-5level] [%logger:%line] --%mdc{client} %msg%n"/>
<!-- 可参考：spring-boot.jar!/org/springframework/boot/logging/logback/defaults.xml -->
<!-- https://logback.qos.ch/manual/layouts.html#coloring 彩色日志另一种写法，举个例子
<pattern>%yellow(%date{yyyy-MM-dd HH:mm:ss}) |%highlight(%-5level) |%green(%logger:%line) |%black(%msg%n)</pattern>
-->
<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
<conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
<conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
<property name="log_pattern" value="#${app_name}# %clr([%d{yyyy-MM-dd HH:mm:ss.SSS}]){faint} [%thread] %clr([%-5level]) %clr([%-60.60logger{60}:%-3line]){cyan} --%mdc{client} %msg%n%wEx"/>
<!-- Log Appender Begin -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--日志内容格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
<!--<pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] [%-5level] %logger{50} - %msg%n</pattern>-->
<pattern>${log_pattern}</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<springProfile name="prod">
<!--输出到文件-->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${log_path}/${app_name}/${app_name}-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<maxFileSize>${max_file_size}</maxFileSize>
<maxHistory>${logger_max_history}</maxHistory>
<totalSizeCap>1GB</totalSizeCap>
</rollingPolicy>
<encoder>
<pattern>${log_pattern}</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
</springProfile>
<springProfile name="test">
<!--输出到文件-->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${log_path}/${app_name}/${app_name}-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<maxFileSize>${max_file_size}</maxFileSize>
<maxHistory>${logger_max_history}</maxHistory>
<totalSizeCap>1GB</totalSizeCap>
</rollingPolicy>
<encoder>
<pattern>${log_pattern}</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
</springProfile>
<springProfile name="prod">
<root level="INFO">
<appender-ref ref="FILE"/>
</root>
</springProfile>
<springProfile name="test">
<root level="DEBUG">
<appender-ref ref="FILE"/>
</root>
</springProfile>
<springProfile name="dev">
<root level="DEBUG">
<appender-ref ref="STDOUT"/>
</root>
</springProfile>
</configuration>
```
application.properties 样例：
```
spring.application.name=qiniu-sync-nas
# 日志配置
logging.path=D:/vfsroot/logs
logging.file.max-history=7
logging.file.max-size=10MB
# 会检查终端是否支持ANSI，是的话就采用彩色输出
spring.output.ansi.enabled=detect
```
---
旧 web 项目使用 logback 配置可参考[旧 web 项目使用 logback](/jiu-web-xiang-mu-shi-yong-logback/)
---
日志规范可参考：[惊讶！我定的日志规范被CTO在全公司推广了](https://juejin.im/post/5e01a184e51d45581e44178a)
Spring Boot学习3——日志管理
Copyright: 采用 知识共享署名4.0 国际许可协议进行许可
Links: https://halo.sherlocky.com/archives/spring-bootxue-xi-3-ri-zhi-guan-li