WebView データモニタリング¶
まず、以下の実行プラットフォームとパッケージ方式に従ってホスト設定を完了してから、Web ページを初期化してください。
Android はオフラインパッケージと uni ミニプログラムのシナリオのみをサポートします。
設定¶
通常の uni-app では、RUM 初期化時に設定します:
import { rum } from '@/uni_modules/GC-UniPlugin';
rum.setConfig({
enableTraceWebView: true,
allowWebViewHost: [
'example.com'
]
});
enableTraceWebView:WebView RUM ブリッジを有効にするかどうか。デフォルトはtrueです。allowWebViewHost:追跡を許可する WebView Host のリスト。未設定の場合はすべての Host を収集します。
通常の uni-app では、先に Mobile SDK と RUM の初期化を完了してから WebView を読み込む必要があります。uni ミニプログラムでは、ホスト App が SDK と RUM の初期化を完了するため、重複して初期化しないでください。
プラットフォームの説明¶
- Android および iOS では標準の
<web-view>を使用します。実際の機能は Native SDK とパッケージ方式によって異なります。 - HarmonyOS では、業務側が
WebviewControllerを保持しているかどうかに応じて、対応する統合方式を選択します。詳細はHarmonyOS 統合を参照してください。 - uni ミニプログラムの WebView 収集機能は、ホスト App に統合された Native SDK によって提供されます。Android ホストでは、さらに
ft-pluginをインストールして適用する必要があります。
HarmonyOS 統合¶
HarmonyOS の WebView Bridge は、対象ページを読み込む前にインストールする必要があります。業務側が WebviewController を保持しているかどうかに応じて、以下のいずれかの方式を選択してください。同じ WebView で 2 つの方式を同時に使用しないでください。
業務側が WebviewController を保持していない場合¶
通常の uni-app ページで WebviewController を直接管理しない場合、HarmonyOS プラットフォームではプラグインが提供するネイティブ埋め込みコンポーネント gcwebview を使用します。このコンポーネントは、コントローラーが利用可能になったときに Bridge を自動でインストールし、コンポーネントの破棄時に自動で解放します。
<!-- #ifdef APP-HARMONY -->
<embed
class="harmony-webview"
tag="gcwebview"
:options="{
src: webviewUrl,
viewName: 'order-detail'
}"
></embed>
<!-- #endif -->
<!-- #ifndef APP-HARMONY -->
<web-view :src="webviewUrl" />
<!-- #endif -->
src:読み込む Web ページのアドレス。viewName:オプションの Native RUM View 名。各業務 WebView に意味のある安定した名前を設定することを推奨します。未設定の場合はデフォルトでwebviewが使用されます。gcwebviewを使用する場合、rum.attachWebView()またはrum.detachWebView()を呼び出す必要はありません。
業務側が WebviewController を保持している場合¶
HarmonyOS ネイティブページ、UTS ネイティブ WebView、または uni ミニプログラムのホスト App で、業務コードが WebviewController を独自に保持している場合は、コントローラーの onControllerAttached コールバックで rum.attachWebView() を呼び出し、その時点で対象ページがまだ読み込まれていないことを確認してください:
Web({ src: webviewUrl, controller })
.onControllerAttached(() => {
rum.attachWebView(controller, 'order-detail');
});
WebView の破棄時に対応する Bridge を解放します:
rum.attachWebView() は、RUM の初期化が完了しており、かつ enableTraceWebView が true の場合にのみ有効になります。したがって、先に rum.setConfig() を実行してから、WebView を作成するかコントローラーをバインドしてください。ページの読み込み完了後にバインドすると、最初のドキュメントの Web RUM Bridge を逃します。
uni ミニプログラムのホスト App でこの方式を使用する前に、初回の uni ミニプログラム起動前にホスト拡張の registerNativeModules(context) 登録を完了する必要があります。
Web ページの初期化¶
上記のホスト設定を完了した後、ページの初期化に進み、次にWebView データの検証に従ってレポートを確認してください。
使用上の推奨事項¶
- 上記のページ初期化の説明に従って Web SDK の統合を完了します。
- Native SDK/RUM の初期化が完了してから WebView を読み込みます。
allowWebViewHostを使用して、ブリッジを許可する業務ドメインを制限します。- HarmonyOS では
gcwebviewと手動のattachWebView()方式のいずれか一方を選択します。 - Android、iOS、HarmonyOS の実機環境で、それぞれ WebView データと現在の RUM View の関連付けを検証します。