ConfigurationProperties 不绑定属性答案

【问题标题】：ConfigurationProperties does not bind propertiesConfigurationProperties 不绑定属性
【发布时间】：2017-06-02 20:01:24
【问题描述】：

我想通过使用 @ConfigurationProperties 注释将我的 application.properties 自动绑定到一个类中。首先，我尝试使用 @Value 注释并能够将属性值注入到类变量中。但是，@ConfigurationProperties 没有将属性注入到值中。

我的应用程序属性：

spring.jpa.show-sql=false
my.url=my_url
my.name=muatik

应用程序.java

package com.muatik;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;


@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        final ApplicationContext ctx = SpringApplication.run(Application.class, args);
        final ConfigBinder confs = ctx.getBean(ConfigBinder.class);
        System.out.println(confs.getUrl());
        System.out.println(confs.getName());
    }

}

ConfigBinder.java

package com.muatik;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;



@Component
@ConfigurationProperties(prefix="my")
public class ConfigBinder {

    @Value("${my.name}")
    private String name;

    private String url; // expected to be filled automatically

    public String getUrl() {
        return this.url;
    }

    public String getName() {
        return this.name;
    }
}

输出：

...
2017-01-18 15:19:29.720  INFO 4153 --- [           main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8080 (http)
2017-01-18 15:19:29.724  INFO 4153 --- [           main] com.muatik.Application                   : Started Application in 4.212 seconds (JVM running for 4.937)
null
muatik

这个实现有什么问题？

编辑和解决方案：可能重复：Spring Boot @ConfigurationProperties not retrieving properties from Environment

我发现我错过了 ConfigBinder 中的设置器。添加它们后，它现在可以工作了。

【问题讨论】：

根据文档@ConfigurationProperties 仅适用于@Configuration 注释类
我用 @Configuration 注释了 ConfigBinder，但它仍然不起作用。
这是您缺少的属性的设置器。我也想知道为什么我的属性值没有被填充。如果您使用@Value，您可以保持私密。如果你想让前缀的东西起作用，只需为要设置的属性添加一个 setter。

标签： java spring spring-boot

【解决方案1】：

您需要从属性类中删除 @Component 并添加设置器，因为 @ConfigurationProperties 使用标准 bean 属性绑定：

@ConfigurationProperties(prefix="my")
public class ConfigBinder {

    private String name;

    private String url; // expected to be filled automatically

    public String getUrl() {
        return this.url;
    }

    public String getName() {
        return this.name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public void setUrl(String url) {
        this.url = url;
    }
}

并将@EnableConfigurationProperties 添加到您的主类：

@SpringBootApplication
@EnableConfigurationProperties(ConfigBinder.class)
public class Application {

    public static void main(String[] args) {
        final ApplicationContext ctx = SpringApplication.run(Application.class, args);
        final ConfigBinder confs = ctx.getBean(ConfigBinder.class);
        System.out.println(confs.getUrl());
        System.out.println(confs.getName());
    }

}

【讨论】：

我进行了更改，但结果相同。更新代码在这里：github.com/muatik/spring-playground/tree/master/…
@Muatik 为您的字段添加设置器。它们是必需的，因为@ConfigurationProperties 使用标准 bean 属性绑定。我更新了我的答案。
或者使用lombok @Data为ConfigBinder生成所有必要的方法。
这是不正确的，你不需要使用“@EnableConfigurationProperties”，这是一个选择：“启用对ConfigurationProperties注解bean的支持。ConfigurationProperties bean可以以标准方式注册（例如使用@Bean 方法），或者为了方便，可以直接在这个注解上指定。”
最小是setter方法

【解决方案2】：

主要问题是您没有设置器。当您将设置器放入 ConfigBuilder 时工作正常。 ConfigBuilder必须是这样的

@Component
@ConfigurationProperties(prefix="my")
public class ConfigBinder {

    private String name;

    private String url;

    // Getters and Setters !!!
}

【讨论】：

我在 Spring 中使用 Kotlin，这对我来说是个问题。