Spring Boot Actuator Endpoints 如何使用？Spring Boot 运行状况端点的用法

Spring Boot Actuator 是一个用于监控和管理 Spring Boot 应用程序的模块，它提供了各种端点，用于获取应用程序的运行时信息。其中之一就是运行状况端点（Health Endpoint），它的主要作用是提供应用程序的健康状态信息。这个端点对于运维人员和开发人员来说非常有用，因为它可以帮助他们快速了解应用程序是否正常运行，以及如果出现问题时应该采取哪些措施。

运行状况端点的主要优势包括：

实时健康状态：运行状况端点提供了实时的应用程序健康状态，包括是否存活（UP）或不可用（DOWN）。
自定义健康检查：你可以自定义健康检查，以满足特定的应用程序需求，例如检查数据库连接、消息队列等。
集成监控系统：运行状况端点可以与各种监控系统集成，如 Prometheus、Grafana 等，以便进行监控和警报。

Spring Boot Actuator Endpoints 使用场景

使用运行状况端点有许多场景，以下是一些常见的使用示例：

生产环境监控：在生产环境中，运行状况端点可以用于监视应用程序的健康状态，及时发现问题并采取措施，以确保高可用性和稳定性。
自动化运维：运维团队可以编写脚本或自动化工具来定期检查运行状况端点，自动化地进行故障排除和修复。
CI/CD 集成：在持续集成和持续交付（CI/CD）流水线中，可以使用运行状况端点来验证新版本的应用程序是否健康，并在不正常时中止部署。

常见 Spring Boot Actuator 端点

1./actuator/health：此端点用于检查应用程序的健康状态。它返回一个包含应用程序健康信息的 JSON 响应，包括是否存活、数据库连接状态等。
2./actuator/info：此端点用于提供应用程序的自定义信息。你可以配置自己的应用程序信息，例如版本号、描述等，并通过此端点获取它们。
3./actuator/metrics：此端点提供了应用程序的各种度量指标，如内存使用、线程池信息、HTTP 请求计数等。你可以使用这些指标来监控应用程序的性能。
4./actuator/env：此端点允许查看应用程序的环境属性。你可以查看应用程序配置的属性值，以及 Spring Boot 的自动配置属性。
5./actuator/beans：此端点提供了应用程序中所有 Spring Bean 的列表，以及它们的依赖关系。这对于调试 Spring 应用程序非常有用。
6./actuator/loggers：此端点用于查看和修改应用程序的日志级别。你可以动态地更改应用程序中不同类的日志级别，以进行日志记录调试。
7./actuator/auditevents：此端点提供了安全审计事件的信息，例如用户登录、访问授权等。这对于监控应用程序的安全性非常有用。
8./actuator/trace：此端点允许查看 HTTP 请求和响应的跟踪信息，包括请求和响应的头部、参数等。这对于排查问题和分析请求非常有用。
Spring Boot Actuator 端点通过 HTTP 协议暴露，因此你可以通过浏览器、命令行工具（如 curl）或其他 HTTP 客户端来访问它们。通常情况下，它们在生产环境中处于安全模式，需要进行适当的身份验证和授权才能访问。

Spring Boot Actuator Endpoints 配置

要在 Spring Boot 项目中使用运行状况端点，你需要执行以下步骤：

1. 添加依赖

首先，在你的pom.xml文件中添加 Spring Boot Actuator 依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

2. 配置端点

在application.properties或application.yml文件中，你可以配置哪些端点应该启用。例如，要启用运行状况端点，可以添加以下配置：

management.endpoints.web.exposure.include=health

3. 自定义健康检查

如果你需要自定义健康检查，可以创建一个实现HealthIndicator接口的类，并注册为 Spring Bean。这个自定义健康指示器将被运行状况端点用于检查应用程序的健康状态。

import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.stereotype.Component;

@Component
public class CustomHealthIndicator implements HealthIndicator {

    @Override
    public Health health() {
        // 在这里执行自定义的健康检查逻辑
        if (isCustomHealthCheckSuccessful()) {
            return Health.up().build();
        } else {
            return Health.down().build();
        }
    }

    private boolean isCustomHealthCheckSuccessful() {
        // 实现你的自定义健康检查逻辑
        // 返回 true 表示健康，返回 false 表示不健康
    }
}

Spring Boot Actuator Endpoints 实践案例

要使用 Spring Boot Actuator Endpoints，需要执行以下步骤：

1.添加依赖：首先，确保你的 Spring Boot 项目已经添加了 Spring Boot Actuator 依赖。你可以在项目的pom.xml（如果使用 Maven）或build.gradle（如果使用 Gradle）文件中添加以下依赖：
使用 Maven：

  <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-actuator</artifactId>
   </dependency>

使用 Gradle：

 implementation 'org.springframework.boot:spring-boot-starter-actuator'

2.配置端点：默认情况下，Spring Boot Actuator 会启用一些核心端点，但你可以根据需要进行自定义配置。在application.properties或application.yml文件中，你可以添加配置来启用或禁用特定端点，以及配置它们的属性。例如，以下是一个配置示例，启用了所有核心端点：
使用application.properties：

 management.endpoints.web.exposure.include=*

使用application.yml：

 management:
 endpoints:
   web:
     exposure:
       include: "*"

你也可以配置单个端点的属性，例如更改健康检查端点的路径或修改日志级别端点的访问权限。具体的配置取决于你的需求。

3.访问端点：启用端点后，你可以使用 HTTP 请求来访问它们。例如，要查看健康检查端点，可以使用以下命令：

 curl http://localhost:8080/actuator/health

或者在浏览器中访问 http://localhost:8080/actuator/health。

访问Spring Boot Actuator 端点路由 — 访问 Spring Boot Actuator 端点路由

4.授权和安全性：默认情况下，Spring Boot Actuator 端点是受保护的，需要进行适当的身份验证和授权才能访问。你可以使用 Spring Security 或其他安全框架来配置端点的访问权限。在application.properties或application.yml中配置 Spring Security 规则，以允许或拒绝访问端点。

例如，要允许所有用户访问所有端点，可以添加以下 Spring Security 配置：
使用application.properties：

management.endpoints.web.security.enabled=false

使用application.yml：

management:
 endpoints:
   web:
     security:
       enabled: false

5.自定义端点：除了使用默认的端点，你还可以创建自定义端点来公开应用程序的特定信息或功能。要创建自定义端点，你需要实现Endpoint接口，并将其注册到 Spring 容器中。

例如，以下是一个自定义端点的示例：

   @Component
   public class CustomEndpoint implements Endpoint<Map<String, Object>> {
       @Override
       public String getId() {
           return "custom";
       }

       @Override
       public Map<String, Object> invoke() {
           // 返回自定义信息
           Map<String, Object> customInfo = new HashMap<>();
           customInfo.put("message", "This is a custom endpoint");
           // 添加更多自定义信息
           return customInfo;
       }
   }

然后，你可以通过 HTTP 请求访问自定义端点，例如 http://localhost:8080/actuator/custom。

通过执行上述步骤，你就可以使用 Spring Boot Actuator Endpoints 来监控、管理和诊断你的 Spring Boot 应用程序了。请根据你的需求自定义配置端点和安全性设置。

Spring Boot Actuator Endpoints 注意事项

在使用运行状况端点时，有一些注意事项需要考虑：

安全性：运行状况端点可能包含敏感信息，因此在生产环境中应适当保护它们，以防止未经授权的访问。
自定义检查：自定义健康检查逻辑应该设计得足够健壮，以确保准确地反映应用程序的健康状态。
版本兼容性：确保 Spring Boot Actuator 的版本与你的 Spring Boot 应用程序版本兼容，以避免不必要的问题。

使用 Apifox 测试和管理接口

如果你是 JAVA 开发者，你经常需要与 API 打交道，确保你的应用程序能够正常工作。这时，一个强大的接口测试工具就会派上用场。

Apifox 是一个比 Postman 更强大的接口测试工具，Apifox = Postman + Swagger + Mock + JMeter，Apifox 支持调试 http（s）、WebSocket、Socket、gRPC、Dubbo 等协议的接口，并且集成了 IDEA 插件。在开发完接口后，可以通过 Apifox 的 IDEA 插件一键自动生成接口文档，多端同步，非常方便测试和维护。

立即体验 Apifox

知识扩展：

参考链接：

Spring Boot Actuator 官方文档：https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html
Spring Boot Actuator GitHub 仓库：https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator