Java 中 Spring Boot 怎么使用 Actuator 监控应用健康状态-java教程-PHP中文网

spring boot actuator 是用于监控和管理应用的模块，默认仅暴露 /actuator/health 端点，需配置 dependency 和 management.endpoints.web.exposure.include 才能启用 info、metrics 等端点；健康检查支持自定义 healthindicator，可集成 spring security 限制访问权限，并通过 show-details 和 time-to-live 等参数控制细节展示与超时行为。

java 中 spring boot 怎么使用 actuator 监控应用健康状态

Spring Boot Actuator 是一个用于监控和管理应用的模块，它能快速暴露应用的健康、指标、配置等信息，默认只开放 /actuator/health 端点，其余需显式配置才能访问。

启用 Actuator 并暴露端点

在 pom.xml 中添加依赖：

<dependency><groupid>org.springframework.boot</groupid><artifactid>spring-boot-starter-actuator</artifactid></dependency>

然后在 application.yml 或 application.properties 中配置暴露哪些端点：

management:
  endpoints:
    web:
      exposure:
        include: health,info,metrics,env,beans,loggers
  endpoint:
    health:
      show-details: when_authorized

注意：Spring Boot 2.x 默认只暴露 health 和 info；若要查看详细健康信息（如数据库、Redis 是否连通），需设 show-details，且配合安全配置（如 Spring Security）控制访问权限。

deep-java-review

Java项目代码review工具。分析Git变更+完整调用链路上下文，推断业务需求，进行多维度评分和分类汇总，生成完整PRD文档。包含细粒度Java代码审查清单（Null安全、异常处理、Streams、并发、equals/hashCode、资源管理、API设计、性能、MyBatis/ORM、事务边界、SQL/DD...

下载

查看应用健康状态

启动应用后，访问 http://localhost:8080/actuator/health 可看到基础健康信息，例如：

{
  "status": "UP",
  "components": {
    "db": { "status": "UP", "details": { "database": "MySQL", "validationQuery": "isValid()" } },
    "redis": { "status": "DOWN", "details": { "error": "Cannot connect..." } }
  }
}

状态为 UP 表示整体健康；任一关键组件（如数据库）返回 DOWN，整体也变为 DOWN
自定义健康指示器可继承 AbstractHealthIndicator 或实现 HealthIndicator 接口，比如检查第三方服务连通性
健康检查默认是懒加载的，首次调用才执行；可通过 management.endpoint.health.show-components=always 强制显示所有组件

集成 Spring Security 控制访问权限

Actuator 端点敏感，生产环境必须限制访问。添加 Spring Security 依赖后，在配置类中放行或保护特定路径：

@Configuration
public class ActuatorSecurityConfig {
  @Bean
  public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
    http.requestMatcher(EndpointRequest.toAnyEndpoint())
        .authorizeHttpRequests(auth -> auth
            .requestMatchers(EndpointRequest.to("health", "info")).permitAll()
            .requestMatchers(EndpointRequest.toAnyEndpoint()).hasRole("ADMIN"));
    return http.build();
  }
}

EndpointRequest.toAnyEndpoint() 匹配所有 Actuator 路径
建议仅对 /actuator/health 和 /actuator/info 开放匿名访问，其余端点要求认证
配合 management.endpoint.health.show-details=when_authorized 才能生效

扩展健康检查（如数据库、缓存、外部 API）

以检查 Redis 连通性为例，新建一个健康指示器：

@Component
public class RedisHealthIndicator implements HealthIndicator {
  private final RedisTemplate redisTemplate;

  public RedisHealthIndicator(RedisTemplate redisTemplate) {
    this.redisTemplate = redisTemplate;
  }

  @Override
  public Health health() {
    try {
      redisTemplate.getConnectionFactory().getConnection().ping();
      return Health.up().withDetail("message", "Redis is available").build();
    } catch (Exception e) {
      return Health.down().withDetail("error", e.getMessage()).build();
    }
  }
}

Spring Boot 会自动发现并注册所有 HealthIndicator 实现类
组件名默认取类名前缀（如 RedisHealthIndicator → redis），也可用 @Endpoint(id = "my-redis") 自定义
避免在健康检查中做耗时操作，超时默认 1 秒，可通过 management.endpoint.health.time-to-live=5000 调整

Java免费学习笔记：立即使用
解锁 Java 大师之旅：从入门到精通的终极指南