Prometheus ServletRegistrationBean构造函数未定义问题排查与修复

嘿，我帮你梳理下这个错误的来龙去脉，还有对应的解决办法——这个坑我之前在Spring Boot版本升级的时候踩过，大概率是版本不兼容搞的鬼：

错误成因分析 #

这个错误本质是Spring Boot版本迭代带来的API变更，具体有这几个常见原因：

• Spring Boot 1.x vs 2.x的API差异：在Spring Boot 1.x中，ServletRegistrationBean确实有接收Servlet实例和路径字符串的构造器，但到了2.x版本，这个构造器被移除了，官方改用了更灵活的构造器+配置方法的组合。
• Actuator/Metrics依赖版本不匹配：如果你的项目里Spring Boot核心是2.x，但Actuator或者Metrics相关依赖还是1.x的老版本，就会出现类构造器不兼容的情况；反过来也一样。
• 错误的类导入：你可能不小心导入了第三方的MetricsServlet类，或者是旧版本Actuator里的类，导致和当前版本的ServletRegistrationBean不匹配。

解决方法 #

根据不同的场景，这里有几个靠谱的解决方向：

1. 适配Spring Boot 2.x+的正确写法（推荐） #

Spring Boot 2.x之后，Prometheus监控的官方推荐方案是用Micrometer来集成，所以咱们得调整代码和依赖：

首先确保引入正确的Maven依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-registry-prometheus</artifactId>
</dependency>

然后修改你的配置类，用新版的API创建ServletRegistrationBean：

import io.micrometer.prometheus.PrometheusMeterRegistry;
import io.micrometer.prometheus.PrometheusMetricsServlet;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class PrometheusMonitoringConfig {

    @Bean
    public ServletRegistrationBean<PrometheusMetricsServlet> prometheusServletRegistration(PrometheusMeterRegistry meterRegistry) {
        // 初始化Prometheus的Metrics Servlet
        PrometheusMetricsServlet prometheusServlet = new PrometheusMetricsServlet(meterRegistry);
        // 创建RegistrationBean并设置Servlet，再添加路径映射
        ServletRegistrationBean<PrometheusMetricsServlet> registrationBean = new ServletRegistrationBean<>(prometheusServlet);
        registrationBean.addUrlMappings("/actuator/prometheus"); // 这里可以自定义路径
        return registrationBean;
    }
}

这样写既符合2.x的API规范，也能正常暴露Prometheus的监控端点。

2. 统一所有Spring Boot相关依赖的版本 #

如果是版本冲突导致的问题，一定要确保你的项目依赖版本统一。比如在Maven的pom.xml里，通过spring-boot-starter-parent来管理版本：

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.7.14</version> <!-- 选一个稳定的2.x版本，比如LTS版本 -->
    <relativePath/>
</parent>

这样所有的starter依赖（包括Actuator）都会自动继承这个版本，避免版本不兼容的问题。

3. 回退到Spring Boot 1.x（不推荐） #

如果因为特殊需求必须用旧的构造器写法，可以回退到Spring Boot 1.x版本，但这个方案不建议——因为1.x已经停止维护很久了，存在安全漏洞和功能缺失的风险。

总结 #

这个问题的核心就是版本差异导致的API不兼容，最稳妥的方式是升级到Spring Boot 2.x+，采用Micrometer集成Prometheus的官方方案，同时确保所有依赖版本统一。

内容的提问来源于stack exchange，提问作者Bambus