如何使用Lombok注解处理SpringBoot中的可选配置值

问题解决最优方案 #

你已经使用了@ConfigurationProperties，不需要再混用@Value注解，@ConfigurationProperties原生支持可选配置项自动赋值为null，不会抛出配置缺失异常，这是最符合SpringBoot规范的实现方式。

错误原因 #

你当前代码混用了@ConfigurationProperties和@Value，@Value默认要求配置项必须存在，找不到对应配置就会直接抛出异常。

改造步骤 #

1. 移除所有@Value注解，通过配置类字段和配置层级做自动绑定
2. 嵌套配置类对应optionalPrefix层级，非必填配置不存在时会自动赋值为null
3. 可搭配@Validated做必填项校验，保证必填配置one缺失时按预期抛出异常

改造后代码示例 #

import lombok.Getter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.validation.annotation.Validated;
import jakarta.validation.constraints.NotBlank;

@ConfigurationProperties(prefix = "prefix")
@Validated
@Getter
public class PrefixProperties {
    // 必填配置，缺失时抛出异常，符合业务预期
    @NotBlank
    private String one;
    // 可选配置，不存在时自动赋值为null
    private OptionalPrefix optionalPrefix;

    @Getter
    public static class OptionalPrefix {
        private String two;
    }
}

4. 在项目启动类上添加@EnableConfigurationProperties(PrefixProperties.class)注解开启自动绑定即可，不需要给配置类加@Configuration注解注册Bean。

兼容@Value的临时方案 #

如果你坚持要使用@Value写法，可以给配置项添加默认空值声明，找不到配置时会自动赋值为null：

@Getter
@Value("${prefix.optionalPrefix.two:#{null}}")
private String two;

该方案不推荐，混用时会导致配置逻辑分散，提升后续维护成本。

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