Spring Boot Actuator:自定义端点,其顶部具有MVC层

logo-spring-io

Spring Boot Actuator端点允许您监视应用程序并与之交互。 Spring Boot包含许多内置端点,您也可以添加自己的端点。
添加自定义端点就像创建一个从org.springframework.boot.actuate.endpoint.AbstractEndpoint扩展的类一样容易。 但是Spring Boot Actuator也提供了用MVC层装饰端点的可能性。

端点端点

有许多内置端点,但是缺少一个端点是公开所有端点的端点。 默认情况下,终结点通过HTTP公开,其中终结点的ID映射到URL。 在下面的示例中,创建了具有ID endpoints的新端点,并且其invoke方法返回所有可用端点:

@Component
public class EndpointsEndpoint extends AbstractEndpoint<List<Endpoint>> {private List<Endpoint> endpoints;@Autowiredpublic EndpointsEndpoint(List<Endpoint> endpoints) {super("endpoints");this.endpoints = endpoints;}@Overridepublic List<Endpoint> invoke() {return endpoints;}
}

@Component注释将端点添加到现有端点列表中。 /endpoints URL现在将公开所有具有idenabledsensitive属性的端点:

[{"id": "trace","sensitive": true,"enabled": true},{"id": "configprops","sensitive": true,"enabled": true}
]

新端点还将作为MBean在JMX服务器上注册: [org.springframework.boot:type=Endpoint,name=endpointsEndpoint]

MVC端点

Spring Boot Actuator提供了一项附加功能,该功能是通过org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint接口在终结点之上的MVC层的策略MvcEndpoint可以使用@RequestMapping和其他Spring MVC功能。

请注意, EndpointsEndpoint返回所有可用的端点。 但是,如果用户可以通过其enabled sensitive属性过滤端点,那就太好了。

MvcEndpoint必须使用有效的@RequestMapping方法创建一个新的MvcEndpoint 。 请注意,不允许在类级别使用@Controller@RequestMapping ,因此使用@Component来使端点可用:

@Component
public class EndpointsMvcEndpoint extends EndpointMvcAdapter {private final EndpointsEndpoint delegate;@Autowiredpublic EndpointsMvcEndpoint(EndpointsEndpoint delegate) {super(delegate);this.delegate = delegate;}@RequestMapping(value = "/filter", method = RequestMethod.GET)@ResponseBodypublic Set<Endpoint> filter(@RequestParam(required = false) Boolean enabled,@RequestParam(required = false) Boolean sensitive) {}
}

新方法将在/endpoints/filter URL下可用。 该方法的实现很简单:它获取可选的enabled sensitive参数,并过滤委托的invoke方法结果:

@RequestMapping(value = "/filter", method = RequestMethod.GET)
@ResponseBody
public Set<Endpoint> filter(@RequestParam(required = false) Boolean enabled,@RequestParam(required = false) Boolean sensitive) { Predicate<Endpoint> isEnabled =endpoint -> matches(endpoint::isEnabled, ofNullable(enabled));Predicate<Endpoint> isSensitive =endpoint -> matches(endpoint::isSensitive, ofNullable(sensitive));return this.delegate.invoke().stream().filter(isEnabled.and(isSensitive)).collect(toSet());
}private <T> boolean matches(Supplier<T> supplier, Optional<T> value) {return !value.isPresent() || supplier.get().equals(value.get());
}

用法示例:

  • 所有启用的端点: /endpoints/filter?enabled=true
  • 所有敏感端点: /endpoints/filter?sensitive=true
  • 所有已启用和敏感的端点: /endpoints/filter?enabled=true&sensitive=true

使端点可发现

EndpointsMvcEndpoint使用MVC功能,但仍返回纯终结点对象。 如果Spring HATEOAS在类路径中,则可以扩展filter方法以返回org.springframework.hateoas.Resource以及指向端点的链接:

class EndpointResource extends ResourceSupport {private final String managementContextPath;private final Endpoint endpoint;EndpointResource(String managementContextPath, Endpoint endpoint) {this.managementContextPath = managementContextPath;this.endpoint = endpoint;if (endpoint.isEnabled()) {UriComponentsBuilder path = fromCurrentServletMapping().path(this.managementContextPath).pathSegment(endpoint.getId());this.add(new Link(path.build().toUriString(), endpoint.getId()));    }}public Endpoint getEndpoint() {return endpoint;}
}

EndpointResource将包含指向每个已启用端点的链接。 请注意,构造函数采用managamentContextPath变量。 该变量包含一个Spring Boot Actuator management.contextPath属性值。 用于设置管理端点的前缀。

EndpointsMvcEndpoint类中所需的更改:

@Component
public class EndpointsMvcEndpoint extends EndpointMvcAdapter {@Value("${management.context-path:/}") // default to '/'private String managementContextPath;@RequestMapping(value = "/filter", method = RequestMethod.GET)@ResponseBodypublic Set<Endpoint> filter(@RequestParam(required = false) Boolean enabled,@RequestParam(required = false) Boolean sensitive) {// predicates declarationsreturn this.delegate.invoke().stream().filter(isEnabled.and(isSensitive)).map(e -> new EndpointResource(managementContextPath, e)).collect(toSet());}
}

我的Chrome浏览器中安装了JSON Formatter的结果:

act-jsonviewer

但是,为什么不直接从EndpointsEnpoint返回资源呢? 在EndpointResource了从HttpServletRequest中提取信息的UriComponentsBuilder ,它将在调用MBean的getData操作时引发异常(除非不需要JMX)。

管理端点状态

端点不仅可以用于监视,还可以用于管理。 已经有内置的ShutdownEndpoint (默认情况下禁用),可以关闭ApplicationContext 。 在以下(假设的)示例中,用户可以更改所选端点的状态:

@RequestMapping(value = "/{endpointId}/state")
@ResponseBody
public EndpointResource enable(@PathVariable String endpointId) {Optional<Endpoint> endpointOptional = this.delegate.invoke().stream().filter(e -> e.getId().equals(endpointId)).findFirst();if (!endpointOptional.isPresent()) {throw new RuntimeException("Endpoint not found: " + endpointId);}Endpoint endpoint = endpointOptional.get();        ((AbstractEndpoint) endpoint).setEnabled(!endpoint.isEnabled());return new EndpointResource(managementContextPath, endpoint);
}

呼叫disabled端点用户时,应收到以下响应:

{"message": "This endpoint is disabled"
}

更进一步

下一步可能是为自定义(或现有)端点添加用户界面,但这不在本文讨论范围之内。 如果您有兴趣,可以看看Spring Boot Admin ,它是Spring Boot应用程序的简单管理界面。

摘要

Spring Boot Actuator 提供了Spring Boot的所有生产就绪功能以及许多内置端点。 只需花费很少的精力,即可添加自定义端点,以扩展应用程序的监视和管理功能。

参考文献

  • http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#production-ready

翻译自: https://www.javacodegeeks.com/2014/10/spring-boot-actuator-custom-endpoint-with-mvc-layer-on-top-of-it.html

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/361479.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

jQuery自适应倒计时插件

jQuery自适应倒计时插件 在线演示本地下载更多专业前端知识&#xff0c;请上 【猿2048】www.mk2048.com

Linux三大共享文件的方法

1. Samba Samba 用于Linux 和windows之间的共享&#xff0c;ubuntu里面默认没有安装samba 在安装好samba之后&#xff0c;就用开始配置samba服务: Samba服务器主要配置文件为/etc/samba/smb.conf&#xff0c;并且可以将NetBIOS名与主机的对应关系写在/etc/samba /lmhosts文件中…

Unity3D实践系列03,使用Visual Studio编写脚本与调试

在Unity3D中&#xff0c;只有把脚本赋予Scene中的GameObject&#xff0c;脚本才会得以执行。 添加Camera类型的GameObject。 Unity3D默认使用"MonoDevelop"编辑器&#xff0c;这里&#xff0c;我想使用Visual Studio作为编辑器。 依次点击"Edit","Pre…

纯CSS3文字Loading动画特效

纯CSS3文字Loading动画特效是一款个性的loading文字加载动画。 在线演示本地下载更多专业前端知识&#xff0c;请上 【猿2048】www.mk2048.com

所有OSGi套件的通用CXF请求拦截器

几个月以来&#xff0c;我一直在研究Apache CXF&#xff0c;Karaf和Felix&#xff0c;我发现所有这些捆绑技术都非常有趣。 在处理一些用例时&#xff0c;我陷入一种情况&#xff0c;即我只需要一个Interceptor即可在发送到Karaf应用程序下部署的任何捆绑包的每个HTTP请求上执行…

通过init-connect + binlog 实现MySQL审计功能

背景&#xff1a; 假设这么一个情况&#xff0c;你是某公司mysql-DBA&#xff0c;某日突然公司数据库中的所有被人为删了。 尽管有数据备份&#xff0c;但是因服务停止而造成的损失上千万&#xff0c;现在公司需要查出那个做删除操作的人。 但是拥有数据库操作权限的人很多&…

AngularJS中ui-router全攻略

首先是angular-ui-router的基本用法。■ 如何引用依赖angular-ui-router angular.module(app,["ui.router"]).config(function($stateProvider){$stateProvider.state(stateName, stateCofig);}) ■ $stateProvider.state(stateName, stateConfig)stateName是string类…

如何为JBoss Developer Studio 8设置BPM和规则工具

最新的JBoss Developer Studio&#xff08;JBDS&#xff09;的发布带来了有关如何开始使用尚未安装的各种JBoss Integration和BPM产品工具集的问题。 在本系列文章中&#xff0c;我们将为您概述如何安装每套工具并说明它们支持哪些产品。 这将有助于您在着手进行下一个JBoss集…

基于HTML5陀螺仪实现ofo首页眼睛移动效果

最近用ofo小黄车App的时候&#xff0c;发现以前下方扫一扫变成了一个眼睛动的小黄人&#xff0c;觉得蛮有意思的&#xff0c;这里用HTML5仿一下效果。 ofo眼睛效果 效果分析 从效果中不难看出&#xff0c;是使用陀螺仪事件实现的。 这里先来看一下HTML5中陀螺仪事件的一些概…

定时开机 命令 自动开机

自动开机&#xff1a; 首先开机后按住Delete键&#xff0c;就是平常常用的删除按键&#xff0c;然后就会进入到BIOS界面。虽然是一个满眼E文的蓝色世界&#xff0c;但不要害怕&#xff0c;没有问题的。 在BIOS设置主界面中选择“Power”选项,进入电源管理窗口。有些机器是在“P…

多米诺骨牌 优化版

算法&#xff1a; 在之前搜索出状态的基础上&#xff0c;再压缩一次状态。 View Code //by yefeng #include<iostream> using namespace std;typedef long long LL; const int mod 9937; int mask,idx, n , m;struct Matrix{int mat[257][257];void zero(){ memse…

Apache Camel请向我解释这些端点选项的含义

在即将发布的Apache Camel 2.15中&#xff0c;我们使Camel更智能。 现在&#xff0c;它可以充当老师&#xff0c;并向您说明其配置方式以及这些选项的含义。 Camel可以做的第一课是告诉您如何配置所有端点以及这些选项的含义。 接下来我们要学习的课程是让Camel解释EIP的选项…

JS正则表达式的基础用法

RegExp&#xff08;正则表达式&#xff09;对象 正则表达式是一个描述字符模式的对象&#xff0c;可以处理更复杂的字符串。进行匹配替换。 常用的修饰符&#xff1a; i/m/g 使用方法&#xff1a; 【声明方法一: new RegExp(value)】 var patt new RegExp(value)&#xff1b…

JS获取屏幕浏览器网页高度和宽度属性

1 网页可见区域宽&#xff1a;document.body.clientWidth 2 网页可见区域高&#xff1a;document.body.clientHeight 3 网页可见区域宽&#xff1a;document.body.offsetWidth (包括边线的宽) 4 网页可见区域高&#xff1a;document.body.offsetHeight (包括边线的宽) 5 网页正…

微信扫码进入小程序

这几天开发完小程序之后&#xff0c;需要实现微信扫码进入小程序&#xff0c;坎坎坷坷的过程终于实现了&#xff0c;现在做一总结&#xff1a; 1、配置二维码规则&#xff1a; 2、页面插入代码即可&#xff1a; onLoad: function(options) {console.log("index 生命周期 o…

使用用户名/密码和Servlet安全性保护WebSockets

RFC 6455提供了WebSockets安全注意事项的完整列表。 其中一些是在协议本身中烘焙的&#xff0c;其他一些则需要更多有关如何在特定服务器上实现它们的解释。 让我们谈谈协议本身内置的一些安全性&#xff1a; HTTP请求中的Origin头仅包含标识发起该请求的主体&#xff08;网页…

文件的读取

这几天在研究文件读取问题&#xff0c;写了个小demo&#xff0c;如下&#xff1a; <!DOCTYPE html> <html lang"en"> <head><meta charset"UTF-8"><title>Document</title> </head> <body><input type…

关于stm32启动文件的选择

关于stm32启动文件的选择 1推荐- startup_stm32f10x_ld_vl.s: for STM32 Low density Value line devices - startup_stm32f10x_ld.s: for STM32 Low density devices - startup_stm32f10x_md_vl.s: for STM32 Medium density Value line devices - startup_stm32f10x_md.s: fo…

如何使用GZip和Jersey压缩Java REST API中的响应

在某些情况下&#xff0c;您的REST api会提供非常长的响应&#xff0c;我们都知道移动设备/网络上的传输速度和带宽仍然非常重要。 我认为这是开发支持移动应用程序的REST api时需要解决的第一个性能优化点。 你猜怎么了&#xff1f; 因为响应是文本&#xff0c;所以我们可以压…

C函数篇(recv函数)

简述 从一个套接口接收数据。表头文件&#xff1a;#include<sys/types.h>#include<sys/socket.h>int PASCAL FAR recv( SOCKET s, char FAR* buf, int len, int flags);s&#xff1a;一个标识已连接套接口的描述字。buf&#xff1a;用于接收数据的缓冲区。len&…