方便好使的java.util.Properties类

时间:2023-01-07 19:38:02

今天偶然碰到这个类,发现jdk中这些平时不大用到的类还挺好玩儿的,用起来也特别实在方便,随便写点记录下。

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类这种特别奇葩的类,但是这些不常用的工具类还是很方便使用的,要能用起来,在用得到的时候还是很能提高效率的。比自己写解析方便快捷多了。