spring boot中的日志入门

日志通常不会在需求阶段作为一个功能单独提出来，也不会在产品方案中看到它的细节。但是，这丝毫不影响它在任何一个系统中的重要地位。

报警系统与日志系统的关系

为了保证服务的高可用，发现问题一定要及时，定位并解决问题一定要迅速。

生产环境一旦出现问题，预警系统就会通过邮件，短信甚至电话的方式实施多维轰炸模式，确保相关负责人不会错过每一个可能的Bug。

而预警系统判断疑似Bug大部分来源于日志系统。比如说某个微服务接口由于各种原因导致频繁调用出错，此时调用段就会捕获这样的异常并打印ERROR级别的日子，当该错误日志达到一定出现次数的时候就会触发报警系统。

try {
    // 调用某服务
} catch(Exception e) {
    Logger.error("错误信息", e);
}

因此日志十分重要。

Spring Boot的默认日志

Spring Boot默认使用Logback日志系统，如果不需要更改为其他日志系统，如Log4j2等，则无需多余的配置，Logback默认将日志打印到控制台上。

要使用Logback，原则上是需要添加Maven依赖的。

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

但是由于Spring Boot项目中一般会引用spring-boot-starter或spring-boot-starter-web，这两个起步依赖中都已经包含了对spring-boot-starter-logging的依赖，所以无需额外添加依赖，配置logback-spring.xml就可以了。以logback-spring.xml命名，spring会自动识别加载。


如果要切换成Log4j2的话，就需要在pom.xml中排除Spring Boot自带的commons-logging，然后再引入log4j2的依赖，否则会导致jar包冲突。

<!--排除 commons‐logging-->
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
   <exclusions>
      <exclusion>
      <groupId>commons‐logging</groupId>
      <artifactId>commons‐logging</artifactId>
      </exclusion>
   </exclusions>
</dependency>

<!--引入log4j2 -->
<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

然后再引入log4j.properties文件就可以了。

### set log levels ###
log4j.rootLogger = debug,stdout,D,E

### 输出到控制台 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern =  %d{ABSOLUTE} ===== %5p %c{ 1 }:%L - %m%n

### 输出到日志文件 ###
#log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
#log4j.appender.D.File = logs/log.log
#log4j.appender.D.Append = true
#log4j.appender.D.Threshold = DEBUG ## 输出DEBUG级别以上的日志
#log4j.appender.D.layout = org.apache.log4j.PatternLayout
#log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

### 保存异常信息到单独文件 ###
#log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
#log4j.appender.D.File = logs/error.log ## 异常日志文件名
#log4j.appender.D.Append = true
#log4j.appender.D.Threshold = ERROR ## 只输出ERROR级别以上的日志!!!
#log4j.appender.D.layout = org.apache.log4j.PatternLayout
#log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

日志的级别

日志的级别从低到高：trace（跟踪）<debug（调试）<info（信息）<warm（警告）<error（错误），设置的级别越低，显示的日志级别的信息越多。例如如果设置的日志级别是info的话，低于info级别的trace或debug的日志都不会显示。

Spring Boot在不对日志进行任何设置的情况下，默认的日志root级别是info，即输出的是info级别及以上的日志。

用一个测试类来测试日志的输出级别：

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootCacheApplicationTests {
    private static final Logger log = LoggerFactory.getLogger(SpringbootCacheApplicationTests.class);
    
    /**
      * 测试 日志级别：
      * 级别由低到高： trace < debug < info < warm < error  设置的级别越低显示的日志信息越多。
      * 可以调整输出的日志级别，只会显示高于设置级别的日志。
      */
    @Test
    public void testLog() {
        log.trace("这是trace日志。。。");
        log.debug("这是debug日志。。。");
        // spring 默认设置的级别是info级别，没有指定级别的情况下，会使用spring默认的root级别（显示的是info级别的信息）
        log.info("这是info日志。。。");
        log.warn("这是warm日志。。。");
        log.error("这是error日志。。。");
    }     

}

测试的结果是只会输出info级别以上的日志信息（trace和debug不打印在控制台）。因此在开发环境中如果要打印SQL语句等debug调试信息的话，就要对日志级别进行设置。

日志输出信息的组成部分

1.时间日期：精确到毫秒。

2.日志级别：ERROR, WARN, INFO, DEBUG 或 TRACE。

3.分隔符：标识实际日志的开始。

4.进程ID。

5.线程名：需要用方括号括起来，不然可能会截断控制台的输出。

6.Logger的名称：通常是源代码的类名。

7.日志主要内容。

日志的配置

日志可以通过两种方式配置，一种是application.properties或application.yml文件配置（Spring Boot全局配置文件）；一种是Logback的xml文件配置。第一种方式需要把所有的日志配置写在properties或者yml文件里面，配置迁移不方便，写的感觉也有点乱，很繁杂，对log4j2的支持也不好。因此推荐使用的是第二种，配置迁移只要复制粘贴，然后改一下里面的配置就好了。

通过application.properties或application.yml文件配置。

这部分的内容就不说了，实际中用得比较少（其实是懒），如果需要的话可以到Spring Boot的官方文档中查找相关的配置：https://docs.spring.io/spring-boot/docs/2.0.0.RELEASE/reference/html/boot-features-logging.html#_environment_properties。

通过Logback的xml文件配置。

由于日志服务一般都在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目录下面即可。但是如果你想要完全掌控日志配置，但是又不想用locagback.xml作为Logback配置的名字，就需要通过logging.config属性去执行自定义的名字，例如：

logging.config=classpath:logging-config.xml

虽然一般是并不需要改变配置文件的名字，但是如果你想要针对不同运行时Profile（不同的环境，比如生产环境和开发环境的切换）使用不同的日志配置，这个功能就会很有用。

这里示例一个logback-spring.xml的配置文件的内容：

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
    <!-- 定义日志的根目录 -->
    <property name="LOG_HOME" value="/app/log" />
    <!-- 定义日志文件名称 -->
    <property name="appName" value="ll-springboot"></property>
    <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!--
        日志输出格式：
            %d表示日期时间，
            %thread表示线程名，
            %-5level：级别从左显示5个字符宽度
            %logger{50} 表示logger名字最长50个字符，否则按照句点分割。 
            %msg：日志消息，
            %n是换行符
        -->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </layout>
    </appender>

    <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->  
    <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 指定日志文件的名称 -->
        <file>${LOG_HOME}/${appName}.log</file>
        <!--
        当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
        TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。
        -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
            滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动
            %i：当文件大小超过maxFileSize时，按照i进行文件滚动
            -->
            <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!--
            可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动，
            且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。注意，删除旧文件是，
            那些为了归档而创建的目录也会被删除。
            -->
            <MaxHistory>365</MaxHistory>
            <!--
            当日志文件超过maxFileSize指定的大小是，根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的，必须配置timeBasedFileNamingAndTriggeringPolicy
            -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 日志输出格式： -->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
        </layout>
    </appender>

    <!-- 
        logger主要用于存放日志对象，也可以定义日志类型、级别
        name：表示匹配的logger类型前缀，也就是包的前半部分
        level：要记录的日志级别，包括 TRACE < DEBUG < INFO < WARN < ERROR
        additivity：作用在于children-logger是否使用 rootLogger配置的appender进行输出，
        false：表示只用当前logger的appender-ref，
        true：表示当前logger的appender-ref和rootLogger的appender-ref都有效
    -->
    <!--
        logger是记录Logger对象输出的日志级别的
        　　sercvice实现类引入日志对象可以查看方法的报错信息以及打印sql语句，public static final Logger logger = LoggerFactory.getLogger(SysUserServiceImpl.class);
   　　　生产环境：
　　　　　　　一般把level设为error，可以记录错误的日志信息，毕竟主要是要记录错误信息进行错误定位。
　　　　　开发环境：
　　　　　　　类中引入了logger日志对象时，level级别用info,debug都可以，都有错误信息输出。
　　 -->
    <!-- hibernate logger -->
    <logger name="com.ll" level="info" />
    <!-- Spring framework logger -->
    <logger name="org.springframework" level="debug" additivity="false"></logger>

    <!-- 
    root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，
    要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。 
    -->
　　<！-- 一般用默认的info就可以 -->
    <root level="info">
        <!-- 控制台输出日志-->
        <appender-ref ref="stdout" />
        <!--
        开发环境：
            不需要往文件记录日志，可以把这个appender-ref ref="appLogAppender"注释，上面那个往文件写日志的appender也要注释,不然每天都产生一个空文件；
        生产环境：
            需要往文件记录日志，此时appender-ref ref="appLogAppender"就不能注释了，不然没日志记录到文件，上面那个往文件写日志的appender也要放开。
         -->
        <appender-ref ref="appLogAppender" />
    </root>
</configuration>

配置文件其实不需要记太多东西，只要知道在什么地方要改什么配置就行了。

日志的使用

在完成了日志系统的配置之后，就可以愉快地享受日志系统带来的快乐了（滑稽）。

日志系统的使用方法就是在业务代码中使用Logger对象调用相应的方法完成日志的输出。

声明并初始化一个Logger对象。

public static final Logger logger = LoggerFactory.getLogger(日志要监控的类.class);

调用相应的方法输出日志。

try {
    // 业务代码
} catch(Exception e) {
    logger.error("你的代码出错了，笨蛋。", e);
}

这样就能在程序运行时输出相应的日志信息。

"我一个人在路上，偶尔想起你。"