Утечка памяти в DatePickerDialog. Как определить, в чем проблема?

Question

Я использую эту MaterialDateTimePicker библиотеку в моем приложении. У меня проблема с поиском root причины утечки. DatePickerDialog течет в зависимости от того, что показывает журнал. Я не уверен, что в библиотеке есть проблема, но я думаю, что я делаю что-то не так.

У меня есть View, который отображает текущую дату. Пользователь может щелкнуть по нему, затем отобразится DatePickerDialog. Затем он выбирает день и нажимает кнопку ok на DatePickerDialog. Я получаю дату, форматирую ее и затем представляю. Через несколько секунд Leak Canary lib говорит: «Эй, ты слил. Было бы здорово, если бы вы сказали мне, что не так с моим кодом.

Итак, это мой пользовательский виджет.

import android.content.Context
import androidx.core.content.ContextCompat
import androidx.fragment.app.FragmentManager
import com.atco.forsite.R
import com.atco.forsite.screens.utility.DatePickerOFIState.NOW_FUTURE
import com.atco.forsite.screens.utility.DatePickerOFIState.PAST_NOW
import com.jakewharton.rxrelay2.PublishRelay
import com.wdullaer.materialdatetimepicker.date.DatePickerDialog
import java.util.Calendar

enum class DatePickerOFIState {
    PAST_NOW,
    NOW_FUTURE
}

class DatePickerOFI(
    private val context: Context,
    private val fm: FragmentManager,
    private val state: DatePickerOFIState
) : DatePickerDialog.OnDateSetListener {

    /**
     * Subscribe to this observer in order to be notified when the result is ready.
     */
    val relay: PublishRelay<Calendar> = PublishRelay.create()

    private val datePicker: DatePickerDialog

    companion object {
        const val TAG = "DatePickerDialog"
    }

    init {
        val now = Calendar.getInstance()
        datePicker = DatePickerDialog.newInstance(
                this,
                now.get(Calendar.YEAR),
                now.get(Calendar.MONTH),
                now.get(Calendar.DAY_OF_MONTH)
        )
        datePicker.version = DatePickerDialog.Version.VERSION_2
        datePicker.accentColor = ContextCompat.getColor(context, R.color.primaryBlue)
        datePicker.setOkColor(ContextCompat.getColor(context, R.color.white))
        datePicker.setCancelColor(ContextCompat.getColor(context, R.color.white))

        when (state) {
            PAST_NOW -> datePicker.maxDate = now
            NOW_FUTURE -> datePicker.minDate = now
        }
    }

    fun show() {
        datePicker.show(fm, TAG)
    }

    override fun onDateSet(view: DatePickerDialog?, year: Int, monthOfYear: Int, dayOfMonth: Int) {
        val calendar = Calendar.getInstance()
        calendar.set(year, monthOfYear, dayOfMonth)
        relay.accept(calendar)
    }
}

В моем Activity нет ничего особенного. Я открываю DatePickerDialog следующим образом:

class SafetyExchangeActivity : AppCompatActivity() {

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

        val datePicker = DatePickerOFI(this, supportFragmentManager, DatePickerOFIState.PAST_NOW)
        datePicker.relay.safeSubscribe(createDefaultObserver(logger) {
            setReportDate(this)
        })

        etReportedDate.setOnClickListener {
            datePicker.show()
        }
    }
}

След утечки:

┬───
│ GC Root: System class
│
├─ android.view.inputmethod.InputMethodManager class
│    Leaking: NO (InputMethodManager↓ is not leaking and a class is never leaking)
│    ↓ static InputMethodManager.sInstance
├─ android.view.inputmethod.InputMethodManager instance
│    Leaking: NO (DecorView↓ is not leaking and InputMethodManager is a singleton)
│    ↓ InputMethodManager.mCurRootView
├─ com.android.internal.policy.DecorView instance
│    Leaking: NO (LinearLayout↓ is not leaking and View attached)
│    mContext instance of com.android.internal.policy.DecorContext, wrapping activity com.atco.forsite.screens.records.safetyExchange.SafetyExchangeActivity with mDestroyed = false
│    Parent android.view.ViewRootImpl not a android.view.View
│    View#mParent is set
│    View#mAttachInfo is not null (view attached)
│    View.mWindowAttachCount = 1
│    ↓ DecorView.mContentRoot
├─ android.widget.LinearLayout instance
│    Leaking: NO (SafetyExchangeActivity↓ is not leaking and View attached)
│    mContext instance of com.atco.forsite.screens.records.safetyExchange.SafetyExchangeActivity with mDestroyed = false
│    View.parent com.android.internal.policy.DecorView attached as well
│    View#mParent is set
│    View#mAttachInfo is not null (view attached)
│    View.mWindowAttachCount = 1
│    ↓ LinearLayout.mContext
├─ com.atco.forsite.screens.records.safetyExchange.SafetyExchangeActivity instance
│    Leaking: NO (Activity#mDestroyed is false)
│    ↓ SafetyExchangeActivity.datePicker
│                             ~~~~~~~~~~
├─ com.atco.forsite.screens.utility.DatePickerOFI instance
│    Leaking: UNKNOWN
│    ↓ DatePickerOFI.datePicker
│                    ~~~~~~~~~~
╰→ com.wdullaer.materialdatetimepicker.date.DatePickerDialog instance
​     Leaking: YES (ObjectWatcher was watching this because com.wdullaer.materialdatetimepicker.date.DatePickerDialog received Fragment#onDestroy() callback and Fragment#mFragmentManager is null)
​     key = dd153a49-8e66-45f7-8736-16342134e7f6
​     watchDurationMillis = 5297
​     retainedDurationMillis = 297

METADATA

Build.VERSION.SDK_INT: 29
Build.MANUFACTURER: Google
LeakCanary version: 2.2
App process name: com.atco.forsite
Analysis duration: 8193 ms

Answer 1

Это, вероятно, должно быть var:

private lateinit var datePicker: DatePickerDialog

И оно должно быть деконструировано onDestroy:

override fun onDestroy() {
    datePicker = null;
    super.onDestroy()
}

Answer 2

В соответствии с трассировкой утечки, я думаю, что источником проблемы является эта строка

private val datePicker: DatePickerDialog

в DatePickerOFI классе.

В качестве решения, я думаю, вам нужно обнулить datePicker переменная экземпляра, как только ваша работа будет завершена, т.е. диалог будет закрыт.