Spring Boot 1.5.x新特性：動態修改日誌級

阿新 • • 發佈：2018-12-18

Spring Boot 1.5.x新特性：動態修改日誌級

前天Spring Boot 1.5終於迎來了第一個RELEASE版本：1.5.0，但是由於一個編譯依賴問題在第二天直接連擊到了1.5.1。該版本的釋出包含了超過320位貢獻者的奉獻、10000多次的程式碼提交。

每次Spring Boot版本更新所帶來的新特性都是我們每個使用者特別關注的。雖然其中不少特性可能對於大部分使用者來說還不一定適用，但是作為基礎知識的儲備還是有一定的必要性。對於1.5.x版本的新特性列表讀者可以直接檢視官方博文：《Spring Boot 1.5.1 released》來了解它們，本文不做這些概要性的介紹。在後續的一段時間內，本部落格將會陸續介紹一些筆者關心且將會使用的關於Spring Boot 1.5.x中的一些新特性。

loggers端點

本文我們就來看看Spring Boot 1.5.x中引入的一個新的控制端點：/loggers，該端點將為我們提供動態修改Spring Boot應用日誌級別的強大功能。該功能的使用非常簡單，它依然延續了Spring Boot自動化配置的實現，所以只需要在引入了spring-boot-starter-actuator依賴的條件下就會自動開啟該端點的功能（更多關於spring-boot-starter-actuator模組的詳細介紹可見：《Spring Boot Actuator監控端點小結》一文）。

下面，我們不妨通過一個實際示例來看看如何使用該功能：

構建一個基礎的Spring Boot應用。如果您對於如何構建還不熟悉，可以參考《使用Intellij中的Spring Initializr來快速構建Spring Boot/Cloud工程》一文。

在pom.xml引入如下依賴（如果使用Intellij中的Spring Initializr的話直接在提示框中選下web和actuator模組即可）。

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.5.1.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository --> 

</parent>
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

在應用主類中新增一個介面用來測試日誌級別的變化，比如下面的實現：

@RestController
@SpringBootApplication
public class DemoApplication {
    private Logger logger = LoggerFactory.getLogger(getClass());
    @RequestMapping(value = "/test", method = RequestMethod.GET)
    public String testLogLevel() {
        logger.debug("Logger Level ：DEBUG");
        logger.info("Logger Level ：INFO");
        logger.error("Logger Level ：ERROR");
        return "";
    }
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

為了後續的試驗順利，在application.properties中增加一個配置，來關閉安全認證校驗。

management.security.enabled=false

不然在訪問/loggers端點的時候，會報如下錯誤：

{
  "timestamp": 1485873161065,
  "status": 401,
  "error": "Unauthorized",
  "message": "Full authentication is required to access this resource.",
  "path": "/loggers/com.didispace"
}

測試驗證

在完成了上面的構建之後，我們啟動示例應用，並訪問/test端點，我們可以在控制檯中看到如下輸出：

2017-01-31 22:34:57.123  INFO 16372 --- [nio-8000-exec-1] ication$$EnhancerBySpringCGLIB$$d2a0b1e2 : Logger Level ：INFO
2017-01-31 22:34:57.124 ERROR 16372 --- [nio-8000-exec-1] ication$$EnhancerBySpringCGLIB$$d2a0b1e2 : Logger Level ：ERROR

由於預設的日誌級別為INFO，所以並沒有輸出DEBUG級別的內容。下面我們可以嘗試通過/logger端點來將日誌級別調整為DEBUG，比如，傳送POST請求到/loggers/com.didispace端點，其中請求體Body內容為：

{
    "configuredLevel": "DEBUG"
}

重新訪問/test端點，我們將在控制檯中看到如下輸出，在/test端點中定義的DEBUG日誌內容被列印了出來：


2017-01-31 22:37:35.252 DEBUG 16372 --- [nio-8000-exec-5] ication$$EnhancerBySpringCGLIB$$d2a0b1e2 : Logger Level ：DEBUG
2017-01-31 22:37:35.252  INFO 16372 --- [nio-8000-exec-5] ication$$EnhancerBySpringCGLIB$$d2a0b1e2 : Logger Level ：INFO
2017-01-31 22:37:35.252 ERROR 16372 --- [nio-8000-exec-5] ication$$EnhancerBySpringCGLIB$$d2a0b1e2 : Logger Level ：ERROR

可以看到，到這裡為止，我們並沒有重啟過Spring Boot應用，而只是簡單的通過呼叫/loggers端點就能控制日誌級別的更新。除了POST請求之外，我們也可以通過GET請求來檢視當前的日誌級別設定，比如：傳送GET請求到/loggers/com.didispace端點，我們將獲得對於com.didispace包的日誌級別設定：


{
  "configuredLevel": "DEBUG",
  "effectiveLevel": "DEBUG"
}

我們也可以不限定條件，直接通過GET請求訪問/loggers來獲取所有的日誌級別設定，這裡就不列舉具體返回，讀者可以自行嘗試。

本文由程式猿DD-翟永超創作，採用 CC BY 3.0 CN協議進行許可。可自由轉載、引用，但需署名作者且註明文章出處。如轉載至微信公眾號，請在文末新增作者公眾號二維碼。

這裡寫圖片描述

Spring Boot 1.5.x新特性：動態修改日誌級