Spring注解驱动开发第19讲——使用@PropertySource加载配置文件，我只看这一篇！！

- 日理万妓 2022-12-25 15:48 195阅读 0赞

# 简单介绍一下@PropertySource和@PropertySources这俩注解 #

## @PropertySource注解概述 ##

@PropertySource注解是Spring 3.1开始引入的配置类注解。通过@PropertySource注解可以将properties配置文件中的key/value存储到Spring的Environment中，Environment接口提供了方法去读取配置文件中的值，参数是properties配置文件中定义的key值。当然了，也可以使用@Value注解用`${}`占位符为bean的属性注入值。

我们来看一下@PropertySource注解的源代码，如下所示。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70_pic_center]  
从@PropertySource的源码中可以看出，我们可以通过@PropertySource注解指定多个properties文件，使用的形式如下所示。

@PropertySource(value={ "classpath:/person.properties", "classpath:/car.properties"})

细心的读者可以看到，在@PropertySource注解的上面标注了如下的注解信息。

@Repeatable(PropertySources.class)

看到这里，小伙伴们是不是有种恍然大悟的感觉呢？没错，我们也可以使用@PropertySources注解来指定properties配置文件。

## @PropertySources注解概述 ##

首先，我们也来看下@PropertySources注解的源码，如下所示。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70_pic_center 1]  
@PropertySources注解的源码比较简单，只有一个PropertySource\[\]数组类型的value属性，那我们如何使用@PropertySources注解指定配置文件呢？其实也很简单，使用如下所示的方式就可以了。

@PropertySources(value={ 
        @PropertySource(value={ "classpath:/person.properties"}),
        @PropertySource(value={ "classpath:/car.properties"}),
    })

是不是很简单呢？接下来，我们就以一个小案例来说明@PropertySource注解的用法。

# 一个小案例来说明@PropertySource注解的用法 #

## 准备工作 ##

首先，我们在工程的src/main/resources目录下创建一个配置文件，例如person.properties，该文件的内容如下所示。

person.nickName=小甜甜

然后，我们在Person类中新增一个nickName字段，如下所示。

package com.meimeixia.bean;
    
    import org.springframework.beans.factory.annotation.Value;
    
    public class Person { 
    	
    	@Value("李阿昀")
    	private String name;
    	@Value("#{20-2}")
    	private Integer age;
    
    	private String nickName; // 昵称
    	
    	public String getNickName() { 
    		return nickName;
    	}
    	public void setNickName(String nickName) { 
    		this.nickName = nickName;
    	}
    	public String getName() { 
    		return name;
    	}
    	public void setName(String name) { 
    		this.name = name;
    	}
    	public Integer getAge() { 
    		return age;
    	}
    	public void setAge(Integer age) { 
    		this.age = age;
    	}
    	public Person(String name, Integer age) { 
    		super();
    		this.name = name;
    		this.age = age;
    	}
    	public Person() { 
    		super();
    		// TODO Auto-generated constructor stub
    	}
    	@Override
    	public String toString() { 
    		return "Person [name=" + name + ", age=" + age + ", nickName=" + nickName + "]";
    	}
    	
    }

目前，我们并没有为Person类的nickName字段赋值，所以，此时Person类的nickName字段的值为空。我们可以运行IOCTest\_PropertyValue类中的test01()方法来看下输出结果，如下所示。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70_pic_center 2]  
可以看到，Person类的nickName字段的值确实输出了null。

## 使用XML配置文件方式获取值 ##

如果我们需要在XML配置文件中获取person.properties文件中的值，那么我们首先需要在Spring的XML配置文件中引入context名称空间，并且使用context命名空间导入person.properties文件，之后在bean的属性字段中使用如下方式将person.properties文件中的值注入到Person类的nickName字段上。

<context:property-placeholder location="classpath:person.properties" />
    
    
    <bean id="person" class="com.meimeixia.bean.Person">
        <property name="age" value="18"></property>
        <property name="name" value="liayun"></property>
        <property name="nickName" value="${person.nickName}"></property>
    </bean>

此时，整个beans.xml文件的内容如下所示。

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans" xmlns:context="http://www.springframework.org/schema/context" xmlns:p="http://www.springframework.org/schema/p" xmlns:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.2.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.2.xsd">
    
    	<context:property-placeholder location="classpath:person.properties" />
    	
    	
    	<bean id="person" class="com.meimeixia.bean.Person">
    		<property name="age" value="18"></property>
    		<property name="name" value="liayun"></property>
    		<property name="nickName" value="${person.nickName}"></property>
    	</bean>
    	
    </beans>

这样就可以将person.properties文件中的值注入到Person类的nickName字段上了。

然后，我们在IOCTest\_PropertyValue类中创建一个test02()测试方法，如下所示。

@Test
    public void test02() { 
        ClassPathXmlApplicationContext applicationContext = new ClassPathXmlApplicationContext("classpath:beans.xml");
        Person person = (Person) applicationContext.getBean("person");
        System.out.println(person);
    }

接着，运行以上test02()方法，输出的结果信息如下所示。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70_pic_center 3]

## 使用注解方式获取值 ##

如果我们使用注解的方式，那么该如何做呢？首先，我们需要在MainConfigOfPropertyValues配置类上添加一个@PropertySource注解，如下所示。

package com.meimeixia.config;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.context.annotation.PropertySource;
    
    import com.meimeixia.bean.Person;
    
    // 使用@PropertySource读取外部配置文件中的key/value保存到运行的环境变量中，加载完外部的配置文件以后，使用${}取出配置文件中的值
    @PropertySource(value={ "classpath:/person.properties"})
    @Configuration
    public class MainConfigOfPropertyValues { 
    
    	@Bean
    	public Person person() { 
    		return new Person();
    	}
    	
    }

这里使用的`@PropertySource(value={"classpath:/person.properties"})`注解就相当于XML配置文件中使用的`<context:property-placeholder location="classpath:person.properties" />`。

然后，我们就可以在Person类的nickName字段上使用@Value注解来获取person.properties文件中的值了，如下所示。

@Value("${person.nickName}")
    private String nickName; // 昵称

配置完成后，我们再次运行IOCTest\_PropertyValue类中的test01()方法来看下输出结果，如下所示。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70_pic_center 4]  
可以看到，此时Person类的nickName字段已经注入`小甜甜`这个值了。

## 使用Environment获取值 ##

上面我已经说过，使用@PropertySource注解读取外部配置文件中的key/value之后，是将其保存到运行的环境变量中了，所以我们也可以通过运行环境来获取外部配置文件中的值。

这里，我们可以稍微修改一下IOCTest\_PropertyValue类中的test01()方法，即在其中添加一段使用Environment获取person.properties文件中的值的代码，如下所示。

@Test
    public void test01() { 
        printBeans(applicationContext);
        System.out.println("===================");
        
        Person person = (Person) applicationContext.getBean("person");
        System.out.println(person);
        
        ConfigurableEnvironment environment = applicationContext.getEnvironment();
        String property = environment.getProperty("person.nickName");
        System.out.println(property);
        
        // 关闭容器
        applicationContext.close();
    }

运行以上test01()方法，可以看到输出的结果信息如下所示。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70_pic_center 5]  
可以看到，使用Environment确实能够获取到person.properties文件中的值。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/767ce69d9b414189be9ca65ae73c8bb3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221120/64c6c1a4a6174fa78ff420ade231cc3a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70_pic_center 2]: https://img-blog.csdnimg.cn/20201202155956107.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U=,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70_pic_center 3]: https://img-blog.csdnimg.cn/20201202164005468.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U=,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70_pic_center 4]: https://img-blog.csdnimg.cn/20201202164016731.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U=,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70_pic_center 5]: https://img-blog.csdnimg.cn/2020120216402710.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U=,size_16,color_FFFFFF,t_70#pic_center