Spring中属性文件properties的读取与使用

Posted 2020-09-10 星朝

实际项目中，通常将一些可配置的定制信息放到属性文件中（如数据库连接信息，邮件发送配置信息等），便于统一配置管理。例中将需配置的属性信息放在属性文件/WEB-INF/configInfo.properties中。 

其中部分配置信息（邮件发送相关）： 

Java代码  

1. #邮件发送的相关配置  
2. email.host = smtp.163.com  
3. email.port = xxx  
4. email.username = xxx  
5. email.password = xxx  
6. email.sendFrom = [e-mail]  

在Spring容器启动时，使用内置bean对属性文件信息进行加载，在bean.xml中添加如下： 

Xml代码  

1. <!-- spring的属性加载器，加载properties文件中的属性 -->  
2. <bean id="propertyConfigurer"  
3.     class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">  
4.     <property name="location">  
5.         <value>/WEB-INF/configInfo.properties</value>  
6.     </property>  
7.     <property name="fileEncoding" value="utf-8" />  
8. </bean>  

属性信息加载后其中一种使用方式是在其它bean定义中直接根据属性信息的key引用value，如邮件发送器bean的配置如下： 

Xml代码  

1. <!-- 邮件发送 -->  
2.     <bean id="mailSender"  
3.         class="org.springframework.mail.javamail.JavaMailSenderImpl">  
4.         <property name="host">  
5.             <value>${email.host}</value>  
6.         </property>  
7.         <property name="port">  
8.             <value>${email.port}</value>  
9.         </property>  
10.         <property name="username">  
11.             <value>${email.username}</value>  
12.         </property>  
13.         <property name="password">  
14.             <value>${email.password}</value>  
15.         </property>  
16.         <property name="javaMailProperties">  
17.             <props>  
18.                 <prop key="mail.smtp.auth">true</prop>  
19.                 <prop key="sendFrom">${email.sendFrom}</prop>  
20.             </props>  
21.         </property>  
22.     </bean>  

另一种使用方式是在代码中获取配置的属性信息，可定义一个javabean：ConfigInfo.java，利用注解将代码中需要使用的属性信息注入；如属性文件中有如下信息需在代码中获取使用： 

Java代码  

1. #生成文件的保存路径  
2. file.savePath = D:/test/  
3. #生成文件的备份路径，使用后将对应文件移到该目录  
4. file.backupPath = D:/test bak/  

ConfigInfo.java 中对应代码： 

Java代码  

1. @Component("configInfo")  
2. public class ConfigInfo {  
3.     @Value("${file.savePath}")  
4.     private String fileSavePath;  
5.   
6.     @Value("${file.backupPath}")  
7.     private String fileBakPath;  
8.           
9.     public String getFileSavePath() {  
10.         return fileSavePath;  
11.     }  
12.   
13.     public String getFileBakPath() {  
14.         return fileBakPath;  
15.     }      
16. }  

业务类bo中使用注解注入ConfigInfo对象： 

Java代码  

1. @Autowired  
2. private ConfigInfo configInfo;  

需在bean.xml中添加组件扫描器，用于注解方式的自动注入： 

Xml代码  

1. <context:component-scan base-package="com.my.model" />  

（上述包model中包含了ConfigInfo类）。 

通过get方法获取对应的属性信息，优点是代码中使用方便，缺点是如果代码中需用到新的属性信息，需对ConfigInfo.java做相应的添加修改。