1. 程式人生 > >spring boot logback 多環境列印日誌

spring boot logback 多環境列印日誌

       spring boot預設使用的是logback列印日誌的,但它也支援log4j  log4j2等日誌(這些要調整匯入的jar包了),在專案的application.properties裡面只能簡單的配置一些日誌的相關資訊,如果想要配置複雜的日誌輸出,例如每天按照級別分別輸出一個日誌檔案,不通的開發環境使用不通的日誌配置,這時就要在resources下面新建 logback-spring.xml  用xml的方式來配置

這裡說的就是多環境,日誌怎麼配置

spring boot 用自帶的logback列印日誌:

  1. 多環境列印.
  2. 生產環境輸出到控制檯和檔案,一天一個檔案,保留30天.
  3. 開發環境輸出到控制檯.
  4. 測試環境輸出到控制檯和列印sql(mybatis)輸出.

用idea新增一個web模組的spring boot專案.

直接上logback-spring.xml放在resources下面

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!--引入預設的一些設定-->
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <!--web資訊-->
    <logger name="org.springframework.web" level="info"/>

    <!--寫入日誌到控制檯的appender,用預設的,但是要去掉charset,否則windows下tomcat下亂碼-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <!--定義日誌檔案的儲存地址 勿在 LogBack 的配置中使用相對路徑-->
    <property name="LOG_PATH" value="D:/logs/yunchuang/yunchuang"/>
    <!--寫入日誌到檔案的appender-->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日誌檔案輸出的檔名,每天一個檔案-->
            <FileNamePattern>${LOG_PATH}.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日誌檔案保留天數-->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
        <!--日誌檔案最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>

    <!--非同步到檔案-->
    <appender name="asyncFileAppender" class="ch.qos.logback.classic.AsyncAppender">
        <discardingThreshold>0</discardingThreshold>
        <queueSize>500</queueSize>
        <appender-ref ref="FILE"/>
    </appender>

    <!--生產環境:列印控制檯和輸出到檔案-->
    <springProfile name="prod">
        <root level="info">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="asyncFileAppender"/>
        </root>
    </springProfile>

    <!--開發環境:列印控制檯-->
    <springProfile name="dev">
        <root level="info">
            <appender-ref ref="CONSOLE"/>
        </root>
    </springProfile>

    <!--測試環境:列印控制檯-->
    <springProfile name="test">
        <!-- 列印sql -->
        <logger name="com.yunchuang.dao" level="DEBUG"/>
        <root level="info">
            <appender-ref ref="CONSOLE"/>
        </root>
    </springProfile>
</configuration>

修改application.yml新增多環境

spring:
  profiles:
    active: prod
---
server:
  port: 8009
spring:
  profiles: dev
---
server:
  port: 8009
spring:
  profiles: test
---
server:
  port: 8008
spring:
  profiles: prod

加入一個RestController來測試日誌是否成功.

package com.yunchuang;
 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
 
/**
* log
*
* @author 尹冬飛
* @create 2017-04-12 16:28
*/
@RestController
public class LogDemo {
    private static Logger log= LoggerFactory.getLogger(LogDemo.class);
 
    @GetMapping("/")
    public String a(){
        log.trace("======trace");
        log.debug("======debug");
        log.info("======info");
        log.warn("======warn");
        log.error("======error");
        return "123";
    }
}

下面是我怎麼寫出來上面這些東西的.

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/base.xml"/>
    <logger name="org.springframework.web" level="DEBUG"/>
</configuration>
<springProfile name="staging">
    <!-- configuration to be enabled when the "staging" profile is active -->
</springProfile>

<springProfile name="dev, staging">
    <!-- configuration to be enabled when the "dev" or "staging" profiles are active -->
</springProfile>

<springProfile name="!production">
    <!-- configuration to be enabled when the "production" profile is not active -->
</springProfile>

由這2個部分就可以看出來logback是怎麼配置的了,列印日誌需要引入base.xml,多環境列印需要<springProfile>標籤.只要把怎麼列印放入多環境標籤即可.所以需要開啟base.xml看看他是怎麼寫入日誌的.

<?xml version="1.0" encoding="UTF-8"?>

<!--
Base logback configuration provided for compatibility with Spring Boot 1.1
-->

<included>
    <include resource="org/springframework/boot/logging/logback/defaults.xml" />
    <property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/>
    <include resource="org/springframework/boot/logging/logback/console-appender.xml" />
    <include resource="org/springframework/boot/logging/logback/file-appender.xml" />
    <root level="INFO">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="FILE" />
    </root>
</included>
<?xml version="1.0" encoding="UTF-8"?>

<!--
Console appender logback configuration provided for import, equivalent to the programmatic
initialization performed by Boot
-->

<included>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>utf8</charset>
        </encoder>
    </appender>
</included>
  • 開啟defaults.xml發現是一些系統預設設定.
  • 開啟console-appender.xml發現是輸出到控制檯的appender設定.
  • 開啟file-appender.xml發現是輸出到檔案的appender設定.
  • <root>標籤注入了這2個appender,同時列印到控制檯和檔案.因為你在<configuration debug="true">時啟動專案就能看到控制檯,就能發現他會輸出日誌到一個檔案.可以到我的電腦裡找到這個檔案.

所以整個框架就明瞭了.在自己定義配置的logback-spring.xml裡需要的幾部分

  • defaults.xml系統的一些預設設定保留.
  • console-appender.xml列印到控制檯的設定保留.但是需要去掉設定編碼,所以把裡面的程式碼考過來,並去掉編碼設定.因為這裡會亂碼,下面詳細說.
  • <root>保留,放到多環境裡.想只打印到控制檯,就注入控制檯appender,想列印控制檯和檔案就注入控制檯和檔案這2個appender即可.
  • 列印sql,用<logger name="com.yunchuang.dao" level="DEBUG" />
  • 名稱為什麼是logback-spring.xml,官方文件裡有說明,用了擴充套件表示式,必須用這個名字.