跳过内容

@capgo/capacitor-webview-crash

原生 WebView 故障恢复、手动重启和长时间运行 Capacitor 应用程序的 WebView 回收。

该插件在前一个Capacitor WebView 进程死亡或被回收时存储一个本机标记,然后在应用程序恢复后将该标记暴露给下一个 JavaScript 运行时。它还可以在崩溃后、在固定的时间间隔内、在 cron 计划内或当 JavaScript 明确要求时从本机code 重启 WebView restartWebView()这有助于避免长时间会话期间的内存积累,适用于 kiosk、POS、仪表盘、扫描器和显示器应用程序。

  • 本机崩溃重启 - 在 iOS 或 Android 上重启 WebView renderer 进程死亡时
  • 定时重启 - 使用本机计时器在长时间运行的 WebView 上进行回收 restartIntervalMs 或墙钟 restartCron.
  • 手动本机重启 - 允许 JavaScript 请求一个新的本机 WebView restartWebView() 而无需进行页面重新加载
  • Capacitor配置 - 暴露 WebViewCrashPluginConfig 用于 plugins.WebViewCrashcapacitor.config.ts.
  • getPendingCrashInfo - 返回存储的本机崩溃或重启标记,或者 null 当没有任何标记时。
  • clearPendingCrashInfo - 在应用程序恢复其状态后清除存储的标记。
  • simulateCrashRecovery - 创建一个虚拟崩溃标记,以便在本地测试恢复流程。
  • addListener - 触发 webViewRestoredAfterCrash 用于崩溃标记和 webViewRestoredAfterRestart 用于任何本机重启标记。
方法描述
getPendingCrashInfo返回已存储的本机崩溃或重启标记,或者 null 当没有待处理的标记时。
clearPendingCrashInfo在应用程序恢复其状态后清除存储的标记。
simulateCrashRecovery创建一个模拟崩溃标记,以便在本地测试恢复流程。
restartWebView写入 reason: 'manualRestart' 并要求本机code创建一个新的 WebView。
addListener触发 webViewRestoredAfterCrashwebViewRestoredAfterRestart 当一个监听器附加并且匹配的标记仍在等待时。
removeAllListeners移除所有插件监听器。

配置类型

配置类型

该插件增强了Capacitor的 PluginsConfig 具有类型的 WebViewCrash 配置项:

export interface WebViewCrashPluginConfig {
restartOnCrash?: boolean;
restartIntervalMs?: number;
restartCron?: string;
restartAfterCrashDelayMs?: number;
}
  • 该插件检测 WebView 崩溃后的恢复。它不会阻止底层崩溃。
  • 恢复的 JavaScript 运行时是新的,因此在此 API 触发时,之前的 WebView 中的内存状态已经丢失了。
  • 预定重启写 reason: 'periodicRestart'手动重启写 reason: 'manualRestart'. 在启用短暂重启间隔、cron计划或调用之前,保存未保存的状态 restartWebView().
  • restartCron 使用设备本地时区的5个字段cron语法,例如 0 3 * * * 每天 03:00 重启。不要同时配置两个计划:当 restartCron 设置且 restartIntervalMs 大于 0.
  • 在 Android 上,额外的字段,如 didCrashrendererPriorityAtExit 可能可用。
  • 在 iOS 上,插件记录 appState 当终止的 WebView 过程被观察到时。手动和计划重启重建Capacitor桥接视图,因此创建一个新的 WKWebView Source Of Truth

This reference is synced from src/definitions.tscapacitor-webview-crash.

Keep going from @capgo/capacitor-webview-crash

Section titled “Keep going from @capgo/capacitor-webview-crash”

如果您正在使用 @capgo/capacitor-webview-crash 来规划原生媒体和界面行为,连接它与 使用 @capgo/capacitor-webview-crash 为原生能力在使用 @capgo/capacitor-webview-crash 中 使用 @capgo/capacitor-live-activities 为使用@capgo/capacitor-live-activities的原生能力, @capgo/capacitor-live-activities 为@capgo/capacitor-live-activities的实现细节, 使用@capgo/capacitor-video-player 为使用@capgo/capacitor-video-player的原生能力, 和 @capgo/capacitor-video-player 为@capgo/capacitor-video-player的实现细节,