Spring Boot调用自身及其他应用自定义健康检查及不识别问题排查

一、自定义健康指示器不生效的根因 #

• 1. 组件扫描未覆盖依赖包
     你将健康指示器写在依赖应用A中，Spring Boot启动类默认仅扫描自身所在包及其子包下的组件，若A的类所在包不在B的启动类扫描范围内，@Component注解不会生效，该类不会被注册为Spring Bean，自然不会被actuator识别。
• 2. 端点配置错误
     management.endpoints.web.exposure.include配置的是要暴露的独立端点，健康指示器是health端点下的子指标，不是独立端点，你在配置中加入adapterDownstream属于无效配置，不会产生任何作用。
• 3. Bean实例化失败
     你的代码中同时存在@RequiredArgsConstructor和自定义有参构造，注解不会生效；同时构造方法的两个参数RestTemplate和downStreamUrl没有对应注入规则，即便类被扫描到，也会因为Spring无法完成实例化导致Bean注册失败。

二、修复步骤 #

1. 配置组件扫描
   在应用B的启动类上添加@ComponentScan注解，明确指定要扫描的A、B包路径：

@SpringBootApplication
@ComponentScan(basePackages = {"com.xxx.a包路径", "com.xxx.b包路径"})
public class BApplication {
    public static void main(String[] args) {
        SpringApplication.run(BApplication.class, args);
    }
}

2. 修正配置文件
   修改application.properties，删除无效的adapterDownstream暴露配置：

management.endpoints.web.exposure.include=health,info,prometheus
spring.jackson.serialization.INDENT_OUTPUT=true
management.endpoint.health.show-details=always

3. 修正健康指示器代码
   补充参数注入规则，确保Bean可以正常实例化，同时确保容器中存在RestTemplate的Bean：

@Component
public class AdapterDownstreamHealthIndicator implements HealthIndicator {

    private final RestTemplate restTemplate;
    private final String downStreamUrl;

    public AdapterDownstreamHealthIndicator(RestTemplate restTemplate,
                                            @Value("${downstream.url:http://localhost:8081/actuator}") String downStreamUrl) {
        this.restTemplate = restTemplate;
        this.downStreamUrl = downStreamUrl;
    }

    @Override
    public Health health() {
        // 原有业务逻辑
        return Health.down().build();
    }
}

新增RestTemplate的Bean注册（放在A的配置类中即可）：

@Bean
public RestTemplate restTemplate() {
    return new RestTemplate();
}

4. 验证
   启动应用后先访问http://localhost:9091/actuator/health，返回结果中会包含adapterDownstream的状态信息，此时再访问http://localhost:9091/actuator/health/adapterDownstream即可触发断点，返回对应的健康状态。

三、其他问题解答 #

1. 同一应用内自定义健康指示器的调用 #

将HealthIndicator实现类注册为Spring Bean后，Spring Boot会自动将所有健康指示器的结果聚合到health端点的返回值中，直接访问/actuator/health即可查看所有指标，也可以通过/actuator/health/{指标名}单独调用单个健康指示器。

2. 调用其他Spring Boot应用的自定义健康指示器 #

直接通过RestTemplate/WebClient调用目标应用的/actuator/health/{指标名}接口，解析返回的状态字段即可，就是你当前代码中注释的实现逻辑。

3. 是否需要使用CompositeHealthContributor #

不需要。CompositeHealthContributor仅用于需要将多个相关的健康指标归为同一个分组的场景，比如你有10个下游依赖的健康检查，要统一放在downstream分组下展示，才需要使用复合组件。你当前的场景单个HealthIndicator完全可以满足需求。

内容的提问来源于stack exchange，提问作者du-it