在SpringBoot中添加Logback日志處理

前言

SpringBoot項目中在官方文檔中說明，默認已經依賴了一些日志框架。而其中推薦使用的就是Logback，所以這一次我將在我的模版中加入Logback日志的配置，說明一下，SpringBoot已經依賴了Logback所以不需要手動添加依賴。

已經加入我的github模版中：https://github.com/LinkinStars/springBootTemplate

 

如何配置

1、在resources目錄下新建logback-spring.xml

只要你的名字是logback-spring.xml的話SpringBoot會自動識別和讀取它的，所以你就不需要在application.yml進行其他的配置了。

配置文件具體如下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="true">
    <!-- 項目名稱 -->
    <property name="PROJECT_NAME" value="springBootTemplate" />

    <!--定義日志文件的存儲地址 勿在 LogBack 的配置中使用相對路徑-->
    <property name="LOG_HOME" value="${catalina.base}/logs" />

    <!-- 控制台輸出 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <withJansi>true</withJansi>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度%msg：日志消息，%n是換行符-->
            <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] %highlight([%-5level] %logger{50} - %msg%n)</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- 系統錯誤日志文件 -->
    <appender name="SYSTEM_FILE"  class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 過濾器，只打印ERROR級別的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--日志文件輸出的文件名-->
            <FileNamePattern>${LOG_HOME}/${PROJECT_NAME}.system_error.%d{yyyy-MM-dd}.%i.log</FileNamePattern>
            <!--日志文件保留天數-->
            <MaxHistory>15</MaxHistory>
            <!--日志文件最大的大小-->
            <MaxFileSize>10MB</MaxFileSize>
        </rollingPolicy>

        <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>
            <charset>UTF-8</charset>
        </encoder>
    </appender>
    <logger name="system_error" additivity="true">
        <appender-ref ref="SYSTEM_FILE"/>
    </logger>

    <!-- 自己打印的日志文件，用於記錄重要日志信息 -->
    <appender name="MY_INFO_FILE"  class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 過濾器，只打印ERROR級別的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--日志文件輸出的文件名-->
            <FileNamePattern>${LOG_HOME}/${PROJECT_NAME}.my_info.%d{yyyy-MM-dd}.%i.log</FileNamePattern>
            <!--日志文件保留天數-->
            <MaxHistory>15</MaxHistory>
            <!--日志文件最大的大小-->
            <MaxFileSize>10MB</MaxFileSize>
        </rollingPolicy>

        <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>
            <charset>UTF-8</charset>
        </encoder>
    </appender>
    <logger name="my_info" additivity="true">
        <appender-ref ref="MY_INFO_FILE"/>
    </logger>

    <!-- 開發環境下的日志配置 -->
    <springProfile name="dev">
        <root level="INFO">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="SYSTEM_FILE" />
        </root>
    </springProfile>

    <!-- 生產環境下的日志配置 -->
    <springProfile name="prod">
        <root level="INFO">
            <appender-ref ref="SYSTEM_FILE" />
        </root>
    </springProfile>
</configuration>

 

2、其實至此為止你已經可以正常使用你的日志工具了，但是既然是我的模版，我需要給它添加我使用的工具類，從而方便日志的打印

package com.linkinstars.springBootTemplate.utils;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * @Description: 日志工具類
 * @Author: LinkinStar
 */
public class LogUtil {

    /**
     * 將信息打印到自定義日志（my_info.log）中
     * @param message 需要被打印的信息
     */
    public static void printLog(String message){
        Logger logger  =  LoggerFactory.getLogger("my_info");

        StringBuffer logOut = new StringBuffer();
        logOut.append("\n");
        logOut.append(message);
        logOut.append("\n");

        logger.info(logOut.toString());
    }

    /**
     * 將信息打印到自定義日志（system_error.log）中
     * @param e 異常信息
     */
    public static void printLog(Exception e, Class<?> clazz){
        Logger logger  =  LoggerFactory.getLogger(clazz);

        StringBuffer logOut = new StringBuffer();
        logOut.append("\n");
        logOut.append(e.toString());
        logOut.append("\n");

        StackTraceElement[] errorList = e.getStackTrace();
        for (StackTraceElement stackTraceElement : errorList) {
            logOut.append(stackTraceElement.toString());
            logOut.append("\n");
        }

        logOut.append("\n");
        logOut.append("\n");

        logger.error(logOut.toString());
    }

}

這個工具類會根據之后的情況發生改變暫時只是用例

 

3、日志打印的說明

首先在配置文件中<springProfile name="prod">

當我們在修改

spring:
  # 選擇加載不同環境的配置文件
  profiles:
    active: dev

同樣的logback這里的配置文件也會讀取相應的配置，比如你使用dev那么就會讀取dev下的配置，如果你使用prod就會使用prod下的配置。

也就是說等到項目需要上線的時候，你只需修改springBoot的配置文件就可以了，不需要對logback進行修改，就可以實現在生產環境下和開發環境下打印不同的日志級別

在控制台打印的信息經過處理顯示的顏色會有不同的區分，很容易發現問題。

 

還有是日志文件的分類

通過我的工具類中會分離我打印的日志

我將我所需要的重要日志信息打印在my_info文件中去，而重要的錯誤信息存放在system_error文件中

其他的配置請參考logback配置文件詳解等

 

參考文檔

logback官方給出的配置文件說明https://logback.qos.ch/manual/layouts.html#conversionWord

所參考的博客配置：http://blog.csdn.net/tigerd1995/article/details/50845999