Spring Boot 2.x 自定義Endpoint

概述

在使用Spring Boot的時候我們經常使用actuator，健康檢查，bus中使用/refresh等。這里記錄如何使用注解的方式自定義Endpoint。可用於滿足一些服務狀態監控，或者優雅停機等。

准備

Spring Boot項目，pom中加入：

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

編寫自定義Endpoint

@Configuration
@Endpoint(id = "my-endpoint")
public class MyEndpoint {

    @ReadOperation
    public Map<String, Object> endpoint() {
        Map<String, Object> map = new HashMap<>(16);
        map.put("message", "this is my endpoint");
        return map;
    }
}

1.配置

management.endpoints.web.exposure.include=my-endpoint

2.啟動&測試

啟動后可以看到日志：

Mapped "{[/actuator/my-endpoint],methods=[GET],produces=[application/vnd.spring-boot.actuator.v2+json || application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.web.servlet.AbstractWebMvcEndpointHandlerMapping$OperationHandler.handle(javax.servlet.http.HttpServletRequest,java.util.Map<java.lang.String, java.lang.String>)

3.注意

• @EndPoint中的id不能使用駝峰法，需要以-分割。
• @Spring Boot會去掃描@EndPoint注解下的@ReadOperation, @WriteOperation, @DeleteOperation注解，分別對應生成Get/Post/Delete的Mapping。注解中有個produces參數，可以指定media type, 如：application/json等。