java.util.prefs.Preferences

java.util.prefs.Preferences

---

Preferences类是在JDK1.4中首次提供的，可以用它来存放应用程序的配置数据，这里对Preferences类做点介绍。

1、Preferences的基本概念

很多软件的菜单里都有“Setting”或“Preferences”这样的选项用来设定或修改软件的配置，这些配置信息在不同的操作系统中是存放在不同的地方的，比如，Windows操作系统中统一存储各个应用程序的配置信息的地方就是注册表，Windows下的应用程序都可以将自己的配置信息存放到注册表中。

JDK中的Preferences类也提供了一个让Java应用程序存放配置信息的统一方法，即每一个基于Java的应用程序都可以使用Preferences类存放自己的配置信息。

Preferences类是平台无关的，也就是在Windows平台上运行的Java应用程序可以用Preferences类存放配置信息，在Linux平台上运行的Java应用程序也可以使用Preferences类来存放自己的配置信息，对应用程序来说，它只管用Preferences类就好了， 不用管最终的配置信息在程序运行平台上的具体存放位置。

Preferences类将应用程序的配置信息存放在具体的操作系统平台上，具体来说，在Windows操作系统下存放在注册表中，在Linux平台下是放在使用应用程序的用户的home目录下面的一个隐藏文件中。

Preferences类用树状结构来存放应用程序的配置信息，树中的每个节点的路径名是/com/mycompany/myapp这种形式的，每个节点上都存放了一个键值对组成的表。每个应用程序可以在属于自己的节点上存放自己的配置信息，这些配置信息就构成了一个表，这个表就是节点的内容。

Preferences类有两个树，分别是系统树（它用来存放全部用户的共有信息）和用户树（它用来存放用户自己的配置信息）。在Windows操作系统下，系统树的根节点是HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft\Prefs，而用户树的根节点是HKEY_CURRENT_USER\software\JavaSoft\Prefs。

这里的“系统”指的是什么，什么信息可以放在“系统树”中？什么信息可以放在“用户树”中？Preferences类的文档给出如下解释：

“The precise description of "use" and "system" will vary from implementation to implementation. Typical information stored in the user preference tree might include font choice, color choice, or preferred window location and size for a particular application. Typical information stored in the system preference tree might include installation configuration data for an application.”

2、Preferences类的用法

为了用Preferences类来存放配置信息，必须先得到用户树或系统树的根节点，然后在根节点之下建立应用程序自己的子节点，在这个子节点上存放应用程序的配置信息。

Preferecens root = Preferences.userRoot();  // 获得用户树的根节点

或者

Preferences root = Preferences.systemRoot(); // 获得系统树的根节点

获得了用户树或系统树的根节点，就可以为自己的应用程序在根节点之下创建子节点了，用自己创建的子节点来存放自己的应用程序的配置信息。

Preferences node = root.node("/com/mycompany/myapp"); // 为应用程序在用户树（或者系统树）中建立一个节点或者获得一个已有的路径名为root/com/mycompany/myapp的节点

一旦获得了节点，就可以用如下各方法访问节点包含的键值表了。

String get(String key, String defVal)

int getInt(String key, int defVal)

Long getLong(String key, long defVal)

float getFloat(String key, float defVal)

double getDouble(String key, double defVal)

boolean getBoolean(String key, boolean defVal)

byte[] getByteArray(String key, byte[] defVal)

读取配置节点的键值对的时候，必须指定默认值，以防节点中的键没有值。

同时，也可以使用如下的各方法向节点中存放配置信息。

void put(String key, String value)

void putInt(String key, int value)

void putLong(String key, long value)

void putFloat(String key, float value)

void putDouble(String key, double value)

void putBoolean(String key, boolean value)

void putByteArray(String key, byte[] value)

用下面的方法可以在访问节点的键值对之前，获得全部的键：

String[] keys()

还可以用下面的方法把节点中某一个键值对移去不要了：

void remove(String key)

可以用下面的方法把一个节点全部移除不要：

void removeNode()

具体的用法，可以参见下面的例子。在这个例子中应用程序在用户树下的test节点上存放了三个配置信息，然后把这个test节点的配置信息导出到test包所在的目录。

package test;

import java.util.prefs.Preferences;
import java.io.FileOutputStream;

public class Test
{
    public static void main(String[] args) throws Exception
    {
		Preferences root = Preferences.userRoot();
		Preferences testNode = root.node("/test");

		//获取以下三个配置
		int intKey = testNode.getInt("intKey", 0);
		double doubleKey = testNode.getDouble("doubleKey", 0.0);
		boolean booleanKey = testNode.getBoolean("booleanKey", true);

		//存配置
		testNode.putInt("intKey", 100);
		testNode.putDouble("doubleKey", 1000.01);
		testNode.putBoolean("booleanKey", false);
		
// 导出配置
		FileOutputStream out = new FileOutputStream("testConf.xml");
		testNode.exportNode(out);
    }
}

在Windows下编译、运行以上程序，可以在注册表的HKEY_CURRENT_USER\Software\JavaSoft\Prefs\test节点看到存储的三个配置信息，同时在test包所在的路径下可以看到testConf.xml文件，此文件的内容为导出的配置信息。testConf.xml文件的内容如下：

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE preferences SYSTEM "http://java.sun.com/dtd/preferences.dtd">
<preferences EXTERNAL_XML_VERSION="1.0">
  <root type="user">
    <map/>
    <node name="test">
      <map>
        <entry key="intKey" value="100"/>
        <entry key="doubleKey" value="1000.01"/>
        <entry key="booleanKey" value="false"/>
      </map>
    </node>
  </root>
</preferences>

3、Preferences保存的配置信息的导入导出

Preferences类存放的配置信息还可以导出成XML文件，同时也可以将XML文件中的配置信息导入到指定的节点中。有了这个导入导出的功能，就可以在将这些配置信息从一台机器迁移到另外一台机器了。

用如下方法导出配置信息，导出的数据以XML格式存储：

void exportSubtree(OutputStream out) // 将一个节点及其下级子树都导出

void exportNode(OutputStream out) // 只导出一个节点所存储的键值对表

用如下方法导入：

void importPreferences(InputStream in)

4、其他问题及参考资料

根据以上的介绍足可以用Preferences类来存储配置信息了，当然想要进一步了解，还可以参考java.util.prefs包中各个类的说明文档。

以上内容参考了java.util.prefs.Preferences类的文档和《CoreJava》10.8.3的内容。