Значение Spring Boot application.properties не заполняется


97

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

Когда я запускаю приложение ниже, внешняя конфигурация в файле application.properties не попадает в переменную внутри bean-компонента. Я уверен, что делаю глупость, спасибо за любые предложения.

MyBean.java (находится в / src / main / java / foo / bar /)

package foo.bar;

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

@Component
public class MyBean {

    @Value("${some.prop}")
    private String prop;

    public MyBean() {
        System.out.println("================== " + prop + "================== ");
    }
}

Application.java (находится в / src / main / java / foo /)

package foo;

import foo.bar.MyBean;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.SpringApplication;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@ComponentScan
@EnableAutoConfiguration
public class Application {

    @Autowired
    private MyBean myBean;

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

application.properties (находится в / src / main / resources /)

some.prop=aabbcc

Вывод журнала при запуске приложения Spring Boot:

grb-macbook-pro:properties-test-app grahamrb$ java -jar ./build/libs/properties-test-app-0.1.0.jar

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v1.1.5.RELEASE)

2014-09-10 21:28:42.149  INFO 16554 --- [           main] foo.Application                          : Starting Application on grb-macbook-pro.local with PID 16554 (/Users/grahamrb/Dropbox/dev-projects/spring-apps/properties-test-app/build/libs/properties-test-app-0.1.0.jar started by grahamrb in /Users/grahamrb/Dropbox/dev-projects/spring-apps/properties-test-app)
2014-09-10 21:28:42.196  INFO 16554 --- [           main] ationConfigEmbeddedWebApplicationContext : Refreshing org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@67e38ec8: startup date [Wed Sep 10 21:28:42 EST 2014]; root of context hierarchy
2014-09-10 21:28:42.828  INFO 16554 --- [           main] o.s.b.f.s.DefaultListableBeanFactory     : Overriding bean definition for bean 'beanNameViewResolver': replacing [Root bean: class [null]; scope=; abstract=false; lazyInit=false; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration$WhitelabelErrorViewConfiguration; factoryMethodName=beanNameViewResolver; initMethodName=null; destroyMethodName=(inferred); defined in class path resource [org/springframework/boot/autoconfigure/web/ErrorMvcAutoConfiguration$WhitelabelErrorViewConfiguration.class]] with [Root bean: class [null]; scope=; abstract=false; lazyInit=false; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=org.springframework.boot.autoconfigure.web.WebMvcAutoConfiguration$WebMvcAutoConfigurationAdapter; factoryMethodName=beanNameViewResolver; initMethodName=null; destroyMethodName=(inferred); defined in class path resource [org/springframework/boot/autoconfigure/web/WebMvcAutoConfiguration$WebMvcAutoConfigurationAdapter.class]]
2014-09-10 21:28:43.592  INFO 16554 --- [           main] .t.TomcatEmbeddedServletContainerFactory : Server initialized with port: 8080
2014-09-10 21:28:43.784  INFO 16554 --- [           main] o.apache.catalina.core.StandardService   : Starting service Tomcat
2014-09-10 21:28:43.785  INFO 16554 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet Engine: Apache Tomcat/7.0.54
2014-09-10 21:28:43.889  INFO 16554 --- [ost-startStop-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2014-09-10 21:28:43.889  INFO 16554 --- [ost-startStop-1] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 1695 ms
2014-09-10 21:28:44.391  INFO 16554 --- [ost-startStop-1] o.s.b.c.e.ServletRegistrationBean        : Mapping servlet: 'dispatcherServlet' to [/]
2014-09-10 21:28:44.393  INFO 16554 --- [ost-startStop-1] o.s.b.c.embedded.FilterRegistrationBean  : Mapping filter: 'hiddenHttpMethodFilter' to: [/*]
================== null==================
2014-09-10 21:28:44.606  INFO 16554 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/**/favicon.ico] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2014-09-10 21:28:44.679  INFO 16554 --- [           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error],methods=[],params=[],headers=[],consumes=[],produces=[],custom=[]}" onto public org.springframework.http.ResponseEntity<java.util.Map<java.lang.String, java.lang.Object>> org.springframework.boot.autoconfigure.web.BasicErrorController.error(javax.servlet.http.HttpServletRequest)
2014-09-10 21:28:44.679  INFO 16554 --- [           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error],methods=[],params=[],headers=[],consumes=[],produces=[text/html],custom=[]}" onto public org.springframework.web.servlet.ModelAndView org.springframework.boot.autoconfigure.web.BasicErrorController.errorHtml(javax.servlet.http.HttpServletRequest)
2014-09-10 21:28:44.716  INFO 16554 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2014-09-10 21:28:44.716  INFO 16554 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/webjars/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2014-09-10 21:28:44.902  INFO 16554 --- [           main] o.s.j.e.a.AnnotationMBeanExporter        : Registering beans for JMX exposure on startup
2014-09-10 21:28:44.963  INFO 16554 --- [           main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8080/http
2014-09-10 21:28:44.965  INFO 16554 --- [           main] foo.Application                          : Started Application in 3.316 seconds (JVM running for 3.822)
^C2014-09-10 21:28:54.223  INFO 16554 --- [       Thread-2] ationConfigEmbeddedWebApplicationContext : Closing org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@67e38ec8: startup date [Wed Sep 10 21:28:42 EST 2014]; root of context hierarchy
2014-09-10 21:28:54.225  INFO 16554 --- [       Thread-2] o.s.j.e.a.AnnotationMBeanExporter        : Unregistering JMX-exposed beans on shutdown

4
И как следует @Valueзаменить, прежде чем bean-компонент будет построен? Ваш способ «определения», если значение установлено неверно. В этот момент он всегда будет нулевым, так как @Valueбудет обработан ПОСЛЕ построения объекта.
M. Deinum

Ответы:


165

То, как вы выполняете внедрение свойства, не сработает, потому что внедрение выполняется после вызова конструктора.

Вам необходимо выполнить одно из следующих действий:

Лучшее решение

@Component
public class MyBean {

    private final String prop;

    @Autowired
    public MyBean(@Value("${some.prop}") String prop) {
        this.prop = prop;
        System.out.println("================== " + prop + "================== ");
    }
}

Решение, которое будет работать, но менее тестируемое и немного менее читаемое

@Component
public class MyBean {

    @Value("${some.prop}")
    private String prop;

    public MyBean() {

    }

    @PostConstruct
    public void init() {
        System.out.println("================== " + prop + "================== ");
    }
}

Также обратите внимание, что это не относится к Spring Boot, но применяется к любому приложению Spring.


Мне пришлось добавить аннотацию @Autowired к конструктору, чтобы он заработал,
Себастьян Тромп

1
Спасибо за чаевые. Это должно быть в документации Spring, где говорится об аннотации @Value, но эти ребята, похоже, не заинтересованы в обратной связи по их документации :(
Alex Worden

1
Сэкономил мне немного времени. Благодарность!
Роберт Москаль,

1
@geoand Что, если у вас более 10 значений, вам нужно будет вводить все 10 так, как вы это сделали? Или есть более чистый способ
Джесси

1
@Jackie Действительно есть способ чище! Отъезд @ConfigurationPropertiesи @EnableConfigurationPropertiesаннотации
geoand 07

5

Пользователь geoand прав, указывая здесь на причины и предлагая решение. Но лучший подход - это инкапсулировать вашу конфигурацию в отдельный класс, скажем, Java-класс SystemContiguration, а затем внедрить этот класс в любые службы, которые вы хотите использовать эти поля.

Ваш текущий способ (@grahamrb) чтения значений конфигурации непосредственно в службы подвержен ошибкам и вызовет головные боли при рефакторинге, если имя параметра конфигурации будет изменено.


Как не было бы меньше головной боли, если бы у вас был отдельный класс для этого свойства? У вас все еще будет строка, которую нужно запомнить при рефакторинге
dot_Sp0T

4
Вам нужно «запомнить» только одно место, а не номер N. Скалярные значения, существующие в SystemContiguration, обеспечивают строгую типизацию. Кроме того, если есть бизнес-логика, которая имеет "вилки" ~~~ на основе значений, поступающих из конфигурации ~~~ ....., лучше вставить что-то в класс / businessLogic, которому нужны значения. Ака, гораздо проще имитировать SystemContiguration, чем пытаться заставить @Value работать повсюду.
granadaCoder

3

Собственно, у меня ниже работает нормально.

@Component
public class MyBean {

   public static String prop;

   @Value("${some.prop}")
   public void setProp(String prop) {
      this.prop= prop;
   }

   public MyBean() {

   }

   @PostConstruct
   public void init() {
      System.out.println("================== " + prop + "================== ");
   }

}

Теперь, когда я хочу, просто вызовите

MyBean.prop

он вернет значение.


2

Этот ответ может или не может быть применим к вашему случаю ... Однажды у меня был подобный симптом, и я дважды проверял свой код много раз, и все выглядело хорошо, но @Valueнастройка все еще не вступала в силу. А затем после того, как я сделал File > Invalidate Cache / Restartс моей IntelliJ(моей IDE), проблема исчезла ...

Это очень легко попробовать, так что, возможно, стоит попробовать


1

Используя класс Environment, мы можем получить application. Значения свойств

@Autowired,

private Environment env;

и доступ с помощью

String password =env.getProperty(your property key);

0

Следуй этим шагам. 1: - создайте свой класс конфигурации, как показано ниже.

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.beans.factory.annotation.Value;

@Configuration
public class YourConfiguration{

    // passing the key which you set in application.properties
    @Value("${some.pro}")
    private String somePro;

   // getting the value from that key which you set in application.properties
    @Bean
    public String getsomePro() {
        return somePro;
    }
}

2: - когда у вас есть класс конфигурации, введите переменную из нужной конфигурации.

@Component
public class YourService {

    @Autowired
    private String getsomePro;

    // now you have a value in getsomePro variable automatically.
}

0

Если вы работаете в большом многомодульном проекте с несколькими разными application.propertiesфайлами, попробуйте добавить свое значение в файл свойств родительского проекта.

Если вы не уверены, какой проект является вашим родительским, проверьте файл проекта pom.xmlна наличие<parent> тега.

Это решило проблему для меня.


0

Вы можете использовать EnvironmentClass для получения данных:

@Autowired
private Environment env;
String prop= env.getProperty('some.prop');
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.