跳到主要内容
版本：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 中的硬件返回按钮​

Ionic 通过在 IonicConfig 中设置 experimentalCloseWatcher: true，为在浏览器或 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 调用下一个返回按钮处理程序。

处理程序优先级是否传播描述
覆盖层100否适用于覆盖层组件 ion-action-sheet、ion-alert、ion-loading、ion-modal、ion-popover 和 ion-picker。
菜单99否适用于 ion-menu。
导航0是适用于路由导航（即 Angular 路由）。

目录

编辑此页