跳到主要内容
版本：v8

硬件返回按钮

硬件返回按钮存在于大多数 Android 设备上。在原生应用中，它可以用来关闭模态框、导航到上一个视图、退出应用等。在 Ionic 中，默认情况下，当按下返回按钮时，当前视图将从导航栈中弹出，并显示上一个视图。如果导航栈中不存在上一个视图，则不会发生任何操作。本指南将展示如何自定义硬件返回按钮的行为。

备注

硬件返回按钮指的是 Android 设备上的物理返回按钮，不应与浏览器返回按钮或 ion-back-button 混淆。本指南中的信息仅适用于 Android 设备。

概述​

在支持的环境中，当用户按下硬件返回按钮时，Ionic Framework 会触发 ionBackButton 事件。

监听 ionBackButton 事件时，你可以注册一个处理函数来执行操作。该处理函数可以执行诸如退出应用或打开确认对话框等操作。每个处理函数都必须分配一个优先级。默认情况下，每次按下硬件返回按钮仅触发一个处理函数。优先级值用于确定应调用哪个回调。这很有用，因为如果你打开了模态框，你可能不希望按下硬件返回按钮时模态框关闭_并且_应用向后导航。每次只运行一个处理函数，允许模态框关闭，但仍需要再次按下硬件返回按钮才能向后导航。

在某些情况下，你可能希望触发多个处理函数。每个处理函数回调都会接收一个函数作为参数，该函数可用于告诉 Ionic 调用下一个处理函数。

支持情况​

下表显示了硬件返回按钮支持在不同环境中的差异。

环境状态
Capacitor仅在安装了 @capacitor/app 包时支持。
Cordova支持
浏览器仅当 experimentalCloseWatcher 为 true 且平台支持 Close Watcher API 时支持。
PWA仅当 experimentalCloseWatcher 为 true 且平台支持 Close Watcher API 时支持。

在浏览器或 PWA 中的硬件返回按钮​

通过将 IonicConfig 中的 experimentalCloseWatcher 设为 true，Ionic 可以实验性地在浏览器或 PWA 中处理硬件返回按钮。启用此功能后，Ionic 将使用 Close Watcher API 将任何关闭请求传递给 ionBackButton 事件。这包括按下硬件返回按钮进行导航或按 Escape 键关闭模态框。

Chrome 从 Chrome 120 开始支持 Close Watcher。

为了获得完整的硬件返回按钮支持，我们建议使用 Capacitor 或 Cordova。

备注

如果 Close Watcher 不受支持或 experimentalCloseWatcher 为 false，在浏览器或作为 PWA 运行应用时，ionBackButton 事件将不会触发。

基本用法​

document.addEventListener('ionBackButton', (event) => {
  event.detail.register(10, () => {
    console.log('处理函数被调用！');
  });
});

在这个示例中，我们注册了一个处理函数，当按下硬件返回按钮时会被调用。我们将优先级设置为 10，并且没有指示框架我们希望调用下一个处理函数。因此，任何优先级低于 10 的处理函数将不会被调用。优先级大于 10 的处理函数将首先被调用。

如果存在具有相同优先级值的处理函数，则_最后_注册的处理函数将被调用。更多信息请参阅具有相同优先级的处理函数。

调用多个处理函数​

每个硬件返回按钮回调都有一个 processNextHandler 参数。调用此函数可以让你继续调用硬件返回按钮处理函数。

document.addEventListener('ionBackButton', (event) => {
  event.detail.register(5, () => {
    console.log('另一个处理函数被调用！');
  });

  event.detail.register(10, (processNextHandler) => {
    console.log('处理函数被调用！');

    processNextHandler();
  });
});

这个示例展示了如何指示 Ionic Framework 你希望触发下一个处理函数。所有回调都提供了一个 processNextHandler 函数作为参数。调用此函数将导致下一个处理函数（如果存在）被触发。

具有相同优先级的处理函数​

在内部，Ionic Framework 使用了类似于优先级队列的机制来管理硬件返回按钮处理函数。优先级值最大的处理函数将首先被调用。如果存在多个具有相同优先级值的处理函数，则_最后_添加到队列中的相同优先级的处理函数将首先被调用。

document.addEventListener('ionBackButton', (event) => {
  // 处理函数 A
  event.detail.register(10, (processNextHandler) => {
    console.log('处理函数 A 被调用！');

    processNextHandler();
  });

  // 处理函数 B
  event.detail.register(10, (processNextHandler) => {
    console.log('处理函数 B 被调用！');

    processNextHandler();
  });
});

在上面的示例中，处理函数 A 和 B 的优先级都是 10。由于处理函数 B 是最后注册的，Ionic Framework 将在调用处理函数 A 之前调用处理函数 B。

退出应用​

在某些情况下，可能希望在按下硬件返回按钮时退出应用。这可以通过结合使用 ionBackButton 事件和 Capacitor/Cordova 提供的方法来实现。

import { BackButtonEvent } from '@ionic/core';
import { App } from '@capacitor/app';

...

const routerEl = document.querySelector('ion-router');
document.addEventListener('ionBackButton', (event: BackButtonEvent) => {
  event.detail.register(-1, () => {
    const path = window.location.pathname;
    if (path === routerEl.root) {
      App.exitApp();
    }
  });
});

这个示例展示了当用户按下硬件返回按钮且导航栈中没有任何内容时，应用将退出。也可以在退出应用之前显示确认对话框。

建议在退出应用之前检查用户是否在根页面。开发者可以在 Ionic Angular 中使用 IonRouterOutlet 的 canGoBack 方法，在 Ionic React 和 Ionic Vue 中使用 IonRouter 的 canGoBack 方法。

内部框架处理函数​

下表列出了 Ionic Framework 使用的所有内部硬件返回按钮事件处理函数。Propagates 列记录了该特定处理函数是否指示 Ionic Framework 调用下一个返回按钮处理函数。

处理函数优先级是否传播描述
Overlays100否适用于覆盖组件 ion-action-sheet、ion-alert、ion-loading、ion-modal、ion-popover 和 ion-picker。
Menu99否适用于 ion-menu。
Navigation0是适用于路由导航（例如 Angular Routing）。

Contents

编辑此页