Spring Boot学习笔记（七）——日志管理篇

---

前提

这篇博文是这套Spring Boot学习笔记的第七篇——日志管理篇，主要内容包含如何编写logback配置文件，以及如何调用日志框架。如果需要了解有关Spring Boot的综述信息或博文的索引信息，请移步：
《综述篇》

---

日志配置文件的内容

其实写过log4J之类的日志框架的配置文件之后，你会发现这些配置的内容都大同小异，作用无外乎理清以下内容：

• 日志的输出分为两个部分
  • 在控制台上
  • 在日志文件中
• 配置文件的路径及名称规则
• 追加器(Appender)的滚动规则
  • 按大小滚动
  • 按时间滚动
• 日志输出的级别(Info、Warn、Error、Fatal)

---

Logback配置说明

由于配置属性众多，如果一一说明会比较复杂，层级关系也不好说明，所以直接贴出代码，说明都在注释中。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- %m输出的信息, %p日志级别, %t线程名, %d日期, %c类的全名, %i索引 -->
    <!-- appender是configuration的子节点,是负责写日志的组件 -->
    <!-- ConsoleAppender把日志输出到控制台 -->
    <!--    <property name="CONSOLE_LOG_PATTERN" -->
    <!--               value="%date{yyyy-MM-dd HH:mm:ss} | %highlight(%-5level) | %boldYellow(%thread) | %boldGreen(%logger) | %msg%n"/> -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <!--<pattern>${CONSOLE_LOG_PATTERN}</pattern> -->
            <pattern>%date{yyyy-MM-dd HH:mm:ss} %highlight(%-5level) (%file:%line\)- %m%n</pattern>
            <!-- 控制台也要使用utf-8，不要使用gbk -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- RollingFileAppender:滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->
    <!-- 1.先按日期存日志，日期变了，将前一天的日志文件名重命名为xxx%日期%索引，新的日志仍然是sys.log -->
    <!-- 2.如果日期没有变化，但是当前日志文件的大小超过1kb时，对当前日志进行分割 重名名 -->
    <appender name="syslog" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>logs/sys.log</File>
        <!-- rollingPolicy:当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。 -->  
        <!-- TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 活动文件的名字会根据fileNamePattern的值，每隔一段时间改变一次 -->  
            <!-- 文件名：log/sys.2017-12-05.0.log -->
            <fileNamePattern>logs/sys.%d.%i.log</fileNamePattern>
            <!-- 每产生一个日志文件，该日志文件的保存期限为30天 -->
            <maxHistory>30</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy  class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">      
                <!-- maxFileSize:这是活动文件的大小，默认值是10MB,本篇设置为1KB，只是为了演示 -->    
                <maxFileSize>10MB</maxFileSize>      
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>      
            <!-- pattern节点，用来设置日志的输入格式 -->  
            <pattern>      
                %d %p (%file:%line\)- %m%n    
            </pattern>      
            <!-- 记录日志的编码 -->  
            <charset>UTF-8</charset> <!-- 此处设置字符集 -->     
        </encoder>
    </appender>
    <!-- 控制台日志输出级别 -->
    <root level="info">
        <appender-ref ref="STDOUT" />
    </root>
    <!-- 指定项目中某个包，当有日志操作行为时的日志记录级别 -->  
    <!-- com.implementist.artanis为根包，也就是只要是发生在这个根包下面的所有日志操作行为的权限都是DEBUG -->
    <!-- 级别依次为【从高到低】：FATAL > ERROR > WARN > INFO > DEBUG > TRACE  -->  
    <logger name="com.implementist.demo" level="DEBUG">
        <appender-ref ref="syslog" />      
    </logger>
</configuration>

---

两个需要注意的属性

在上述的配置信息中，需要注意的是<File>和<fileNamePattern>这两个属性，文件路径有几种不同的情况：

• logs/：在工程的相对路径中创建logs文件夹，并在其下生成日志文件。经过测试，使用JAR包启动工程时，会在其同级目录生成logs文件夹。
• /logs/：在系统的相对路径中创建logs文件夹，并在其下生成日志文件。此种方法在实际开发和部署环境中没有问题，但是会导致Travis CI持续集成时无法创建logs文件，进而导致整个build失败。

---

为工程引用配置

这个在Spring Boot工程中很简单

• 将上述配置文件命名为logback-boot.xml，放在src/main/resources文件夹中。
• 在application.yml配置文件中添加以下内容：

logging:
  config: classpath:logback-boot.xml

---

输出日志

其实在前面的Lombok那篇博文中已经写过了，我们可以通过给类上面加一个@Slf4j注解，就可以直接调用log变量进行日志输出。例如：

@Slf4j
public class TestClass {
	public void anyMethod(){
		...
		log.info("Some log message of info level");
		log.debug("Some log message of debug level");
		log.warn("Some log message of warn level");
		log.error("Some log message of error level");
		...
	}
}

---

后记

日志配置方面的知识比较少，基本上都是直接Copy一份配置信息然后自己改一改就能用了。但是日志输出方面的格式和规约也很重要，要作为一个成熟的软件工程师还是要学好如何优雅地打日志的，后面学习了之后再做总结。