SpringBoot：强大的 Actuator 服务监控与管理
SpringBoot是为了简化Spring应用的创建、运行、调试、部署等一系列问题而诞生的产物，自动装配的特性让我们可以更好的关注业务本身而不是外部的XML配置，我们只需遵循规范，引入相关的依赖就可以轻易的搭建出一个 WEB 工程
actuator是spring boot项目中非常强大一个功能，有助于对应用程序进行监视和管理，通过 restful api 请求来监管、审计、收集应用的运行情况，针对微服务而言它是必不可少的一个环节…
actuator 的核心部分，它用来监视应用程序及交互，spring-boot-actuator中已经内置了非常多的 Endpoints（health、info、beans、httptrace、shutdown等等），同时也允许我们自己扩展自己的端点
Spring Boot 2.0 中的端点和之前的版本有较大不同,使用时需注意。另外端点的监控机制也有很大不同，启用了不代表可以直接访问，还需要将其暴露出来，传统的management.security管理已被标记为不推荐。
status，认证显示全部信息详情）Noinfo显示任意的应用信息（在资源文件写info.xxx即可）Noliquibase展示Liquibase 数据库迁移Yesmetrics展示当前应用的 metrics 信息Yesmappings显示所有 @RequestMapping 路径集列表Yesscheduledtasks显示应用程序中的计划任务Yessessions允许从Spring会话支持的会话存储中检索和删除用户会话。Yesshutdown允许应用以优雅的方式关闭（默认情况下不启用）Yesthreaddump执行一个线程dumpYeshttptrace显示HTTP跟踪信息（默认显示最后100个HTTP请求 - 响应交换）Yes导入依赖在 pom.xml 中添加 spring-boot-starter-actuator 的依赖
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId></dependency><dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId></dependency>
注意事项
如果要访问info接口想获取maven中的属性内容请记得添加如下内容
<build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> <executions> <execution> <goals> <goal>build-info</goal> </goals> </execution> </executions> </plugin> </plugins></build>属性配置
在 application.properties 文件中配置actuator的相关配置，其中info开头的属性，就是访问info端点中显示的相关内容，值得注意的是Spring Boot2.x中，默认只开放了info、health两个端点，剩余的需要自己通过配置management.endpoints.web.exposure.include属性来加载（有include自然就有exclude，不做详细概述了）。如果想单独操作某个端点可以使用management.endpoint.端点.enabled属性进行启用或禁用
# 描述信息info.blog-url=http://blog.battcn.cominfo.author=Levininfo.version=@project.version@# 加载所有的端点/默认只加载了 info / healthmanagement.endpoints.web.exposure.include=*management.endpoint.health.show-details=always# 可以关闭制定的端点management.endpoint.shutdown.enabled=false# 路径映射，将 health 路径映射成 rest_health 那么在访问 health 路径将为404，因为原路径已经变成 rest_health 了，一般情况下不建议使用# management.endpoints.web.path-mapping.health=rest_health
简单测试
启动项目，访问 http://localhost:8080/actuator/info 看到如下内容代表配置成功
{ "blog-url": "http://blog.battcn.com", "author": "Levin", "version": "0.0.1-SNAPSHOT"}自定义 - 重点
上面讲了很多都是配置相关，以及自带的一些端点，在实际应用中有时候默认并不能满足我们的要求，比如Spring Boot默认的健康端点就很有可能不能满足
下列是依赖spring-boot-xxx-starter后相关HealthIndicator的实现（通过management.health.defaults.enabled 属性可以禁用它们），但想要获取一些额外的信息时，自定义的作用就体现出来了…
Cassandra 数据库是否启动。DiskSpaceHealthIndicator检查磁盘空间不足。DataSourceHealthIndicator检查是否可以获得连接 DataSource。ElasticsearchHealthIndicator检查 Elasticsearch 集群是否启动。InfluxDbHealthIndicator检查 InfluxDB 服务器是否启动。JmsHealthIndicator检查 JMS 代理是否启动。MailHealthIndicator检查邮件服务器是否启动。MongoHealthIndicator检查 Mongo 数据库是否启动。Neo4jHealthIndicator检查 Neo4j 服务器是否启动。RabbitHealthIndicator检查 Rabbit 服务器是否启动。RedisHealthIndicator检查 Redis 服务器是否启动。SolrHealthIndicator检查 Solr 服务器是否已启动。健康端点（第一种方式）实现HealthIndicator接口，根据自己的需要判断返回的状态是UP还是DOWN，功能简单。
package com.battcn.health;import org.springframework.boot.actuate.health.Health;import org.springframework.boot.actuate.health.HealthIndicator;import org.springframework.stereotype.Component;/** * <p>自定义健康端点</p> * * @author Levin * @since 2018/5/24 0024 */@Component("my1")public class MyHealthIndicator implements HealthIndicator { private static final String VERSION = "v1.0.0"; @Override public Health health() { int code = check(); if (code != 0) { Health.down().withDetail("code", code).withDetail("version", VERSION).build(); } return Health.up().withDetail("code", code) .withDetail("version", VERSION).up().build(); } private int check() { return 0; }}
简单测试
启动项目，访问 http://localhost:8080/actuator/health 看到如下内容代表配置成功
{ "status": "UP", "details": { "my1": { "status": "UP", "details": { "code": 0, "version": "v1.0.0" } }, "diskSpace": { "status": "UP", "details": { "total": 100944310272, "free": 55071866880, "threshold": 10485760 } } }}健康端点（第二种方式）
继承AbstractHealthIndicator抽象类，重写doHealthCheck方法，功能比第一种要强大一点点，默认的DataSourceHealthIndicator 、 RedisHealthIndicator 都是这种写法，内容回调中还做了异常的处理。
package com.battcn.health;import org.springframework.boot.actuate.health.AbstractHealthIndicator;import org.springframework.boot.actuate.health.Health;import org.springframework.stereotype.Component;/** * <p>自定义健康端点</p> * <p>功能更加强大一点，DataSourceHealthIndicator / RedisHealthIndicator 都是这种写法</p> * * @author Levin * @since 2018/5/24 0024 */@Component("my2")public class MyAbstractHealthIndicator extends AbstractHealthIndicator { private static final String VERSION = "v1.0.0"; @Override protected void doHealthCheck(Health.Builder builder) throws Exception { int code = check(); if (code != 0) { builder.down().withDetail("code", code).withDetail("version", VERSION).build(); } builder.withDetail("code", code) .withDetail("version", VERSION).up().build(); } private int check() { return 0; }}
简单测试
启动项目，访问 http://localhost:8080/actuator/health 看到如下内容代表配置成功
{ "status": "UP", "details": { "my2": { "status": "UP", "details": { "code": 0, "version": "v1.0.0" } }, "my1": {...}, "diskSpace": {...} }}定义自己的端点
上面介绍的 info、health 都是spring-boot-actuator内置的，真正要实现自己的端点还得通过@Endpoint、 @ReadOperation、@WriteOperation、@DeleteOperation。
注解介绍
不同请求的操作，调用时缺少必需参数，或者使用无法转换为所需类型的参数，则不会调用操作方法，响应状态将为400（错误请求）
@Endpoint 构建 rest api 的唯一路径@ReadOperation GET请求，响应状态为 200 如果没有返回值响应 404（资源未找到）@WriteOperation POST请求，响应状态为 200 如果没有返回值响应 204（无响应内容）@DeleteOperation DELETE请求，响应状态为 200 如果没有返回值响应 204（无响应内容）package com.battcn.endpoint;
import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import java.util.HashMap;
import java.util.Map;
/**
<p>@Endpoint 是构建 rest 的唯一路径 </p>不同请求的操作，调用时缺少必需参数，或者使用无法转换为所需类型的参数，则不会调用操作方法，响应状态将为400（错误请求）<P>@ReadOperation = GET 响应状态为 200 如果没有返回值响应 404（资源未找到） </P><P>@WriteOperation = POST 响应状态为 200 如果没有返回值响应 204（无响应内容） </P><P>@DeleteOperation = DELETE 响应状态为 200 如果没有返回值响应 204（无响应内容） </P>@author Levin@since 2018/5/24 0024
*/
@Endpoint(id = "battcn")
public class MyEndPoint {
@ReadOperation
public Map<String, String> hello() {
Map<String, String> result = new HashMap<>();
result.put("author", "Levin");
result.put("age", "24");
result.put("email", "1837307557@qq.com");
return result;
}
}
以为这就大功告成了吗，现实告诉我的是`spring-boot`默认是不认识这玩意的，得申明成一个`Bean`（请看 **主函数**）主函数
package com.battcn;import com.battcn.endpoint.MyEndPoint;import org.springframework.boot.SpringApplication;import org.springframework.boot.actuate.autoconfigure.endpoint.condition.ConditionalOnEnabledEndpoint;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;/** * @author Levin */@SpringBootApplicationpublic class Chapter13Application { public static void main(String[] args) { SpringApplication.run(Chapter13Application.class, args); } @Configuration static class MyEndpointConfiguration { @Bean @ConditionalOnMissingBean @ConditionalOnEnabledEndpoint public MyEndPoint myEndPoint() { return new MyEndPoint(); } }}测试
完成准备事项后，启动Chapter13Application 访问 http://localhost:8080/actuator/battcn 看到如下内容代表配置成功…
{ "author": "Levin", "age": "24", "email": "1837307557@qq.com"}总结
参考文档：https://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#production-ready
目前很多大佬都写过关于 SpringBoot 的教程了，如有雷同，请多多包涵，本教程基于最新的 spring-boot-starter-parent：2.0.2.RELEASE编写，包括新版本的特性都会一起介绍…
本文的重点是你有没有收获与成长，其余的都不重要，希望读者们能谨记这一点。同时我经过多年的收藏目前也算收集到了一套完整的学习资料，包括但不限于：分布式架构、高可扩展、高性能、高并发、Jvm性能调优、Spring，MyBatis，Nginx源码分析，Redis，ActiveMQ、Mycat、Netty、Kafka、Mysql、Zookeeper、Tomcat、Docker、Dubbo、Nginx等多个知识点高级进阶干货，希望对想成为架构师的朋友有一定的参考和帮助
感兴趣的可以加一下三千人Java技术交流分享群：“708 701 457”免费获取声明：本站所有文章资源内容，如无特殊说明或标注，均为采集网络资源。如若本站内容侵犯了原著者的合法权益，可联系本站删除。
