前言

SpringBoot 在所有內部日志中使用Commons Logging，但是默認配置也提供了對常用日志的支持，如：Java Util Logging，Log4J, Log4J2和Logback。每種Logger都可以通過配置使用控制台或者文件輸出日志內容。

默認日志Logback

SLF4J——簡單日志門面，對應的英文為Simple Logging Facade，是存取日志的標准接口，包括slf4j、log4j、jdk logging api和apache common-log等具體實現。

其實SLF4J類似於Commons Logging，也是一個日志接口，而Logback類似於Log4j，是一個日志的實現。

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::                (v2.4.5)

2021-05-11 14:37:21.934  INFO 10716 --- [  restartedMain] com.pro.MyBlogSiteApplication            : Starting MyBlogSiteApplication using Java 11.0.9 on DESKTOP-04S0A5K with PID 10716 (C:\Users\ibbd\Desktop\sundry\my-blog-site\target\classes started by ibbd in C:\Users\ibbd\Desktop\sundry\my-blog-site)
2021-05-11 14:37:21.937  INFO 10716 --- [  restartedMain] com.pro.MyBlogSiteApplication            : The following profiles are active: dev
2021-05-11 14:37:22.021  INFO 10716 --- [  restartedMain] .e.DevToolsPropertyDefaultsPostProcessor : Devtools property defaults active! Set 'spring.devtools.add-properties' to 'false' to disable
2021-05-11 14:37:22.021  INFO 10716 --- [  restartedMain] .e.DevToolsPropertyDefaultsPostProcessor : For additional web related logging consider setting the 'logging.level.web' property to 'DEBUG'
2021-05-11 14:37:23.584  INFO 10716 --- [  restartedMain] c.a.d.s.b.a.DruidDataSourceAutoConfigure : Init DruidDataSource
2021-05-11 14:37:24.675  INFO 10716 --- [  restartedMain] com.alibaba.druid.pool.DruidDataSource   : {dataSource-1} inited
2021-05-11 14:37:25.656  INFO 10716 --- [  restartedMain] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8081 (http)
2021-05-11 14:37:25.675  INFO 10716 --- [  restartedMain] o.apache.catalina.core.StandardService   : Starting service [Tomcat]

從默認的日志信息可以看出

時間日期：精確到毫秒
日志級別：ERROR, WARN, INFO, DEBUG or TRACE
進程ID
分隔符：--- 標識實際日志的開始
線程名：方括號括起來（可能會截斷控制台輸出）
Logger名：通常使用源代碼的類名
日志內容

自定義日志配置

根據不同的日志系統，你可以按如下規則組織配置文件名，就能被正確加載：

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 下面即可

如果你即想完全掌控日志配置，但又不想用logback.xml作為Logback配置的名字，application.yml可以通過logging.config屬性指定自定義的名字：

logging.config=classpath:logging-config.xml

日志級別

日志級別從低到高分為

TRACE < DEBUG < INFO < WARN < ERROR < FATAL

如果設置為 WARN ，則低於 WARN 的信息都不會輸出

一般設置為 DEBUG 就夠用了

使用

1. 依賴

spring-boot-starter 這個包就自帶了 logging 的依賴包, AOP這個包后面會用到

使用的 SpringBoot 版本：v2.4.5

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

2. 配置 logback-spring.xml

在 src/main/resources 目錄下新建 logback-spring.xml 配置文件

<?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="30 seconds">
    <!--  彩色日志依賴  -->
    <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" />

    <!--  日志文件儲存地址, 通過application配置文件傳入  -->
<!--    <springProperty scope="context" name="LOG_PATH" source="logback.logDir" />-->
    <!--定義日志文件的存儲地址 勿在 LogBack 的配置中使用相對路徑-->
    <property name="LOG_PATH" value="./logs"/>

    <!--  控制台彩色日志格式  -->
    <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{${LOG_DATEFORMAT_PATTERN:-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}}" />
    <!--  日志文件日志格式  -->
    <property name="FILE_LOG_PATTERN" value="${FILE_LOG_PATTERN:-%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%15t] %-40.40logger{39} : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}" />


    <!-- 控制台輸出 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>


    <!-- 按照每天及大小生成日志文件 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--日志文件輸出的文件名-->
            <FileNamePattern>${LOG_PATH}/my-blog-site.%d{yyyy-MM-dd}.%i.log</FileNamePattern>
            <!--日志文件最大大小-->
            <maxFileSize>100MB</maxFileSize>
            <!--日志文件保留天數-->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${FILE_LOG_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!-- 過濾級別,
            如果想分類生成日志文件的話(分成debug、info、error等三個日志文件, 每個文件只記錄自己級別的日志),
            1. 直接把這個 <appender> 復制三分改一下 FileNamePattern 和 name.
            2. 把 <filter> 注釋去掉改一下 level 就可以了
        -->
<!--        <filter class="ch.qos.logback.classic.filter.LevelFilter">-->
<!--            <level>info</level>-->
<!--            <onMatch>ACCEPT</onMatch>-->
<!--            <onMismatch>DENY</onMismatch>-->
<!--        </filter>-->
    </appender>


    <!-- 日志輸出級別
        如果使用springProfile, 就需要在application配置文件中通過 spring.profiles.active=dev 來指定環境,
        也可以直接去掉 <springProfile> 這個標簽或者把它整個注釋掉
     -->
    <springProfile name="dev,prod">
        <logger name="org.springframework" level="INFO" additivity="false">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="FILE"/>
        </logger>
        <logger name="com.netflix" level="INFO" additivity="false">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="FILE"/>
        </logger>
        <logger name="com.pro.test" level="DEBUG" additivity="false">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="FILE"/>
        </logger>
        <logger name="java.sql" level="DEBUG" additivity="false">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="FILE"/>
        </logger>
        <!--項目包的路徑-->
        <logger name="com.pro" level="DEBUG,INFO" additivity="false">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="FILE"/>
        </logger>
    </springProfile>

	<root level="INFO">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="FILE" />
    </root>
</configuration>

3. 全局日志AOP實現

Pointcut 切入點說明

1. execution(public * *(..)) # ——表示匹配所有public方法
2. execution(* set*(..)) # ——表示所有以“set”開頭的方法
3. execution(* com.pro.service.UserService.*(..)) # ——表示匹配所有UserService接口的方法
4. execution(* com.pro.service.*.*(..)) # ——表示匹配service包下所有的方法
5. execution(* com.pro.service..*.*(..)) # ——表示匹配service包和它的子包下的方法

# () 參數說明
()匹配沒有參數；  (..)代表任意多個參數；   (*)代表一個參數，但可以是任意型；    (*,String)代表第一個參數為任何值,第二個為String類型。

記錄日志

package com.pro.aspect;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.util.Arrays;


/**
 * 請求日志處理
 */
@Aspect
@Component
public class WebLogAspect {
    private static final Logger LOGGER = LoggerFactory.getLogger(WebLogAspect.class);

    ThreadLocal<Long> startTime = new ThreadLocal<>();

    // 切入點
    @Pointcut("execution(* com.pro.controller..*.*(..))")
    public void pc() {}

    // 前置通知
    @Before("pc()")
    public void doBefore(JoinPoint joinPoint) {
        // 記錄請求開始時間
        startTime.set(System.currentTimeMillis());

        // 接收請求, 記錄請求內容
        ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = requestAttributes.getRequest();
        // 記錄請求內容
        LOGGER.info("URL: " + request.getRequestURL().toString());
        LOGGER.info("HTTP_METHOD: " + request.getMethod());
        LOGGER.info("IP: " + request.getRemoteAddr());
        LOGGER.info("CLASS_METHOD: " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        LOGGER.info("Args: " + Arrays.toString(joinPoint.getArgs()));
    }

    // 返回通知
    @AfterReturning(returning = "result", pointcut = "pc()")
    public void doAfterReturning(Object result) {
        // 請求返回內容
        LOGGER.info("RESPONSE: " + result);
        LOGGER.info("SPEND TIME: " + (System.currentTimeMillis() - startTime.get()));

        // 用完之后移除, 避免內存泄漏
        startTime.remove();
    }
    
    // 異常通知
    @AfterThrowing(value = "pc()", throwing = "e")
    public void doAfterThrowing(JoinPoint joinPoint, Exception e) {
        // 獲取類名加方法名
        String name = joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName();
        // 記錄異常信息
        LOGGER.info("Exception_Class_Method: {}, Exception_Message: {}", name, e.getMessage());
    }
}

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 springboot筆記04——讀取配置文件+使用slf4j日志 Springboot的slf4j的配置文件模板 JAVAEE——SpringBoot日志篇：日志框架SLF4j、日志配置、日志使用、切換日志框架 SpringBoot之集成slf4j日志框架 SpringBoot - 日志的配置和使用詳解（SLF4j、Logback） SpringBoot--logger日志配置，使用@Slf4j注解 SpringBoot使用Slf4j進行日志配置 springboot通過slf4j配置日志 SpringBoot集成slf4j日志配置 springboot自帶日志slf4j使用