本文基于spring boot 2.2.0 release版本。

在上一篇文章《spring boot Actuator原理詳解之啟動》詳細介紹了在web環境下，Actuator是如何啟動的，這里對流程做一個簡單的總結：

掃描所有@Endpoint注解的類，這些類都是Endpoint；

使用過濾器對Endpoint對象進行過濾，沒有被過濾掉的才可以進入下一步；

讀取Endpoint對象的每個方法，判斷是否有@ReadOperation、@WriteOperation、@DeleteOperation三個注解，如果有，則針對每個被注解的方法創建操作對象Operation；

根據操作對象、Endpoint對象、Endpoint名創建為RequestMappingInfo，并將其注冊到spring mvc中；

注冊成功之后，Endpoint對象便可以對外提供服務。

明白了上面整個啟動流程之后，我們也可以編寫一個自定義的Endpoint。
自定義Endpoint的關鍵點：

類上必須有注解@Endpoint，注解必須設置id值，否則啟動拋出如下異常：Caused by: java.lang.IllegalStateException: No @Endpoint id attribute specified for XXXClass；

必須指定方法注解為下面三個中一個：@ReadOperation、@WriteOperation、@DeleteOperation；

注解@Selector可以指定路徑參數，比如/actuator/caches/{cache}花括號里面的內容是路徑參數，我們可以在方法入參上添加@Selector來指定路徑參數，比如public String counters(@Selector int value)；

默認Endpoint對象的方法都是以json格式返回客戶端，可以通過設置@ReadOperation、@WriteOperation、@DeleteOperation的produces屬性指定其他格式。

下面給出一個自定義Endpoint的例子：

/*** 統計方法該Endpoint對象的次數*/ @Component @Endpoint(id="counter") public class Counter {private AtomicInteger cnt=new AtomicInteger(0);@ReadOperationpublic int counter() {return cnt.getAndAdd(1);}@ReadOperationpublic int counters(@Selector int value) {return cnt.getAndAdd(value);} }

上面這個類只是一個示例，并沒有實際意義。運行起來后，訪問http://localhost:8079/actuator/counter，每次訪問都會返回一個比之前大1的數字。

我們還可以使用注解@EndpointWebExtension擴展已有的Endpoint。
下面是spring提供的對EnvironmentEndpoint的擴展：

@EndpointWebExtension(endpoint = EnvironmentEndpoint.class) public class EnvironmentEndpointWebExtension {private final EnvironmentEndpoint delegate;public EnvironmentEndpointWebExtension(EnvironmentEndpoint delegate) {this.delegate = delegate;}@ReadOperationpublic WebEndpointResponse<EnvironmentEntryDescriptor> environmentEntry(@Selector String toMatch) {EnvironmentEntryDescriptor descriptor = this.delegate.environmentEntry(toMatch);return new WebEndpointResponse<>(descriptor, getStatus(descriptor));}private int getStatus(EnvironmentEntryDescriptor descriptor) {if (descriptor.getProperty() == null) {return WebEndpointResponse.STATUS_NOT_FOUND;}return WebEndpointResponse.STATUS_OK;} }

就web環境下來說，如果擴展類的方法有與原類相同的http請求路徑，那么擴展類會替換掉原來的方法，也就是說，訪問該路徑時，不會訪問到原類的方法，而是訪問到擴展類。

總結

以上是生活随笔為你收集整理的spring boot Actuator之自定义Endpoint的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。