Spring Boot2.x如何自定义Endpoint

更新时间：2020年02月27日 10:40:00 作者：Kancy

这篇文章主要介绍了Spring Boot2.x如何自定义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;
  }
}

1.配置

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

2.启动&测试

启动后可以看到日志：

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

3.注意

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

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

基于SpringBoot2的Shiro最简配置操作(两个文件)
这篇文章主要介绍了基于SpringBoot2的Shiro最简配置操作(两个文件)，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2021-01-01
java中常用的排序方法
今天给大家介绍一下，java中常用的排序方法。
2013-04-04
Spring MVC实现文件上传和下载
这篇文章主要为大家详细介绍了Spring MVC实现文件上传和下载，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-04-04
浅谈自定义注解在Spring中的应用
这篇文章主要介绍了浅谈自定义注解在Spring中的应用，具有一定借鉴价值，需要的朋友可以参考下。
2017-12-12
java版飞机大战实战项目详细步骤
这篇文章主要为大家详细介绍了java版飞机大战实战项目详细步骤，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2020-11-11
详解Spring boot上配置与使用mybatis plus
这篇文章主要介绍了详解Spring boot上配置与使用mybatis plus，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-05-05
springboot application.yml使用@@pom文件配置问题
这篇文章主要介绍了springboot application.yml使用@@pom文件配置问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-07-07
通过Java带你了解网络IO模型
这篇文章将通过Java带大家了解网络IO模型，包括BIO,NoBlockingIO,NIO（NewIO）,AIO等做了详细得介绍，感兴趣的小伙伴可以参考阅读本文
2023-05-05
Java HashMap源码深入分析讲解
在java开发中，HashMap是最常用、最常见的集合容器类之一，下面一起温故一下，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-08-08
java(swing)+ mysql实现学生信息管理系统源码
这篇文章主要分享了java mysql实现学生信息管理系统的源码，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-11-11