快捷導(dǎo)航

SpringBoot使用slf4j日志并輸出到文件中的操作方法

更新時間：2023年08月16日 08:43:53 作者：99年的可樂

這篇文章主要介紹了SpringBoot使用slf4j日志并輸出到文件中，本文通過實(shí)例代碼給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下

slf4j日志（3月11日）

再使用前，先了解一下介紹，否則你也不會用！

1、日志級別

SLF4J將日志分為trace、debug、info、warn、error五個級別，每個級別對應(yīng)記錄不同的日志，對應(yīng)不同的使用場景。
日志級別從低到高分為

TRACE < DEBUG < INFO < WARN < ERROR < FATAL

如果設(shè)置為 WARN ，則低于 WARN 的信息都不會輸出

一般設(shè)置為 DEBUG 就夠用了，看具體的業(yè)務(wù)需求，開發(fā)時設(shè)置成 trace 方便定位問題，在生產(chǎn)環(huán)境上，將這個日志級別再設(shè)置成 error 級別即可。

trace

trace是最低優(yōu)先級的日志，一般用來追蹤詳細(xì)的程序運(yùn)行流，比如程序的運(yùn)行過程中，運(yùn)行到了哪一個方法，進(jìn)入了哪一條分支。通過trace程序的運(yùn)行流程，可以判斷程序是否按照期望的邏輯在運(yùn)行。舉個例子，有以下代碼段。

public class Car{
//點(diǎn)火
public void fire(){
log.trace("fire")
...
}

debug

debug是比trace高一級別的日志，該級別的日志就是用來debug用的。這類日志往往用在判斷是否有出現(xiàn)bug的場景，且往往記錄了代碼運(yùn)行的詳細(xì)信息，比如方法調(diào)用傳入的參數(shù)信息。

假設(shè)運(yùn)行的過程中出現(xiàn)了問題，為了定位問題的原因，可以使用debug級別的日志來記錄檔位，通過記錄運(yùn)行時傳入的gear來判斷是不是因?yàn)闄n位輸入錯誤而導(dǎo)致Car起步失敗。

//掛檔
public void gear(int gear){
log.trace("gear")
//記錄檔位
log.debug(gear)
...
}

info

info比debug高一級別，用來記錄程序運(yùn)行的一些關(guān)鍵信息，它不像trace那樣記錄程序運(yùn)行的整個流程，也不像debug那樣為了解決問題而記錄詳細(xì)的信息。

info記錄的是整個系統(tǒng)的運(yùn)行信息，比如系統(tǒng)運(yùn)行到了哪一個階段，到達(dá)了哪一個狀態(tài)。還是以車啟動為例子，將啟動的代碼修改如下。

public void static main(String[] args){
Car car = new Car();
car.fire();
car.clutch();
car.gear(1);
car.looseBrake();
log.info("car is ready to run faster !");
}
可以看到，運(yùn)行完looseBrake方法之后，使用info記錄了車的狀態(tài)，車已經(jīng)完成了起步了，可以踩油門加速了。

warn

warn比info的級別更高，用來記錄一些警告信息。警告信息表示，程序進(jìn)入了一個特殊的狀態(tài)，在該狀態(tài)下程序可以繼續(xù)運(yùn)行，但是不建議讓程序進(jìn)入該狀態(tài)，因?yàn)樵摖顟B(tài)可能導(dǎo)致結(jié)果出現(xiàn)問題

車啟動的過程中如果以大于1檔起步，就使用warn記錄警告，告訴調(diào)用者不推薦這樣使用，實(shí)際上2檔起步也是可以的，但可能會出問題

//掛檔
public void gear(int gear){
log.trace("gear")
//記錄檔位
log.debug(gear)
if(gear > 1){
log.warn("gear "+ gear +" is too high !")
}
...
}

error

error級別的日志是最高優(yōu)先級了，用來記錄運(yùn)行時的錯誤信息，表示程序運(yùn)行過程中出現(xiàn)了需要被解決的問題，往往是一些異常。使用error日志的時候，一般會將詳細(xì)的異常出現(xiàn)的原因記錄。

public void static main(String[] args){
Car car = new Car();
try{
car.fire();
car.clutch();
car.gear(1);
car.looseBrake();
}catch(Exception e){
log.error("run failed !",e.getCause())
}
log.info("car is ready to run faster !");
}

2、spring boot使用日志接口介紹

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

SLF4J類似于Commons Logging，也是一個日志接口，而Logback類似于Log4j，是一個日志的實(shí)現(xiàn)。

根據(jù)不同的日志系統(tǒng)，你可以按如下規(guī)則組織配置文件名，就能被正確加載：

Spring Boot官方推薦使用帶有 -spring 的文件名作為你的日志配置（如logback-spring.xml，而不是logback.xml），命名為logback-spring.xml的日志配置文件，spring boot可以為它添加一些spring boot特有的配置項(xiàng)（下面會提到）。

默認(rèn)的命名規(guī)則，并且放在 src/main/resources 下面即可

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-starter 這個包就自帶了 logging 的依賴包，SpringBoot會默認(rèn)使用 logback 作為日志框架，在生成springboot項(xiàng)目的時候可以直接勾選logback，那么就可以直接使用logback了。手動添加的話，建議使用slf4j+logback，后面項(xiàng)目更容易維護(hù)：

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

日志配置類介紹

如下配置將：

在根目錄 applog 中每天生成一個文件夾，并生成一個天級別的日志文件。
Logger標(biāo)簽：作為日志的記錄器，把它關(guān)聯(lián)到應(yīng)用的對應(yīng)的context上后，主要用于存放日志對象，也可以定義日志類型、級別。
Appender主要用于指定日志輸出的目的地，目的地可以是控制臺、文件、遠(yuǎn)程套接字服務(wù)器、 MySQL、PostreSQL、 Oracle和其他數(shù)據(jù)庫、 JMS和遠(yuǎn)程UNIX Syslog守護(hù)-進(jìn)程等。
Layout 負(fù)責(zé)把事件轉(zhuǎn)換成字符串，格式化的日志信息的輸出

logback-spring.xml，放在 src/main/resources 下面

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <contextName>logback</contextName>
    <!--輸出到控制臺-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    <!--按天生成日志,即一天只生成一個文件夾和一個日志文件-->
    <appender name="logFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <Prudent>true</Prudent>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>
                applog/%d{yyyy-MM-dd}/%d{yyyy-MM-dd}.log
            </FileNamePattern>
        </rollingPolicy>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>
                %d{yyyy-MM-dd HH:mm:ss} -%msg%n
            </Pattern>
        </layout>
    </appender>
    <!-- logger節(jié)點(diǎn)，可選節(jié)點(diǎn)，作用是指明具體的包或類的日志輸出級別，
    以及要使用的<appender>（可以把<appender>理解為一個日志模板）。
    addtivity：非必寫屬性，是否向上級loger傳遞打印信息。默認(rèn)是true-->
    <logger name="com.framework.job" additivity="false">
        <appender-ref ref="console"/>
        <appender-ref ref="logFile"/>
    </logger>
    <!--項(xiàng)目的整體的日志打印級別為info-->
    <root level="info">
        <appender-ref ref="console"/>
        <appender-ref ref="logFile"/>
    </root>
</configuration>

日志級別單獨(dú)配置

在application.yml使用以下方式，可以單獨(dú)設(shè)置每個包下的日志記錄級別，其中file屬性可有可無

logging:
  file: applog/sys.log
  level:
    com:
      leshangju:
        prism:
          auth:
            dao: debug
          usershop:
            dao: debug
          loginuser:
            dao: debug

application.properties

logging.level.com.framework.job : info

測試結(jié)果

@Slf4j
public class MyJob extends QuartzJobBean {
    @Override
    protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
        System.out.println("啟動定時任務(wù) My Job：" + LocalDateTime.now());
        log.trace("進(jìn)入了myjob任務(wù)");
        try {
            Thread.sleep(3000);
            log.trace("睡了3秒");
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        log.info("結(jié)束任務(wù)！");
        System.out.println("end  My Job：" + LocalDateTime.now());
    }
}

控制臺：

在這里插入圖片描述