美文网首页Java高级交流Java 杂谈
大牛带你深入SpringBoot:自定义Endpoint 及实现

大牛带你深入SpringBoot:自定义Endpoint 及实现

作者: Java小生 | 来源:发表于2018-08-07 15:19 被阅读7次

    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

    相关文章

      网友评论

        本文标题:大牛带你深入SpringBoot:自定义Endpoint 及实现

        本文链接:https://www.haomeiwen.com/subject/pecavftx.html