Programowy dostęp do pliku właściwości za pomocą Springa?

Używamy poniższego kodu, aby wstrzyknąć fasolom Spring właściwości z pliku właściwości.

<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>

Czy istnieje sposób, w jaki możemy uzyskać programistyczny dostęp do właściwości? Próbuję zrobić jakiś kod bez iniekcji zależności. Więc chciałbym mieć taki kod:

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

A co z PropertiesLoaderUtils ?

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

Jeśli wszystko, co chcesz zrobić, to uzyskać dostęp do wartości zastępczej z kodu, jest @Valueadnotacja:

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

Aby uzyskać dostęp do symboli zastępczych z SPEL, użyj następującej składni:

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

Aby udostępnić konfigurację widokom, które mają wyłączony SPEL, można użyć tej sztuczki:

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(); }
}

A następnie użyj ekspozytora, aby wyświetlić właściwości w widoku:

<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>

Następnie użyj widocznych właściwości, takich jak:

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

To rozwiązanie ma tę zaletę, że można polegać na standardowej implementacji symbolu zastępczego wprowadzonej przez tag context: property-placeholder.

Na koniec, jeśli naprawdę potrzebujesz a do przechwytywania wszystkich właściwości zastępczych i ich wartości, musisz potokować je przez StringValueResolver, aby upewnić się, że symbole zastępcze działają w wartościach właściwości zgodnie z oczekiwaniami. Poniższy kod zrobi to.

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(); }
}

KREDYT : Programowy dostęp do właściwości w Spring bez ponownego czytania pliku właściwości

Znalazłem fajną implementację programowego dostępu do właściwości wiosną bez ponownego ładowania tych samych właściwości, które zostały już załadowane przez sprężynę. [Ponadto nie jest wymagane zakodowanie na stałe lokalizacji pliku właściwości w źródle]

Dzięki tym zmianom kod wygląda na bardziej przejrzysty i łatwiejszy w utrzymaniu.

Koncepcja jest dość prosta. Po prostu rozszerz domyślny element zastępczy właściwości sprężyny (PropertyPlaceholderConfigurer) i przechwyć właściwości, które ładuje w zmiennej lokalnej

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();
    }

}

Przykład użycia

SpringPropertiesUtil.getProperty("myProperty")

Sprężynowe zmiany konfiguracji

<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>

Mam nadzieję, że pomoże to rozwiązać problemy, które masz

Zrobiłem to i zadziałało.

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

To powinno działać.

Można również użyć narzędzi sprężynowych lub wczytać właściwości za pośrednictwem elementu PropertiesFactoryBean.

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

lub:

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

Następnie możesz je odebrać w swojej aplikacji za pomocą:

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

i dodatkowo użyj tych właściwości w swojej konfiguracji:

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

Jest to również w dokumentach: http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#xsd-config-body-schemas-util-properties

Utwórz klasę jak poniżej

    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);

        }

    }

Następnie wszędzie tam, gdzie chcesz uzyskać dostęp do właściwości użytkowania

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

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

- napisz metody pobierające i ustawiające w klasie akcesora

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

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

Jak wiesz, nowsze wersje Springa nie używają PropertyPlaceholderConfigurer, a teraz używają innej koszmarnej konstrukcji o nazwie PropertySourcesPlaceholderConfigurer. Jeśli próbujesz uzyskać rozwiązane właściwości z kodu i chcesz, aby zespół Spring dał nam na to sposób dawno temu, zagłosuj na ten post! ... bo tak to się robi w nowy sposób:

Podklasa 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();
    }
}

Aby go użyć, upewnij się, że używasz podklasy w swojej @Configuration i zapisz odniesienie do niej do późniejszego użytku.

@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;
    }
}

Stosowanie:

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

Oto kolejna próbka.

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

To mi pomoże:

ApplicationContextUtils.getApplicationContext().getEnvironment()

Spowoduje to rozwiązanie wszelkich zagnieżdżonych właściwości.

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();
}

Możesz uzyskać swoje właściwości poprzez Environmentzajęcia. Zgodnie z dokumentacją:

Właściwości odgrywają ważną rolę w prawie wszystkich aplikacjach i mogą pochodzić z różnych źródeł: plików właściwości, właściwości systemu JVM, zmiennych środowiskowych systemu, JNDI, parametrów kontekstu serwletu, obiektów właściwości ad-hoc, map itd. Rolą obiektu środowiska w odniesieniu do właściwości jest zapewnienie użytkownikowi wygodnego interfejsu usługowego do konfigurowania źródeł własności i rozwiązywania z nich właściwości.

Mając środowisko jako envzmienną, po prostu wywołaj:

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

Możesz uzyskać swoje `` surowe '' właściwości poprzez:

env.getProperty("your-property")

Przeszuka wszystkie źródła nieruchomości, które zarejestrowała wiosna.

Możesz uzyskać Środowisko poprzez:

• wstrzyknąć ApplicationContext, implementując, ApplicationContextAwarea następnie wywołującgetEnvironment() kontekst
• wdrożyć EnvironmentAware.

Uzyskuje się to poprzez implementację klasy, ponieważ właściwości są rozwiązywane na wczesnym etapie uruchamiania aplikacji, ponieważ mogą być wymagane do budowy fasoli.

Przeczytaj więcej na temat dokumentacji: dokumentacja środowiska wiosennego

Ten post wyjaśnia również, jak uzyskać dostęp do właściwości: http://maciej-miklas.blogspot.de/2013/07/spring-31-programmatic-access-to.html

Możesz uzyskać dostęp do właściwości wczytanych przez obiekt zastępczy właściwości sprężyny nad takim komponentem bean sprężyny:

@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;
    }
}

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

w servlet-context.xml możesz potem bezpośrednio używać swojego pliku wszędzie

Użyj poniższego kodu w swoim pliku konfiguracyjnym sprężyny, aby załadować plik ze ścieżki klasy aplikacji

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

To najlepszy sposób, w jaki mam to do pracy:

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);
    }
}