Как я могу ввести значение свойства в Spring Bean, который был настроен с использованием аннотаций?

294

У меня есть куча бобов Spring, которые взяты из classpath с помощью аннотаций, например

@Repository("personDao")
public class PersonDaoImpl extends AbstractDaoImpl implements PersonDao {
    // Implementation omitted
}

В XML-файле Spring определен PropertyPlaceholderConfigurer :

<bean id="propertyConfigurer" 
  class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
    <property name="location" value="/WEB-INF/app.properties" />
</bean> 

Я хочу внедрить одно из свойств из app.properites в bean-компонент, показанный выше. Я не могу просто сделать что-то вроде

<bean class="com.example.PersonDaoImpl">
    <property name="maxResults" value="${results.max}"/>
</bean>

Потому что PersonDaoImpl не присутствует в XML-файле Spring (он выбирается из пути к классам с помощью аннотаций). Я получил, насколько следующее:

@Repository("personDao")
public class PersonDaoImpl extends AbstractDaoImpl implements PersonDao {

    @Resource(name = "propertyConfigurer")
    protected void setProperties(PropertyPlaceholderConfigurer ppc) {
    // Now how do I access results.max? 
    }
}

Но мне не понятно, как я могу получить доступ к интересующей меня собственности ppc?

Донал
источник
1
По сути, я задал тот же вопрос, хотя и в несколько ином сценарии: stackoverflow.com/questions/310271/… . Пока никто не смог ответить на это.
Спенсер Кормос
Обратите внимание, что с весны 3.1 PropertyPlaceholderConfigurerбольше не является рекомендуемым классом. Предпочитаю PropertySourcesPlaceholderConfigurerвместо. В любом случае вы можете использовать более короткое определение XML <context:property-placeholder />.
Майкл Пифел

Ответы:

292

Вы можете сделать это весной 3, используя поддержку EL. Пример:

@Value("#{systemProperties.databaseName}")
public void setDatabaseName(String dbName) { ... }

@Value("#{strategyBean.databaseKeyGenerator}")
public void setKeyGenerator(KeyGenerator kg) { ... }

systemPropertiesявляется неявным объектом и strategyBeanявляется именем бина.

Еще один пример, который работает, когда вы хотите получить свойство из Propertiesобъекта. Это также показывает, что вы можете применять @Valueк полям:

@Value("#{myProperties['github.oauth.clientId']}")
private String githubOauthClientId;

Вот сообщение в блоге, которое я написал об этом для немного большей информации.

Прощай, StackExchange
источник
8
Это systemPropertiesпросто System.getProperties()? Я предполагаю, что если я хочу внедрить свои собственные свойства в bean-компонент Spring, мне нужно определить и <bean id="appProperties" class="org.springframework.beans.factory.config.PropertiesFactoryBean">затем прочитать значения из этого в другой bean-компонент, используя что-то вроде@Value("#{appProperties.databaseName}")
Dónal
11
Из ответа Макса обязательно обратите внимание, что вы также можете использовать заполнители в выражениях $ {db.doStuff}, тогда вам не нужен PropertiesFactoryBean, просто placeholderConfigurer
gtrak
9
Вы можете добавить свои собственные свойства, используя util: properties; например, <util: properties id = "config" location = "classpath: /spring/environment.properties" />. См. Отредактированный ответ о том, как получить значение. (Я понимаю, что, вероятно, слишком поздно, чтобы быть полезным для Дона, но, надеюсь, другие выиграют.)
2
Это работало только для меня, когда я использовал util: properties в моем файле appname-servlet.xml. Использование propertyConfigurer, определенного в моем applicationContext.xml (не Spring MVC), не сработало.
Асаф Месика
Для более подробного прочтения, посвященного некоторым из этого, проверьте также этот вопрос SOF: stackoverflow.com/questions/6425795/…
arcseldon
143

Лично я люблю этот новый способ в Spring 3.0 из документов :

private @Value("${propertyName}") String propertyField;

Нет добытчиков или сеттеров!

Со свойствами, загружаемыми через конфиг:

<bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"
      p:location="classpath:propertyFile.properties" name="propertiesBean"/>

В дальнейшем я могу даже контролировать щелчок по выражению EL в IntelliJ, и это приводит меня к определению свойства!

Также есть полностью не XML-версия :

@PropertySource("classpath:propertyFile.properties")
public class AppConfig {

    @Bean
    public static PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer() {
        return new PropertySourcesPlaceholderConfigurer();
    }
barrymac
источник
9
убедитесь, что добавили в пространство имен uri xmlns: p = " springframework.org/schema/p ", чтобы использовать атрибуты с префиксом p :.
Шейн Ли
3
Почему этот метод работает в тестовом контексте, а не в основном?
Луксмир
9
Вздох, я потратил час, пытаясь заставить работать только аннотации, и обнаружил, чего не хватает только после прочтения этого ответа - объявления магического статического компонента PropertySauceYadaYada. Весенняя любовь!
Кранах
@ barrymac эй, Барри, ты знаешь, в чем разница между @Value (# {...}) и @Value ($ {...}). Спасибо
Ким
1
Это работает для меня. Совет только один: аннотация @Component обязательна.
yaki_nuka
121

Существует новые аннотации @Valueв Spring 3.0.0M3 . @Valueподдержка не только #{...}выражений, но и ${...}заполнителей

AdrieanKhisbe
источник
20
+1 Если пример помогает, вот он - @Value (value = "# {'$ {server.env}'}") или просто @Value ("# {'$ {server.env}'}")
Сому
31

<context:property-placeholder ... /> является XML-эквивалентом PropertyPlaceholderConfigurer.

Пример: applicationContext.xml

<context:property-placeholder location="classpath:test.properties"/>  

Класс компонента

 private @Value("${propertyName}") String propertyField;
Шейн Ли
источник
1
Для меня это сработало, только если автопроводка включена через <context:component-scan base-package="com.company.package" />Для справки, я использую пружину через ApplicationContext, а не в веб-контексте.
Мустафа
15

Другой альтернативой является добавление bean-компонента appProperties, показанного ниже:

<bean id="propertyConfigurer"   
  class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="location" value="/WEB-INF/app.properties" />
</bean> 


<bean id="appProperties" 
          class="org.springframework.beans.factory.config.PropertiesFactoryBean">
        <property name="singleton" value="true"/>

        <property name="properties">
                <props>
                        <prop key="results.max">${results.max}</prop>
                </props>
        </property>
</bean>

При получении этот bean-компонент может быть приведен к java.util.Propertiesобъекту, который будет содержать свойство с именем, из results.maxкоторого читается значение app.properties. Опять же, этот bean-компонент может быть внедрен зависимостью (как экземпляр java.util.Properties) в любой класс с помощью аннотации @Resource.

Лично я предпочитаю это решение (другому, которое я предложил), так как вы можете точно ограничить, какие свойства предоставляются appProperties, и вам не нужно читать app.properties дважды.

Донал
источник
У меня тоже работает. Но нет ли другого способа получить доступ к свойствам из PropertyPlaceholderConfigurer через аннотацию @Value (при использовании нескольких PropertyPlaceholderConfigurer в нескольких файлах congif XML)?
Царь
9

Мне нужно иметь два файла свойств, один для производства и переопределения для разработки (которые не будут развернуты).

Чтобы иметь оба, бин Properties, который может быть подключен автоматически, и PropertyConfigurer, вы можете написать:

<bean id="appProperties" class="org.springframework.beans.factory.config.PropertiesFactoryBean">
    <property name="singleton" value="true" />

    <property name="ignoreResourceNotFound" value="true" />
    <property name="locations">
        <list>
            <value>classpath:live.properties</value>
            <value>classpath:development.properties</value>
        </list>
    </property>
</bean>

и ссылка на Бин свойств в PropertyConfigurer

<bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
    <property name="properties" ref="appProperties" />
</bean>
Вилли аус Рор
источник
7

Прежде чем мы получим Spring 3 - который позволяет вам вводить константы свойств непосредственно в ваши bean-компоненты с помощью аннотаций - я написал подкласс bean-компонента PropertyPlaceholderConfigurer, который делает то же самое. Таким образом, вы можете пометить ваши установщики свойств, и Spring автоматически соединит ваши свойства с вашими компонентами следующим образом:

@Property(key="property.key", defaultValue="default")
public void setProperty(String property) {
    this.property = property;
}

Аннотация выглядит следующим образом:

@Retention(RetentionPolicy.RUNTIME) 
@Target({ElementType.METHOD, ElementType.FIELD})
public @interface Property {
    String key();
    String defaultValue() default "";
}

PropertyAnnotationAndPlaceholderConfigurer выглядит следующим образом:

public class PropertyAnnotationAndPlaceholderConfigurer extends PropertyPlaceholderConfigurer {

    private static Logger log = Logger.getLogger(PropertyAnnotationAndPlaceholderConfigurer.class);

    @Override
    protected void processProperties(ConfigurableListableBeanFactory beanFactory, Properties properties) throws BeansException {
        super.processProperties(beanFactory, properties);

        for (String name : beanFactory.getBeanDefinitionNames()) {
            MutablePropertyValues mpv = beanFactory.getBeanDefinition(name).getPropertyValues();
            Class clazz = beanFactory.getType(name);

            if(log.isDebugEnabled()) log.debug("Configuring properties for bean="+name+"["+clazz+"]");

            if(clazz != null) {
                for (PropertyDescriptor property : BeanUtils.getPropertyDescriptors(clazz)) {
                    Method setter = property.getWriteMethod();
                    Method getter = property.getReadMethod();
                    Property annotation = null;
                    if(setter != null && setter.isAnnotationPresent(Property.class)) {
                        annotation = setter.getAnnotation(Property.class);
                    } else if(setter != null && getter != null && getter.isAnnotationPresent(Property.class)) {
                        annotation = getter.getAnnotation(Property.class);
                    }
                    if(annotation != null) {
                        String value = resolvePlaceholder(annotation.key(), properties, SYSTEM_PROPERTIES_MODE_FALLBACK);
                        if(StringUtils.isEmpty(value)) {
                            value = annotation.defaultValue();
                        }
                        if(StringUtils.isEmpty(value)) {
                            throw new BeanConfigurationException("No such property=["+annotation.key()+"] found in properties.");
                        }
                        if(log.isDebugEnabled()) log.debug("setting property=["+clazz.getName()+"."+property.getName()+"] value=["+annotation.key()+"="+value+"]");
                        mpv.addPropertyValue(property.getName(), value);
                    }
                }

                for(Field field : clazz.getDeclaredFields()) {
                    if(log.isDebugEnabled()) log.debug("examining field=["+clazz.getName()+"."+field.getName()+"]");
                    if(field.isAnnotationPresent(Property.class)) {
                        Property annotation = field.getAnnotation(Property.class);
                        PropertyDescriptor property = BeanUtils.getPropertyDescriptor(clazz, field.getName());

                        if(property.getWriteMethod() == null) {
                            throw new BeanConfigurationException("setter for property=["+clazz.getName()+"."+field.getName()+"] not available.");
                        }

                        Object value = resolvePlaceholder(annotation.key(), properties, SYSTEM_PROPERTIES_MODE_FALLBACK);
                        if(value == null) {
                            value = annotation.defaultValue();
                        }
                        if(value == null) {
                            throw new BeanConfigurationException("No such property=["+annotation.key()+"] found in properties.");
                        }
                        if(log.isDebugEnabled()) log.debug("setting property=["+clazz.getName()+"."+field.getName()+"] value=["+annotation.key()+"="+value+"]");
                        mpv.addPropertyValue(property.getName(), value);
                    }
                }
            }
        }
    }

}

Не стесняйтесь изменить по вкусу

Рикардо Гладуэлл
источник
3
Обратите внимание, что я создал новый проект для вышеуказанного: code.google.com/p/spring-property-annotations
Рикардо Гладуэлл,
7

Вы также можете комментировать свой класс:

@PropertySource("classpath:/com/myProject/config/properties/database.properties")

И есть переменная, как это:

@Autowired
private Environment env;

Теперь вы можете получить доступ ко всем своим свойствам следующим образом:

env.getProperty("database.connection.driver")
Алексис Гамарра
источник
7

Весенний путь:
private @Value("${propertyName}") String propertyField;

это новый способ ввести значение с помощью класса Spring «PropertyPlaceholderConfigurer». Другой способ - позвонить

java.util.Properties props = System.getProperties().getProperty("propertyName");

Примечание. Для @Value нельзя использовать статическое свойство propertyField, оно должно быть только нестатическим, в противном случае возвращается значение null. Чтобы исправить это, для статического поля создается нестатический установщик, и над этим установщиком применяется @Value.

hi.nitish
источник
7

Как упомянуто, @Valueделает работу, и это довольно гибко, поскольку вы можете иметь пружинный EL в нем.

Вот несколько примеров, которые могут быть полезны:

//Build and array from comma separated parameters 
//Like currency.codes.list=10,11,12,13
@Value("#{'${currency.codes.list}'.split(',')}") 
private List<String> currencyTypes;

Еще один, чтобы получить setотlist

//If you have a list of some objects like (List<BranchVO>) 
//and the BranchVO has areaCode,cityCode,...
//You can easily make a set or areaCodes as below
@Value("#{BranchList.![areaCode]}") 
private Set<String> areas;

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

@Value("${amount.limit}")
private int amountLimit;

Вы можете вызывать статические методы:

@Value("#{T(foo.bar).isSecurityEnabled()}")
private boolean securityEnabled;

Вы можете иметь логику

@Value("#{T(foo.bar).isSecurityEnabled() ? '${security.logo.path}' : '${default.logo.path}'}")
private String logoPath;
Алиреза Фаттахи
источник
5

Возможным решением является объявление второго компонента, который читает из того же файла свойств:

<bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
    <property name="location" value="/WEB-INF/app.properties" />
</bean> 

<util:properties id="appProperties" location="classpath:/WEB-INF/app.properties"/>

Компонент с именем appProperties имеет тип java.util.Properties и может быть введен зависимостью с помощью атрибута @Resource, показанного выше.

Донал
источник
4

Если вы застряли в Spring 2.5, вы можете определить bean-компонент для каждого из ваших свойств и внедрить их с помощью квалификаторов. Как это:

  <bean id="someFile" class="java.io.File">
    <constructor-arg value="${someFile}"/>
  </bean>

и

@Service
public class Thing
      public Thing(@Qualifier("someFile") File someFile) {
...

Это не супер читаемый, но он выполняет свою работу.

Nik
источник
2

Значения автопроводки в Spring Beans:

Большинство людей знают, что вы можете использовать @Autowired, чтобы сказать Spring, чтобы он вставлял один объект в другой, когда он загружает контекст вашего приложения. Менее известный фрагмент информации заключается в том, что вы также можете использовать аннотацию @Value для вставки значений из файла свойств в атрибуты компонента. см. этот пост для получения дополнительной информации ...

новые вещи в Spring 3.0 || значения bean для автопроводки || значения свойств автопроводки весной

Счастливый
источник
2

Для меня это был ответ @ Lucky, а именно, строка

AutowiredFakaSource fakeDataSource = ctx.getBean(AutowiredFakaSource.class);

со страницы отладки капитана

это решило мою проблему. У меня есть приложение на основе ApplicationContext, запускаемое из командной строки и, судя по ряду комментариев к SO, Spring по-разному подключает их к приложениям на основе MVC.

ben3000
источник
1

Я думаю, что наиболее удобный способ ввести свойства в bean-компонент - это метод setter.

Пример:

package org.some.beans;

public class MyBean {
    Long id;
    String name;

    public void setId(Long id) {
        this.id = id;
    }

    public Long getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }
}

XML-определение бина:

<bean id="Bean1" class="org.some.beans.MyBean">
    <property name="id" value="1"/>
    <property name="name" value="MyBean"/>
</bean>

Для каждого именованного propertyметода setProperty(value)будет вызван.

Этот способ особенно полезен, если вам нужно более одного компонента на основе одной реализации.

Например, если мы определим еще один bean-компонент в xml:

<bean id="Bean2" class="org.some.beans.MyBean">
    <property name="id" value="2"/>
    <property name="name" value="EnotherBean"/>
</bean>

Тогда код так:

MyBean b1 = appContext.getBean("Bean1");
System.out.println("Bean id = " + b1.getId() + " name = " + b1.getName());
MyBean b2 = appContext.getBean("Bean2");
System.out.println("Bean id = " + b2.getId() + " name = " + b2.getName());

Будет печатать

Bean id = 1 name = MyBean
Bean id = 2 name = AnotherBean

Итак, в вашем случае это должно выглядеть так:

@Repository("personDao")
public class PersonDaoImpl extends AbstractDaoImpl implements PersonDao {

    Long maxResults;

    public void setMaxResults(Long maxResults) {
        this.maxResults = maxResults;
    }

    // Now use maxResults value in your code, it will be injected on Bean creation
    public void someMethod(Long results) {
        if (results < maxResults) {
            ...
        }
    }
}
Сергей Пикалев
источник
0

Если вам нужно больше гибкости для конфигураций, попробуйте Settings4jPlaceholderConfigurer: http://settings4j.sourceforge.net/currentrelease/configSpringPlaceholder.html

В нашем приложении мы используем:

  • Предпочтения по настройке PreProd- и Prod-System
  • Предпочтения и переменные среды JNDI (JNDI перезаписывает предпочтения) для «mvn jetty: run»
  • Системные свойства для UnitTests (аннотация @BeforeClass)

Порядок по умолчанию, в котором ключ-значение-Источник проверяется первым, описан в:
http://settings4j.sourceforge.net/currentrelease/configDefault.html.
Его можно настроить с помощью settings4j.xml (с точностью до log4j.xml) в вашем CLASSPATH.

Дайте мне знать ваше мнение: settings4j-user@lists.sourceforge.net

с дружеским приветом,
Харальд

brabenetz
источник
-1

Используйте класс Spring «PropertyPlaceholderConfigurer»

Простой пример, показывающий, что файл свойств читается динамически как свойство бина

<bean id="placeholderConfig"
        class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
    <property name="locations">
        <list>
            <value>/WEB-INF/classes/config_properties/dev/database.properties</value>
        </list>
    </property> 
</bean>

<bean id="devDataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource" destroy-method="close">
    <property name="driverClass" value="${dev.app.jdbc.driver}"/>
    <property name="jdbcUrl" value="${dev.app.jdbc.url}"/>
    <property name="user" value="${dev.app.jdbc.username}"/>
    <property name="password" value="${dev.app.jdbc.password}"/>
    <property name="acquireIncrement" value="3"/>
    <property name="minPoolSize" value="5"/>
    <property name="maxPoolSize" value="10"/>
    <property name="maxStatementsPerConnection" value="11000"/>
    <property name="numHelperThreads" value="8"/>
    <property name="idleConnectionTestPeriod" value="300"/>
    <property name="preferredTestQuery" value="SELECT 0"/>
</bean> 

Файл свойств

dev.app.jdbc.driver = com.mysql.jdbc.Driver

dev.app.jdbc.url = JDBC: MySQL: // локальный: 3306 / addvertisement

dev.app.jdbc.username = корень

dev.app.jdbc.password = корень

Рави Ранджан
источник