RecyclerView 周りで割と簡単に起きるメモリリーク 2つとその解決方法

Android を触り始めて１年弱、LeakCanary を初めて使ってみたところ、普通に使っているつもりだった RecyclerView 周りでメモリリークを起こしていると怒られたので、サンプルプログラム を作って調べてみました。なお、サンプルは全て Kotlin です。

ケース 1. RecyclerView.adapter が Activity よりも長生きする場合

メモリリーク

このサンプルは、下図のようなベーシックな構造をとっています。

Fragment が RecyclerView を表示していて、その adapter がカスタムの ViewHolder を供給しています。一つだけ、通常(!?) の構造から逸脱しているとすれば、それは Fragment が adapter への参照を保持していることです。せっかく Fragment を使っているので、adapter の生存時間を Fragment に合わせ、回転等が起きても adapter の状態を維持できるようにしています。

しかし、この参照が、どうもメモリリークを引き起こすようです。

LeakCanary によるリークのツリーは以下のようになります。

これによると、GC root から RecyclerView.mAdapter への参照が保持される限り、Activity がリークする、と読めます。

つまり、どうも RecyclerView.Adapter から RecyclerView 経由で Activity への参照が内部的に張られているようです。 (下図点線参照)

解決法 1

adapter の生存期間を Activity に合わせる。

class MainActivityFragment : Fragment() {
    // Discard permanent reference to the adapter
-   val adapter = MainRecyclerViewAdapter()
-   
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        return inflater.inflate(R.layout.fragment_activity_main, container, false)
    }

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)

        // Recreate adapter instance every time after rotation
-       recyclerView.adapter = adapter
+       recyclerView.adapter = MainRecyclerViewAdapter()
        recyclerView.layoutManager = LinearLayoutManager(activity!!)
    }
} 

この解決方法は、原因を考えればわかりやすいですが、 adapter に状態を保持できなくなる、という欠点があります。回転が起きると adapter は毎度初期化されるので、状態はどこか別に保存しておいて、そこから随時読み込むという形にする必要があります。

解決法 2

onDestroyView で recyclerView.adapter = null を呼んでやるだけです。

class MainActivityFragment : Fragment() {
    // Discard permanent reference to the adapter
    val adapter = MainRecyclerViewAdapter()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        return inflater.inflate(R.layout.fragment_activity_main, container, false)
    }

+   override fun onDestroyView() {
+       super.onDestroyView()
+       recyclerView.adapter = null
+   }
+
    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState) 
        recyclerView.adapter = adapter
    }
}

詳細は Android のコードを読まないとわかりませんが、RecyclerView => adapter の参照を切った時に adapter から RecyclerView の隠れ参照 (!?) も切ってくれて、循環参照がなくなるのだと思います。

ケース 1 のまとめ

解決法 1 は「adapterに状態を持たせられない」という制限ができてしまうので、解決法 2 が汎用的でより良いと思われます。

一つ付け加えて起きたいのは、このタイプのメモリリークは ViewPager では起きません。おそらく、隠れ参照の張られ方が RecyclerView と違うのだと思います。

ケース 2. Rx の disposable を RecyclerView.ViewHolder で使い、dispose しなかった/できなかった場合。

メモリリーク

これは、RecyclerView に限った話ではなく、Disposable を dispose せずに放ってしまったという一般的なバグで起きることですが、「いつ dispose したらいいんだ」という問題は結構あって、 RecyclerView 特有の問題かな、と思いました。

class MainRecyclerViewHolder(itemView: View): RecyclerView.ViewHolder(itemView) {
    val disposable = CompositeDisposable()

    init {
        disposable += AppState.stateSubject.subscribe {
            itemView.textView.text = "Status : $it"
            someMethod()
        }
    }

    fun someMethod() {
        println("Doing nothing...")
    }
}

カスタムの ViewHolder インスタンスが、スタティックな Rx subject に subscribe しています。明らかにここでは disposable を dispose してないんで、subscribe ブロックがリークします。ただ、それだけではなく、subscriber ブロックが ViewHolder への参照を持っているため ViewHolder がリークし、ViewHolder も内部的に Activity への参照を持っているようで Activity もリークします。LeakCanary によるリークツリーは以下のようになります。:

内部的には ViewHolder から Activity への参照があるということが伺えます。

解決法 1

disposable を ViewHolder.finalize() で dispose します。この時気をつけないといけないのは、subscriber ブロックから ViewHolder への参照は WeakReference で行なわないといけないということです。そうしないと、subscriber ブロックからの参照が生きているので ViewHolder.finalize() が永久に呼ばれず、dispose も呼ばれないことになってしまいます。

     val disposable = CompositeDisposable()

     init {
+        val weakItemView = WeakReference<View>(itemView)
+        val weakSelf = WeakReference<MainRecyclerViewHolder>(this)
+
         disposable += AppState.stateSubject.subscribe {
-            itemView.textView.text = "Status : $it"
-            someMethod()
+            weakItemView.get()?.textView?.text = "Status : $it"
+            weakSelf.get()?.someMethod()
         }
     }

     fun someMethod() {
         println("Doing nothing...")
     }
+
+    protected fun finalize() {
+        if (!disposable.isDisposed()) {
+            disposable.dispose()
+        }
+        println("MainRecyclerViewHolder reclaimed")
+    }

この方法には finalize() がいつ呼ばれるか分からない、という問題があります。回転が起きた後 ViewHolder のインスタンスが画面からはデタッチされた後でも、GC が呼ばれるまで finalize() は呼ばれません。なので、GC が起きるまでの間、画面に表示されない ViewHolder インスタンスがゾンビのように生きていて Rx イベントを受け続けるという状態が起こり得ます。

解決法 2

Activity で Disposable インスタンスを生成し、パラメータとして ViewHolder まで受け渡し、ViewHolder ではそれを使う、という方法です。これで、回転が起きて Activity が死んだ時には、GC を待たずに subscriber ブロックも dispose することができます。

MainActivity:

class MainActivity : AppCompatActivity() {
+   val disposable = CompositeDisposable()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
    }

+   override fun onDestroy() {
+       super.onDestroy()
+
+       if (!disposable.isDisposed) {
+           disposable.dispose()
+       }
+   }

MainActivityFragment:

class MainActivityFragment : Fragment() {

-   val adapter = MainRecyclerViewAdapter()
+   private lateinit var adapter: MainRecyclerViewAdapter

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

+       adapter = MainRecyclerViewAdapter((activity as MainActivity).disposable)
        retainInstance = true
    }
    ...

MainRecyclerViewAdapter:

-class MainRecyclerViewAdapter: RecyclerView.Adapter<MainRecyclerViewHolder>() {
+class MainRecyclerViewAdapter(val activityDisposable: CompositeDisposable) : RecyclerView.Adapter<MainRecyclerViewHolder>() {
    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): MainRecyclerViewHolder {
        val itemView = LayoutInflater.from(parent.context).inflate(R.layout.view_holder_main, parent, false)
-       return MainRecyclerViewHolder(itemView)
+       return MainRecyclerViewHolder(itemView, activityDisposable)
    }
    ...

MainRecyclerViewHolder:

-class MainRecyclerViewHolder(itemView: View): RecyclerView.ViewHolder(itemView) {
+class MainRecyclerViewHolder(itemView: View, val activityDisposable: CompositeDisposable): RecyclerView.ViewHolder(itemView) {
    val disposable = CompositeDisposable()

    init {
        disposable += AppState.stateSubject.subscribe {
            itemView.textView.text = "Status : $it"
            someMethod()
        }
+       activityDisposable.add(disposable)
    }
}

ViewHolder の生存期間が Activity と同じであると保証できる場合には解決法 2 は万全です。

しかし、ViewHolder が Activity が死んでからも生き続けるケースがある場合にはこの方法はまずくて、Activity が死んだ後は、受け取るべきイベントを受けれない ViewHolder が出てきてしまいます。とは言っても、僕にはこのケースが起きるシチュエーションが今の所、想像できません。

また、Activity がまだ生きている間に ViewHolder が死ぬケースがある場合も問題です(複数の Fragment が Activity によって切り変えられるケース、など)。死んだはずの ViewHolder が Rx イベントを受け続ける事態が発生します。しかしこの場合は、Activity の代わりに Fragment の生存期間を ViewHolder と合わせてやればいいので、Activity ではなく、Fragmentから Disposable を渡せばいいはずです。

ケース 2 のまとめ

ViewHolder が Activity が死んでからも生き続けるケースという問題があるものの、そんなケースが実際には存在しそうにないので、事実上解決法 2 が汎用的な解だと思います（間違ってたらご教授ください）。Activity が複数 Fragment を切り替えて使用している場合には、Activity の代わりに、Fragmentから Disposable を渡せばいいはずです。

しかし、ViewHolder が死ぬ時に確実に呼ばれるコールバックがあれば (onDestroy 的な) 簡単に解決するのになぁ。。

総括

• RecyclerView.Adapter が Activity より長生きした場合に Activity がリークする可能性があることと、その解決法を示しました。
• RecyclerView.ViewHolder で Rx を使った時に Activity がリークする可能性と、その解決法を示しました。

LeakCanary を使うまで意識できていませんでしたが、RecyclerView.Adapter/RecyclerView.ViewHolder から Activity への隠れ参照があるようです。

LeakCanary は最高ですね。最初は少々疑って、自分でも Activity の finalize() メソッドが呼ばれているかどうかをチェックして Activity のリークを確認しましたが、LeakCanary のリークレポートと完全に一致していました。今後全てのプロジェクトで使っていきたいツールです。