メインコンテンツへスキップ
@capgo/capacitor-webview-crash 認証とセキュリティ オープンソース

WebViewのクラッシュ Capacitor プラグイン

クラッシュした WebView をネイティブで再起動し、長時間実行中の WebView を一定間隔でリサイクルします

インストール

bun add @capgo/capacitor-webview-crash bunx cap sync
npm、pnpm、または yarn
  • npm install @capgo/capacitor-webview-crash
  • pnpm add @capgo/capacitor-webview-crash
  • yarn add @capgo/capacitor-webview-crash

ガイド

Capacitor で WebView Crash を使う方法

実機でテストする

Capgo アプリをダウンロードして、QR code をスキャンしてください。

WebView Crash プラグインのプレビュー QR code

@capgo/capacitor-webview-crash を使用

WebView のクラッシュ復旧を検出し、停止した WebView をネイティブに再起動。メモリプレッシャーが OOM になる前に、長時間稼働する WebView を一定間隔でリサイクルします。

インストール

npm install @capgo/capacitor-webview-crash
npx cap sync

このプラグインで利用可能な機能

  • iOS/Android での WebView クラッシュ後のネイティブ再起動。
  • 数日間稼働するキオスク、POS、サイネージ、スキャナー、ダッシュボードアプリ向けの、一定間隔でのネイティブ WebView 再起動。
  • restartWebView - ページのリロードなしで、JavaScript から新しいネイティブ WebView をリクエストできます。
  • WebViewCrashPluginConfig - 型 plugins.WebViewCrash のオプション capacitor.config.ts.
  • getPendingCrashInfo - 保存されたネイティブのクラッシュまたは再起動マーカーを返します。または null null を返します。
  • clearPendingCrashInfo - アプリが状態を復元した後に、保存されたマーカーをクリアします。
  • simulateCrashRecovery - 回復フローをローカルでテストできるように、偽のクラッシュマーカーを作成します。
  • webViewRestoredAfterCrash - 復元されたランタイムに未処理のクラッシュマーカーがある場合に発火するリスナーイベント。
  • webViewRestoredAfterRestart - 未処理のネイティブ再起動マーカーがある場合に発火するリスナーイベント。

使用例

import { WebViewCrash } from '@capgo/capacitor-webview-crash';

await WebViewCrash.addListener('webViewRestoredAfterCrash', async (info) => {
  console.log('Recovered after a WebView crash', info);
  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);
}

Nativeの自動再起動

再起動の動作を以下で設定します capacitor.config.ts JavaScript が利用できない場合でも動作を維持できるようにします:

import type { CapacitorConfig } from '@capacitor/cli';
import type { WebViewCrashPluginConfig } from '@capgo/capacitor-webview-crash';

const webViewCrash: WebViewCrashPluginConfig = {
  restartOnCrash: true,
  restartCron: '0 3 * * *',
  restartAfterCrashDelayMs: 0,
};

const config: CapacitorConfig = {
  plugins: {
    WebViewCrash: webViewCrash,
  },
};

export default config;

スケジュール再起動の書き込み reason: 'periodicRestart'. 入力が不正な場合は、 restartIntervalMs 固定間隔の場合 restartCron または、デバイスのローカルタイムゾーンで5フィールドのcronスケジュールの場合、例えば 0 3 * * * 毎日03:00に再起動する場合。両方のスケジュールを同時に設定しないでください: restartCron が設定されており、 restartIntervalMs が 0より大きい場合、ネイティブ初期化時に致命的な設定エラーが発生します。短いスケジュールを使用する前に、重要なアプリ状態を永続化してください。

Nativeの手動再起動

呼び出す restartWebView() JavaScriptがネイティブWebViewを能動的に置き換えるべきと判断した場合、例えばメモリ負荷の高いワークフローの後:

await WebViewCrash.restartWebView();

このメソッドは書き込みます reason: 'manualRestart' ネイティブの code に新しい WebView の作成を要求します。Android ではホストアクティビティが再作成され、iOS では Capacitor ブリッジビューが再構築されて新しい WKWebView WebViewが作成されるようにします。

リファレンス全文

@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. の使い方」のネイティブ機能については

よくある質問

WebView CrashプラグインのFAQ

CapacitorアプリにWebView Crashプラグインをインストールするには?

"bun add @capgo/capacitor-webview-crash"(または"npm install @capgo/capacitor-webview-crash")を実行し、続けて"bunx cap sync"を実行すると、iOSとAndroidのプロジェクトにネイティブのcodeが反映されます。あとはアプリのcodeで"@capgo/capacitor-webview-crash"からインポートしてください。

@capgo/capacitor-webview-crashはReact、Vue、Angularで動作しますか?

はい。WebView CrashはCapacitorパッケージなので、Ionic、React、Vue、Angular、Svelte、素のJavaScriptなど、Capacitor上で動くあらゆるWebフレームワークで動作します。

@capgo/capacitor-webview-crash はどの Capacitor バージョンをサポートしていますか?

Capgo プラグインは Capacitor のメジャーバージョンに合わせています。使用している Capacitor のメジャーバージョンに一致するプラグインのメジャーバージョンを使ってください (例: Capacitor 8 ならプラグイン v8)。GitHub の README にある互換性テーブルに、メンテナンス中のバージョンが記載されています。

@capgo/capacitor-webview-crash は無料でオープンソースですか?

はい。ソースcodeは https://github.com/Cap-go/capacitor-webview-crash/ のGitHubで公開されており、npmから無料でインストールできます。バグ報告やプルリクエストをお待ちしています。

App Storeのレビューなしで、WebView Crashを使用しているcodeを更新できますか?

プラグインのインストールやアップグレードはネイティブの code を変更するため、新しいストアビルドが必要です。その後は、プラグインを呼び出す JavaScript、HTML、CSS の変更を Capgo Live Updates で即座に配信できます。

アプリのレビューを待たずに WebView Crash の変更をリリース

プラグインをストア用ビルドに組み込めば、Capgo live updates で JavaScript、HTML、CSS の変更を数分でユーザーに配信できます

Capgo から始める