如何从属性文件中读取值？

Question

我正在使用弹簧。我需要从属性文件中读取值。这是内部属性文件而不是外部属性文件。属性文件可以如下所示。

some.properties ---file name. values are below.

abc = abc
def = dsd
ghi = weds
jil = sdd

我需要从属性文件中读取这些值，而不是以传统方式。如何实现？ spring 3.0有什么最新的方法吗？

Answer 1

在您的上下文中配置 PropertyPlaceholder：

<context:property-placeholder location="classpath*:my.properties"/>

然后引用 bean 中的属性：

@Component
class MyClass {
  @Value("${my.property.name}")
  private String[] myValues;
}

使用多个逗号分隔值解析属性：

my.property.name=aaa,bbb,ccc

如果这不起作用，您可以使用属性定义一个 bean，手动注入并处理它：

<bean id="myProperties"
      class="org.springframework.beans.factory.config.PropertiesFactoryBean">
  <property name="locations">
    <list>
      <value>classpath*:my.properties</value>
    </list>
  </property>
</bean>

以及 bean :

@Component
class MyClass {
  @Resource(name="myProperties")
  private Properties myProperties;

  @PostConstruct
  public void init() {
    // do whatever you need with properties
  }
}

Answer 2

有多种方法可以实现相同的目的。下面是spring中一些常用的方式

1. -

   使用PropertyPlaceholderConfigurer

2. 使用 PropertySource

3. 使用 ResourceBundleMessageSource

4. 使用 PropertiesFactoryBean

   还有更多......................

假设 ds.type是属性文件中的关键。

---

使用 PropertyPlaceholderConfigurer

注册 PropertyPlaceholderConfigurer bean-

<context:property-placeholder location="classpath:path/filename.properties"/>

或

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

或

@Configuration
public class SampleConfig {
 @Bean
 public static PropertySourcesPlaceholderConfigurer placeHolderConfigurer() {
  return new PropertySourcesPlaceholderConfigurer();
  //set locations as well.
 }
}

注册 PropertySourcesPlaceholderConfigurer 后，您可以访问值

@Value("${ds.type}")private String attr; 

---

- 使用 PropertySource

在最新的 Spring 版本中，您不需要使用 @PropertySource 注册 PropertyPlaceHolderConfigurer，我找到了一个很好的链接来了解版本兼容性 -

@PropertySource("classpath:path/filename.properties")
@Component
public class BeanTester {
    @Autowired Environment environment; 
    public void execute() {
        String attr = this.environment.getProperty("ds.type");
    }
}

---

使用ResourceBundleMessageSource

注册Bean-

<bean id="messageSource" class="org.springframework.context.support.ResourceBundleMessageSource">
  <property name="basenames">
    <list>
      <value>classpath:path/filename.properties</value>
    </list>
  </property>
</bean>

访问值-

((ApplicationContext)context).getMessage("ds.type", null, null);

或

@Component
public class BeanTester {
    @Autowired MessageSource messageSource; 
    public void execute() {
        String attr = this.messageSource.getMessage("ds.type", null, null);
    }
}

---

使用PropertiesFactoryBean

将Bean-

<bean id="properties"
      class="org.springframework.beans.factory.config.PropertiesFactoryBean">
  <property name="locations">
    <list>
      <value>classpath:path/filename.properties</value>
    </list>
  </property>
</bean>

Wire Properties实例注册到您的类中-

@Component
public class BeanTester {
    @Autowired Properties properties; 
    public void execute() {
        String attr = properties.getProperty("ds.type");
    }
}

Answer 3

在配置类中

@Configuration
@PropertySource("classpath:/com/myco/app.properties")
public class AppConfig {
   @Autowired
   Environment env;

   @Bean
   public TestBean testBean() {
       TestBean testBean = new TestBean();
       testBean.setName(env.getProperty("testbean.name"));
       return testBean;
   }
}

Answer 4

这是一个额外的答案，对我理解它的工作原理也有很大帮助： http: //www.javacodegeeks.com/2013/07/spring-bean-and-propertyplaceholderconfigurer.html

任何 BeanFactoryPostProcessor bean 都必须使用 static 修饰符声明

@Configuration
@PropertySource("classpath:root/test.props")
public class SampleConfig {
 @Value("${test.prop}")
 private String attr;
 @Bean
 public SampleService sampleService() {
  return new SampleService(attr);
 }

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

Answer 5

如果您需要在不使用@Value的情况下手动读取属性文件。

感谢 Lokesh Gupta 写得很好的页面：博客

package utils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.ResourceUtils;

import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;
import java.io.File;


public class Utils {

    private static final Logger LOGGER = LoggerFactory.getLogger(Utils.class.getName());

    public static Properties fetchProperties(){
        Properties properties = new Properties();
        try {
            File file = ResourceUtils.getFile("classpath:application.properties");
            InputStream in = new FileInputStream(file);
            properties.load(in);
        } catch (IOException e) {
            LOGGER.error(e.getMessage());
        }
        return properties;
    }
}

Answer 6

另一种方法是使用 ResourceBundle。基本上，您可以使用不带“.properties”的名称来获取捆绑包，

private static final ResourceBundle resource = ResourceBundle.getBundle("config");

并且可以使用以下命令恢复任何值：

private final String prop = resource.getString("propName");

Answer 7

您需要将 PropertyPlaceholderConfigurer bean 放入应用程序上下文中并设置其位置属性。

请参阅此处的详细信息：http://www.zparacha.com/ how-to-read-properties-file-in-spring/

您可能需要稍微修改一下属性文件才能使此功能正常工作。

希望有帮助。

Answer 8

我想要一个不由 spring 管理的实用程序类，因此没有像 @Component、@Configuration 等 Spring 注释。但我希望该类从 application 读取.properties

我设法通过让类了解 Spring Context 来使其工作，从而了解 Environment，从而了解 environment.getProperty() 按预期工作。

明确地说，我有：

application.properties

mypath=somestring

Utils.java

import org.springframework.core.env.Environment;

// No spring annotations here
public class Utils {
    public String execute(String cmd) {
        // Making the class Spring context aware
        ApplicationContextProvider appContext = new ApplicationContextProvider();
        Environment env = appContext.getApplicationContext().getEnvironment();

        // env.getProperty() works!!!
        System.out.println(env.getProperty("mypath")) 
    }
}

ApplicationContextProvider.java （请参阅 Spring 获取当前ApplicationContext)

import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;

@Component
public class ApplicationContextProvider implements ApplicationContextAware {
    private static ApplicationContext CONTEXT;

    public ApplicationContext getApplicationContext() {
        return CONTEXT;
    }

    public void setApplicationContext(ApplicationContext context) throws BeansException {
        CONTEXT = context;
    }

    public static Object getBean(String beanName) {
        return CONTEXT.getBean(beanName);
    }
}

Answer 9

 [project structure]: https://i.sstatic.net/RAGX3.jpg
-------------------------------
    package beans;

        import java.util.Properties;
        import java.util.Set;

        public class PropertiesBeans {

            private Properties properties;

            public void setProperties(Properties properties) {
                this.properties = properties;
            }

            public void getProperty(){
                Set keys = properties.keySet();
                for (Object key : keys) {
                    System.out.println(key+" : "+properties.getProperty(key.toString()));
                }
            }

        }
    ----------------------------

        package beans;

        import org.springframework.context.ApplicationContext;
        import org.springframework.context.support.ClassPathXmlApplicationContext;

        public class Test {

            public static void main(String[] args) {
                // TODO Auto-generated method stub
                ApplicationContext ap = new ClassPathXmlApplicationContext("resource/spring.xml");
                PropertiesBeans p = (PropertiesBeans)ap.getBean("p");
                p.getProperty();
            }

        }
    ----------------------------

 - driver.properties

    Driver = com.mysql.jdbc.Driver
    url = jdbc:mysql://localhost:3306/test
    username = root
    password = root
    ----------------------------



     <beans xmlns="http://www.springframework.org/schema/beans"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:util="http://www.springframework.org/schema/util"
               xsi:schemaLocation="
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
        http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-3.0.xsd">

            <bean id="p" class="beans.PropertiesBeans">
                <property name="properties">
                    <util:properties location="classpath:resource/driver.properties"/>
                </property>
            </bean>

        </beans>

Answer 10

我建议阅读此链接 https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html 来自 SpringBoot 文档，了解如何注入外部配置。他们不仅讨论了从属性文件中检索，还讨论了 YAML 甚至 JSON 文件。我发现这很有帮助。我希望你也这样做。

Answer 11

在 Spring Boot 版本 3 中；
创建如下文件： GlobalProperties.java

package com.tester.trader.config;

import lombok.Data;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties
@PropertySource({"classpath:global.properties"})
@Data
@ToString
public class GlobalProperties {
    private String loginUrl;
    private String symbolsUrl;
}

将文件 global.properties 添加到 application.properies 旁边的资源文件夹中，然后粘贴以下内容

symbolsUrl=https://api.market-stage.test.com/market/symbol-thumb
loginUrl="https://api.test.com/api/sign-in"

现在您可以在每个服务中 @Autowired ，例如这：

@Autowired
GlobalProperties globalProperties;


public String readIt(){
       return globalProperties.getSymbolsUrl()
}