Merlin 的魔力: 操作首选项
(通过 JSR 10)为 Java 1.4 增加的 java.util.prefs 包,通过提供对特定于实现的注册表(例如,Windows 平台上的 Windows 注册表)的访问能力,使您能够操作用户首选项数据和配置数据。在
Merlin 的魔力的这一部分,John Zukowski 向您介绍了 Preferences 类并教您使用这个类。他用一个样本程序说明了所有的问题。 请在
“客户端 Java 编程”讨论论坛与作者和其他读者交流您关于本文的心得。
您是不是曾经需要保存程序的配置数据但却不知应将数据存储在哪里? 虽然您可以使用属性文件或资源束获取这些信息,但 Java 平台从未指定过用于存储这些文件的标准位置。JSR 10 出现后一切都变了,它为 Java 1.4 API 提供增加的 java.util.prefs 包。存储机制是特定于实现的细节,但程序员不必知道,也不必操心。对于 Windows 平台,它的位置是在“Windows 注册表”。 您虽然不能够对注册表自由控制,但您的确可以通过一个公共根节点访问所有的应用程序。
开始
命名很恰当的 Preferences 类提供操作首选项的基本框架。这个类提供了一系列静态和抽象方法来操作两套首选项(其中一套是用户首选项,另一套是系统首选项)中的其中一套。 使用静态方法,您会得到一个特定于平台的实现,就象 WindowsPreferences 类; 然后您可以使用由这个特定于平台的实现实现的抽象方法来做这项工作。
用包将程序的首选项分组是个好习惯,可以避免与其它应用程序的命名冲突。 当您查找 Preferences 对象时,只需传递包的名称。在使用非静态方法时, 您可以传递对自身的引用( this ),程序将为您确定查找的是哪个包,如清单 1 所示。
清单 1. 从非静态方法获取 Preferences 对象
Preferences userPrefs = Preferences.userNodeForPackage(this); Preferences sysPrefs = Preferences.systemNodeForPackage(this); |
但是,如果您使用的是静态方法,您就必须得到根节点并自己提供包,如清单 2 所示。
清单 2. 从静态方法获取 Preferences 对象
Preferences userPrefs = Preferences.userRoot().node("/net/zukowski/ibm"); Preferences sysPrefs = Preferences.systemRoot().node("/net/zukowski/ibm"); |
有了进行操作的节点后,您就可以轻松地设置、获取、除去和转储设置选项。只要把 Preferences 对象当作一个大的键 — 值散列表(这个表把树形结构中的键组织起来)。可它不是“集合框架”( Collections Framework)的部件,(关于“集合框架”的更多信息,请参阅 参考资料)。
写数据
我们将从讨论如何存储首选项开始。 Preferences 类提供一系列 put() 方法,如下所示,用于存储值。除支持基本的字符串之外,您还可以存储布尔值、双精度数、浮点数、整型数、长整型数和字节数组(考虑序列化)。助手方法采用适当的数据类型并执行必要的转换以便将数据存储为字符串。
- put(String key, String value)
- putBoolean(String key, boolean value)
- putByteArray(String key, byte value[])
- putDouble(String key, double value)
- putFloat(String key, float value)
- putInt(String key, int value)
- putLong(String key, long value)
所有的 put() 方法都返回一个 void。如果存储机制不可用,将抛出一个 BackingStoreException 。
注意:一个特定首选项的键长度被限制为 Preferences.MAX_KEY_LENGTH (80)个字符,而它的值被限制为 Preferences.MAX_VALUE_LENGTH (8192)个字符。
读数据
可通过下面所示的一系列 get() 方法获取特定的首选项。与写数据相似,每种受支持的数据类型,都有自己的与众不同的方法。但与获取数据时不同的是,在备用存储不可用,或有些东西尚未保存时您必须提供缺省值。这要求您确保自己的程序至少要有合理的缺省设置选项。
- get(String key, String default)
- getBoolean(String key, boolean default)
- getByteArray(String key, byte default[])
- getDouble(String key, double default)
- getFloat(String key, float default)
- getInt(String key, int default)
- getLong(String key, long default)
如果您对首选项名称不确定,您可以用 keys() 方法查找一列与节点相关联的键。这个方法返回节点的 String[] 。 除获取和存储个别首选项以及获取一列关键字之外,您还可以用 clear() 、 remove() 和 removeNode() 除去节点和值。
转储数据
如果您想在系统提供的备用存储器之外保存和恢复首选项,您可以在 XML 格式的文档中执行这些操作。您可以用 exportNode() 导出一个节点或用 exportSubtree() 导出整个子树。信息以 UTF-8 格式存储。然后,当您想恢复信息时,可使用 importPreferences() 方法。
侦听
“好奇心会害死一只猫”,但如果您对弄清除首选项何时改变很感兴趣,您可以注册一个 NodeChangeListener 或 PreferenceChangeListener ,而不考虑随之而来的后果。 NodeChangeListener 负责通知您节点被添加和除去的时间, 而 PreferenceChangeListener 告诉您值的变化。这些都紧跟着基本 JavaBeans 组件事件用 add/removeNodeChangeListener(NodeChangeListener) 和 add/removePreferenceChangeListener() 方法处理结构之后发生。基本上,您先实现侦听器,然后注册侦听器,这样您会发现将来的变化。
完整的示例
真的就这些。清单 3 为您提供了一个完整的示例来试验新功能(也可从 参考资料下载)。程序运行后会自己清除,所以如果您想在注册表中找到值,请注释掉程序尾部的清除代码。
清单 3. 完整的示例
package net.zukowski.ibm;
import java.io.*;
import java.util.prefs.*;
public class Prefs {
public static void main(String args[]) {
String denominations[] =
{"One", "Two", "Five", "Ten", "Twenty"};
String pictures[] =
{"Washington", "Jefferson", "Lincoln", "Hamilton", "Jackson"};
NodeChangeListener nodeChangeListener =
new NodeChangeListener() {
public void childAdded(NodeChangeEvent event) {
Preferences parent = event.getParent();
Preferences child = event.getChild();
System.out.println(parent.name() + " has a new child " +
child.name());
}
public void childRemoved(NodeChangeEvent event) {
Preferences parent = event.getParent();
Preferences child = event.getChild();
System.out.println(parent.name() + " lost a child " +
child.name());
}
};
PreferenceChangeListener preferenceChangeListener =
new PreferenceChangeListener() {
public void preferenceChange(PreferenceChangeEvent event) {
String key = event.getKey();
String value = event.getNewValue();
Preferences node = event.getNode();
System.out.println(node.name() + " now has a value of " +
value + " for " + key);
}
};
// Look up user root
Preferences prefs =
Preferences.userRoot().node("/net/zukowski/ibm");
// Add listeners
prefs.addNodeChangeListener(nodeChangeListener);
prefs.addPreferenceChangeListener(preferenceChangeListener);
// Save a bunch of key-value pairs
for (int i=0, n=denominations.length; i < n; i++) {
prefs.put(denominations[i], pictures[i]);
}
// Display all the entries
try {
String keys[] = prefs.keys();
for (int i=0, n=keys.length; i < n; i++) {
System.out.println(keys[i] + ": " + prefs.get(keys[i], "Unknown"));
}
} catch (BackingStoreException e) {
System.err.println("Unable to read backing store: " + e);
}
// Create child
Preferences child = Preferences.userRoot().node("/net/zukowski/ibm/foo");
// Save to XML file
try {
FileOutputStream fos = new FileOutputStream("prefs.out");
prefs.exportNode(fos);
} catch (Exception e) {
System.err.println("Unable to export nodes: " + e);
}
// Clean up
try {
prefs.removeNode();
} catch (BackingStoreException e) {
System.err.println("Unable to access backing store: " + e);
}
}
}
来自 “ ITPUB博客 ” ,链接:http://blog.itpub.net/374079/viewspace-130245/,如需转载,请注明出处,否则将追究法律责任。