Java中Properties类简介
知识学而不用,就等于没用,到真正用到的时候还得重新再学。
Properties类继承自Hashtable,如下:
它主要用于读取Java的配置文件,由于配置文件中的很多变量时经常改变的,通过这个类可以让用户脱离程序本身去修改相关的变量配置。在Java中,其配置文件常为.properties文件,格式为文本文件,内容的格式为“键=值”的格式,#打头的是注释行,Properties会忽略注释。允许只有key没有value,没有value时,value会被set成null。java.util.Properties是对properties这类配置文件的映射。支持key-value类型和xml类型两种
properties类实现了Map接口,所以很明显,他是用map来存储key-value数据,所以也注定存入数据是无序的,这个点需要注意。只能通过key的方式来get对应value。针对key-value这种配置文件,是用load方法就能直接映射成map。Properties属性文件在JAVA应用程序中是经常可以看得见的,也是特别重要的一类文件。它用来配置应用程序的一些信息,不过这些信息一般都是比较少的数据,没有必要使用数据库文件来保存。
这个类中有几个很重要的方法归纳如下:
- getProperty ( String key),用指定的键在此属性列表中搜索属性。也就是通过参数 key ,得到 key 所对应的 value值
- load ( InputStream inStream),从输入流中读取属性列表(键值对)。通过对指定的文件进行装载来获取该文件中的所有键 - 值对。以供 getProperty ( String key) 来搜索。
- setProperty ( String key, String value) ,调用 Hashtable 的方法 put 。他通过调用基类的put方法来设置 键 - 值对。
- store ( OutputStream out, String comments),以适合使用 load 方法加载到 Properties 表中的格式,将此 Properties 表中的属性列表(键和元素对)写入输出流。与 load 方法相反,该方法将键 - 值对写入到指定的文件中去。
- clear (),清除所有装载的 键 - 值对。该方法在基类中提供。
java读取Properties文件
这里列出组常用的一种方法:通过java.lang.Class类的getResourceAsStream(String name)方法来实现。
InputStream in = getClass().getResourceAsStream("资源Name");
或者InputStream in = new BufferedInputStream(new FileInputStream(filepath));
Properties实例
- Java虚拟机(JVM)有自己的配置文件(system.properties),如下就可以获得JVM的系统属性
1 import java.util.Properties; 2 public class ReadJVM { 3 public static void main(String[] args) { 4 Properties pps = System.getProperties(); 5 pps.list(System.out); 6 } 7 }
运行结果(截取部分)如下:
- 新建一个配置文件Test.properties
name=JJ Weight=4444 Height=3333
1 public class getProperties { 2 public static void main(String[] args) throws FileNotFoundException, IOException { 3 Properties pps = new Properties(); 4 pps.load(new FileInputStream("Test.properties")); 5 //第一步就是要将文件读取到Properties类对象中,由于load有一个参数是InputStream,所以我们可以用 InputStream的子类FileInputStream将属性文件读取到Properties对象中,知道prop.properties的路径,我们就用FileInputStream(String name)构造函数: 6 Enumeration enum1 = pps.propertyNames();//得到配置文件的名字 7 while(enum1.hasMoreElements()) { 8 String strKey = (String) enum1.nextElement(); 9 String strValue = pps.getProperty(strKey); 10 System.out.println(strKey + "=" + strValue); 11 } 12 } 13 }
如下类实现了Properties的常用操作
//关于Properties类常用的操作 public class TestProperties { //根据Key读取Value public static String GetValueByKey(String filePath, String key) { Properties pps = new Properties(); try { InputStream in = new BufferedInputStream (new FileInputStream(filePath)); pps.load(in); String value = pps.getProperty(key); System.out.println(key + " = " + value); return value; }catch (IOException e) { e.printStackTrace(); return null; } } //读取Properties的全部信息 public static void GetAllProperties(String filePath) throws IOException { Properties pps = new Properties(); InputStream in = new BufferedInputStream(new FileInputStream(filePath)); pps.load(in); Enumeration en = pps.propertyNames(); //得到配置文件的名字 while(en.hasMoreElements()) { String strKey = (String) en.nextElement(); String strValue = pps.getProperty(strKey); System.out.println(strKey + "=" + strValue); } } //写入Properties信息 public static void WriteProperties (String filePath, String pKey, String pValue) throws IOException { Properties pps = new Properties(); InputStream in = new FileInputStream(filePath); //从输入流中读取属性列表(键和元素对) pps.load(in); //调用 Hashtable 的方法 put。使用 getProperty 方法提供并行性。 //强制要求为属性的键和值使用字符串。返回值是 Hashtable 调用 put 的结果。 OutputStream out = new FileOutputStream(filePath); pps.setProperty(pKey, pValue); //以适合使用 load 方法加载到 Properties 表中的格式, //将此 Properties 表中的属性列表(键和元素对)写入输出流 pps.store(out, "Update " + pKey + " name"); } public static void main(String [] args) throws IOException{ //String value = GetValueByKey("Test.properties", "name"); //System.out.println(value); //GetAllProperties("Test.properties"); WriteProperties("Test.properties","long", "212"); } }
结果:Test.properties中文件的数据为
#Update long name #Sun Feb 23 18:17:16 CST 2014 name=JJ Weight=4444 long=212 Height=3333
除此之外,java的properties文件需要放到classpath下面,这样程序才能读取到,有关classpath实际上就是java类或者库的存放路径,在java工程中,properties放到class文件一块。在web应用中,最简单的方法是放到web应用的WEB- INF\classes目录下即可,也可以放在其他文件夹下面,这时候需要在设置classpath环境变量的时候,将这个文件夹路径加到 classpath变量中,这样也也可以读取到。在此,你需要对classpath有个深刻理解,classpath绝非系统中刻意设定的那个系统环境变量,WEB-INF\classes其实也是,va工程的class文件目录也是。
在我们知道如何读写一个属性文件之后,我们仍然还有很多需要注意的问题,因为load和store方法都是按照ISO-8859-1的编码方式读写属性流文件的,而ILatin1 的字符和某些特殊字符,而对于非Latin1 的字符和某些特殊字符,则要使用与字符和字符串字面值所用的类似转义序列,以值和元素的形式来表示它们。所以当我们在处理中文时,不可以在直接修改属性文件时,将中文的值赋予给属性,而是要在JAVA程序中通过setProperty方法给属性赋予中文的值,因为这样store会将中文转换成 unicode码,在读取时系统会将读取到的unicode码按系统的编码打印出来,对于中文系统,通常是GBK码,这样中文才能够正常显示。
另外一种配置形式是xml形式的,这种配置相对上面一种就少见一点。
xml形式的配置文件格式大略是这样:
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd"> <properties> <comment>Hi</comment> <entry key="foo">bar</entry> <entry key="fu">baz</entry> </properties>
读取xml配置跟读取kv配置没差别,就是把load换成xml对应的loadFromXML方法,代码大略是这样:
1 public class LoadSampleXML { 2 public static void main(String args[]) throws Exception { 3 Properties prop = new Properties(); 4 FileInputStream fis = 5 new FileInputStream("sampleprops.xml"); 6 prop.loadFromXML(fis); 7 prop.list(System.out); 8 System.out.println("\nThe foo property: " + 9 prop.getProperty("foo")); 10 } 11 }
把内存中的properties对象写入到xml文件中也和上面差不多,就是把list方法改成xml对应的storeToXML方法。
代码大略是这样:
1 import java.io.IOException; 2 import java.io.File; 3 import java.io.FileInputStream; 4 import java.io.PrintStream; 5 import java.util.Properties; 6 7 public class Test { 8 public static void main(String[] args) { 9 Properties p = new Properties(); 10 p.setProperty("id","dean"); 11 p.setProperty("password","123456"); 12 13 try{ 14 PrintStream fW = new PrintStream(new File("e:\\test1.xml")); 15 p.storeToXML(fW,"test"); 16 } catch (IOException e) { 17 e.printStackTrace(); 18 } 19 } 20 } 21