非staticネストクラスが握っちゃう、エンクロージングオブジェクトの暗黙的参照

この記事は、Javaにおける「非staticネストクラスが、エンクロージングオブジェクトを暗黙的参照として握っちゃうから、気を付けましょう」について述べます。

なぜ、気を付けなければならないのか、と言えば、「メモリーリークを引き起こす可能性を高めてしまうから」です。

そして結論は、「ネストクラスは、`static`修飾子を付けた方がイイ（さすれば、エンクロージングオブジェクトを暗黙的参照として握ることはないから）」です。エンクロージングオブジェクトは短命で、ネストクラスのインスタンスの方が長命である場合は特にです！

# 事のきっかけはAndroidアプリ開発時

（この記事は、Androidアプリ開発に特化したものではありません。が、読み進めていけばJavaに関わることになっていきますので、当初は我慢してお読みください）

ある日のことでございます。AndroidアプリをJavaで作っていた時に、Android Studio[^1]が、こんな警告を出してきました。

[^1]: IntelliJ IDEAを改造して作られたAndroidアプリ開発専用IDE

![thisasynctaskclassshouldbestaticorleaksmightoccur.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/100612/9c3bcd8f-3f64-f41a-4771-2f8faf733715.png)


> This 'AsyncTask' class should be static or leaks might occur

CouponAsyncTaskと名付けたこのクラスは、ネストクラス（インナークラス・内部クラス）として定義しているのですが、「static修飾子を付けなさいよ、さもなければメモリリークを引き起こすかもよ」と吹き出しに書かれています。まあ、怖い。

Android Studioが備えているコードチェック機能「Lint」が教えてくれる詳しい説明を見ますと、

> Static Field Leaks
> A static field will leak contexts.
> Non-static inner classes have an implicit reference to their outer class. If that outer class is for example a Fragment or Activity, then this reference means that the long-running handler/loader/task will hold a reference to the activity which prevents it from getting garbage collected.
> Similarly, direct field references to activities and fragments from these longer running instances can cause leaks.
> ViewModel classes should never point to Views or non-application Contexts.
> Issue id: StaticFieldLeak

Google翻訳に頼んでみます。

> 静的フィールドリーク
> 静的フィールドはコンテキストをリークします。
> 非静的内部クラスには、外部クラスへの暗黙的な参照があります。 その外部クラスがたとえばフラグメントまたはアクティビティである場合、この参照は、長時間実行されるハンドラー/ローダー/タスクがガベージコレクションの取得を妨げるアクティビティへの参照を保持することを意味します。
> 同様に、これらのより長時間実行されているインスタンスからのアクティビティおよびフラグメントへの直接フィールド参照は、リークを引き起こす可能性があります。
> ViewModelクラスは、ビューまたは非アプリケーションコンテキストを指すことはありません。
> 問題ID：StaticFieldLeak

難しい英文を、難しい日本語に翻訳されてもねえ...チンプンカンプンです。

## 開発者サイトに書いてありました

ちゃんとAndroidアプリ開発者向け公式サイトに「スレッド化されたオブジェクトを使ったコード設計によく見られる欠陥の例」として掲載されていました。あるあるなんでしょうね。
[スレッド化によるパフォーマンスの向上［非明示的参照］](https://developer.android.com/topic/performance/threads?hl=ja#implicit)

この公式サイトの日本語ページでは「非明示的参照」と訳されていますが、原文は「Implicit references」と書かれています。
当記事では「暗黙的参照」と五字熟語で語っていきます。

# ネストクラス

いきなり「非staticネストクラスが握っちゃう、エンクロージングオブジェクトの暗黙的参照」について語ろうにも、このお題目に乗っかっている情報量が多いので、前提知識を一つ一つ説明していきます。
急がば回れ、です。ただ、ちょっともどかしいかもしれませんが。

「ネストクラス（nested class）」は、「インナークラス（inner class）」とも呼ばれます。当記事は「ネストクラス」で統一します。

```java:Fooクラスには2つのネストクラスがある
public class Foo {
    class Bar {
        void methodBar() {
            System.out.println("methodBar");
        }
    }

    static class Baz {
        void methodBaz() {
            System.out.println("methodBaz");
        }
    }

    void methodFoo() {
        System.out.println("methodFoo");
    }
}
```

この場合、

- BarクラスとBazクラスは、「Fooクラスのネストクラス」と言います。
- Fooのことは、「Barクラスのエンクロージングクラス」と言います。

「エンクロージングクラス（enclosing class）」は、「アウタークラス（outer class）」とも呼ばれます。当記事は「エンクロージングクラス」で統一します。

BarとBazの違いは、`static`修飾子が付いているか否かなので、

- Barクラスは、「Fooクラスの非staticネストクラス」と言います。面倒くさいと思う人は「Fooクラスのネストクラス」で済ませてしまいますが。
- Bazクラスは、「Fooクラスのstaticネストクラス」と言います。

## ネストクラスのインスタンスを生成するには

```java:Fooの2つのネストクラスのインスタンスを生成する
class Main {
    public static void main(String[] args) {
        Foo foo = new Foo();
        Foo.Bar bar = foo.new Bar();

        Foo.Baz baz = new Foo.Baz();
    }
}
```

### 非staticネストクラスのインスタンスを生成する場合

Barクラスのインスタンスを生成するには、2行を要しました。どうしても1行で済ませたい場合は、以下のコードとなります。

```java:1行でBarクラスのインスタンスを生成
Foo.Bar bar = new Foo().new Bar();
```

いずれにせよ、非staticネストクラスのインスタンスを生成する場合は、エンクロージングのインスタンスが必要です。
そして、`new`演算子の前に`.`が付くのも特徴的です。

### staticネストクラスのインスタンスを生成する場合

事前にエンクロージングのインスタンスなんて要りません。いきなり`new`できます。

特徴的なのは、クラス名が「`Baz`」ではなく、「`Foo.Baz`」という名前だということです。クラス名の合間に`.`が含まれているのが特徴的です。

# 書籍「Effective Java」に当たる

[Effective java](https://www.maruzen-publishing.co.jp/item/?book_no=303054)は、第1版（2001年刊行）から「非staticのメンバークラスよりもstaticのメンバークラスを選ぶ」べしとのたまっております。それは2018年に刊行された第3版ですら残っている御成敗式目です。

> メモリリークは壊滅的になり得ます。

とか　
> メモリリークの検出がたいてい難しいです。

とか
> 余分な参照を保持しメモリと時間を無駄に使います。

など、怖いことが書かれています。なぜなら、

>  **static修飾子を省略すると、個々のインスタンスはエンクロージングオブジェクトへの関係のない参照を持ってしまいます。その参照を保存することは時間とメモリを必要とします。深刻なのは、その参照がなければガベージコレクションの対象になる場合、そのエンクロージングインスタンスが残ってしまう可能性があることです。** 

と書かれてあります。

# エンクロージングのインスタンスはもう不要なのに、天国に召されない

前出のプログラムをちょっと改変してみました。staticネストクラスである`Baz`はちょっと退かせました。

```java:
public class Main {
    public static void main(String[] args) {
        Foo foo = new Foo();
        Foo.Bar bar = foo.new Bar();

        foo = null;
        System.gc();
//        foo.methodFoo(); // NullPointerException発生
        bar.methodBar();
    }
}
```

エンクロージングクラスの`Foo`のインスタンスに`null`を代入してガベージコレクション(GC)を実行させてから、非staticネストクラスの`Bar`インスタンスにメソッドを呼び出してみました。実行してみますと、以下の通りです。

```console:実行結果
methodBar
```

へえ、ちゃんと動くんだぁ！と私は瞠目してしまいました。

Javaの仕様としては、私がいくらエンクロージングクラスの`Foo`のインスタンスに`null`を代入しても、その非staticネストクラスの`Bar`インスタンスが動く限り、`foo`と名付けたオブジェクトはGCされない（GC対象と見做されず華麗にスルーされた）のです。なぜなら、 **`bar`が`foo`を暗黙的参照として保持しているから** です。

ファニーな例えとしてイラストにすると、こんなかんじでしょうか。

![joubutudekinai.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/100612/df1a27f3-1c32-639a-db14-cbf2c62018c4.png)


階段を一歩ずつ登っていってる女性が、`bar`で、元気いっぱいです。

一方、成仏したがっているお爺ちゃんが`foo`なんですが、`bar`が握ってるのでね、なかなか天国へ召されずにいるのですよ。地縛霊になりかねません。

- 握っている＝参照している
- 天国へ召される＝GCによりメモリから解放される
- 地縛霊＝メモリリーク

で読み替えてください。

## では、短絡的にネストクラスにstaticを付けるだけで万事解決！といくのか？

FooとかBarとかBazの題材をやめて、以下のプログラムを見てください。

```java:ビフォアー：ネストクラスが非staticだ
class Fizz {
    private Integer x = 12;
    private static Integer y = 34;

    class Buzz {
        void m() {
            x = 56;
            y = 78;
            System.out.println(x + y);
        }
    }
}

class FizzBuzzMain {
    public static void main(String[] args) {
        Fizz.Buzz fb = new Fizz().new Buzz();
        fb.m();
    }
}
```
```console:ビフォアーの実行結果
134
```

（わざとらしく）やるなっつってんのに非staticネストクラスですよ。では、安直にこの`Buzz`と名付けたネストクラスにstatic修飾子を付けてあげましょう。

```java:アフター
class Fizz {
    private Integer x = 12;
    private static Integer y = 34;

    static class Buzz {
        void m() {
            x = 56; // xがstaticフィールドではないのでコンパイル不可
            y = 78;
            System.out.println(x + y); // xがstaticフィールドではないのでコンパイル不可
        }
    }
}

class FizzBuzzMain {
    public static void main(String[] args) {
        Fizz.Buzz fb = new Fizz.Buzz();
        fb.m();
    }
}
```

途端にコンパイルできなくなりました。`x`がstaticフィールドではないために、ダメだとIDEが怒り出します。

なぜなのか。それは、 **staticネストクラスは、エンクロージングのstaticメンバーにのみアクセス可能** だからです。

# また再びのAndroidアプリ開発の話に戻ります

作りたかったAndroidアプリは、このアニメーションGIFをご覧ください。

![countup.gif](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/100612/7e2b7bba-1246-178e-a465-2d936b79a855.gif)


起動したとたんに、勝手にカウントアップが始まります。このアニメーションGIFは、3まで至ったらまたSTART!を繰り返しているアニメーションですが、本当はこのアプリはSTART!から始まったら「9」まで数え上げたらお終い（「9」を出力したままキープ）なんです。

そしてそのプログラムは以下の通りです。Androidアプリ開発未経験者の方も我慢しておつきあいください。

```java:画面のクラス
public class MainActivity extends AppCompatActivity {

    private TextView textView;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        textView = findViewById(R.id.text_view);
        new MyTask().execute();
    }

    class MyTask extends AsyncTask<Void, String, Void> {
        @Override
        protected Void doInBackground(Void... voids) {
            for (int i = 0; i < 10; i++) {
                try {
                    Thread.sleep(1000);
                    publishProgress(String.valueOf(i));
                } catch (InterruptedException e) {
                    Log.e("MyTask", e.getMessage(), e);
                }
            }
            return null;
        }

        @Override
        protected void onProgressUpdate(String... values) {
            textView.setText(values[0]);
        }
    }
}
```

Androidで「画面のクラス」を作りたければ、`AppCompatActivity`を継承したクラスをコーディングしはじめます。

`TextView`というクラスは、画面中央に配置して「START!」か「0」とか「1」とか表示している、文字列を表示する（ことしかできない）ビュー（部品）です。
この`TextView`を非同期処理で「0」を「1」に、そして「2」へと1000ミリ秒きざみで変えさせたい。これがこのアプリの要件です。

非同期処理をしたければ、`AsyncTask`のサブクラスを定義して、それにその処理をコーディングしておきます。

![MainActivity_MyTask.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/100612/fc7a854e-3efe-8f1d-e4e2-206c6f7e5972.png)

その非同期処理をする`MyTask`に`execute()`メソッドを呼び出すと、`MyTask`が処理を始めます。
この画像の赤い囲みが`TextView`です。`MyTask`がこの`TextView`に、`"0"`とか`"1"`とか`"2"`とか文字列を上書きします。これでカウントアップするように見せかけています。

それでは、`MyTask`クラスに`static`を付けてみます。

![Non-static field.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/100612/87657e1a-2097-2caa-4790-637595664132.png)

IDEが真っ赤に怒り出しました。なぜならその`textView`と名付けたフィールド、static修飾子を付けてませんからね！

## MainActivityのインスタンスはもう不要なのに、天国に召されない

前出の階段を元気に登っている女性と地縛霊のお爺ちゃんのイラストを今一度見てください。

Androidでは、不要になった画面は、GCされます。「不要になった画面」とは、ユーザが戻るボタンを押すなどしてその画面を非表示にした（消しちゃう）時のことをいいます。
一般的にAndroid端末はPCと比較してメモリが少ないです[^2]。なのでユーザが非表示にした画面＝Activityクラスのインスタンスはランタイムにより速やかにGCされます。

[^2]: 10GBのRAMを搭載しているAndroid”ゲーミング”スマホとか市販されてますが、まあそれは置いておいて。

ユーザが気軽に戻るボタンを押しちゃう、という所作ひとつで、その画面＝Activityインスタンスは不要！んじゃGC！と短命なりにし運命になりがちです。
しかして、バックグラウンドで（否、「バックグラウンド」という用語は正鵠を射てなくて、正確には「ワーカースレッドにおいての非同期処理で」と言った方が適切です）`MyTask`は、己の仕事（カウントアップ）を達成しきるまで生きることになります。

この、生存期間の比較で【　エンクロージングインスタンス　＜　ネストクラスのインスタンス　】であることを危惧して警告を出してくれたのがAndroid StudioというIDEなのです。

この私が作ったアプリを起動して、カウントアップが`MyTask`の仕業により始まっても、ユーザがもういいやと戻るボタンを押すなどして画面を非表示にする（消す、アプリをやめる）としても、 **非staticネストクラスのインスタンスである`MyTask`オブジェクトは、`MainActivity`インスタンスの暗黙的参照を保持している** ので、とっくに表示されてないんだからとっととGCされちゃえばいいのに、GCされない状態に陥ります。
ユーザが見えてないところで、`MyTask`は脈々とカウントアップのお仕事をしているのです。
イラストの、女性である`MyTask`は１段１段階段を登って。でもその右手には、成仏できないお爺ちゃん`MainActivity`をしっかり握っちゃってて。ユーザはこのお爺ちゃんが見えてないのに。

## 解決したくとも、にっちもさっちも

私はここでジレンマに我が身が嘖（さいな）まれるのです。

- この`MyTask`は、この`MainActivity`でしか使われないクラスだから、ネストクラスにしたい。
- しかしstaticネストクラスにせよとIDEが警告を出す。
- ところが`TextTview`型のフィールドはstaticフィールドにはしたくない（すべきではないので）。
- となると、この`MyTask`とこの`MainActivity`は、別クラスに分けるか。
- でもそうなると、`TextTview`の参照の受け渡しが面倒だ（今度はこの受け渡しでヘタこくと`TextTview`がメモリリークのタネとなりかねん）。
- `TextTview`を持っているのは（持つべきなのは）`MainActivity`だし、その`TextTview`の文字列を変えるのは`MyTask`だ。
- だったらやっぱり、この`MyTask`は、この`MainActivity`のネストクラスにしたい。
- [`java.lang.ref.WeakReference<T>`](https://docs.oracle.com/javase/jp/11/docs/api/java.base/java/lang/ref/WeakReference.html)を使うか...。

ずっとずっとこれに悩んでいます。どこかでなにかを妥協しなければいけないのかもしれません。

以上です。なんだかこれで終わりにしていいのか、良心の呵嘖（かしゃく）に悩む私に、福沢諭吉先生の御言葉でこの記事を綴じたいと思ひます。

> されども不良の子に窘（くる）しめらるるの苦痛は、地獄の呵嘖よりも苦しくして、然（しか）も生前現在の身を以てこの呵嘖に当たらざるを得ず。

> _福沢諭吉「教育の事」1878（明治11）年_

ちょっとユキチよ、「地獄の呵責よりも苦しくて」はシビアすぎて引くわ。
やめた。和辻先生に縋（すが）ることにします。

> かく道元の説く慈悲の前には、「悪は必ずしも呵嘖すべきものでない」。

> _和辻哲郎「日本精神史研究」1922（大正11）年_

以上です。