Springを使用してプログラムでプロパティファイルにアクセスしますか?


137

以下のコードを使用して、プロパティファイルのプロパティをSpring Beanに注入します。

<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
ここに質問があります、これは私のものとどのように異なり、さらに2票あり、2番目に投稿されました...
Zoidberg

3
私を打ち負かして、投票することができませんでした:)私はを使用しませんでしたPropertyPlaceholderConfigurerが、タスクにはやりすぎです。
skaffman 2009年

5
私は彼が持っていたものにできるだけ近づくことを試みていました、私は十分な詳細を提供しなかったために何度も反対投票されました。いずれにせよ、あなたの答えは正解なので投票に値します。私は2票も獲得しなかったので、私は嫉妬していると思います、LOL。
ゾイドバーグ、

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']}

このソリューションには、context:property-placeholderタグによって挿入された標準のプレースホルダー実装に依存できるという利点があります。

最後に、すべてのプレースホルダープロパティとその値をキャプチャする必要がある場合は、それらを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/…を
anttix

50

CREDITプロパティファイルを再読み込みせずに、Springのプロパティにプログラムでアクセス

Springが既にロードしているのと同じプロパティを再ロードせずに、Springでプログラムからプロパティにアクセスする優れた実装を見つけました。[また、ソース内のプロパティファイルの場所をハードコードする必要はありません]

これらの変更により、コードはよりクリーンで保守しやすくなります。

コンセプトはかなりシンプルです。Springのデフォルトプロパティプレースホルダー(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")

Spring構成の変更

<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システムプロパティまたは実行プロパティをEclipseに設定することで解決できます。ビルドプロパティを持つこともできます。このソリューションは少し想定しており、それに対処する必要がありますが、同時にこの回答は、SpringプロパティとJavaプロパティを別々にではなく1つの場所にロードするための標準的な方法に沿ったものです。別のオプションは、ファイルにmyFileを含む一般プロパティファイルをロードし、それを使用して残りを取得することです。
Rob

1
この回避策をSpring 3.1以降の「新しい」PropertySourcesPlaceholderConfigurerに適用しようとしましたが、メソッドprocessProperties(ConfigurableListableBeanFactory beanFactory、Properties props)が非推奨になり、「props」引数にアクセスできないようになりました。PropertySourcesPlaceholderConfigurerのソースを見ると、プロパティを公開するためのクリーンな方法が見つかりません。それを行うためのアイデアはありますか?ありがとう!
ホルヘパラシオ

48

私はこれを行い、それはうまくいきました。

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

うまくいくはずです。


25

また、Spring Utilsを使用するか、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
最善の答えは、環境を自動配線するだけです。
スボチン

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

これは私を助けます:

ApplicationContextUtils.getApplicationContext().getEnvironment()

ApplicationContextUtilsが含まれているパッケージ
Luke

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

Springが登録したすべてのプロパティソースを検索します。

次の方法で環境を取得できます。

  • 実装ApplicationContextAwareしてApplicationContextを注入しgetEnvironment()、コンテキストを呼び出す
  • 実装しEnvironmentAwareます。

プロパティはBeanの構築に必要な場合があるため、アプリケーションの起動の初期段階でプロパティが解決されるため、クラスの実装を通じて取得されます。

ドキュメンテーションの詳細を読む:Spring Environmentのドキュメント


1

この投稿は、またハウツーアクセスのプロパティをexplatis:http://maciej-miklas.blogspot.de/2013/07/spring-31-programmatic-access-to.html

このようなSpring Beanを介して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" />`

その後、servlet-context.xmlで、どこでもファイルを直接使用できます


0

Spring構成ファイルで以下のコードを使用して、アプリケーションのクラスパスからファイルをロードしてください

 <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");を呼び出します。
Daniel Almeida、
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.