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

• • 编写自定义endpoint
• spring boot 常用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

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