Spring 中使用Properties文件

Posted 2020-06-17

Spring提供了加载Properties文件的工具类：org.springframework.beans.factory.config.PropertyPlaceholderConfigurer。

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

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

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

<!-- 邮件发送 -->  
    <bean id="mailSender"  
        class="org.springframework.mail.javamail.JavaMailSenderImpl">  
        <property name="host">  
            <value>${email.host}</value>  
        </property>  
        <property name="port">  
            <value>${email.port}</value>  
        </property>  
        <property name="username">  
            <value>${email.username}</value>  
        </property>  
        <property name="password">  
            <value>${email.password}</value>  
        </property>  
        <property name="javaMailProperties">  
            <props>  
                <prop key="mail.smtp.auth">true</prop>  
                <prop key="sendFrom">${email.sendFrom}</prop>  
            </props>  
        </property>  
    </bean>

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

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

ConfigInfo.java 中对应代码：

@Component("configInfo")
public class ConfigInfo {
    @Value("${file.savePath}")
    private String fileSavePath;

    @Value("${file.backupPath}")
    private String fileBakPath;
        
    public String getFileSavePath() {
        return fileSavePath;
    }

    public String getFileBakPath() {
        return fileBakPath;
    }    
}

业务类bo中使用注解注入ConfigInfo对象：
@Autowired
private ConfigInfo configInfo;
需在bean.xml中添加组件扫描器，用于注解方式的自动注入：
<context:component-scan base-package="com.my.model" />
（上述包model中包含了ConfigInfo类）。

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