如何保护@ConfigurationProperties类免受更改？

Question

要使用@ConfigurationProperties注释，必须创建一个包含getters和setters的类：

@ConfigurationProperties(prefix = "some")
public class PropertiesConfig {
    private boolean debug;

    public boolean isDebug() {
        return debug;
    }

    public void setDebug(boolean debug) {
        this.debug = debug;
    }
}

但这会导致有人试图通过调用以下命令来修改此值：

@Autowire
private PropertiesConfig config;        
//....

config.setDebug(true);

有没有一种方法可以创建@ConfigurationProperties注释类，而不使用setter和外部解析器/读取器类？

Answer 1

从Spring Boot 2.2中，终于可以定义用@ConfigurationProperties装饰的不可变类。
留档显示了一个例子。
你只需要声明一个构造函数与字段绑定（而不是setter方式）：

@ConstructorBinding
@ConfigurationProperties(prefix = "some")
public class PropertiesConfig {
    private boolean debug;

    public AcmeProperties(boolean enabled) {
        this.enabled = enabled;   
    }

    public boolean isDebug() {
        return debug;
    }

}

注意1：您必须定义一个且仅有一个带有绑定参数的构造函数：

在此设置中，必须使用要绑定的属性列表定义一个构造函数，并且只能定义一个构造函数，并且不能绑定构造函数中的属性以外的其他属性。

注2：引入了@DefaultValue来定义不可变属性绑定的默认值。

可以使用@DefaultValue指定默认值，并且将应用相同的转换服务来强制将String值转换为缺失属性的目标类型。

以下是从官方文档中获得的更详细示例：

import java.net.InetAddress;
import java.util.List;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.DefaultValue;
import org.springframework.boot.context.properties.ConstructorBinding;

@ConstructorBinding
@ConfigurationProperties("acme")
public class AcmeProperties {

    private final boolean enabled;

    private final InetAddress remoteAddress;

    private final Security security;

    public AcmeProperties(boolean enabled, InetAddress remoteAddress, Security security) {
        this.enabled = enabled;
        this.remoteAddress = remoteAddress;
        this.security = security;
    }

    public boolean isEnabled() { ... }

    public InetAddress getRemoteAddress() { ... }

    public Security getSecurity() { ... }

    public static class Security {

        private final String username;

        private final String password;

        private final List<String> roles;

        public Security(String username, String password,
                @DefaultValue("USER") List<String> roles) {
            this.username = username;
            this.password = password;
            this.roles = roles;
        }

        public String getUsername() { ... }

        public String getPassword() { ... }

        public List<String> getRoles() { ... }

    }

}

Answer 2

像这样的东西工作正常

@Configuration
class MyAppPropertiesConfiguration {

    @Bean
    @ConfigurationProperties(prefix = "some")
    public PropertiesConfig propertiesConfig () {
        return new PropertiesConfigImpl();
    }

    public interface PropertiesConfig {
            public boolean isDebug();
    }

    private static class PropertiesConfigImpl implements PropertiesConfig {
        private boolean debug;

        @Override
        public boolean isDebug() {
            return debug;
        }

        public void setDebug(boolean debug) {
            this.debug = debug;
        }
    }
}

然后呢

@Autowired PropertiesConfig properties;

Answer 3

一种尽可能少使用样板代码的方法是只使用带有getter的接口

public interface AppProps {
    String getNeededProperty();
}

在Lombok的@Getter和@Setter注释的帮助下，在实现中摆脱样板文件的Getter和Setter：

@ConfigurationProperties(prefix = "props")
@Getter
@Setter
public class AppPropsImpl implements AppProps {
    private String neededProperty;
}

然后，对于Bean BO只能通过接口访问其他bean，可以将其标记为<代码> @组件< /代码>，或者在主应用程序类上使用<代码> @ EnablCon图形属性（AppPrimSpl.class）< /Cl>，将其放入一个将通过接口公开的配置：

@Configuration
@EnableConfigurationProperties
public class PropsConfiguration  {
    @Bean
    public AppProps appProps(){
        return new AppPropsImpl();
    }
}

现在这个bean只能通过使用接口注入，这使得setters对其他bean不可用：

public class ApplicationLogicBean {
    @Autowired
    AppProps props;

    public void method(){
        log.info("Got " + props.getNeededProperty());
    }
}

使用Spring靴1.5.3和Lombok 1.16.16进行测试。