Preferences API

Preferences API と他の機構との比較

設定および構成データは、多くの場合、java.util.Properties API を使用してプロパティファイルにアクセスし、このファイルに格納していました。ただし、ディスク上でのファイルの位置またはファイルの名前に関する標準は存在しませんでした。この場合、ユーザの設定データのバックアップ作成や、マシン間のデータ転送が困難になります。アプリケーション数が増加するにつれて、ファイル名が重複する可能性が高くなります。また、ローカルディスクが存在しない場合、またはデータを外部データストア (企業全域にわたる LDAP ディレクトリサービスなどの) に保存する場合には、この方法は使用できません。

適用例は少なくなりますが、JNDI (Java Naming and Directory Interface) API を使用してディレクトリサービスにアクセスし、そこに格納する場合もありました。Properties API と異なり、JNDI では、任意のデータストアを使用できます (バックエンドの中立性)。JNDI は強力な API ですが、サイズが比較的大きく、5 つのパッケージと 83 のクラスから構成されます。JNDI には、ディレクトリ名前空間内で設定データを格納する場所、または格納する名前空間に関するポリシーが存在しません。

Properties および JNDI には、単純で、汎用的な、バックエンドの中立性を持つ設定管理機能はありません。Preferences API では、Properties API の単純さと JNDI のバックエンドの中立性が同時に実現されます。Preferences API には、名前の重複を回避し、一貫性を保持し、安定性を向上するために必要なポリシーが組み込まれています。ただし、バッキングデータストアの使用は推奨されていません。

使用上の注意

包含クラスの Preferences オブジェクトを取得する

ここでは、インラインの String リテラルではなく、static final フィールドが、キー名 (NUM_ROWS および NUM_COLS) として使用されています。このようにすると、キー名の入力ミスによる実行時のバグが発生する可能性が減少します。

        Preferences prefs = Preferences.systemNodeForPackage(this);

Static メソッドの Preferences オブジェクトを取得する

    Static String ourNodeName = "/com/acme/widget";

    static void foo() {
        Preferences prefs = Preferences.userRoot().node(ourNodeName);

        ...
    }

    static Preferences prefs =  Preferences.systemRoot().node(ourNodeName);

不可分な更新

    int x, y;
    ...
    prefs.put(POSITION, x + "," + y);

    static int X_DEFAULT = 50, Y_DEFAULT = 25;
    void baz() {
        String position = prefs.get(POSITION, X_DEFAULT + "," + Y_DEFAULT);
        int x, y;
        try {
            int i = position.indexOf(',');
            x = Integer.parseInt(coordinates.substring(0, i));
            y = Integer.parseInt(position.substring(i + 1));
        } catch(Exception e) {
            // Value was corrupt, just use defaults
            x = X_DEFAULT;
            y = Y_DEFAULT;
        }
        ...
    }

バッキングストアのステータスを判断する

    private static final String BACKING_STORE_AVAIL = "BackingStoreAvail";

    private static boolean backingStoreAvailable() {
        Preferences prefs = Preferences.userRoot().node("");
        try {
            boolean oldValue = prefs.getBoolean(BACKING_STORE_AVAIL, false);
            prefs.putBoolean(BACKING_STORE_AVAIL, !oldValue);
            prefs.flush();
        } catch(BackingStoreException e) {
            return false;
        }
        return true;
    }

Java コレクション API の設計に関する FAQ