注:转载之>>>http://www.cnblogs.com/bakari/p/3562244.html和http://www.cnblogs.com/lingiu/p/3468464.html
Java中Properties类的操作
知识学而不用,就等于没用,到真正用到的时候还得重新再学。最近在看几款开源模拟器的源码,里面涉及到了很多关于Properties类的引用,由于Java已经好久没用了,而这些模拟器大多用Java来写,外加一些脚本语言Python,Perl之类的,不得已,又得重新拾起。本文通过看《Java编程思想》和一些网友的博客总结而来,只为简单介绍Properties类的相关操作。
一、Java Properties类
Java中有个比较重要的类Properties(Java.util.Properties),主要用于读取Java的配置文件,各种语言都有自己所支持的配置文件,配置文件中很多变量是经常改变的,这样做也是为了方便用户,让用户能够脱离程序本身去修改相关的变量设置。像Python支持的配置文件是.ini文件,同样,它也有自己读取配置文件的类ConfigParse,方便程序员或用户通过该类的方法来修改.ini配置文件。在Java中,其配置文件常为.properties文件,格式为文本文件,文件的内容的格式是“键=值”的格式,文本注释信息可以用"#"来注释。
Properties类继承自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 (),清除所有装载的 键 - 值对。该方法在基类中提供。
二、Java读取Properties文件
Java读取Properties文件的方法有很多,详见: 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),我们可以通过下面的方式来获取。
1、获取JVM的系统属性
1 import java.util.Properties; 2 3 public class ReadJVM { 4 public static void main(String[] args) { 5 Properties pps = System.getProperties(); 6 pps.list(System.out); 7 } 8 }
结果:
2、随便新建一个配置文件(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 Enumeration enum1 = pps.propertyNames();//得到配置文件的名字 6 while(enum1.hasMoreElements()) { 7 String strKey = (String) enum1.nextElement(); 8 String strValue = pps.getProperty(strKey); 9 System.out.println(strKey + "=" + strValue); 10 } 11 } 12 }
3、一个比较综合的实例
根据key读取value
读取properties的全部信息
写入新的properties信息
1 //关于Properties类常用的操作 2 public class TestProperties { 3 //根据Key读取Value 4 public static String GetValueByKey(String filePath, String key) { 5 Properties pps = new Properties(); 6 try { 7 InputStream in = new BufferedInputStream (new FileInputStream(filePath)); 8 pps.load(in); 9 String value = pps.getProperty(key); 10 System.out.println(key + " = " + value); 11 return value; 12 13 }catch (IOException e) { 14 e.printStackTrace(); 15 return null; 16 } 17 } 18 19 //读取Properties的全部信息 20 public static void GetAllProperties(String filePath) throws IOException { 21 Properties pps = new Properties(); 22 InputStream in = new BufferedInputStream(new FileInputStream(filePath)); 23 pps.load(in); 24 Enumeration en = pps.propertyNames(); //得到配置文件的名字 25 26 while(en.hasMoreElements()) { 27 String strKey = (String) en.nextElement(); 28 String strValue = pps.getProperty(strKey); 29 System.out.println(strKey + "=" + strValue); 30 } 31 32 } 33 34 //写入Properties信息 35 public static void WriteProperties (String filePath, String pKey, String pValue) throws IOException { 36 Properties pps = new Properties(); 37 38 InputStream in = new FileInputStream(filePath); 39 //从输入流中读取属性列表(键和元素对) 40 pps.load(in); 41 //调用 Hashtable 的方法 put。使用 getProperty 方法提供并行性。 42 //强制要求为属性的键和值使用字符串。返回值是 Hashtable 调用 put 的结果。 43 OutputStream out = new FileOutputStream(filePath); 44 pps.setProperty(pKey, pValue); 45 //以适合使用 load 方法加载到 Properties 表中的格式, 46 //将此 Properties 表中的属性列表(键和元素对)写入输出流 47 pps.store(out, "Update " + pKey + " name"); 48 } 49 50 public static void main(String [] args) throws IOException{ 51 //String value = GetValueByKey("Test.properties", "name"); 52 //System.out.println(value); 53 //GetAllProperties("Test.properties"); 54 WriteProperties("Test.properties","long", "212"); 55 } 56 }
结果:
Test.properties中文件的数据为:
#Update long name #Sun Feb 23 18:17:16 CST 2014 name=JJ Weight=4444 long=212 Height=3333
java.util.Properties是对properties这类配置文件的映射。支持key-value类型和xml类型两种。
key-value类型的配置文件大略长这样:
#测试环境配置:平台路径配置 jstrd_home=D:/TMS2006/webapp/tms2006/WEB-INF/ dbPort = localhost databaseName = myd dbUserName = root
#打头的是注释行,Properties会忽略注释。允许只有key没有value。
例如这样:
#测试环境配置:平台路径配置 jstrd_home=D:/TMS2006/webapp/tms2006/WEB-INF/ dbPort =
databaseName
这种情况下,value会被set成null。
properties类实现了Map接口,所以很明显,他是用map来存储key-value数据,所以也注定存入数据是无序的,这个点需要注意。只能通过key的方式来get对应value。
针对key-value这种配置文件,是用load方法就能直接映射成map,非常简单好用。这种配置文件也是我们最重要碰到的配置文件,利用properties读取这类文件到内存一行代码就欧科,比自己解析强大多了,这点很赞。
读取配置文件的大略代码如下:
1 public class LoadSample { 2 public static void main(String args[]) throws Exception { 3 Properties prop = new Properties(); 4 FileInputStream fis = 5 new FileInputStream("sample.properties"); 6 prop.load(fis); 7 prop.list(System.out); 8 System.out.println("\nThe foo property: " + 9 prop.getProperty("foo")); 10 } 11 }
第六行的load方法直接生产一个内存map,第九行就能get到对应的value了,简单快捷。
这里的第七行list方法是一个输出方法,这边是输出到console,也可以输出到文件等,就能实现内存写入配置文件了。
比如这样:
1 //通过list 方法将Properties写入Properties文件 2 import java.io.IOException; 3 import java.io.File; 4 import java.io.FileInputStream; 5 import java.io.PrintStream; 6 import java.util.Properties; 7 8 public class Test { 9 public static void main(String[] args) { 10 11 Properties p = new Properties(); 12 p.setProperty("id","dean"); 13 p.setProperty("password","123456"); 14 15 try{ 16 PrintStream fW = new PrintStream(new File("e:\\test1.properties")); 17 p.list(fW );} catch (IOException e) { 18 e.printStackTrace(); 19 20 } 21 } 22 }
这样就能把内存中的properties对象写入到文件中了。
另外一种配置形式是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
总的来说,虽然jdk中存在date类这种特别奇葩的类,但是这些不常用的工具类还是很方便使用的,要能用起来,在用得到的时候还是很能提高效率的。比自己写解析方便快捷多了。