Access properties file programmatically with Spring

Question

We use the code below to inject Spring beans with properties from a properties file    lt bean class  org springframework beans factory config PropertyPlaceholderConfigurer  gt       lt property name  locations  value  classpath  my properties   gt   lt  bean gt    lt bean id  blah  class  abc  gt       lt property name  path  value    the path    gt   lt  bean gt    Is there a way we can access the properties programmatically   I m trying to do some code without dependency injection   So I d like to just have some code like this   PropertyPlaceholderConfigurer props   new PropertyPlaceholderConfigurer    props load  classpath  my properties    props get  path

User · Answer

This is the finest way I got it to work   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

User · Answer

Please use the below code in your spring configuration file to load the file from class path of your application    lt context property-placeholder     ignore-unresolvable  true  ignore-resource-not-found  false  location  classpath property-file-name    gt

User · Answer

create  properties file in classpath of your project and add path configuration in xml  lt context property-placeholder location  classpath     properties    gt     in servlet-context xml after that u can directly use your file everywhere

User · Answer

Create a class like below      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                       Then wherever you want to access a property use        Autowired         private Environment environment      and getters and setters then access using       environment getProperty envName                         letter fdi letterdetails restServiceUrl      -- write getters and setters in the accessor class      public Environment getEnvironment                 return environment            enter code here           public void setEnvironment Environment environment                this environment   environment

User · Answer

This post also explatis howto access properties  http   maciej-miklas blogspot de 2013 07 spring-31-programmatic-access-to html  You can access properties loaded by spring property-placeholder over such spring bean    Named public class PropertiesAccessor        private final AbstractBeanFactory beanFactory       private final Map lt String String gt  cache   new ConcurrentHashMap lt  gt           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

User · Answer

CREDIT  Programmatic access to properties in Spring without re-reading the properties file  I ve found a nice implementation of accessing the properties programmatically in spring without reloading the same properties that spring has already loaded   Also  It is not required to hardcode the property file location in the source   With these changes  the code looks cleaner  amp  more maintainable   The concept is pretty simple  Just extend the spring default property placeholder  PropertyPlaceholderConfigurer  and capture the properties it loads in the local variable  public class SpringPropertiesUtil extends PropertyPlaceholderConfigurer        private static Map lt String  String gt  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 lt String  String gt             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               Usage Example  SpringPropertiesUtil getProperty  myProperty     Spring configuration changes   lt bean id  placeholderConfigMM  class  SpringPropertiesUtil  gt       lt property name  systemPropertiesModeName  value  SYSTEM PROPERTIES MODE OVERRIDE   gt       lt property name  locations  gt       lt list gt           lt value gt classpath myproperties properties lt  value gt       lt  list gt       lt  property gt   lt  bean gt    Hope this helps to solve the problems you have

User · Answer

This will resolve any nested properties   public class Environment extends PropertyPlaceholderConfigurer           Map that hold all the properties      private Map lt String  String gt  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 lt String  String gt         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

User · Answer

You can also use either the spring utils  or load properties via the PropertiesFactoryBean    lt util properties id  myProps  location  classpath com foo myprops properties   gt    or    lt bean id  myProps  class  org springframework beans factory config PropertiesFactoryBean  gt     lt property name  location  value  classpath com foo myprops properties   gt   lt  bean gt    Then you can pick them up in your application with    Resource name    myProps   private Properties myProps    and additionally use these properties in your config    lt context property-placeholder properties-ref  myProps   gt    This is also in the docs  http   docs spring io spring docs current spring-framework-reference htmlsingle  xsd-config-body-schemas-util-properties

User · Answer

If all you want to do is access placeholder value from code  there is the  Value annotation    Value    settings some property    String someValue    To access placeholders From SPEL use this syntax        settings some property      To expose configuration to views that have SPEL turned off  one can use this trick   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 lt String  String gt   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 lt String gt  keySet     throw new UnsupportedOperationException           Override public Set lt java util Map Entry lt String  String gt  gt  entrySet     throw new UnsupportedOperationException           Override public Collection lt String gt  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 lt   extends String    extends String gt  t    throw new UnsupportedOperationException          And then use the exposer to expose properties to a view    lt bean class  org springframework web servlet view UrlBasedViewResolver  id  tilesViewResolver  gt       lt property name  viewClass  value  org springframework web servlet view tiles2 TilesView   gt       lt property name  attributesMap  gt           lt map gt               lt entry key  config  gt                   lt bean class  com my app PropertyPlaceholderExposer    gt               lt  entry gt           lt  map gt       lt  property gt   lt  bean gt    Then in view  use the exposed properties like this     config  settings some property      This solution has the advantage that you can rely on standard placeholder implementation injected by the context property-placeholder tag   Now as a final note  if you really need a to capture all placeholder properties and their values  you have to pipe them through StringValueResolver to make sure that placeholders work inside the property values as expected  The following code will do that   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 lt String  String gt         Map lt String  String gt  props   new HashMap lt String  String gt           Override     protected void processProperties ConfigurableListableBeanFactory beanFactory  Properties props              throws BeansException            this props clear            for  Entry lt Object  Object gt  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 lt String  String gt  e  props entrySet                e setValue valueResolver resolveStringValue e getValue                    Implement map interface to access stored properties      Override public Set lt String gt  keySet     return props keySet           Override public Set lt java util Map Entry lt String  String gt  gt  entrySet     return props entrySet           Override public Collection lt String gt  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 lt   extends String    extends String gt  t    throw new UnsupportedOperationException

User · Answer

Here is another sample    XmlBeanFactory factory   new XmlBeanFactory new FileSystemResource  beans xml     PropertyPlaceholderConfigurer cfg   new PropertyPlaceholderConfigurer    cfg setLocation new FileSystemResource  jdbc properties     cfg postProcessBeanFactory factory

User · Answer

How about PropertiesLoaderUtils   Resource resource   new ClassPathResource   my properties    Properties props   PropertiesLoaderUtils loadProperties resource

User · Answer

As you know the newer versions of Spring don t use the PropertyPlaceholderConfigurer and now use another nightmarish construct called  PropertySourcesPlaceholderConfigurer  If you re trying to get resolved properties from code  and wish the Spring team gave us a way to do this a long time ago  then vote this post up       Because this is how you do it the new way   Subclass 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              To use it  make sure to use your subclass in your  Configuration and save off a reference to it for later use    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            Usage   Object value   PropertiesConfig commonEnvConfig getProperty  key subkey

User · Answer

You can get your properties through Environment class  As documentation stands      Properties play an important role in almost all applications  and may originate from a variety of sources  properties files  JVM system properties  system environment variables  JNDI  servlet context parameters  ad-hoc Properties objects  Maps  and so on  The role of the environment object with relation to properties is to provide the user with a convenient service interface for configuring property sources and resolving properties from them    Having Environment as a env variable  simply call    env resolvePlaceholders    your-property default-value      You can get your  raw  properties through    env getProperty  your-property     It will search through all properties source that spring has registered   You can either obtain Environment through     inject ApplicationContext by implementing ApplicationContextAware and then call getEnvironment   on context  implement EnvironmentAware    It s obtain through implementation of a class because properties are resolved on early stage of application startup  as they may be required for bean construction    Read more on documentation  spring Environment documentation

User · Answer

I have done this and it has worked   Properties props   PropertiesLoaderUtils loadAllProperties  my properties    PropertyPlaceholderConfigurer props2   new PropertyPlaceholderConfigurer    props2 setProperties props     That should work

User · Answer

I know this is an old thread  however  this topic in my opinion becomes of great importance for those using the functional approach for all those usecases where you need a microservice that loads  quot instantly quot  and therefore you avoid using annotations  The problem that remained unsolved was to load eventually the environment variables which I had in my application yml  public class AppPropsLoader   public static Properties load       var propPholderConfig   new PropertySourcesPlaceHolderConfigurer      var yaml   new YamlPropertiesFactoryBean      ClassPathResource resource   new ClassPathResource  quot application yml quot      Objects requireNonNull resource   quot File application yml does not exist quot      yaml setResources resource     Objects requireNonNull yaml getObject     quot Configuration cannot be null quot      propPholderConfig postProcessBeanFactory new DefaultListableBeanFactory       propPholderConfig setProperties yaml getObject       PropertySources appliedPropertySources      propPholderConfig getAppliedPropertySources      var resolver   new PropertySourcesPlaceholderResolver appliedPropertySources     Properties resolvedProps   new Properties      for  Map Entry lt Object  Object gt  prop  yaml getObject   entrySet          resolvedProps setProperty  String prop getKey           getPropertyValue resolver resolvePlaceHolders prop getValue            return resolvedProps     static String getPropertyValue Object prop       var val   String valueOf prop      Pattern p   Pattern compile  quot            a-zA-Z0-9-            quot       Matcher m   p matcher val      if m matches          return System getEnv m group 2           return val

User · Answer

This help me   ApplicationContextUtils getApplicationContext   getEnvironment

[spring] Access properties file programmatically with Spring?

Examples related to spring

Examples related to properties