概要
KaizenPlatformのJavaScriptコードはオプションとして Speculation Rules API を利用した「リンク先読み (prefetch)」機能を提供しています。ユーザーがリンクにマウスホバー(デスクトップ)またはタップ開始(モバイル)するなどの操作シグナルを検出した段階で、遷移候補ページの HTML ドキュメントを事前取得し、実際にクリック/タップしてナビゲーションが発生した際の初期表示を短縮します。
このページではリンク先読み機能の設定方法、および技術的な詳細について記述します。
システム要件
ブラウザ対応状況
- 対応ブラウザ: Chrome、Edge、Opera (Speculation Rules APIをサポートするブラウザ)
- 対応状況の確認: MDN Web Docs - Speculation Rules API] の
prefetch key行を参照
前提条件
- KaizenPlatformのJavaScriptコードが対象ページに実装されていること
- リンク先読み機能が有効化されていること
- 設定条件に合致するリンクが存在すること
設定手順
機能の有効化
-
サイドバーの「サイト改善」から「リンク先読み」を選択します。
-
「リンク先読み機能を有効にする」チェックボックスをオンにします。
- 下記の設定項目を入力後、「保存する」ボタンをクリックします。
注意: デフォルトでは無効になっています。有効化する前に、以下の設定項目を適切に構成してください。誤設定により不要なページや状態変更系URL(例: /logout)を先読みしてしまうと副作用が発生する場合があります。
設定項目
対象ページURL(正規表現)
リンク先読み機能を適用するページのURLパターンを正規表現で指定します。
- 完全なURL(スキーム、ホスト、パス、クエリパラメータ、フラグメントを含む)に対してマッチングが行われます。
- 例:
^https://example\.com/products/.*$
- 例:
- 指定パターンに合致しないページでは、リンク先読み機能は動作しません。
先読みを有効にするリンクパターン(ホワイトリスト)
先読みを許可するリンクのURLパターンをワイルドカード形式で指定します。
-
/から始まる文字列でURLのパス部分を指定します。 - クエリパラメータ(
?以降)やフラグメント(#以降)は評価対象外です。 - 任意の文字列にマッチするワイルドカード
*が使用可能です。- 例:
/products/*,/category/*/items*.html
- 例:
- 後述のブラックリストのいずれにも該当せず、かつこのホワイトリストのいずれかに該当するリンク先が先読みの対象となります。
先読みを無効にするリンクパターン(ブラックリスト)
先読みを禁止するリンクのURLパターンをワイルドカード形式で指定します。
- ホワイトリストと同様の形式で指定します。
- 例:
/logout*,/admin/*,/api/*
- 例:
- ブラックリストのいずれか一つでも該当するリンクは対象外となります。
- ホワイトリストとブラックリストの両方に該当する場合、ブラックリストが優先されます。
リンク先読み機能の詳細について(エンジニア向け)
機能の仕組み
この機能は Chrome 等のブラウザに搭載された Speculation Rules API を利用して実現されています。「対象ページURL(正規表現)」に該当するページへのアクセス時に <script type="speculationrules"> タグを動的に埋め込みます。
Chrome をお使いの場合、このタグが埋め込まれたページで DevTools を開いて「Application」タブ→「Speculation loads」→「Speculations」から、対象となるリンク先や先読み状況を確認できます。
先読みが発動する条件
対象要素とトリガー
-
デスクトップ:
<a>タグや<area>タグにマウスカーソルを重ねた(ホバーした)際に発動します。 - モバイル: リンクをタップした瞬間に先読みが開始され、指を離すと先読みしたキャッシュを使用してページ遷移します。
注意事項
- キーボードの Tab キーでフォーカスした場合は発動しません。
-
<form>タグや<link>タグなどは現在対象外です。
先読みされるリンクについて
対象となるリンク
-
<a>タグや<area>タグのhref属性で指定されたURLが先読みされます。 - 設定されたホワイトリストのいずれかにマッチするURLのみが対象となります。
-
target=_blank等の別タブで開くリンクについても先読みの対象となります。
対象外となるケース
-
href属性がjavascript:やmailto:などの特殊なスキームの場合。 - 設定されたブラックリストのいずれかに該当するURLの場合。
注意事項
- マウスホバー時点で
href属性に記載されたURLが先読みされますので、onclick等で後から遷移先を変更している場合には効果がありません。 -
onclick属性やping属性の動作には影響しません。
リンクパターンの設定について
パス指定の推奨方法
-
推奨:
/から始まる絶対パスで指定してください(例:/products/*) - 非推奨: 相対パスでの指定(全ページで共通設定のため困難)
- 非推奨: 別ホストの指定(制約が大きいため)
ワイルドカード使用方法
-
*は0個以上の任意の文字にマッチします。 - パターンは完全一致で評価されます。
- 例:
/example*.htmは/example.htmにマッチしますが、/example.htmlにはマッチしません。
- 例:
キャッシュの動作について
Cookie の扱い
- 先読みリクエスト送信時には通常通り Cookie が送信され、レスポンス時には
set-cookieによる cookie の更新もその時点で行われます。 - リンク先が別ホストの場合、その別ホストで Cookie が未発行の場合のみ先読みされます。
キャッシュの有効範囲と期限
- スコープ: タブごとに独立(他のタブのキャッシュは使用されません)
- 有効期限: 300秒(5分間)固定
- 容量制限: 同時に2つのページまでキャッシュ可能(タブごとに2ページまで)
キャッシュのクリア条件
- ページ遷移が発生した時点でクリアされます。
- SPAのように実際のページ遷移を行わずURLだけ更新する場合はクリアされません。
重複リクエストの防止
- 同一の
href属性を持つリンクは重複してリクエストされません。 - ただし、クエリパラメータやフラグメントが異なる場合は別々にリクエストしてキャッシュされます。
エラーハンドリング
- 2xx以外のステータスコードが返された場合はキャッシュされません。
- エラーが発生したURLは、同一タブ内では再度ホバーしても先読みされません。
キャッシュ制御ヘッダーについて
- レスポンスヘッダーの
Cache-Control: no-cache等のキャッシュ制御は無視されます。 -
Vary: Cookieヘッダーが設定されていても、Cookie変更後でもキャッシュが使用されます。
JavaScript APIとの関係
-
fetch()API などのJavaScriptによるアクセスでは、先読みキャッシュは使用されません。 - 同一URLがキャッシュされていても、通常通りリクエストが送信されます。
不具合を起こす可能性のあるリンクについて
GETリクエストで状態変更を伴うリンク
- 例: GETリクエストでログアウト場合、マウスホバーしただけでログアウトしてしまう可能性があります。
- ブラックリスト設定例:
/*logout*,/*signout*
- ブラックリスト設定例:
- 例: GETリクエストで削除が可能な場合、マウスホバーだけで削除されてしまう可能性があります。
- ブラックリスト設定例:
/*delete*,/*remove*
- ブラックリスト設定例:
ワンタイムトークンを使用するリンク
- トークンが先読み時に消費され、実際のクリック時に無効になる場合があります。
- ブラックリスト設定例:
/*token=*
- ブラックリスト設定例:
課金や決済に関するリンク
- 予期しない課金やセッション状態の異常が発生する可能性があります。
- ブラックリスト設定例:
/*payment*,/*checkout*/,/purchase/*
- ブラックリスト設定例:
内容が動的に生成されるリンク
- URLは変わらないまま、内容が動的に変わるリンク先の場合、リンクホバーから実クリックまでのタイムラグや状態変化によって、本来より古い内容のキャッシュが返される可能性があります。
- 具体的には、サーバー側で現在時刻やセッションの情報等によってリンク先の内容が変わるようなリンク先が対象となります。
- ブラックリスト設定例:
/*notification*,/*download*
0 コメント