开始
复制一个包含安装步骤和此插件的完整Markdown指南的设置提示。
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-webview-crash`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/webview-crash/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
安装
标题为“安装”您可以使用我们的 AI 助手设置来安装插件。将 Capgo 技能添加到您的 AI 工具中,使用以下命令:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins然后使用以下提示:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-webview-crash` plugin in my project.如果您prefer手动设置,安装插件并运行以下命令并遵循以下平台特定说明:
npm install @capgo/capacitor-webview-crashnpx cap sync导入
导入import { WebViewCrash } from '@capgo/capacitor-webview-crash';推荐恢复流程
推荐恢复流程尽早在应用启动时附加监听器,以便恢复的运行时可以在用户继续浏览之前反应:
import { WebViewCrash } from '@capgo/capacitor-webview-crash';
await WebViewCrash.addListener('webViewRestoredAfterCrash', async (info) => { console.log('Recovered after a WebView crash', info);
// Rehydrate critical state, reopen the correct screen, or prompt the user to retry. await WebViewCrash.clearPendingCrashInfo();});
await WebViewCrash.addListener('webViewRestoredAfterRestart', async (info) => { console.log('Recovered after a native WebView restart', info); await WebViewCrash.clearPendingCrashInfo();});
const pending = await WebViewCrash.getPendingCrashInfo();// Note: the listener callback may have already cleared the pending marker.if (pending.value) { console.log('Pending crash or restart marker', pending.value);}原生自动重启
原生自动重启在 capacitor.config.ts 以便决策在JavaScript运行时崩溃或尚未加载时仍然在原生code中:
import type { CapacitorConfig } from '@capacitor/cli';import type { WebViewCrashPluginConfig } from '@capgo/capacitor-webview-crash';
const webViewCrash: WebViewCrashPluginConfig = { // Enabled by default. Keep this on for long-running apps. restartOnCrash: true,
// Use a 5-field cron schedule in the device local timezone. // Do not combine restartCron with an active restartIntervalMs. restartCron: '0 3 * * *',
// Optional delay before restarting after a crash. restartAfterCrashDelayMs: 0,};
const config: CapacitorConfig = { plugins: { WebViewCrash: webViewCrash, },};
export default config;使用 restartIntervalMs 适用于 restartCron 的应用程序,用户可能会在同一个 0 3 * * * 中保持打开状态几天: reason: 'periodicRestart', then Android recreates the host activity and iOS rebuilds the Capacitor bridge view so a new WKWebView is created from native code.
的应用程序,例如 restartCron ,在设备本地时间区的 *重启。预定的重启写入一个等待标记, restartCron 重新创建宿主活动, restartIntervalMs 重建 0桥接视图,因此一个新的
手动原生重启
手动原生重启调用 restartWebView() 当当前 JavaScript 运行时决定原生 WebView 应该被替换时,例如在内存密集型工作流或进入长时间无人看管的会话之前:
await WebViewCrash.restartWebView();该方法写入一个待处理的标记符号 reason: 'manualRestart', 解决当前调用,然后要求原生 code 创建一个新的 WebView。Android 重建宿主活动。iOS 重建 Capacitor 桥视图,因此创建一个新的 WKWebView 而不是重新加载当前页面。
API概述
API概述getPendingCrashInfo
获取待处理的崩溃信息获取待处理的崩溃信息 null 当没有任何待处理的事项时。
const pending = await WebViewCrash.getPendingCrashInfo();if (pending.value) { console.log(pending.value.platform, pending.value.reason);}clearPendingCrashInfo
标题:清除待处理的崩溃信息在恢复处理完成后,清除存储的标记。
await WebViewCrash.clearPendingCrashInfo();simulateCrashRecovery
标题:模拟崩溃恢复创建一个虚拟崩溃标记,以便 QA 和本地调试可以在不崩溃真实 WebView 的情况下演练恢复路径。
const simulated = await WebViewCrash.simulateCrashRecovery();console.log(simulated.value);restartWebView
标题:重启 WebView存储一个手动重启标记,并要求本机 code 创建一个新的 WebView。
await WebViewCrash.restartWebView();平台说明
Platform notes- Android从
onRenderProcessGone包括didCrash和rendererPriorityAtExit当平台提供时 - iOS从
webViewWebContentProcessDidTerminate包括 - Manual and scheduled restarts create a fresh WebView. Android recreates the host activity; iOS rebuilds the Capacitor bridge view.
- 手动和预定重启创建一个新的WebView。Android重新创建宿主活动;iOS重建__CAPGO_KEEP_0__桥接视图。
reason: 'periodicRestart'预定重启使用reason: 'manualRestart'. - 手动重启使用
Web不检测真实渲染器崩溃。Web实现仅模拟本地存储的行为。
类型参考PendingCrashInfoResult
待处理崩溃信息结果export interface PendingCrashInfoResult { /** * Stored crash or restart metadata, or `null` when no marker is pending. */ value: WebViewCrashInfo | null;}WebViewCrashPluginConfig
WebView崩溃插件配置export interface WebViewCrashPluginConfig { /** * Restart the WebView from native code when the renderer process dies. * * @default true */ restartOnCrash?: boolean;
/** * Fixed native interval, in milliseconds, for proactively replacing long-running WebViews. * * Set to `0` to disable interval restarts. Do not combine an active interval * with `restartCron`; native initialization fails fast when both schedules are configured. * * @default 0 */ restartIntervalMs?: number;
/** * Cron schedule for proactively replacing long-running WebViews. * * Uses standard 5-field cron syntax in the device local timezone: * `minute hour day-of-month month day-of-week`. * * Examples: * - `0 3 * * *` restarts every day at 03:00. * - `0,30 * * * *` restarts every 30 minutes. * * Do not combine this with an active `restartIntervalMs`; native initialization * fails fast when both schedules are configured. */ restartCron?: string;
/** * Delay, in milliseconds, before restarting after a crash. * * @default 0 */ restartAfterCrashDelayMs?: number;}WebViewCrashInfo
WebView崩溃信息export interface WebViewCrashInfo { /** * Platform that detected and stored the marker. */ platform: WebViewCrashPlatform;
/** * Unix timestamp in milliseconds for when the marker was written. */ timestamp: number;
/** * ISO-8601 version of `timestamp`. */ timestampISO: string;
/** * Platform-specific reason for the crash or restart marker. */ reason: WebViewCrashReason;
/** * Last known WebView URL when the marker was written. */ url?: string;
/** * Android-only hint from `RenderProcessGoneDetail.didCrash()`. */ didCrash?: boolean;
/** * Android-only renderer priority reported at exit. */ rendererPriorityAtExit?: number;
/** * iOS-only application state captured when the WebView process died. */ appState?: WebViewCrashAppState;}WebViewCrashPlatform
WebView崩溃平台export type WebViewCrashPlatform = 'android' | 'ios' | 'web';WebViewCrashReason
WebView崩溃原因export type WebViewCrashReason = | 'renderProcessGone' | 'webContentProcessDidTerminate' | 'periodicRestart' | 'manualRestart' | 'simulated';WebViewCrashAppState
WebView崩溃应用状态export type WebViewCrashAppState = 'active' | 'inactive' | 'background' | 'unknown';真实数据来源
真实数据来源本页面由插件生成 src/definitions.ts当公共API在上游发生变化时,请重新同步。
继续从开始
继续从开始如果您正在使用 开始 为计划原生媒体和界面行为 Using @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的实现细节