Spring загружает класс конфигурации только с пустыми переменными-членами - PullRequest
Новая
       30

Spring загружает класс конфигурации только с пустыми переменными-членами

0 голосов
/ 02 июля 2018

У меня есть веб-приложение Spring, и я пытаюсь загрузить файл конфигурации YAML в класс конфигурации Java. Однако мой класс конфигурации содержит пустые переменные-члены только после того, как он был создан в моем тесте JUnit. Я новичок в весне и, вероятно, пропустил что-то очевидное. Я создал проект с Maven и у меня есть дерево каталогов в стиле Maven.

Моя конфигурация класс Java:

SRC / главная / Java / COM / мой / пакет / 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 / главная / ресурсы / 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".
    }
}

EDIT:

Я изменил свой 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 интерпретировались буквально, как я упоминал в комментарии.

1 Ответ

0 голосов
/ 02 июля 2018

Поскольку я тоже много с этим борюсь (@ConfigurationProperties), я попытался проверить ваш код с помощью простого приложения;

Это Spring Boot Application с версией 2.0.0 (я также тестировал его с 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");
    }

}

И в конце теста все задачи удаются.

Я просто догадываюсь; возможно, вам следует удалить некоторые дополнительные аннотации, которые вы добавили и больше не нужны.

...