在Spring Boot JavaBean属性绑定中使用访问器

Question

我正在使用@configurationproperties将属性绑定到Spring Boot项目中的java bean，如下所示：（示例摘自spring文档）

@ConfigurationProperties("acme")
public class AcmeProperties {

    private boolean enabled;

    private InetAddress remoteAddress;

    private final Security security = new Security();

    public boolean isEnabled() { ... }

    public void setEnabled(boolean enabled) { ... }

    public InetAddress getRemoteAddress() { ... }

    public void setRemoteAddress(InetAddress remoteAddress) { ... }

但是在Spring Boot Docs中有一个警告

映射到Spring Boot中可用的@ConfigurationProperties类的属性（通过属性文件、YAML文件、环境变量等配置）是公共API，但类本身的访问器（getter/setter）并不意味着直接使用。

Answer 1

本文档特别提到了用@configurationproperties注释的内部Spring Boot类。我同意该文档令人困惑，但您可以从下面的Spring Boot GitHub问题注释中看出该文档的意图：

• 不管有什么问题，请不要从我们的@configurationproperties扩展，尤其是使用相同的前缀。
• 注释处理器需要有能够提取默认值和文档之类的东西的源代码。通过扩展编译上下文之外的类，您将无法获得一致的元数据集（更糟糕的是，它们会在您的示例中重复）。

https://github.com/spring-projects/spring-boot/issues/10713#issuecomment-338193282

我们已经记录了@configurationproperties在#16704中不是公共API，因此包括从它们扩展。看看当前的文档，我觉得没有必要添加更明确的内容。

https://github.com/spring-projects/spring-boot/issues/10713#issuecomment-533154033

GitHub问题#16704导致提交47A9BB1，该提交添加了此文档。