六种方式让你在java中读取properties文件

一、这个问题纠结我好久，转过来收藏

       原文地址 http://www.cnblogs.com/hafiz/p/5876243.html

在项目开发的过程中，遇到需要在properties文件中定义一些自定义的变量，以供java程序动态的读取，修改变量，不再需要修改代码的问题。在Spring+SpringMVC+Mybatis框架中通过java程序读取properties文件内容的方式。

二、五种实现方式

方式1.通过context:property-placeholder加载配置文件jdbc.properties中的内容

<context:property-placeholderlocation="classpath:jdbc.properties" ignore-unresolvable="true"/>

　　上面的配置和下面配置等价，是对下面配置的简化

<beanid="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">

   <propertyname="ignoreUnresolvablePlaceholders" value="true"/>

   <propertyname="locations">

      <list>

        <value>classpath:jdbc.properties</value>

      </list>

    </property>

</bean>

注意：这种方式下，如果你在spring-mvc.xml文件中有如下配置，则一定不能缺少下面的红色部分，关于它的作用以及原理

<!-- 配置组件扫描，springmvc容器中只扫描Controller注解 -->

<context:component-scan base-package="com.hafiz.www"use-default-filters="false">

   <context:include-filter type="annotation"expression="org.springframework.stereotype.Controller"/>

</context:component-scan>

方式2.使用注解的方式注入，主要用在java代码中使用注解注入properties文件中相应的value值

<beanid="prop" class="org.springframework.beans.factory.config.PropertiesFactoryBean">

   <!-- 这里是PropertiesFactoryBean类，它也有个locations属性，也是接收一个数组，跟上面一样 -->

   <propertyname="locations">

       <array>

         <value>classpath:jdbc.properties</value>

       </array>

   </property>

</bean>

方式3.使用util:properties标签进行暴露properties文件中的内容

<util:propertiesid="propertiesReader" location="classpath:jdbc.properties"/>

注意：使用上面这行配置，需要在spring-dao.xml文件的头部声明以下红色的部分

<beansxmlns="http://www.springframework.org/schema/beans"

      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

       xmlns:context="http://www.springframework.org/schema/context"

      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.2.xsd

       http://www.springframework.org/schema/context

       http://www.springframework.org/schema/context/spring-context-3.2.xsd

        http://www.springframework.org/schema/util
http://www.springframework.org/schema/util/spring-util.xsd">

方式4.通过PropertyPlaceholderConfigurer在加载上下文的时候暴露properties到自定义子类的属性中以供程序中使用

<beanid="propertyConfigurer" class="com.hafiz.www.util.PropertyConfigurer">

   <propertyname="ignoreUnresolvablePlaceholders" value="true"/>

   <propertyname="ignoreResourceNotFound" value="true"/>

   <propertyname="locations">

       <list>

         <value>classpath:jdbc.properties</value>

       </list>

   </property>

</bean>

自定义类PropertyConfigurer的声明如下:

packagecom.hafiz.www.util;

 

importorg.springframework.beans.BeansException;

importorg.springframework.beans.factory.config.ConfigurableListableBeanFactory;

importorg.springframework.beans.factory.config.PropertyPlaceholderConfigurer;

 

import java.util.Properties;

 

/**

 *Desc:properties配置文件读取类

 *Created by hafiz.zhang on 2016/9/14.

 */

public class PropertyConfigurer extends PropertyPlaceholderConfigurer {

 

    private Propertiesprops;      //存取properties配置文件key-value结果

 

   @Override

    protectedvoid processProperties(ConfigurableListableBeanFactorybeanFactoryToProcess, Properties props)

                            throws BeansException {

       super.processProperties(beanFactoryToProcess,props);

       this.props = props;

    }

 

    public StringgetProperty(String key){

       returnthis.props.getProperty(key);

    }

 

    public StringgetProperty(String key, String defaultValue) {

       returnthis.props.getProperty(key,defaultValue);

    }

 

    public ObjectsetProperty(String key, String value) {

        returnthis.props.setProperty(key,value);

    }

}

使用方式：在需要使用的类中使用@Autowired注解注入即可。

方式5.自定义工具类PropertyUtil，并在该类的static静态代码块中读取properties文件内容保存在static属性中以供别的程序使用

public class PropertyUtil {

    privatestaticfinal Logger logger =LoggerFactory.getLogger(PropertyUtil.class);

    privatestatic Properties props;

    static{

       loadProps();

    }

 

    synchronizedstaticprivate void loadProps(){

       logger.info("开始加载properties文件内容.......");

       props = new Properties();

       InputStream in = null;

       try {
　　　　　　　<!--第一种，通过类加载器进行获取properties文件流-->

           in = PropertyUtil.class.getClassLoader().getResourceAsStream("jdbc.properties");
　　　　　　 <!--第二种，通过类进行获取properties文件流-->

           //in =PropertyUtil.class.getResourceAsStream("/jdbc.properties");

           props.load(in);

       } catch (FileNotFoundException e) {

           logger.error("jdbc.properties文件未找到");

       } catch (IOException e) {

           logger.error("出现IOException");

       } finally {

           try {

                if(null != in) {

                   in.close();

                }

           } catch (IOException e) {

               logger.error("jdbc.properties文件流关闭出现异常");

           }

       }

       logger.info("加载properties文件内容完成...........");

       logger.info("properties文件内容：" + props);

    }

 

    publicstatic StringgetProperty(String key){

       if(null == props) {

           loadProps();

       }

       return props.getProperty(key);

    }

 

    publicstatic StringgetProperty(String key, String defaultValue) {

       if(null == props) {

           loadProps();

       }

       return props.getProperty(key, defaultValue);

    }

}

六、使用Configuration和Bean注解

@Configuration
public class PropertiesConfig {
   @Bean
   public Properties getProperties() throws IOException {
      PropertiesFactoryBean propertiesFactoryBean = new PropertiesFactoryBean();
      propertiesFactoryBean.setLocation(new ClassPathResource("/jdbc.properties"));
      propertiesFactoryBean.afterPropertiesSet();
      return propertiesFactoryBean.getObject();
   }
}