今天逛Android官方文檔的時候發現了一個比較簡單也有點意思的東西。自定義返回導航。這篇文章就這個簡單說一下：

自定義返回導航是啥；
怎么用；
簡單場景；
看一下源碼；

什么是自定義返回導航

簡單點來說就是可以對返回進行攔截了。有人就會說了：之前也可以攔截呀??！
對，以前對后退做攔截的的方式基本上是對onKeyDown方法做攔截（也可以對onBackPressed做攔截），但onKeyDown
職能比較多，包含了很多物理按鍵，現在android官方將返回拿出來單獨處理肯定會好一點的（原理就是對onBackPressed做攔截）。

是這樣的

通過activity的getOnBackPressedDispatcher()方法你可以得到一個OnBackPressedDispatcher，看名字就知道，這是用來調度返回用的，而我們可以通過它的addCallback方法將我們想要的返回邏輯加給他，就像這樣：

val callback = onBackPressedDispatcher.addCallback(this,true){
    //back code
}

這是kotlin對addCallback優化的一個擴展函數，如果是java的話，是這樣的：

OnBackPressedCallback callback = new OnBackPressedCallback(true) {//true 開啟自定義返回邏輯
    @Override
    public void handleOnBackPressed() {
        //back code
    }
};
getOnBackPressedDispatcher().addCallback(callback);

然后我們可以通過callback的setEnabled方法對這個自定義返回邏輯開啟和關閉。callback.setEnabled(false);關閉返回攔截，最主要的功能就這么多。

一個實現場景

我使用自定義返回導航改了一下之前寫的后退提示，通常在退出最后一個activity的時候提醒一下用戶：再點擊就退出這個app啦這樣的需求。改后對比了一下簡潔了好多（也因為是kotlin）：

fun AppCompatActivity.exit(message: String = "再按一次返回鍵退出", duration: Int = Toast.LENGTH_SHORT) {
    onBackPressedDispatcher.addCallback(this, true) {
        val toast = Toast.makeText(this@exit, message, duration)
        toast.show()
        isEnabled = false
        toast.view.postDelayed(
            Runnable {
                isEnabled = true
            },
            if (toast.duration == Toast.LENGTH_SHORT) 4000 else 7000)
    }
}

最后看一下源碼

我們除了要知道怎么用之外，最好要知道怎么實現的，這樣知識才是完整的。而且有關自定義返回導航的代碼也不多，完完全全加起來還不夠一千行應該。
從androidX開始，在activity中（準確來說是在ComponentActivity這一層）后退部分的邏輯變了，變成這樣了

//ComponentActivity
public void onBackPressed() {
    mOnBackPressedDispatcher.onBackPressed();
}

后退的邏輯全都交給了后退調度器了。
點進去一看：

//OnBackPressedDispatcher
public void onBackPressed() {
    Iterator<OnBackPressedCallback> iterator =
            mOnBackPressedCallbacks.descendingIterator();//得到所有注冊到調度器中的各種后退邏輯
    while (iterator.hasNext()) {
        OnBackPressedCallback callback = iterator.next();
        if (callback.isEnabled()) {//如果callback是可用的話
            callback.handleOnBackPressed();//執行自定義后退邏輯
            return;
        }
    }
    if (mFallbackOnBackPressed != null) {//如果沒有執行任何自定義后退邏輯，那么就執行一下這個，如果mFallbackOnBackPressed存在的話
        mFallbackOnBackPressed.run();
    }
}

但是我們始終沒有看到原本后退的邏輯，也就是返回到上一個activity的后退邏輯，但是有這么個東西mFallbackOnBackPressed，無論從邏輯還是名字，原本的后退邏輯這個邏輯應該就藏在這個run方法里了。
往上找找這個實例：

//OnBackPressedDispatcher
public OnBackPressedDispatcher(@Nullable Runnable fallbackOnBackPressed) {
    mFallbackOnBackPressed = fallbackOnBackPressed;
}

原來是初始化的時候設置的，那我們就可以回到ComponentActivity再看看OnBackPressedDispatcher是在哪里被實例化的了：

//ComponentActivity
private final OnBackPressedDispatcher mOnBackPressedDispatcher =
        new OnBackPressedDispatcher(new Runnable() {
            @Override
            public void run() {
                ComponentActivity.super.onBackPressed();//原本的后退邏輯
            }
        });

好了，整個邏輯下來就通了。

小建議

在使用自定義返回導航的時候，注意把LifecycleOwner加上。