大牛帶你深入SpringBoot:自定義Endpoint 及實現原理

Endpoint

SpringBoot的Endpoint主要是用來監控應用服務的運行狀況,并集成在Mvc中提供查看接口。內置的Endpoint比如HealthEndpoint會監控dist和db的狀況,MetricsEndpoint則會監控內存和gc的狀況。 Endpoint的接口如下,其中*invoke()*是主要的方法,用于返回監控的內容,*isSensitive()*用于權限控制。

public interface Endpoint {

String getId();

boolean isEnabled();

boolean isSensitive();

T invoke();

}

Endpoint的加載還是依靠spring.factories實現的。spring-boot-actuator包下的META-INF/spring.factories配置了EndpointAutoConfiguration。

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\

...

org.springframework.boot.actuate.autoconfigure.EndpointAutoConfiguration,\

...

EndpointAutoConfiguration就會注入必要的Endpoint。有些Endpoint需要外部的收集類,比如TraceEndpoint。

@Bean

@ConditionalOnMissingBean

public TraceEndpoint traceEndpoint() {

return new TraceEndpoint(this.traceRepository);

}

TraceEndpoint會記錄每次請求的Request和Response的狀態,需要嵌入到Request的流程中,這里就主要用到了3個類。

1.TraceRepository用于保存和獲取Request和Response的狀態。

public interface TraceRepository {

List findAll();

void add(Map traceInfo);

}

2.WebRequestTraceFilter用于嵌入web request,收集請求的狀態并保存在TraceRepository中。

3.TraceEndpoint,invoke()方法直接調用TraceRepository保存的數據。

Endpoint的Mvc接口主要是通過EndpointWebMvcManagementContextConfiguration實現的,這個類的配置也放在spring.factories中。

...

org.springframework.boot.actuate.autoconfigure.ManagementContextConfiguration=\

org.springframework.boot.actuate.autoconfigure.EndpointWebMvcManagementContextConfiguration,\

org.springframework.boot.actuate.autoconfigure.EndpointWebMvcHypermediaManagementContextConfiguration

EndpointWebMvcManagementContextConfiguration注入EndpointHandlerMapping來實現Endpoint的Mvc接口。

自定義Endpoint

自定義Endpoint也是類似的原理。這里自定義Endpoint實現應用內存的定時收集。完整的代碼放在Github上了。

收集內存,MemStatus是內存的存儲結構,MemCollector是內存的收集類,使用Spring內置的定時功能,每5秒收集當前內存。

2.自定義Endpoint,getId是EndPoint的唯一標識,也是Mvc接口對外暴露的路徑。invoke方法,取出maxMemory和totalMemory和對應的時間。

3.AutoConfig,注入了MyEndPoint,和MemCollector。

public static class EndPointAutoConfig {

private List status = new ArrayList();

@Bean

public MyEndPoint myEndPoint() {

return new MyEndPoint(status);

}

@Bean

public MemCollector memCollector() {

return new MemCollector(status);

}

}

4.程序入口,運行后訪問http://localhost:8080/my 就可以看到了。

@Configuration

@EnableAutoConfiguration

public class CustomizeEndPoint {

public static void main(String[] args) {

SpringApplication application = new SpringApplication(CustomizeEndPoint.class);

application.run(args);

}

}

結語

Endpoint也是通過spring.factories實現擴展功能,注入了對應的Bean來實現應用監控的功能。

如果想學習Java工程化、高性能及分布式、深入淺出。微服務、Spring,MyBatis,Netty源碼分析的朋友可以加Java進階交流群:657741243 有阿里大牛直播講解技術,以及Java大型互聯網技術的視頻免費分享給大家。

點擊鏈接加入群聊【Java技術交流】:https://jq.qq.com/?_wv=1027&k=5waA078

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容