Spring Boot 注解方式自定义Endpoint详解

编辑: admin 分类: java 发布时间: 2021-12-03 来源:互联网
目录
  • 概述
  • 准备
    • 编写自定义Endpoint
    • 配置
    • 启动&测试
  • 注意
    • Spring Boot 常用endpoint的使用
      • Actuator
      • 一些常用 Endpoint
      • 如何访问 Actuator 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;
    }
}

    配置

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

    启动&测试

    启动后可以看到日志：

    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>)

    注意

    • @EndPoint中的id不能使用驼峰法，需要以-分割
    • @Spring Boot会去扫描@EndPoint注解下的@ReadOperation, @WriteOperation, @DeleteOperation注解，分别对应生成Get/Post/Delete的Mapping。注解中有个produces参数，可以指定media type, 如：application/json等。

    Spring Boot 常用endpoint的使用

    Actuator

    目的

    • 监控并管理应用程序

    监控：让我们去发现和了解程序的运行状况各种指标

    管理：比如说通过Actuator去做一个shutdown功能，通过访问一个特定的url去操作，默认是不开启的，另外 还可以在运行的过程中 对日志进行调整

    访问方式

    • HTTP
    • JMX

    默认 会把更多的 Actuator 暴露在JMX上面

    依赖

    • spring-boot-starter-actuator

    一些常用 Endpoint

    只有health和info 默认是可以通过http 进行访问的

    • shutdown 是默认不开启的一个
    • threaddump 去看线程情况
    • Prometheus 虽然是默认开启 但是 必须在pom文件上加入相关依赖 才能提供支持

    如何访问 Actuator Endpoint

    HTTP 访问

    • /actuator/<id >

    端口与路径

    • management.server.address=

    Actuator Endpoint 发布的地址

    • management.server.port=

    Actuator Endpoint 发布的端口号

    • management.endpoints.web.base-path=/actuator

    自定义端口

    • management.endpoints.web.path-mapping.<id>=路径

    修改端点的访问路径(映射)，端点默认使用的是它的 值

    开启 Endpoint

    • management.endpoint.<id>.enabled=true

    开启名为id的 Endpoint

    • management.endpoints.enabled-by-default=false

    端点启用是选择性加入而不是选择性排除。表示禁用了所有端点

    暴露 Endpoint

    • management.endpoints.jmx.exposure.exclude=

    jmx方式排除需要公开的端点

    • management.endpoints.jmx.exposure.include=*

    jmx方式包含需要公开的端点

    • management.endpoints.web.exposure.exclude=

    http方式排除需要公开的端点

    • management.endpoints.web.exposure.include=info, health

    以上为个人经验，希望能给大家一个参考，也希望大家多多支持自由互联。

    【原URL http://www.nextecloud.cn转载请说明出处】
    更多阅读