java - Spring加载一个只有空成员变量的配置类

Question

我有一个 Spring Web 应用程序，我正在尝试将 YAML 配置文件加载到 Java 配置类中。但是，我的配置类在 JUnit 测试中实例化后仅包含空成员变量。我是 Spring 新手，可能错过了一些明显的东西。我用 Maven 构建了项目，并有一个 Maven 风格的目录树。

我的配置Java类:

src/main/java/com/my/package/config/YAMLConfigDatabase:

package com.my.package;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableConfigurationProperties
@ConfigurationProperties(prefix = "database")

public class YAMLConfigDatabase {

    private String url;

    private int port;

    private String schema;

    private String username;

    private String password;

    //Getters and setters are all here.

}

我的配置 YAML 文件:

src/main/resources/application.yml

server.port: 8090

database:
  url: 'localhost'
  port: 3306
  schema: 'my_schema'
  username: 'webappuser'
  password: 'secretPassword'

我的 JUnit 测试来检查我是否确实可以加载配置文件:

package com.my.package;

import com.my.package.config.YAMLConfigDatabase;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = {YAMLConfigDatabase.class})
public class YAMLConfigTest {


    private YAMLConfigDatabase config;

    @Autowired
    public void setYAMLConfigDatabase(YAMLConfigDatabase config){
        this.config = config;
    }

    @Test
    public void isYAMLConfigLoaded(){
        System.out.println(this.config);
        System.out.println(this.config.getPassword()); 
        //The above line returns "null", but I would like it to return "secretPassword".
    }
}

<小时/>

编辑:

我将 YAMLConfigDatabase.java 更改为如下所示:

package com.my.package.config;

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

@ConfigurationProperties(prefix = "database")
@PropertySource(value = "classpath:application.yml") //new line
@Component
public class YAMLConfigDatabase {

    @Value("${url}") //new line
    private String url;

    @Value("${port}") //new line
    private Integer port;

    @Value("${schema}") //new line
    private String schema;

    @Value("${username}") //new line
    private String username;

    @Value("${password}") //new line
    private String password;
}

我使用 Senior Promidor 技巧将 @Value 注释添加到所有成员变量，并且还必须添加行 @PropertySource(value = "classpath:application.yml")。如果我跳过后一步，@Value 注释中的参数将按字面解释，正如我在评论中提到的。

Answer 1

由于我也经常与这个问题作斗争(@ConfigurationProperties)，因此我尝试使用一个简单的应用程序来测试您的代码；

这是一个版本为 2.0.0 的 Spring Boot 应用程序(我也使用 1.5.14 对其进行了测试)

application.yml:

custom:
  var1: aaa
  var2: bbb
  var3: ccc

ConfigClass.java

@Configuration
@ConfigurationProperties(prefix = "custom")
public class ConfigFile {

    private String var1;
    private String var2;
    private String var3;

    public String getVar1() {
        return var1;
    }

    public void setVar1(String var1) {
        this.var1 = var1;
    }

    public String getVar2() {
        return var2;
    }

    public void setVar2(String var2) {
        this.var2 = var2;
    }

    public String getVar3() {
        return var3;
    }

    public void setVar3(String var3) {
        this.var3 = var3;
    }

    @Override
    public String toString() {
        return "ConfigFile{" +
                "var1='" + var1 + '\'' +
                ", var2='" + var2 + '\'' +
                ", var3='" + var3 + '\'' +
                '}';
    }
}

和测试类:

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBootAppTests {

    @Autowired
    ConfigFile configFile;

    @Test
    public void contextLoads() {
        Assert.assertEquals(configFile.getVar1(), "aaa");
        Assert.assertEquals(configFile.getVar2(), "bbb");
        Assert.assertEquals(configFile.getVar3(), "ccc");
    }

}

在测试结束时，所有情况都成功。

我只是猜测；也许您应该删除一些已添加但不再需要的额外注释。