萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> Android 開發

Android Dialog 彈出時攔截 Back 鍵事件:OnCancelListener、OnKeyListener、dispatchKeyEvent 三種方案對比

Dialog 持有焦點時,Activity 的 onKeyDown/onBackPressed 無法接收 Back 鍵事件。本文對比三種攔截方案:Dialog.setOnCancelListener、Dialog.setOnKeyListener、Activity.dispatchKeyEvent,並給出最佳實踐代碼模板。

一、問題根因

Dialog 彈出後成為焦點窗口,Back 鍵事件先分發給 Dialog,Dialog 默認行為:cancel() → 觸發 OnCancelListener → 關閉 Dialog。Activity 不再收到事件。

二、方案一:OnCancelListener (最簡單、語義最清晰)

AlertDialog dialog = new AlertDialog.Builder(this)
    .setTitle("標題")
    .setMessage("內容")
    .setPositiveButton("確定", null)
    .setNegativeButton("取消", null)
    .create();

dialog.setOnCancelListener(dialogInterface -> {
    // 用戶按 Back 鍵、或調用 dialog.cancel() 觸發
    Log.d("Dialog", "Back pressed or cancelled");
    // 執行自定義邏輯:埋點、狀態恢復、防止重複提交等
    onDialogCancelled();
});
dialog.show();
  • 優點:零侵入、符合取消語義、自動處理「點擊外部區域取消」(需 setCanceledOnTouchOutside(true))。
  • 缺點:無法區分「Back 鍵」與「代碼調用 cancel()」,無法攔截並阻止關閉 (如未保存提示)。

三、方案二:OnKeyListener (可攔截並阻止關閉)

dialog.setOnKeyListener((dialogInterface, keyCode, event) -> {
    if (keyCode == KeyEvent.KEYCODE_BACK && event.getAction() == KeyEvent.ACTION_DOWN) {
        // 可在此判斷是否允許關閉
        if (hasUnsavedChanges()) {
            showSaveConfirmDialog(); // 彈出二次確認
            return true; // 消費事件,Dialog 不關閉
        }
        // 允許關閉,返回 false 讓 Dialog 繼續處理
    }
    return false;
});
  • 優點:精準攔截 Back Down 事件、可阻止關閉、可執行異步邏輯後手動 dialog.dismiss()。
  • 缺點:需注意 event.getAction() 避免重複處理 Down/Up,return true 會阻斷所有後續處理 (含 Accessibility)。

四、方案三:Activity.dispatchKeyEvent (全局攔截)

@Override
public boolean dispatchKeyEvent(KeyEvent event) {
    if (event.getKeyCode() == KeyEvent.KEYCODE_BACK && event.getAction() == KeyEvent.ACTION_DOWN) {
        if (currentDialog != null && currentDialog.isShowing()) {
            // 委託給 Dialog 的 OnKeyListener,或直接處理
            return currentDialog.onKeyDown(keyCode, event); // 需 Dialog 繼承實現
        }
    }
    return super.dispatchKeyEvent(event);
}
  • 適用:全局統一處理多個 Dialog 的 Back 行為、或無法修改第三方庫 Dialog 代碼時。
  • 缺點:耦合度高、易誤攔截非 Dialog 場景的 Back 鍵。

五、最佳實踐模板:基類 DialogFragment

public abstract class BaseDialogFragment extends DialogFragment {
    private OnBackPressListener backPressListener;

    public interface OnBackPressListener {
        /** @return true 消費事件阻止關閉,false 允許關閉 */
        boolean onBackPressed();
    }

    public void setOnBackPressListener(OnBackPressListener listener) {
        this.backPressListener = listener;
    }

    @NonNull @Override
    public Dialog onCreateDialog(Bundle savedInstanceState) {
        AlertDialog dialog = (AlertDialog) super.onCreateDialog(savedInstanceState);
        dialog.setOnKeyListener((d, keyCode, event) -> {
            if (keyCode == KeyEvent.KEYCODE_BACK && event.getAction() == KeyEvent.ACTION_DOWN) {
                if (backPressListener != null) {
                    return backPressListener.onBackPressed();
                }
            }
            return false;
        });
        return dialog;
    }
}

// 使用
MyDialogFragment fragment = new MyDialogFragment();
fragment.setOnBackPressListener(() -> {
    if (hasUnsavedData()) {
        showSaveDialog();
        return true; // 阻止關閉
    }
    return false; // 允許關閉
});
fragment.show(getSupportFragmentManager(), "tag");

六、方案選擇決策表

需求推薦方案
單純執行取消邏輯 (埋點、清理)OnCancelListener
需阻止關閉 (未保存提示、二次確認)OnKeyListener + return true
全局統一處理、第三方 DialogActivity.dispatchKeyEvent
DialogFragment 體系、可複用基類封裝 OnKeyListener

根據業務語義選擇方案:取消語義用 OnCancelListener,攔截阻止語義用 OnKeyListener,避免濫用 dispatchKeyEvent 導致事件分發混亂。

copyright © 萬盛學電腦網 all rights reserved