Java Properties 类读取配置文件信息

在我们平时写程序的时候，有些参数是经常改变的，而这种改变不是我们预知的。比如说我们开发了一个操作数据库的模块，在开发的时候我们连接本地的数据库那么
IP ，数据库名称，表名称，数据库主机等信息是我们本地的，要使得这个操作数据的模块具有通用性，那么以上信息就不能写死在程序里。通常我们的做法是用配置文件来解决。

各种语言都有自己所支持的配置文件类型。比如
Python
，他支持 .ini
文件。因为他内部有一个 ConfigParser
类来支持 .ini
文件的读写，根据该类提供的方法程序员可以自由的来操作
.ini 文件。而在
Java 中，Java 支持的是
.properties
文件的读写。 JDK
内置的 java.util.Properties类为我们操作 .properties
文件提供了便利。
 

一．
.properties
文件的形式
==========================================================

 

 

#
以下为服务器、数据库信息
dbPort = localhost

databaseName = mydb

dbUserName = root

dbPassword = root

#
以下为数据库表信息
dbTable = mytable

#
以下为服务器信息
ip = 192.168.0.9

······

在上面的文件中我们假设该文件名为：
test.properties
文件。其中 #
开始的一行为注释信息；在等号“ =
”左边的我们称之为 key
；等号“ =
”右边的我们称之为 value
。（其实就是我们常说的键 -
值对） key
应该是我们程序中的变量。而 value
是我们根据实际情况配置的。
 

二．
JDK
中的
Properties 类
Properties类存在于胞 Java.util
中，该类继承自

Hashtable

，它提供了几个主要的方法：

1．

getProperty

(
String
 key)

，

 
用指定的键在此属性列表中搜索属性。也就是通过参数
key ，得到
key 所对应的
value
。
 

 

 

2．

load

(
InputStream
 inStream)

，从输入流中读取属性列表（键和元素对）。通过对指定的文件（比如说上面的
test.properties
文件）进行装载来获取该文件中的所有键
- 值对。以供

getProperty

(
String
 key)

来搜索。

3．

setProperty

(
String
 key, String
 value)

，调用
Hashtable的方法

put

。他通过调用基类的put方法来设置

键 -
值对。
 

4．

store

(
OutputStream
 out, String
 comments)

，  以适合使用

load

方法加载到

Properties

表中的格式，将此

Properties

表中的属性列表（键和元素对）写入输出流。与
load 方法相反，该方法将键
- 值对写入到指定的文件中去。

5．

clear

()

，清除所有装载的

键
-
值对。该方法在基类中提供。
有了以上几个方法我们就可以对
.properties
文件进行操作了！
三．代码实例

 

 


package configuration;




import java.io.FileInputStream;


import java.io.FileNotFoundException;


import java.io.FileOutputStream;


import java.io.IOException;


import java.util.Properties;






/** *//**


 * 读取properties文件


 * @author Qutr


 *


 */


public class Configuration




...{


    private Properties propertie;


    private FileInputStream inputFile;


    private FileOutputStream outputFile;


    




    /** *//**


     * 初始化Configuration类


     */


    public Configuration()



    ...{


        propertie = new Properties();


    }


    




    /** *//**


     * 初始化Configuration类


     * @param filePath 要读取的配置文件的路径+名称


     */


    public Configuration(String filePath)




    ...{


        propertie = new Properties();




        try ...{


            inputFile = new FileInputStream(filePath);


            propertie.load(inputFile);


            inputFile.close();




        } catch (FileNotFoundException ex) ...{


            System.out.println("读取属性文件--->失败！- 原因：文件路径错误或者文件不存在");


            ex.printStackTrace();




        } catch (IOException ex) ...{


            System.out.println("装载文件--->失败!");


            ex.printStackTrace();


        }


    }//end ReadConfigInfo(...)


    




    /** *//**


     * 重载函数，得到key的值


     * @param key 取得其值的键


     * @return key的值


     */


    public String getValue(String key)




    ...{




        if(propertie.containsKey(key))...{


            String value = propertie.getProperty(key);//得到某一属性的值


            return value;


        }


        else 


            return "";


    }//end getValue(...)


    




    /** *//**


     * 重载函数，得到key的值


     * @param fileName properties文件的路径+文件名


     * @param key 取得其值的键


     * @return key的值


     */


    public String getValue(String fileName, String key)




    ...{




        try ...{


            String value = "";


            inputFile = new FileInputStream(fileName);


            propertie.load(inputFile);


            inputFile.close();




            if(propertie.containsKey(key))...{


                value = propertie.getProperty(key);


                return value;


            }else


                return value;




        } catch (FileNotFoundException e) ...{


            e.printStackTrace();


            return "";




        } catch (IOException e) ...{


            e.printStackTrace();


            return "";




        } catch (Exception ex) ...{


            ex.printStackTrace();


            return "";


        }


    }//end getValue(...)


    




    /** *//**


     * 清除properties文件中所有的key和其值


     */


    public void clear()



    ...{


        propertie.clear();


    }//end clear();


    




    /** *//**


     * 改变或添加一个key的值，当key存在于properties文件中时该key的值被value所代替，

     * 当key不存在时，该key的值是value


     * @param key 要存入的键


     * @param value 要存入的值


     */


    public void setValue(String key, String value)




    ...{


        propertie.setProperty(key, value);


    }//end setValue(...)


    




    /** *//**


     * 将更改后的文件数据存入指定的文件中，该文件可以事先不存在。


     * @param fileName 文件路径+文件名称


     * @param description 对该文件的描述


     */


    public void saveFile(String fileName, String description)




    ...{




        try ...{


            outputFile = new FileOutputStream(fileName);


            propertie.store(outputFile, description);


            outputFile.close();




        } catch (FileNotFoundException e) ...{


            e.printStackTrace();




        } catch (IOException ioe)...{


            ioe.printStackTrace();


        }


    }//end saveFile(...)


    


    public static void main(String[] args)




    ...{


        Configuration rc = new Configuration("./config/test.properties");//相对路径


        


        String ip = rc.getValue("ipp");//以下读取properties文件的值


        String host = rc.getValue("host");


        String tab = rc.getValue("tab");


        


        System.out.println("ip = " + ip + "ip-test leng = " + "ip-test".length());//以下输出properties读出的值


        System.out.println("ip's length = " + ip.length());


        System.out.println("host = " + host);


        System.out.println("tab = " + tab);




        Configuration cf = new Configuration();


        String ipp = cf.getValue("./config/test.properties", "ip");


        System.out.println("ipp = " + ipp);


//        cf.clear();


        cf.setValue("min", "999");


        cf.setValue("max", "1000");


        cf.saveFile("./config/save.perperties", "test");


        


//        Configuration saveCf = new Configuration();


//        saveCf.setValue("min", "10");


//        saveCf.setValue("max", "1000");


//        saveCf.saveFile("./config/save.perperties");


        


    }//end main()

    


}//end class ReadConfigInfo




四．小结 通过上面的例子不难看出，在Java中操作配置文件是非常简单的。在一个需要用到大量配置信息的模块或系统里，我们有必要封装一个专门的类来共使用。通过最后的main函数调用，相信大家可以看出该类的用法。不足指出希望大家多多指点。
 

 Java properties文件的操作 

       java中的properties文件是一种配置文件，主要用于表达配置信息，文件类型为*.properties，格式为文本文件，文件的内容是格式是 "键=值"的格式，在properties文件中，可以用"#"来作注释，properties文件在Java编程中用到的地方很多，操作很方便。下面是 一个操作java properties文件的例子，给出了操作方法和properties文件。从中可以看到如何读取properties文件，并应用读取出来的值，是学
习操作properties文件的好例子。

一、properties文件

IcisReport.properties

------------------------------------------------------
###################################################

#   工商报表应用IcisReport的配置文件               #

#   作者：雷智民                                   #

#   日期：2006年11月21日                           #

###################################################

#

#   说明:业务系统TopIcis和报表系统IcisReport是分离的

#   可分开部署到不同的服务器上，也可以部署到同一个服务

#   器上;IcisReprot作为独立的web应用程序可以使用任何

#   的Servlet容器或者J2EE服务器部署并单独运行，也可以

#   通过业务系统的接口调用作为业务系统的一个库来应用.

#

#   IcisReport的ip

IcisReport.server.ip=192.168.3.143

#   IcisReport的端口

IcisReport.server.port=8080

#   IcisReport的上下文路径

IcisReport.contextPath=/IcisReport

------------------------------------------------------

 

二、操作properties文件的java方法

 

下面是一个操作properties文件的方法

------------------------------------------------------
    /**

     * @return 获取IcisReport报表应用的URL

     */

    private String getIcisReportURL() {

        String icisReportURL = "";              //IcisReport报表应用的URL

        String icisReportServerIP = "";         //IcisReport服务器的IP

        String icisReportServerPort = "";       //IcisReport服务器的服务端口

        String icisReportContextPath="";        //IcisReport应用的ContextPath

        Properties prop = new Properties();

        InputStream in;

        try {

            in = getClass().getResourceAsStream("/IcisReport.properties");

            prop.load(in);

            Set keyValue = prop.keySet();

            for (Iterator it = keyValue.iterator(); it.hasNext();) {

                String key = (String) it.next();

                if (key.equals("IcisReport.server.ip")) {

                    icisReportServerIP = (String) prop.get(key);

                } else if (key.equals("IcisReport.server.port")) {

                    icisReportServerPort = (String) prop.get(key);

                } else if (key.equals("IcisReport.contextPath")){

                    icisReportContextPath=(String) prop.get(key);

                }

            }

        } catch (Exception e) {

            log.error("IO读取出错，找不到IcisReport.properties!");

        }

        if (icisReportServerIP.trim().equals("")) {

            log.error("请检查配置文件IcisReport.properties中的IcisReport.server.ip项的值是否正确!");

        }

        if (icisReportServerPort.trim().equals("")) {

            log.error("请检查配置文件IcisReport.properties中的IcisReport.server.port项的值是否正确!");

        }

        if (icisReportServerPort.trim().equals("")) {

            log.error("请检查配置文件IcisReport.properties中的IcisReport.server.port项的值是否正确!");

        }

        icisReportURL = "http://" + icisReportServerIP.trim() + ":" + icisReportServerPort.trim()+icisReportContextPath.trim();

        log.info("获取的icisReportURL=" + icisReportURL);

        return icisReportURL;

    }

------------------------------------------------------

 

总 结：java的properties文件需要放到classpath下面，这样程序才能读取到，有关classpath实际上就是java类或者库的存放 路径，在java工程中，properties放到class文件一块。在web应用中，最简单的方法是放到web应用的WEB-INF/classes 目录下即可，也可以放在其他文件夹下面，这时候需要在设置classpath环境变量的时候，将这个文件夹路径加到classpath变量中，这样也也可 以读取到。在此，你需要对classpath有个深刻理解，classpath绝非系统中刻意设定的那个系统环境变量，WEB-INF/classes其
实也是，java工程的class文件目录也是。

 

原文地址http://blog.csdn.net/dl88250/article/details/2104561