Idiotproof

参照

参照は、ある場所にあるデータを指す小さなオブジェクト。

Javaにおける参照には次の種類があり、java.lang.refパッケージ以下に存在する。

名前クラスJavaDoc
強参照--
ソフト参照java.lang.ref.SoftReferenceJavaDoc
弱参照java.lang.ref.WeakReferenceJavaDoc
ファントム参照java.lang.ref.PhantomReferenceJavaDoc
ファイナル参照java.lang.ref.FinalReference-

用語整理

用語説明
参照オブジェクトあるオブジェクトへの参照を抽象化したもの。‘Reference.get()‘メソッドを呼び出して、参照先にアクセスできる。
リファレント参照先のオブジェクト。
到達可能性あるリファレントにどうやってアクセスできるのか。

強参照

いわゆる普通の参照。 定義としては、「参照オブジェクトをトラバースすることなく、あるスレッドによって到達できるオブジェクト」。

ソフト参照

強到達可能でない(=普通にアクセスできない)が、ソフト参照からアクセス可能であるオブジェクトを、ソフト到達可能と呼ぶ。

ガベージコレクターは、メモリに余裕がある間は、ソフト到達可能オブジェクトをGCしない。 ヒープがいっぱいになった場合は、GCの対象となる。
ソフト到達可能オブジェクトは、OutOfMemoryErrorが スローされる前に解放されていることが保証される。
要するに、メモリが足りているときは参照を維持するが、メモリがいっぱいになると解放される、ということ。

ソフト参照の開放は、LRUキャッシュのような仕組みで行われる。

JVMのフラグ-XX:SoftRefLRUPolicyMSPerMB=hogeで頻度を指定でき、 ソフト参照への最後のアクセスから、SoftRefLRUPolicyMSPerMB * ヒープの空きメモリMBミリ秒経過していた場合、参照はクリアされる。

一般的なソフト参照の用途はキャッシュ。 Google Guavaのキャッシュは参照に基づいた解放ポリシーを選択できる。 が、リンク先にも書かれているように、あえてこれを使うメリットはあまりない。

弱参照

強到達可能でもソフト到達可能でもない参照。 ソフト参照と似ているが、ソフト参照はメモリに余裕がある間は解放されないのに対し、弱参照は、ほかの参照がなければすぐにGCの対象になり、次回のGCで削除される。 基本的に複数スレッドからアクセスする場合に使うとよい。

Javaパフォーマンスの説明が秀逸だったので引用。

弱い参照とは、JVMに対する「ほかの誰かがまだ使っているなら、私もそのオブジェクトを利用できるようにしてください。 誰も使わなくなったら、破棄してしまってください。必要になった時に私が作りなおします」という意思表明です。 一方ソフト参照は、「メモリに余裕があって、誰かが時々にでも利用しているならそのオブジェクトを保持し続けてください」という意味です。

ファントム参照

ファントム参照は、ファイナライズされたが、まだ解放されていないオブジェクトを指す参照。 ファイナライザーの代わりに、リソースを解放するのに使ったりする。

ファイナル参照

ファイナライザーの実行のために使われる参照。publicでないので普通は意識することはない。JVMが勝手にやってくれる。 Finalizerクラスはこれを継承している。

ReferenceQueue

参照オブジェクトの状態が変更されたときに通知を受け取るために使う。

public final class Main {

    private static class Thing {
        @Override
        public void finalize() {
            System.out.println("Finalizing!");
        }
    }

    private static void test(BiFunction<Thing, ReferenceQueue<Thing>, Reference<Thing>> create) throws InterruptedException {

        Thing t = new Thing();
        ReferenceQueue<Thing> q = new ReferenceQueue<>();
        Reference<Thing> ref = create.apply(t, q);

        // 強参照をクリアして、GCの対象にする
        t = null;

        for (int i = 0; i < 5; i++) {  // JVMの機嫌が悪いとGCされないので、何度かリトライする

            Reference<? extends Thing> r;
            System.out.println(ref.get() != null);
            // 参照がキューに入れられたか調べる
            if ((r = q.poll()) != null) {
                System.out.println(r.getClass());
                return;
            }
            System.gc();
            // GCを待つ
            Thread.sleep(1000);
        }
        System.out.println("Not polled!");
    }

    public static void main(String[] args) throws InterruptedException {
//        test(SoftReference::new);
        test(WeakReference::new);
//        test(PhantomReference::new);
    }

}

上記コードを動かしてみると、ソフト参照は一度もpollされないこと、弱参照とファントム参照はGC後キューに入れられるのがわかる。

この仕組みを利用して、リソースの開放をファイナライザーよりも安全に行うことができる……のだが、Guavaにこれをやるための FinalizableReferenceQueue クラスがあるので、それを使おう。

そもそもなんでファイナライザーを使うべきでないのか

ファイナライザーはいつ実行されるかわからない

GCされるタイミングで呼ばれるので、それがすぐなのか、しばらくたってなのか、永遠にされないのかわからない。

ファイナライザーが実行されないこともある

ファイナライザーの実行は保証されていない。System.runFinalizeはファイナライズの実行を保証しない。

メソッドの呼び出しから制御が戻るのは、Java仮想マシンが、すべての未処理のファイナライズを最大限まで完了し終えたときです。

なんだそりゃ。

System.runFinalizersOnExitはファイナライズの実行を保証するが、デッドロックが発生する可能性があるので使ってはいけない。

ファイナライザがライブ・オブジェクトに対して呼び出される結果になる可能性があり、 そのときにほかのスレッドがそれらのオブジェクトを並行して操作していると、動作が異常になるか、デッドロックが発生します。

ファイナライザーは遅い

ファイナル参照が作られたり、スレッド間の同期が必要だったりするからそりゃ遅いよなあと。

GCを阻害する可能性がある

ファイナライザーの中から、うっかり別のスレッドから自分自身への強参照を作ってしまうかもしれない。 すると当然GCされなくなるので、メモリリークを起こしてしまう……可能性がある。

finalizeメソッドは、このオブジェクトを別のスレッドでふたたび利用可能にすることも含めて、任意のアクションを行うことができます。

finalize()のJavaDocにはこう書いてあるので、「絶対にやってはいけない」というわけではないらしいが……。

任意のオブジェクトについてJava Virtual Machineがfinalizeメソッドを複数回呼び出すことはありません。

このため、二回目以降GC対象になった場合は、ファイナライザーは実行されない。怖い。

じゃあどうするの?

  • GuavaのFinalizableReferenceを使う
  • AutoCloseableを実装して、 try-with-resources構文を使ってリソースを解放するようにする
  • Effective Javaをよく読んで使う

参考

Idiotproof / programming / java / api / 参照