SpringBoot 使用slf4j(logback)入門
說明
在專案中都需要使用日誌元件來記錄和輸出日誌,我們通常使用的日誌方式有System.out.println或log4j。
在Springboot中提供了 SLF4J(Simple Logging Facade For Java),SLF4J是一套日誌介面預設使用logback日誌元件,也可以自己替換為log4j等其他日誌元件
由於我們計劃使用預設的日誌元件,因此也就不需要在額外引入什麼了
準備工作
在專案的contorller包中新建類LogController.java
日誌程式碼
編輯類程式碼如下
package com.gl.springbootapi.controller ;
import com.gl.springbootutils.helper.CommonMethod;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.text .SimpleDateFormat;
import java.util.Date;
@RestController
@RequestMapping("/log")
public class LogController {
private static final Logger loggerStatic = LoggerFactory.getLogger(LogController.class);//靜態方式初始化Log物件
private final Logger logger = LoggerFactory.getLogger(this.getClass());//物件方式初始化Log物件
@GetMapping("")
public String log() {
Date d = CommonMethod.getCurDate();
SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");//設定日期格式
loggerStatic.info("當前時間:"+df.format(d));
logger.info("當前時間:"+df.format(d));
logger.debug("當前時間:"+df.format(d));
logger.warn("當前時間:"+df.format(d));
logger.error("當前時間:"+df.format(d));
return "當前時間:"+df.format(d);
}
}
在這裡我們建立了一個controller的api來觸發日誌記錄,具體contorller的mapping不在這裡說明,在其他文章裡有
程式碼中首先建立log物件,示例程式碼中建立了兩種log物件,一個是靜態的,一個是物件的,如果在物件方法中使用,建議使用物件方式建立,這樣每個類就複製黏貼就行了,使用靜態方法的,需要每個類改類名,很容易遺漏
建立好log物件之後可以記錄日誌
日誌有4個級別,INFO、DEBUG、WARN、ERROR
可以在配置檔案中定義輸出級別
這樣記錄的日誌會在控制檯輸出
如果希望輸出到檔案或資料庫,可以寫配置檔案進行配置
配置
對於日誌的配置可以直接配置到application.properties中,也可以建立logback.xml對logback進行配置,如果同時有兩個配置,application.properties的優先順序更高
application.properties方式配置
loggin.level指定日誌級別,還可以再具體指定包的級別
logging.path指定日誌路徑
logging.file指定日誌檔案(path和file只能使用一個,file優先順序高,file可以指定全路徑)
logging.config指定使用的xml配置檔案地址
logback.xml方式配置
在resources目錄下建立檔案logback.xml
內容如下
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
<!--定義日誌檔案的儲存地址-->
<property name="LOG_HOME" value="/logs" />
<!-- 控制檯輸出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<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>
</encoder>
</appender>
<!-- 按照每天生成日誌檔案 -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日誌檔案輸出的檔名-->
<FileNamePattern>${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log</FileNamePattern>
<!--日誌檔案保留天數-->
<MaxHistory>30</MaxHistory>
</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>
</encoder>
<!--日誌檔案最大的大小-->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>
<!-- 日誌輸出級別 -->
<root level="INFO">
<appender-ref ref="STDOUT" />
<appender-ref ref="FILE" />
</root>
<!--日誌非同步到資料庫 -->
<!--<appender name="DB" class="ch.qos.logback.classic.db.DBAppender">-->
<!--<!–日誌非同步到資料庫 –>-->
<!--<connectionSource class="ch.qos.logback.core.db.DriverManagerConnectionSource">-->
<!--<!–連線池 –>-->
<!--<dataSource class="com.mchange.v2.c3p0.ComboPooledDataSource">-->
<!--<driverClass>com.mysql.jdbc.Driver</driverClass>-->
<!--<url>jdbc:mysql://127.0.0.1:3306/databaseName</url>-->
<!--<user>root</user>-->
<!--<password>root</password>-->
<!--</dataSource>-->
<!--</connectionSource>-->
<!--</appender>-->
</configuration>
這樣就會在磁碟根目錄下建立logs資料夾,日誌就存放到這裡,按照規定的命名規則和大小
說明
如果想使用logback.xml方式進行配置,配置檔案命名為logback.xml,Spring可以直接找到使用,如果希望定義不同環境的配置檔案,例如
logback-dev.xml、logback-test.xml
則需要在application.properties新增配置
logging.config=classpath:logback-test.xml