如何在Spring applicationContext中读取系统环境变量

Question

如何在应用上下文中读取系统环境变量？

我想要类似的东西：

<util:properties id="dbProperties"
        location="classpath:config_DEV/db.properties" />

或者

<util:properties id="dbProperties"
        location="classpath:config_QA/db.properties" />

取决于环境。

我的应用程序上下文中可以有这样的东西吗？

<util:properties id="dbProperties"
        location="classpath:config_${systemProperties.env}/db.properties" />

其中实际 val 是根据系统环境变量设置的

我正在使用 Spring 3.0

Answer 1

你很接近 :o) Spring 3.0 添加了Spring Expression Language 。 您可以使用

<util:properties id="dbProperties" 
    location="classpath:config_#{systemProperties['env']}/db.properties" />

结合java ... -Denv=QA应该可以解决您的问题。

另请注意@yiling 的评论：

为了访问系统环境变量，即 amoe 评论的操作系统级别变量，我们可以简单地在该 EL 中使用“systemEnvironment”而不是“systemProperties”。 喜欢#{systemEnvironment['ENV_VARIABLE_NAME']}

Answer 2

现在你可以把

@Autowired
private Environment environment;

在你的@Component 、 @Bean等中，然后通过Environment类访问属性：

environment.getProperty("myProp");

---

对于@Bean的单个属性

@Value("${my.another.property:123}") // value after ':' is the default
Integer property;

---

另一种方法是方便的@ConfigurationProperties bean：

@ConfigurationProperties(prefix="my.properties.prefix")
public class MyProperties {
  // value from my.properties.prefix.myProperty will be bound to this variable
  String myProperty;

  // and this will even throw a startup exception if the property is not found
  @javax.validation.constraints.NotNull
  String myRequiredProperty;

  //getters
}

@Component
public class MyOtherBean {
  @Autowired
  MyProperties myProperties;
}

注意：设置新环境变量后记得重启eclipse

Answer 3

检查这篇文章。 它为您提供了几种方法来做到这一点，通过支持外部属性的PropertyPlaceholderConfigurer （通过systemPropertiesMode属性）。

Answer 4

是的，您可以执行<property name="defaultLocale" value="#{ systemProperties['user.region']}"/>例如。

变量systemProperties是预定义的，请参阅6.4.1 基于 XML 的配置。

Answer 5

在您的 bean 定义中，确保包含“searchSystemEnvironment”并将其设置为“true”。 如果您使用它来构建文件路径，请将其指定为 file:/// url。

例如，如果您有一个配置文件位于

/testapp/config/my.app.config.properties

然后像这样设置一个环境变量：

MY_ENV_VAR_PATH=/testapp/config

并且您的应用程序可以使用这样的 bean 定义加载文件：

例如

<bean class="org.springframework.web.context.support.ServletContextPropertyPlaceholderConfigurer">
    <property name="systemPropertiesModeName" value="SYSTEM_PROPERTIES_MODE_OVERRIDE" />
    <property name="searchSystemEnvironment" value="true" />
    <property name="searchContextAttributes" value="true" />
    <property name="contextOverride" value="true" />
    <property name="ignoreResourceNotFound" value="true" />
    <property name="locations">
        <list>
            <value>file:///${MY_ENV_VAR_PATH}/my.app.config.properties</value>
        </list>
    </property>
</bean>

Answer 6

使用 Spring EL，您可以编写如下示例

<bean id="myBean" class="path.to.my.BeanClass">
    <!-- can be overridden with -Dtest.target.host=http://whatever.com -->
    <constructor-arg value="#{systemProperties['test.target.host'] ?: 'http://localhost:18888'}"/>
</bean>

Answer 7

对于我的用例，我只需要访问系统属性，但在未定义的情况下提供默认值。

这是你如何做到的：

<bean id="propertyPlaceholderConfigurer"   
    class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">  
    <property name="systemPropertiesModeName" value="SYSTEM_PROPERTIES_MODE_OVERRIDE" />
    <property name="searchSystemEnvironment" value="true" />
</bean>  
<bean id="myBean" class="path.to.my.BeanClass">
    <!-- can be overridden with -Dtest.target.host=http://whatever.com -->
    <constructor-arg value="${test.target.host:http://localhost:18888}"/>
</bean>

Answer 8

声明属性占位符如下

<bean id="propertyPlaceholderConfigurer"   
        class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">  
    <property name="systemPropertiesModeName" value="SYSTEM_PROPERTIES_MODE_OVERRIDE" />
    <property name="locations">
        <list>
            <value>file:///path.to.your.app.config.properties</value>
        </list>
    </property>
</bean>

然后假设您要为 Tomcat bean 或任何 bean 读取System.property("java.io.tmpdir")然后在您的属性文件中添加以下内容：

tomcat.tmp.dir=${java.io.tmpdir}

Answer 9

这是你如何做到的：

<bean id="systemPrereqs" class="org.springframework.beans.factory.config.MethodInvokingFactoryBean" scope="prototype">
             <property name="targetObject" value="#{@systemProperties}" />
             <property name="targetMethod" value="putAll" />
             <property name="arguments">
                   <util:properties>
                       <prop key="deployment.env">dev</prop>
                   </util:properties>
            </property>
    </bean>

但请记住，spring 首先被加载，然后它会加载这个 bean MethodInvokingFactoryBean。 因此，如果您尝试将其用于测试用例，请确保使用依赖项。 例如在这种情况下

如果您将它用于主类，最好使用 pom.xml 将此属性设置为

<systemProperty>
    <name>deployment.env</name>
    <value>dev</value>
</systemProperty>

Answer 10

您可以在属性文件中提及您的变量属性，并定义特定于环境的属性文件，如 local.properties、production.properied 等。

现在基于环境，可以在启动时调用的侦听器之一中读取这些属性文件之一，例如 ServletContextListener。

属性文件将包含各种键的环境特定值。

示例“local.propeties”

db.logsDataSource.url=jdbc:mysql://localhost:3306/logs
db.logsDataSource.username=root
db.logsDataSource.password=root

db.dataSource.url=jdbc:mysql://localhost:3306/main
db.dataSource.username=root
db.dataSource.password=root

示例“production.properties”

db.logsDataSource.url=jdbc:mariadb://111.111.111.111:3306/logs
db.logsDataSource.username=admin
db.logsDataSource.password=xyzqer

db.dataSource.url=jdbc:mysql://111.111.111.111:3306/carsinfo
db.dataSource.username=admin
db.dataSource.password=safasf@mn

要使用这些属性文件，您可以使用下面提到的资源

        PropertyPlaceholderConfigurer configurer = new PropertyPlaceholderConfigurer();
        ResourceLoader resourceLoader = new DefaultResourceLoader();

        Resource resource = resourceLoader.getResource("classpath:"+System.getenv("SERVER_TYPE")+"DB.properties");
        configurer.setLocation(resource);
        configurer.postProcessBeanFactory(beanFactory);

SERVER_TYPE 可以定义为具有适用于本地和生产环境的适当值的环境变量。

通过这些更改 appplicationContext.xml 将有以下更改

<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource">
 <property name="driverClassName" value="com.mysql.jdbc.Driver" />
  <property name="url" value="${db.dataSource.url}" />
  <property name="username" value="${db.dataSource.username}" />
  <property name="password" value="${db.dataSource.password}" />

希望这可以帮助 。

Answer 11

感谢@Yiling。 那是一个提示。

<bean id="propertyConfigurer"
        class="org.springframework.web.context.support.ServletContextPropertyPlaceholderConfigurer">

    <property name="systemPropertiesModeName" value="SYSTEM_PROPERTIES_MODE_OVERRIDE" />
    <property name="searchSystemEnvironment" value="true" />
    <property name="locations">
        <list>
            <value>file:#{systemEnvironment['FILE_PATH']}/first.properties</value>
            <value>file:#{systemEnvironment['FILE_PATH']}/second.properties</value>
            <value>file:#{systemEnvironment['FILE_PATH']}/third.properties</value>
        </list>
    </property>
</bean>

在此之后，您应该有一个名为“FILE_PATH”的环境变量。 确保在创建该环境变量后重新启动终端/IDE。

Answer 12

更新版本 (2020)。

使用System.getenv("ENV_VARIABLE")