Reactで、ページを閉じる直前にデータを送る方法

​​React​Page Visibility API,Playwright,sendBeacon,TypeScript,useEffectEvent

ページを閉じる直前や、別のページへ移る直前にサーバーへデータを送るには、visibilitychange イベントで document.visibilityState が hidden になったときに、navigator.sendBeacon() を呼びます。記事をどこまで読んだか(読了率)や閲覧時間のような、アクセス解析のデータを離脱のときに送る場面で使います。

React では、イベントの登録を useEffect で行い、送る値は useEffectEvent で最新の state から読みます。私は検証環境で、リンクで移動したときと、ページを閉じたときに、データがサーバーに届くことを確かめました。あわせて、まちがえやすい書き方で何が起きるかと、sendBeacon() の制限も試しました。

補足

検証環境は Ubuntu 24.04、Node.js 22.23.4、React / react-dom 19.3.1、TypeScript 7.0.2 です。コードは tsc で型チェックしてから esbuild でまとめ、StrictMode で囲んだ開発ビルドを、Playwright 1.63.0 で操作したヘッドレスの Chromium 153 で開きました。データを受け取るサーバーは、検証環境の中で動かした Node.js のサーバーです。タブの切り替えやウィンドウの最小化はこの検証環境では再現できなかったため、試したのは「リンクで別のページへ移る」と「ページを閉じる」の2つだけです。Firefox や Safari、スマートフォンのブラウザ、実際のインターネット越しの送信、React Router などによる画面の切り替え(ページの読み込みが起きない移動)も試していません。

記事のページを3回スクロールしてからリンクで移動すると、サーバーに読んだ割合が届く
上が実際のページ、下がサーバーが受け取ったデータ。リンクで次のページへ移った瞬間に、そのとき表示していた43%が届く(本文の検証より画面の高さが低いため、割合は本文と違う)。カーソルと回数の表示は、あとから重ねたもの

送るきっかけは visibilitychange にする

MDN の sendBeacon() のページは、ページを使い終わったときにデータを送るなら、visibilitychange イベントで送るのがいちばん確実だとしています。unload・beforeunload・pagehide は、特にスマートフォンでは起きないことがあります。たとえば、ほかのアプリに切り替えたあと、アプリの一覧からブラウザを終了した場合です。

MDN の visibilitychange イベントのページによると、hidden への変化は、ページから確実に知ることができる最後のイベントです。別のページへ移る、タブを切り替える、タブを閉じる、ブラウザを最小化する・閉じる、スマートフォンでほかのアプリに切り替える、のどれでも起きます。

検証環境の Chromium で、3つのイベントそれぞれから sendBeacon() で送ると、次の順で3つとも届きました。別の URL を開いて移動した場合も、ページを閉じた場合も同じです。pagehide の時点では、visibilityState はまだ visible でした。

text
1:beforeunload:visible / 2:pagehide:visible / 3:visibilitychange:hidden

ページが隠れたときに送るフック

フックは次のとおりです。ページが隠れたときに getBody() を呼び、返ってきたデータを url へ送ります。

ts
import { useEffect, useEffectEvent } from 'react';

// ページが見えなくなったときに、getBody() の結果を url へ送る
export function useSendOnHide(url: string, getBody: () => BodyInit | null) {
  // 呼ばれた時点の、いちばん新しい props や state で getBody を呼ぶ
  const onHide = useEffectEvent(() => {
    const body = getBody();
    if (body === null) return;
    const queued = navigator.sendBeacon(url, body);
    if (!queued) console.warn('sendBeacon が送信を受け付けませんでした');
  });

  useEffect(() => {
    const onVisibilityChange = () => {
      if (document.visibilityState === 'hidden') onHide();
    };
    document.addEventListener('visibilitychange', onVisibilityChange);
    return () => document.removeEventListener('visibilitychange', onVisibilityChange);
  }, [url]);
}

イベントの登録と解除は useEffect で行い、送る中身を作る処理は useEffectEvent で包んでいます。公式リファレンスの useEffectEvent の説明によると、useEffectEvent で作った関数は、呼ばれた時点の最新の props や state を読みます。依存配列にも入れません。そのため、state が変わるたびにイベントを登録し直さなくても、ページが隠れた時点の値を送れます。公式リファレンスには、自作のフックの中で useEffectEvent を使う例(useInterval)も載っています。

使う側は、送りたいデータを返す関数を渡すだけです。次の例では、記事のページで、どこまで読んだか(いちばん下までスクロールしたら100%)を送ります。

tsx
import { useEffect, useState } from 'react';
import { useSendOnHide } from './useSendOnHide';

// 読んだ割合(いちばん下までスクロールしたら 100)
function useReadPercent() {
  const [percent, setPercent] = useState(0);
  useEffect(() => {
    const onScroll = () => {
      const max = document.documentElement.scrollHeight - window.innerHeight;
      const now = Math.round((window.scrollY / max) * 100);
      setPercent((p) => Math.max(p, now));
    };
    window.addEventListener('scroll', onScroll, { passive: true });
    return () => window.removeEventListener('scroll', onScroll);
  }, []);
  return percent;
}

function ArticlePage() {
  const percent = useReadPercent();
  useSendOnHide('/log', () => JSON.stringify({ page: '/articles/1', percent }));
  return (
    <p>
      読んだ割合:<output>{percent}</output>% <a href="/next">次のページへ</a>
    </p>
  );
}

検証で使ったページには、このほかにスクロールするための本文の段落があります。検証環境で、画面に「48%」と表示されるまでスクロールしてから、リンクで別のページへ移ったところ、サーバーには次のデータが届きました。ページを閉じた場合も、同じデータが届きました。

text
{"page":"/articles/1","percent":48}

MDN の visibilitychange イベントのページにあるとおり、visibilitychange はタブを切り替えたときにも起きます。このフックは hidden になるたびに送るので、タブを切り替えて戻る操作を繰り返すと、1回の閲覧で何度も送られます。この例では「読んだ割合」は増えるだけの値なので、サーバー側では、同じ閲覧から届いた値のうち最大のものを使えば済みます。

依存配列を空にすると、最初の値が送られる

useEffectEvent を使わずに、useEffect の中のイベントで state を直接読み、依存配列を空にすると、古い値が送られます。

tsx
function ArticlePage() {
  const percent = useReadPercent();
  useEffect(() => {
    const onVisibilityChange = () => {
      if (document.visibilityState === 'hidden') {
        navigator.sendBeacon('/log', JSON.stringify({ page: '/articles/1', percent }));
      }
    };
    document.addEventListener('visibilitychange', onVisibilityChange);
    return () => document.removeEventListener('visibilitychange', onVisibilityChange);
  }, []); // まちがい:percent を使っているのに、依存配列が空
  // ...
}

同じように48%までスクロールしてから移動すると、サーバーに届いたのは0%でした。

text
{"page":"/articles/1","percent":0}

イベントに登録した関数は、最初の描画のときに作られたものです。その関数が覚えている percent は、最初の描画のときの 0 のまま変わりません。画面には48%と表示されていても、送られるのは0%です。

登録を解除しないと、開発中は2回送られる

useEffect から、removeEventListener する関数を返さない書き方も試しました。

tsx
useEffect(() => {
  // まちがい:removeEventListener する関数を返していない
  document.addEventListener('visibilitychange', () => {
    if (document.visibilityState === 'hidden') onHide();
  });
}, []);

リンクで移動したときに届いた数は、次のとおりでした。

書き方 StrictMode あり StrictMode なし
登録を解除しない 2件 1件
この記事のフック 1件 1件

公式リファレンスの StrictMode の説明にあるとおり、開発中の StrictMode は、どの Effect でも、実行(setup)と片付け(cleanup)を1回余分に行います。片付けの関数がないので、イベントが2つ登録されたままになり、データも2回送られました。公式リファレンスは、この動きを、片付けの書き忘れを見つけるためのものとしています。

送るデータの形で、Content-Type が変わる

sendBeacon() には、文字列のほか、Blob・URLSearchParams・FormData などを渡せます(MDN の sendBeacon() のページ)。検証環境で、同じオリジンのサーバーに送ったときの Content-Type は次のとおりでした。送る方法はいずれも POST です。

渡したもの サーバーが受け取った Content-Type
JSON.stringify() した文字列 text/plain;charset=UTF-8
type: 'application/json' の Blob application/json
URLSearchParams application/x-www-form-urlencoded;charset=UTF-8
FormData multipart/form-data; boundary=…

JSON の文字列をそのまま渡すと、Content-Type は text/plain になります。サーバー側で Content-Type を見て JSON として読む作りなら、Blob に包んで application/json を指定します。ただし、送り先が別のオリジンのときは、次の節の問題が起きます。

別のオリジンへ JSON の Blob を送ると、届かないことがある

アクセス解析のサーバーが、ページとは別のオリジンにあることもあります。検証環境で、CORS のヘッダーを返さない別のオリジン(localhost:3001)へ送ると、結果は次のとおりでした。

text
戻り値 [["文字列",true],["Blob(application/json)",true]]
3001 POST /log/string | text/plain;charset=UTF-8 | origin http://localhost:3000 | {"percent":48}
3001 OPTIONS /log/blob | null | origin http://localhost:3000 | 

文字列はそのまま POST で届きました。application/json の Blob は、先に OPTIONS のリクエスト(プリフライト)が届いただけで、データを載せた POST は届きませんでした。

Beacon の仕様では、Content-Type が、CORS の確認なしで送れる値(text/plain など)でないときは、CORS のモードで送ります。仕様のプライバシーとセキュリティの節によると、このときはプリフライトが行われ、送り先のサーバーが Access-Control-Allow-Origin などのヘッダーで許可を返す必要があります。

注意

このとき sendBeacon() は true を返しました。true は「送信の予約を受け付けた」という意味で、届いたことは表しません。別のオリジンへ application/json で送るなら、送り先のサーバーが CORS の許可を返すことを確かめてください。

64KiB を超えるデータは送れない

MDN によると、sendBeacon() で送信を待っているデータの合計は 64KiB(65,536バイト)までで、受け付けられなかったときは false が返ります。検証環境の結果は次のとおりでした。

text
{"65536 バイト":true,"65537 バイト":false}
40000 バイトを続けて2回 [true,false]
fetch keepalive で 65537 バイト TypeError: Failed to fetch

65,536バイトは受け付けられ、1バイト多いと false でした。40,000バイトを続けて2回送ると、2回目は false になりました。Fetch の仕様では、まだ送り終わっていない keepalive のリクエストの分も合わせて、64KiB を超えるかどうかを判断します。Beacon の仕様には、sendBeacon() は fetch() の keepalive と同じ上限を共有すると書かれています。そのため、false が返ったときに fetch() の keepalive で送り直しても、上限は増えません。検証環境では、keepalive を付けた fetch() でも、1回で 65,537バイトを送ると失敗しました。

フックでは、false が返ったときにコンソールに警告を出しています。

ポイント

sendBeacon() で送るのは、64KiB に収まる小さなデータにします。同じタイミングでほかの送信もあると、その分も合計に数えられます。

fetch の keepalive を使う場合

MDN の fetch() のオプションの説明によると、keepalive: true を付けた fetch() は、ページが閉じられてもブラウザが中止しません。POST 以外のメソッドを使いたいとき、ヘッダーなどを細かく決めたいとき、サーバーからの応答を受け取りたいときは、sendBeacon() の代わりにこちらを使います。

ts
fetch('/log', { method: 'POST', body, keepalive: true });

検証環境では、keepalive を付けた fetch() も、付けない fetch() も、移動したときと閉じたときの両方でサーバーに届きました。Chrome DevTools Protocol でネットワークに1秒の遅延を入れても、結果は同じでした。ただし、ページが閉じたあとも送信を続けると MDN が説明しているのは、keepalive を付けた場合です。付けない fetch() が届いたのは、この検証環境での結果です。

​Posted by 86