Доступ до файлу властивостей програмно за допомогою Spring?


137

Ми використовуємо наведений нижче код для введення весняних бобів із властивостями з файлу властивостей.

<bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
    <property name="locations" value="classpath:/my.properties"/>
</bean>

<bean id="blah" class="abc">
    <property name="path" value="${the.path}"/>
</bean>

Чи є спосіб ми отримати доступ до властивостей програмно? Я намагаюся зробити якийсь код без введення залежності. Тому я хотів би просто мати такий код, як цей:

PropertyPlaceholderConfigurer props = new PropertyPlaceholderConfigurer();
props.load("classpath:/my.properties");
props.get("path");

Повний приклад доступу до файлу властивостей навесні - за посиланням: bharatonjava.wordpress.com/2012/08/24/…

Відповіді:


171

Як щодо PropertiesLoaderUtils ?

Resource resource = new ClassPathResource("/my.properties");
Properties props = PropertiesLoaderUtils.loadProperties(resource);

5
ось питання, чим це відрізняється від мого, і має ще два голоси І розміщено друге ...
Zoidberg

3
Перемагає мене, я не потрапив до голосування :) Я б не використав цю програму PropertyPlaceholderConfigurer, хоча це непосильне завдання.
скафман

5
Я намагався максимально наблизитись до того, що він мав, мене стільки разів заперечували за те, що я не надав достатньої кількості деталей. У будь-якому випадку, ваші відповіді заслуговують на голоси, як це правильно, я думаю, я просто заздрю, що я також не отримав 2 голоси, LOL.
Zoidberg

1
що нам дати шлях, якщо файл розміщений у зовнішній директорії, скажімо, папка config?
prnjn

52

Якщо все, що ви хочете зробити, це отримати значення заповнювача заповнення з коду, є @Valueпримітка:

@Value("${settings.some.property}")
String someValue;

Для доступу до заповнювачів із SPEL використовуйте цей синтаксис:

#('${settings.some.property}')

Щоб виставити конфігурацію представленням даних, у яких вимкнено SPEL, можна скористатися цим фокусом:

package com.my.app;

import java.util.Collection;
import java.util.Map;
import java.util.Set;

import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
import org.springframework.stereotype.Component;

@Component
public class PropertyPlaceholderExposer implements Map<String, String>, BeanFactoryAware {  
    ConfigurableBeanFactory beanFactory; 

    @Override
    public void setBeanFactory(BeanFactory beanFactory) {
        this.beanFactory = (ConfigurableBeanFactory) beanFactory;
    }

    protected String resolveProperty(String name) {
        String rv = beanFactory.resolveEmbeddedValue("${" + name + "}");

        return rv;
    }

    @Override
    public String get(Object key) {
        return resolveProperty(key.toString());
    }

    @Override
    public boolean containsKey(Object key) {
        try {
            resolveProperty(key.toString());
            return true;
        }
        catch(Exception e) {
            return false;
        }
    }

    @Override public boolean isEmpty() { return false; }
    @Override public Set<String> keySet() { throw new UnsupportedOperationException(); }
    @Override public Set<java.util.Map.Entry<String, String>> entrySet() { throw new UnsupportedOperationException(); }
    @Override public Collection<String> values() { throw new UnsupportedOperationException(); }
    @Override public int size() { throw new UnsupportedOperationException(); }
    @Override public boolean containsValue(Object value) { throw new UnsupportedOperationException(); }
    @Override public void clear() { throw new UnsupportedOperationException(); }
    @Override public String put(String key, String value) { throw new UnsupportedOperationException(); }
    @Override public String remove(Object key) { throw new UnsupportedOperationException(); }
    @Override public void putAll(Map<? extends String, ? extends String> t) { throw new UnsupportedOperationException(); }
}

А потім скористайтеся експонатором, щоб виставити властивості перегляду:

<bean class="org.springframework.web.servlet.view.UrlBasedViewResolver" id="tilesViewResolver">
    <property name="viewClass" value="org.springframework.web.servlet.view.tiles2.TilesView"/>
    <property name="attributesMap">
        <map>
            <entry key="config">
                <bean class="com.my.app.PropertyPlaceholderExposer" />
            </entry>
        </map>
    </property>
</bean>

Тоді для перегляду використовуйте такі відкриті властивості:

${config['settings.some.property']}

Це рішення має ту перевагу, що ви можете покластися на стандартну реалізацію заповнення заповнення, введену контекстом: тег властивостей-заповнювачів.

Тепер, як остаточне зауваження, якщо вам дійсно потрібен a, щоб захопити всі властивості заповнювачів та їх значення, вам доведеться передавати їх через StringValueResolver, щоб переконатися, що заповнювачі працюють у значеннях властивостей, як очікувалося. Наступний код зробить це.

package com.my.app;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import java.util.Set;

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.config.PropertyPlaceholderConfigurer;
import org.springframework.util.StringValueResolver;

public class AppConfig extends PropertyPlaceholderConfigurer implements Map<String, String> {

    Map<String, String> props = new HashMap<String, String>();

    @Override
    protected void processProperties(ConfigurableListableBeanFactory beanFactory, Properties props)
            throws BeansException {

        this.props.clear();
        for (Entry<Object, Object> e: props.entrySet())
            this.props.put(e.getKey().toString(), e.getValue().toString());

        super.processProperties(beanFactory, props);
    }

    @Override
    protected void doProcessProperties(ConfigurableListableBeanFactory beanFactoryToProcess,
            StringValueResolver valueResolver) {

        super.doProcessProperties(beanFactoryToProcess, valueResolver);

        for(Entry<String, String> e: props.entrySet())
            e.setValue(valueResolver.resolveStringValue(e.getValue()));
    }

    // Implement map interface to access stored properties
    @Override public Set<String> keySet() { return props.keySet(); }
    @Override public Set<java.util.Map.Entry<String, String>> entrySet() { return props.entrySet(); }
    @Override public Collection<String> values() { return props.values(); }
    @Override public int size() { return props.size(); }
    @Override public boolean isEmpty() { return props.isEmpty(); }
    @Override public boolean containsValue(Object value) { return props.containsValue(value); }
    @Override public boolean containsKey(Object key) { return props.containsKey(key); }
    @Override public String get(Object key) { return props.get(key); }
    @Override public void clear() { throw new UnsupportedOperationException(); }
    @Override public String put(String key, String value) { throw new UnsupportedOperationException(); }
    @Override public String remove(Object key) { throw new UnsupportedOperationException(); }
    @Override public void putAll(Map<? extends String, ? extends String> t) { throw new UnsupportedOperationException(); }
}

Thnx за цю дуже повну відповідь! чи є спосіб це зробити з кінцевими полями?
Уорд

2
@WardC ви не можете ввести остаточне поле. Однак ви можете ввести аргумент конструктора і встановити остаточне значення поля всередині конструктора. Див stackoverflow.com/questions/2306078 / ... і stackoverflow.com/questions/4203302 / ...
Анттікс

50

КРЕДИТ : Програмний доступ до властивостей навесні без повторного читання файлу властивостей

Я знайшов гарну реалізацію доступу до властивостей програмно навесні, не перезавантажуючи ті самі властивості, які вже завантажила весна. [Також не потрібно вводити жорсткий код розташування файлу властивостей у джерелі]

Завдяки цим змінам код виглядає більш чистим і ретельним.

Концепція досить проста. Просто розширіть заповнювач властивостей пружини за замовчуванням (PropertyPlaceholderConfigurer) та захопіть властивості, які він завантажує в локальну змінну

public class SpringPropertiesUtil extends PropertyPlaceholderConfigurer {

    private static Map<String, String> propertiesMap;
    // Default as in PropertyPlaceholderConfigurer
    private int springSystemPropertiesMode = SYSTEM_PROPERTIES_MODE_FALLBACK;

    @Override
    public void setSystemPropertiesMode(int systemPropertiesMode) {
        super.setSystemPropertiesMode(systemPropertiesMode);
        springSystemPropertiesMode = systemPropertiesMode;
    }

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

        propertiesMap = new HashMap<String, String>();
        for (Object key : props.keySet()) {
            String keyStr = key.toString();
            String valueStr = resolvePlaceholder(keyStr, props, springSystemPropertiesMode);
            propertiesMap.put(keyStr, valueStr);
        }
    }

    public static String getProperty(String name) {
        return propertiesMap.get(name).toString();
    }

}

Приклад використання

SpringPropertiesUtil.getProperty("myProperty")

Змінюється конфігурація весни

<bean id="placeholderConfigMM" class="SpringPropertiesUtil">
    <property name="systemPropertiesModeName" value="SYSTEM_PROPERTIES_MODE_OVERRIDE"/>
    <property name="locations">
    <list>
        <value>classpath:myproperties.properties</value>
    </list>
    </property>
</bean>

Сподіваюся, це допоможе вирішити проблеми, які у вас є


8
Це не повна реалізація і не працюватиме правильно. PropertyPlaceholderConfigurer використовує PropertyPlaceholderHelper для заміни ВСІХ властивостей заповнювача, включаючи вкладені заповнювачі. У реалізації Kalinga якщо у вас є щось на кшталт myFile = $ {myFolder} /myFile.txt, буквальне значення властивості, яке ви отримаєте з карти за допомогою ключа "myFile", буде $ {myFolder} /myFile.txt.

1
Це правильне рішення. Щоб вирішити стурбованість Брайана. $ {MyFolder} має бути властивістю системи та не бути у файлі властивостей. Це можна вирішити, якщо властивість системи tomcat або запустити властивість, встановлену в затемнення. Можливо, ви навіть зможете мати властивість збірки. Це рішення передбачає, що мало, і слід вирішити це, але в той же час ця відповідь набагато більше, ніж у стандартній практиці завантажувати властивості весни та java в одне місце, а не окремо. Інший варіант - завантажити файл загальних властивостей з файлом myFile і використовувати його, щоб отримати решту.
Роб

1
Я спробував застосувати це рішення до "нового" PropertySourcesPlaceholderConfigurer з весни 3.1+, але я виявив, що метод processProperties (ConfigurableListableBeanFactory beanFactory, Properties props) тепер застарілий, і тому немає доступу до аргументу "реквізиту". Дивлячись на джерела PropertySourcesPlaceholderConfigurer не вдалося знайти чистий спосіб викрити властивості. Якісь ідеї це зробити? Дякую!
Хорхе Паласіо

48

Я це зробив, і це спрацювало.

Properties props = PropertiesLoaderUtils.loadAllProperties("my.properties");
PropertyPlaceholderConfigurer props2 = new PropertyPlaceholderConfigurer();
props2.setProperties(props);

Це має спрацювати.


25

Ви також можете використовувати або пружинні утиліти, або властивості завантаження через PropertiesFactoryBean.

<util:properties id="myProps" location="classpath:com/foo/myprops.properties"/>

або:

<bean id="myProps" class="org.springframework.beans.factory.config.PropertiesFactoryBean">
  <property name="location" value="classpath:com/foo/myprops.properties"/>
</bean>

Потім ви можете забрати їх у своїй заявці за допомогою:

@Resource(name = "myProps")
private Properties myProps;

а також додатково використовувати ці властивості у своєму конфігурації:

<context:property-placeholder properties-ref="myProps"/>

Це також у документах: http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#xsd-config-body-schemas-util-properties


10

Створіть клас, як показано нижче

    package com.tmghealth.common.util;

    import java.util.Properties;

    import org.springframework.beans.BeansException;

    import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;

    import org.springframework.beans.factory.config.PropertyPlaceholderConfigurer;

    import org.springframework.context.annotation.Configuration;

    import org.springframework.context.annotation.PropertySource;

    import org.springframework.stereotype.Component;


    @Component
    @Configuration
    @PropertySource(value = { "classpath:/spring/server-urls.properties" })
    public class PropertiesReader extends PropertyPlaceholderConfigurer {

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

        }

    }

Тоді, де ви хочете отримати доступ до власності

    @Autowired
        private Environment environment;
    and getters and setters then access using 

    environment.getProperty(envName
                    + ".letter.fdi.letterdetails.restServiceUrl");

- записуйте геттери та сетери в клас аксесуарів

    public Environment getEnvironment() {
            return environment;
        }`enter code here`

        public void setEnvironment(Environment environment) {
            this.environment = environment;
        }

1
Безумовно, найкраща відповідь, повинна просто автопровідне середовище.
sbochins

4

Як ви знаєте, новіші версії Spring не використовують PropertyPlaceholderConfigurer, а тепер використовують іншу конструкцію кошмарів під назвою PropertySourcesPlaceholderConfigurer. Якщо ви намагаєтесь отримати вирішені властивості з коду і хочете, щоб команда Spring дала нам змогу зробити це давно, тоді проголосуйте за цю публікацію! ... Тому що це ви робите це по-новому:

Підклас PropertySourcesPlaceholderConfigurer:

public class SpringPropertyExposer extends PropertySourcesPlaceholderConfigurer {

    private ConfigurableListableBeanFactory factory;

    /**
     * Save off the bean factory so we can use it later to resolve properties
     */
    @Override
    protected void processProperties(ConfigurableListableBeanFactory beanFactoryToProcess,
            final ConfigurablePropertyResolver propertyResolver) throws BeansException {
        super.processProperties(beanFactoryToProcess, propertyResolver);

        if (beanFactoryToProcess.hasEmbeddedValueResolver()) {
            logger.debug("Value resolver exists.");
            factory = beanFactoryToProcess;
        }
        else {
            logger.error("No existing embedded value resolver.");
        }
    }

    public String getProperty(String name) {
        Object propertyValue = factory.resolveEmbeddedValue(this.placeholderPrefix + name + this.placeholderSuffix);
        return propertyValue.toString();
    }
}

Для його використання обов'язково використовуйте свій підклас у вашій @Configuration та збережіть посилання на нього для подальшого використання.

@Configuration
@ComponentScan
public class PropertiesConfig {

    public static SpringPropertyExposer commonEnvConfig;

    @Bean(name="commonConfig")
    public static PropertySourcesPlaceholderConfigurer commonConfig() throws IOException {
        commonEnvConfig = new SpringPropertyExposer(); //This is a subclass of the return type.
        PropertiesFactoryBean commonConfig = new PropertiesFactoryBean();
        commonConfig.setLocation(new ClassPathResource("META-INF/spring/config.properties"));
        try {
            commonConfig.afterPropertiesSet();
        }
        catch (IOException e) {
            e.printStackTrace();
            throw e;
        }
        commonEnvConfig.setProperties(commonConfig.getObject());
        return commonEnvConfig;
    }
}

Використання:

Object value = PropertiesConfig.commonEnvConfig.getProperty("key.subkey");

2

Ось ще один зразок.

XmlBeanFactory factory = new XmlBeanFactory(new FileSystemResource("beans.xml"));
PropertyPlaceholderConfigurer cfg = new PropertyPlaceholderConfigurer();
cfg.setLocation(new FileSystemResource("jdbc.properties"));
cfg.postProcessBeanFactory(factory);


2

Це дозволить вирішити будь-які вкладені властивості.

public class Environment extends PropertyPlaceholderConfigurer {

/**
 * Map that hold all the properties.
 */
private Map<String, String> propertiesMap; 

/**
 * Iterate through all the Property keys and build a Map, resolve all the nested values before building the map.
 */
@Override
protected void processProperties(ConfigurableListableBeanFactory beanFactory, Properties props) throws BeansException {
    super.processProperties(beanFactory, props);

    propertiesMap = new HashMap<String, String>();
    for (Object key : props.keySet()) {
        String keyStr = key.toString();
        String valueStr = beanFactory.resolveEmbeddedValue(placeholderPrefix + keyStr.trim() + DEFAULT_PLACEHOLDER_SUFFIX);
        propertiesMap.put(keyStr, valueStr);
    }
} 

/**
 * This method gets the String value for a given String key for the property files.
 * 
 * @param name - Key for which the value needs to be retrieved.
 * @return Value
 */
public String getProperty(String name) {
    return propertiesMap.get(name).toString();
}

2

Ви можете отримати свої властивості через Environmentклас. Як документація стоїть:

Властивості відіграють важливу роль майже у всіх програмах і можуть походити з різних джерел: файлів властивостей, властивостей системи JVM, змінних системного середовища, JNDI, параметрів контексту сервлетів, спеціальних об'єктів властивостей, карт тощо. Роль об'єкта середовища стосовно властивостей полягає у наданні користувачеві зручного сервісного інтерфейсу для налаштування джерел властивостей та вирішення з них властивостей.

Маючи середовище як envзмінну, просто зателефонуйте:

env.resolvePlaceholders("${your-property:default-value}")

Ви можете отримати свої "сировинні" властивості за допомогою:

env.getProperty("your-property")

Він буде шукати всі джерела властивостей, які весна зареєструвала.

Ви можете отримати навколишнє середовище через:

  • ApplicationContextAwareвведіть ApplicationContext, реалізуючи, а потім викликайте getEnvironment()контекст
  • здійснити EnvironmentAware.

Його отримують шляхом впровадження класу, оскільки властивості вирішуються на ранній стадії запуску програми, оскільки вони можуть знадобитися для побудови бобів.

Детальніше про документацію: весняна екологічна документація


1

Цей пост також пояснює, як отримати доступ до властивостей: http://maciej-miklas.blogspot.de/2013/07/spring-31-programmatic-access-to.html

Ви можете отримати доступ до властивостей, завантажених власником Spring властивості-заповнювача, через такий весняний боб:

@Named
public class PropertiesAccessor {

    private final AbstractBeanFactory beanFactory;

    private final Map<String,String> cache = new ConcurrentHashMap<>();

    @Inject
    protected PropertiesAccessor(AbstractBeanFactory beanFactory) {
        this.beanFactory = beanFactory;
    }

    public  String getProperty(String key) {
        if(cache.containsKey(key)){
            return cache.get(key);
        }

        String foundProp = null;
        try {
            foundProp = beanFactory.resolveEmbeddedValue("${" + key.trim() + "}");
            cache.put(key,foundProp);
        } catch (IllegalArgumentException ex) {
           // ok - property was not found
        }

        return foundProp;
    }
}

0
create .properties file in classpath of your project and add path configuration in xml`<context:property-placeholder location="classpath*:/*.properties" />`

в сервлет-контекст.xml після цього ви можете безпосередньо використовувати ваш файл скрізь


0

Будь ласка, використовуйте наведений нижче код у своєму весняному конфігураційному файлі, щоб завантажити файл із шляху класу вашої програми

 <context:property-placeholder
    ignore-unresolvable="true" ignore-resource-not-found="false" location="classpath:property-file-name" />

0

Це найкращий спосіб змусити його працювати:

package your.package;

import java.io.IOException;
import java.util.Properties;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PropertiesLoaderUtils;

public class ApplicationProperties {

    private Properties properties;

    public ApplicationProperties() {
        // application.properties located at src/main/resource
        Resource resource = new ClassPathResource("/application.properties");
        try {
            this.properties = PropertiesLoaderUtils.loadProperties(resource);
        } catch (IOException ex) {
            Logger.getLogger(ApplicationProperties.class.getName()).log(Level.SEVERE, null, ex);
        }
    }

    public String getProperty(String propertyName) {
        return this.properties.getProperty(propertyName);
    }
}

Миттєво активуйте клас та метод виклику obj.getProperty ("my.property.name");
Даніель Альмейда
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.