Springboot之日志整合LogBack（二）

前面已經介紹了各個日志架構了，這裡就直接介紹 Springboot 怎麼整合LogBack日志。

logbok日志使用步驟

1、引入依賴

實際開發中有時不需要引入下面這個依賴，因為有很多其他的依賴中包含了下面這個依賴。

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

2、編寫logback的xml配置檔案（logback-spring.xml）

官方推薦使用的xml名字的格式為：logback-spring.xml而不是logback.xml，至于為什麼，因為帶spring字尾的可以使用這個标簽。用來區分測試、生産環境。

<?xml version="1.0" encoding="UTF-8"?>
<!-- 日志級别從低到高分為TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果設定為WARN，則低于WARN的資訊都不會輸出 -->
<!-- scan:當此屬性設定為true時，配置檔案如果發生改變，将會被重新加載，預設值為true -->
<!-- scanPeriod:設定監測配置檔案是否有修改的時間間隔，如果沒有給出時間機關，預設機關是毫秒。當scan為true時，此屬性生效。預設的時間間隔為1分鐘。 -->
<!-- debug:當此屬性設定為true時，将列印出logback内部日志資訊，實時檢視logback運作狀态。預設值為false。 -->
<configuration  scan="true" scanPeriod="10 seconds">

    <contextName>logback</contextName>
    <!-- name的值是變量的名稱，value的值時變量定義的值。通過定義的值會被插入到logger上下文中。定義變量後，可以使“${}”來使用變量。 -->
    <!--日志檔案存放路徑-->
    <property name="log.path" value="E:/home/kaico/logs" />

    <!-- 彩色日志 -->
    <!-- 彩色日志依賴的渲染類 -->
    <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="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>


    <!--輸出到控制台-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--此日志appender是為開發使用，隻配置最底級别，控制台輸出的日志級别是大于或等于此級别的日志資訊-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
        <encoder>
            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            <!-- 設定字元集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>


    <!--輸出到檔案-->

    <!-- 時間滾動輸出 level為 DEBUG 日志 -->
    <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日志檔案的路徑及檔案名 -->
        <file>${log.path}/log_debug.log</file>
        <!--日志檔案輸出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 設定字元集 -->
        </encoder>
        <!-- 日志記錄器的滾動政策，按日期，按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 日志歸檔 -->
            <fileNamePattern>${log.path}/debug/log-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志檔案保留天數-->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <!-- 此日志檔案隻記錄debug級别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>debug</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 時間滾動輸出 level為 INFO 日志 -->
    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日志檔案的路徑及檔案名 -->
        <file>${log.path}/log_info.log</file>
        <!--日志檔案輸出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!-- 日志記錄器的滾動政策，按日期，按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天日志歸檔路徑以及格式 -->
            <fileNamePattern>${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志檔案保留天數-->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <!-- 此日志檔案隻記錄info級别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>info</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 時間滾動輸出 level為 WARN 日志 -->
    <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日志檔案的路徑及檔案名 -->
        <file>${log.path}/log_warn.log</file>
        <!--日志檔案輸出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 此處設定字元集 -->
        </encoder>
        <!-- 日志記錄器的滾動政策，按日期，按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志檔案保留天數-->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <!-- 此日志檔案隻記錄warn級别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>warn</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>


    <!-- 時間滾動輸出 level為 ERROR 日志 -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日志檔案的路徑及檔案名 -->
        <file>${log.path}/log_error.log</file>
        <!--日志檔案輸出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 此處設定字元集 -->
        </encoder>
        <!-- 日志記錄器的滾動政策，按日期，按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志檔案保留天數-->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <!-- 此日志檔案隻記錄ERROR級别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!--
        <logger>用來設定某一個包或者具體的某一個類的日志列印級别、
        以及指定<appender>。<logger>僅有一個name屬性，
        一個可選的level和一個可選的addtivity屬性。
        name:用來指定受此logger限制的某一個包或者具體的某一個類。
        level:用來設定列印級别，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
              還有一個特俗值INHERITED或者同義詞NULL，代表強制執行上級的級别。
              如果未設定此屬性，那麼目前logger将會繼承上級的級别。
        addtivity:是否向上級logger傳遞列印資訊。預設是true。
    -->
    <!--<logger name="org.springframework.web" level="info"/>-->
    <!--<logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>-->
    <!--
        使用mybatis的時候，sql語句是debug下才會列印，而這裡我們隻配置了info，是以想要檢視sql語句的話，有以下兩種操作：
        第一種把<root level="info">改成<root level="DEBUG">這樣就會列印sql，不過這樣日志那邊會出現很多其他消息
        第二種就是單獨給dao下目錄配置debug模式，代碼如下，這樣配置sql語句會列印，其他還是正常info級别： 推薦使用第二種
     -->


    <!--
        root節點是必選節點，用來指定最基礎的日志輸出級别，隻有一個level屬性
        level:用來設定列印級别，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
        不能設定為INHERITED或者同義詞NULL。預設是DEBUG
        可以包含零個或多個元素，辨別這個appender将會添加到這個logger。
    -->

    <!--開發環境:列印控制台-->
    <springProfile name="hikari">
        <logger name="com.kaico" level="debug"/>
    </springProfile>

    <root level="info">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="DEBUG_FILE" />
        <appender-ref ref="INFO_FILE" />
        <appender-ref ref="WARN_FILE" />
        <appender-ref ref="ERROR_FILE" />
    </root>

    <!--生産環境:輸出到檔案-->
    <!--<springProfile name="pro">-->
    <!--<root level="info">-->
    <!--<appender-ref ref="CONSOLE" />-->
    <!--<appender-ref ref="DEBUG_FILE" />-->
    <!--<appender-ref ref="INFO_FILE" />-->
    <!--<appender-ref ref="ERROR_FILE" />-->
    <!--<appender-ref ref="WARN_FILE" />-->
    <!--</root>-->
    <!--</springProfile>-->

</configuration>

3、修改application.yml配置檔案

主要配置logback的配置檔案的路徑，還有mybatis輸出sql語句的日志。

#列印sql語句到日志
logging:
  level:
    com.kaico.shiro.*: debug
  #logback日志配置檔案的路徑
  config: classpath:logback-spring.xml

4、代碼中使用

可以整合lombok插件來使用日志架構。

package com.kaico.shiro.controller;

import com.kaico.shiro.dao.db1.SysUserDao;
import com.kaico.shiro.pojo.SysUser;
import com.kaico.shiro.service.SysUserService;
import lombok.extern.log4j.Log4j2;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;
import java.util.Map;
import java.util.UUID;

//@Log4j2
@RestController
@RequestMapping("test/")
public class TestController {

    private final static Logger log = LoggerFactory.getLogger(TestController.class);

    @Autowired
    private SysUserDao sysUserDao;

    @Autowired
    private SysUserService sysUserService;

    @RequestMapping(value = "test",method = RequestMethod.GET)
    public String test(){
        List<Map<String, String>> all = sysUserDao.getAll();
        for (Map<String, String> stringStringMap : all) {
            System.out.println("all:" + stringStringMap.entrySet().toString());
        }

        log.info("測試logback日志架構");
        return "你好。";
    }

    @RequestMapping(value = "test1",method = RequestMethod.GET)
    public String test1(){
        int i = sysUserService.insertUser(new SysUser());
        return "你好。" + i;
    }

    @RequestMapping(value = "test2",method = RequestMethod.GET)
    public String test2(String num){
        int i = sysUserDao.insertUser(new SysUser(UUID.randomUUID().toString(), "馮凱" + num));
        return "你好。" + i;
    }
}

注意

使用mybatis的時候，sql語句是debug下才會列印，而這裡我們隻配置了info，是以想要檢視sql語句的話，有以下兩種操作：

第一種把改成這樣就會列印sql，不過這樣日志那邊會出現很多其他消息
第二種就是單獨給dao下目錄配置debug模式，代碼如下，這樣配置sql語句會列印，其他還是正常info級别：

Springboot之日志整合LogBack（二）

logbok日志使用步驟

注意

繼續閱讀

關于Gradle配置的小結

Java小案例——随機數猜測随機數猜測

nginx location中斜線的位置的重要性

27 Best Free Eclipse Plug-ins for Java Developer to be ProductiveCode Quality PluginsText Editor PluginsDependency ManagementVersion Control Integration PluginsFramework Development Continuous Integration Related PluginsOther Utility Plugins

Java String.format方法的簡單使用

neo4j之cypher使用文檔

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

mybatis_入門程式Mybatis入門

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

Effective Java 8:通用程式設計

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method