Spring Boot @ConfigurationProperties如何通过编程方式设置默认值？

当然可以通过编程方式给@ConfigurationProperties设置默认值，不管是自定义的配置类，还是Spring Boot内置的如ServerProperties（对应你提到的port和contextPath）都能实现。我来给你详细拆解两种场景的实现方式，以及你可能踩过的坑：

针对你自己写的配置类，有两种常见的编程式设置默认值的方式：

1. 直接在字段上赋值（最简单的方式） #

如果默认值是固定的，直接在配置类的字段上初始化即可，@ConfigurationProperties会在绑定配置文件属性时自动覆盖这些默认值：

@ConfigurationProperties(prefix = "my.app")
public class MyAppProperties {
    // 直接设置默认值
    private String name = "default-demo-app";
    private int maxRetry = 3;

    // 省略getter和setter
}

2. 动态初始化（适合需要逻辑判断的场景） #

如果默认值需要根据运行环境、系统变量等动态生成，可以在定义@Bean的时候手动初始化配置类：

@Configuration
public class AppConfig {
    @Bean
    @ConfigurationProperties(prefix = "my.app")
    public MyAppProperties myAppProperties() {
        MyAppProperties props = new MyAppProperties();
        // 根据条件动态设置默认值
        if (System.getenv("ENV").equals("dev")) {
            props.setMaxRetry(5);
        }
        return props;
    }
}

你提到的port和contextPath（Spring Boot 2.x及以上是server.servlet.context-path）属于Spring Boot内置的ServerProperties，直接修改这个类的默认值需要注意Spring Boot的自动配置逻辑，推荐两种可靠的方式：

1. 使用WebServerFactoryCustomizer（推荐） #

这个接口专门用来定制嵌入式Web服务器的配置，优先级低于配置文件，正好符合“默认值”的需求——配置文件没指定时用我们设置的值，指定了就用配置文件的：

@Configuration
public class ServerCustomConfig {
    @Bean
    public WebServerFactoryCustomizer<ConfigurableServletWebServerFactory> webServerCustomizer() {
        return factory -> {
            // 设置默认端口
            factory.setPort(8081);
            // 设置默认context-path
            factory.setContextPath("/my-spring-app");
        };
    }
}

2. 自定义ServerProperties Bean #

如果你想直接通过@ConfigurationProperties的方式来控制，也可以自定义ServerProperties的Bean，在初始化时设置默认值，配置文件的属性依然会覆盖这些值：

@Configuration
public class CustomServerPropertiesConfig {
    @Bean
    @ConfigurationProperties(prefix = "server")
    public ServerProperties serverProperties() {
        ServerProperties props = new ServerProperties();
        // 设置默认端口
        props.setPort(8081);
        // 设置默认context-path（注意2.x的路径是servlet下的contextPath）
        props.getServlet().setContextPath("/my-spring-app");
        return props;
    }
}

你之前可能失败的原因 #

• 属性名错误：Spring Boot 2.x之后，contextPath的配置项从server.context-path改成了server.servlet.context-path，如果你的代码里还在操作旧的属性名，自然不会生效；
• 优先级问题：如果你的配置文件里已经写了server.port或server.servlet.context-path，编程式设置的默认值会被覆盖，这是Spring Boot配置优先级的正常逻辑；
• 未正确注册自定义器：如果用WebServerFactoryCustomizer但没把它注册成Bean，Spring Boot不会识别到这个自定义配置。

如果你的需求是不管配置文件有没有设置，都强制用编程式指定的值，可以用EnvironmentPostProcessor在Spring环境加载前注入属性：

public class CustomEnvironmentPostProcessor implements EnvironmentPostProcessor {
    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
        Map<String, Object> customProps = new HashMap<>();
        customProps.put("server.port", 8081);
        customProps.put("server.servlet.context-path", "/my-app");
        environment.getPropertySources().addFirst(new MapPropertySource("custom-defaults", customProps));
    }
}

然后在src/main/resources/META-INF/spring.factories里注册这个处理器：

org.springframework.boot.env.EnvironmentPostProcessor=com.yourpackage.CustomEnvironmentPostProcessor

不过这个场景比较极端，一般不推荐，因为会破坏配置文件的优先级规则。

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