Spring Environment Property Source Configuration

Question

I\'m working on an application library with a utility class called \"Config\" which is backed by the Spring Environment object and provides strongl

Answer 1

It depends on how you want to use the properties, if it is to inject the properties using ${propertyname} syntax, then yes just having PropertySourcesPlaceHolderConfigurer will work, which internally has access to the PropertySources registered in the environment.

If you plan to use Environment directly, using say env.getProperty(), then you are right - the properties using PropertySourcesPlaceHolderConfigurer are not visible here. The only way then is to inject it using Java code, there are two ways that I know of:

a. Using Java Config:

@Configuration
@PropertySource("classpath:/app.properties")
public class SpringConfig{

}

b. Using a custom ApplicationContextInitializer, the way it is described here

Answer 2

I recently ran into the issue of how to register custom property sources in the environment. My specific problem is that I have a library with a Spring configuration that I want to be imported into the Spring application context, and it requires custom property sources. However, I don't necessarily have control over all of the places where the application context is created. Because of this, I do not want to use the recommended mechanisms of ApplicationContextInitializer or register-before-refresh in order to register the custom property sources.

What I found really frustrating is that using the old PropertyPlaceholderConfigurer, it was easy to subclass and customize the configurers completely within the Spring configuration. In contrast, to customize property sources, we are told that we have to do it not in the Spring configuration itself, but before the application context is initialized.

After some research and trial and error, I discovered that it is possible to register custom property sources from inside of the Spring configuration, but you have to be careful how you do it. The sources need to be registered before any PropertySourcesPlaceholderConfigurers execute in the context. You can do this by making the source registration a BeanFactoryPostProcessor with PriorityOrdered and an order that is higher precedence than the PropertySourcesPlaceholderConfigurer that uses the sources.

I wrote this class, which does the job:

package example;

import java.io.IOException;
import java.util.Properties;

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanInitializationException;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.core.Ordered;
import org.springframework.core.PriorityOrdered;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.Environment;
import org.springframework.core.env.MutablePropertySources;
import org.springframework.core.env.PropertiesPropertySource;
import org.springframework.core.env.PropertySource;
import org.springframework.core.io.support.PropertiesLoaderSupport;

/**
 * This is an abstract base class that can be extended by any class that wishes
 * to become a custom property source in the Spring context.
 * <p>
 * This extends from the standard Spring class PropertiesLoaderSupport, which
 * contains properties that specify property resource locations, plus methods
 * for loading properties from specified resources. These are all available to
 * be used from the Spring configuration, and by subclasses of this class.
 * <p>
 * This also implements a number of Spring flag interfaces, all of which are
 * required to maneuver instances of this class into a position where they can
 * register their property sources BEFORE PropertySourcesPlaceholderConfigurer
 * executes to substitute variables in the Spring configuration:
 * <ul>
 * <li>BeanFactoryPostProcessor - Guarantees that this bean will be instantiated
 * before other beans in the context. It also puts it in the same phase as
 * PropertySourcesPlaceholderConfigurer, which is also a BFPP. The
 * postProcessBeanFactory method is used to register the property source.</li>
 * <li>PriorityOrdered - Allows the bean priority to be specified relative to
 * PropertySourcesPlaceholderConfigurer so that this bean can be executed first.
 * </li>
 * <li>ApplicationContextAware - Provides access to the application context and
 * its environment so that the created property source can be registered.</li>
 * </ul>
 * <p>
 * The Spring configuration for subclasses should contain the following
 * properties:
 * <ul>
 * <li>propertySourceName - The name of the property source this will register.</li>
 * <li>location(s) - The location from which properties will be loaded.</li>
 * <li>addBeforeSourceName (optional) - If specified, the resulting property
 * source will be added before the given property source name, and will
 * therefore take precedence.</li>
 * <li>order (optional) - The order in which this source should be executed
 * relative to other BeanFactoryPostProcessors. This should be used in
 * conjunction with addBeforeName so that if property source factory "psfa"
 * needs to register its property source before the one from "psfb", "psfa"
 * executes AFTER "psfb".
 * </ul>
 * 
 * @author rjsmith2
 *
 */
public abstract class AbstractPropertySourceFactory extends
        PropertiesLoaderSupport implements ApplicationContextAware,
        PriorityOrdered, BeanFactoryPostProcessor {

    // Default order will be barely higher than the default for
    // PropertySourcesPlaceholderConfigurer.
    private int order = Ordered.LOWEST_PRECEDENCE - 1;

    private String propertySourceName;

    private String addBeforeSourceName;

    private ApplicationContext applicationContext;

    private MutablePropertySources getPropertySources() {
        final Environment env = applicationContext.getEnvironment();
        if (!(env instanceof ConfigurableEnvironment)) {
            throw new IllegalStateException(
                    "Cannot get environment for Spring application context");
        }
        return ((ConfigurableEnvironment) env).getPropertySources();
    }

    public int getOrder() {
        return order;
    }

    public void setOrder(int order) {
        this.order = order;
    }

    public String getPropertySourceName() {
        return propertySourceName;
    }

    public void setPropertySourceName(String propertySourceName) {
        this.propertySourceName = propertySourceName;
    }

    public String getAddBeforeSourceName() {
        return addBeforeSourceName;
    }

    public void setAddBeforeSourceName(String addBeforeSourceName) {
        this.addBeforeSourceName = addBeforeSourceName;
    }

    public void setApplicationContext(ApplicationContext applicationContext) {
        this.applicationContext = applicationContext;
    }

    /**
     * Subclasses can override this method to perform adjustments on the
     * properties after they are read.
     * <p>
     * This should be done by getting, adding, removing, and updating properties
     * as needed.
     * 
     * @param props
     *            properties to adjust
     */
    protected void convertProperties(Properties props) {
        // Override in subclass to perform conversions.
    }

    /**
     * Creates a property source from the specified locations.
     * 
     * @return PropertiesPropertySource instance containing the read properties
     * @throws IOException
     *             if properties cannot be read
     */
    protected PropertySource<?> createPropertySource() throws IOException {
        if (propertySourceName == null) {
            throw new IllegalStateException("No property source name specified");
        }

        // Load the properties file (or files) from specified locations.
        final Properties props = new Properties();
        loadProperties(props);

        // Convert properties as required.
        convertProperties(props);

        // Convert to property source.
        final PropertiesPropertySource source = new PropertiesPropertySource(
                propertySourceName, props);

        return source;
    }

    @Override
    public void postProcessBeanFactory(
            ConfigurableListableBeanFactory beanFactory) throws BeansException {
        try {
            // Create the property source, and get its desired position in
            // the list of sources.
            if (logger.isDebugEnabled()) {
                logger.debug("Creating property source [" + propertySourceName
                        + "]");
            }
            final PropertySource<?> source = createPropertySource();

            // Register the property source.
            final MutablePropertySources sources = getPropertySources();
            if (addBeforeSourceName != null) {
                if (sources.contains(addBeforeSourceName)) {
                    if (logger.isDebugEnabled()) {
                        logger.debug("Adding property source ["
                                + propertySourceName + "] before ["
                                + addBeforeSourceName + "]");
                    }
                    sources.addBefore(addBeforeSourceName, source);
                } else {
                    logger.warn("Property source [" + propertySourceName
                            + "] cannot be added before non-existent source ["
                            + addBeforeSourceName + "] - adding at the end");
                    sources.addLast(source);
                }
            } else {
                if (logger.isDebugEnabled()) {
                    logger.debug("Adding property source ["
                            + propertySourceName + "] at the end");
                }
                sources.addLast(source);
            }
        } catch (Exception e) {
            throw new BeanInitializationException(
                    "Failed to register property source", e);
        }
    }

}

Of note here is that the default order of this property source factory class is higher precedence than the default order of PropertySourcesPlaceholderConfigurer.

Also, the registration of the property source happens in postProcessBeanFactory, which means that it will execute in the correct order relative to the PropertySourcesPlaceholderConfigurer. I discovered the hard way that InitializingBean and afterPropertiesSet do not respect the order parameter, and I gave up on that approach as being wrong and redundant.

Finally, because this is a BeanFactoryPostProcessor, it is a bad idea to try to wire much in the way of dependencies. Therefore, the class accesses the environment directly through the application context, which it obtains using ApplicationContextAware.

In my case, I needed the property source to decrypt password properties, which I implemented using the following subclass:

package example;

import java.util.Properties;

/**
 * This is a property source factory that creates a property source that can
 * process properties for substituting into a Spring configuration.
 * <p>
 * The only thing that distinguishes this from a normal Spring property source
 * is that it decrypts encrypted passwords.
 * 
 * @author rjsmith2
 *
 */
public class PasswordPropertySourceFactory extends
        AbstractPropertySourceFactory {

    private static final PasswordHelper passwordHelper = new PasswordHelper();

    private String[] passwordProperties;

    public String[] getPasswordProperties() {
        return passwordProperties;
    }

    public void setPasswordProperties(String[] passwordProperties) {
        this.passwordProperties = passwordProperties;
    }

    public void setPasswordProperty(String passwordProperty) {
        this.passwordProperties = new String[] { passwordProperty };
    }

    @Override
    protected void convertProperties(Properties props) {
        // Adjust password fields by decrypting them.
        if (passwordProperties != null) {
            for (String propName : passwordProperties) {
                final String propValue = props.getProperty(propName);
                if (propValue != null) {
                    final String plaintext = passwordHelper
                            .decryptString(propValue);
                    props.setProperty(propName, plaintext);
                }
            }
        }
    }

}

Finally, I specifed the property source factory in my Spring configuration:

<!-- Enable property resolution via PropertySourcesPlaceholderConfigurer. 
    The order has to be larger than the ones used by custom property sources 
    so that those property sources are registered before any placeholders
    are substituted. -->
<context:property-placeholder order="1000" ignore-unresolvable="true" />

<!-- Register a custom property source that reads DB properties, and
     decrypts the database password. -->
<bean class="example.PasswordPropertySourceFactory">
    <property name="propertySourceName" value="DBPropertySource" />
    <property name="location" value="classpath:db.properties" />
    <property name="passwordProperty" value="db.password" />
    <property name="ignoreResourceNotFound" value="true" />

    <!-- Order must be lower than on property-placeholder element. -->
    <property name="order" value="100" />
</bean>

To be honest, with the defaults for order in PropertySourcesPlaceholderConfigurer and AbstractPropertySourceFactory, it is probably not even necessary to specify order in the Spring configuration.

Nonetheless, this works, and it does not require any fiddling with the application context initialization.

Answer 3

The following worked for me with Spring 3.2.4 .

PropertySourcesPlaceholderConfigurer must be registered statically in order to process the placeholders.

The custom property source is registered in the init method and as the default property sources are already registered, it can itself be parameterized using placeholders.

JavaConfig class:

@Configuration
@PropertySource("classpath:propertiesTest2.properties")
public class TestConfig {

    @Autowired
    private ConfigurableEnvironment env;

    @Value("${param:NOVALUE}")
    private String param;

    @PostConstruct
    public void init() {
        env.getPropertySources().addFirst(new CustomPropertySource(param));
    }

    @Bean
    public static PropertySourcesPlaceholderConfigurer placeHolderConfigurer() {
        return new PropertySourcesPlaceholderConfigurer();
    }

    @Bean
    public TestBean1 testBean1() {
        return new TestBean1();
    }
 }

Custom property source:

    public class CustomPropertySource extends PropertySource<Object> {

    public CustomPropertySource(String param) {
        super("custom");
        System.out.println("Custom property source initialized with param " + param + ".");
    }

    @Override
    public Object getProperty(String name) {
        return "IT WORKS";
    }

}

Test bean (getValue() will output "IT WORKS"):

public class TestBean1 {

   @Value("${value:NOVALUE}")
   private String value;

   public String getValue() {
      return value;
   }
}

Answer 4

I had a similar problem, in my case I'm using Spring in a standalone application, after load the default configurations I may need apply another properties file (lazy load configs) present in a config directory. My solution was inspired this Spring Boot documentation, but with no dependency of Spring Boot. See below the source code:

@PropertySources(@PropertySource(value = "classpath:myapp-default.properties"))
public class PersistenceConfiguration {

    private final Logger log = LoggerFactory.getLogger(getClass());

    private ConfigurableEnvironment env;

    @Bean
    public static PropertySourcesPlaceholderConfigurer placeholderConfigurerDev(ConfigurableEnvironment env) {
        return new PropertySourcesPlaceholderConfigurer();
    }


    @Autowired
    public void setConfigurableEnvironment(ConfigurableEnvironment env) {
        for(String profile: env.getActiveProfiles()) {
            final String fileName = "myapp-" + profile + ".properties";
            final Resource resource = new ClassPathResource(fileName);
            if (resource.exists()) {
                try {
                    MutablePropertySources sources = env.getPropertySources();
                    sources.addFirst(new PropertiesPropertySource(fileName,PropertiesLoaderUtils.loadProperties(resource)));
                } catch (Exception ex) {
                    log.error(ex.getMessage(), ex);
                    throw new RuntimeException(ex.getMessage(), ex);
                }
            }
        }
        this.env = env;
    }

    ...

}

Answer 5

I came up with the following which seems to work, but I'm fairly new to Spring, so I'm not so sure how it will hold up under different use cases.

Basically, the approach is to extend PropertySourcesPlaceholderConfigurer and add a setter to allow the user to easily configure a List of PropertySource objects in XML. After creation, the property sources are copied to the current Environment.

This basically allows the property sources to be configured in one place, but used by both placholder configuration and Environment.getProperty scenarios.

Extended PropertySourcesPlaceholderConfigurer

public class ConfigSourcesConfigurer 
        extends PropertySourcesPlaceholderConfigurer
        implements EnvironmentAware, InitializingBean {

    private Environment environment;
    private List<PropertySource> sourceList;

    // Allow setting property sources as a List for easier XML configuration
    public void setPropertySources(List<PropertySource> propertySources) {

        this.sourceList = propertySources;
        MutablePropertySources sources = new MutablePropertySources();
        copyListToPropertySources(this.sourceList, sources);        
        super.setPropertySources(sources);
    }

    @Override
    public void setEnvironment(Environment environment) {
        // save off Environment for later use
        this.environment = environment;
        super.setEnvironment(environment);
    }

    @Override
    public void afterPropertiesSet() throws Exception {

        // Copy property sources to Environment
        MutablePropertySources envPropSources = ((ConfigurableEnvironment)environment).getPropertySources();
        copyListToPropertySources(this.sourceList, envPropSources);
    }

    private void copyListToPropertySources(List<PropertySource> list, MutablePropertySources sources) {

        // iterate in reverse order to insure ordering in property sources object
        for(int i = list.size() - 1; i >= 0; i--) {
            sources.addFirst(list.get(i));
        }
    }
}

beans.xml file showing basic configuration

<beans>
    <context:annotation-config/>
    <context:component-scan base-package="com.mycompany" />

    <bean class="com.mycompany.ConfigSourcesConfigurer">
        <property name="propertySources">
            <list>
                <bean class="org.mycompany.CustomPropertySource" />
                <bean class="org.springframework.core.io.support.ResourcePropertySource">
                    <constructor-arg value="classpath:default-config.properties" />
                </bean>
            </list>
        </property>
    </bean>
    <bean class="com.mycompany.TestBean">
        <property name="stringValue" value="${placeholder}" />
    </bean>
</beans>