【PHP8.x】session_write_close関数の使い方

<?php

/**
 * セッションロックを早期に解放し、並行処理を可能にするデモンストレーション関数。
 *
 * この関数は、PHPのセッションファイルがどのようにロックされ、
 * `session_write_close()` がそのロックを早期に解除することで、
 * 複数のリクエストが同じセッションに同時にアクセスできるようにする方法を示します。
 *
 * `session_write_close()` がないと、セッションを開始したスクリプトが終了するまで、
 * 同じセッションIDを持つ他のスクリプトはセッションロックのために待たされます。
 * これが「session_write_close not working」というキーワードが指す問題の一つ、
 * つまりセッションロックが解除されない、または意図したタイミングで解除されない状況を防ぎます。
 */
function demonstrateSessionWriteClose(): void
{
    // セッションを開始します。
    // これにより、セッションファイルがロックされ、セッションデータが読み込まれます。
    session_start();

    // セッション変数に値を設定または更新します。
    $_SESSION['last_access_time'] = time();
    $_SESSION['access_count'] = ($_SESSION['access_count'] ?? 0) + 1;

    echo "セッションが開始され、データが書き込まれました。<br>";
    echo "現在のセッションID: " . session_id() . "<br>";
    echo "最終アクセス時刻: " . date('Y-m-d H:i:s', $_SESSION['last_access_time']) . "<br>";
    echo "アクセス回数: " . $_SESSION['access_count'] . "<br>";

    // session_write_close() を呼び出すことで、
    // 1. 現在のセッションデータをセッションストレージ（通常はファイル）に保存します。
    // 2. セッションファイルに対するロックを解除します。
    // これにより、このスクリプトがまだ実行中であっても、他のPHPスクリプトが
    // 同じセッションにアクセスできるようになり、並行性が向上します。
    session_write_close();

    echo "<br>--- session_write_close() が呼び出されました ---<br>";
    echo "セッションデータは保存され、セッションロックは解除されました。<br>";
    echo "この時点で、他のリクエストは同じセッションにアクセスできます。<br>";
    echo "この後の処理は、セッションロックを保持する必要がありません。<br>";

    // ここから、セッションデータにアクセスする必要のない、長時間かかる処理をシミュレートします。
    // 例えば、外部APIへのリクエスト、重いデータベースクエリ、ファイルのアップロード処理など。
    echo "<br>セッションロック解除後、長時間かかる処理をシミュレートします (3秒間スリープ)...<br>";
    sleep(3); // 3秒間処理を停止

    echo "<br>長時間かかる処理が完了しました。<br>";
    echo "スクリプトの実行を終了します。<br>";

    // 注: session_write_close() の呼び出し後は、$_SESSION 変数への変更は
    // セッションに保存されません。読み取りは可能ですが、データは session_write_close()
    // 呼び出し時点のもので固定されます。
    // 例えば、以下の行は$_SESSION['access_count']をインクリメントしますが、
    // この変更はセッションストレージには保存されません。
    // $_SESSION['access_count']++;
    // echo "更新しようとしたアクセス回数 (保存されない): " . $_SESSION['access_count'] . "<br>";
}

// 関数を実行します。
demonstrateSessionWriteClose();

session_write_close() 関数は、PHPのセッション管理において、セッションのデータ保存とロック解除を制御するために使用されます。通常、session_start() を呼び出すとセッションが開始され、セッションファイルがロックされ、そのセッションへの変更はスクリプトの実行が終了するまで保存されません。また、セッションロックは、同じセッションIDを持つ他のリクエストがセッションデータにアクセスするのを一時的にブロックし、データの不整合を防ぎます。

しかし、セッションデータへのアクセスが不要になった後もスクリプトが長時間実行される場合、このセッションロックが他のリクエストの処理を妨げ、システムの応答性を低下させる原因となります。このような状況で「php session_write_close not working」と感じることがありますが、それはセッションロックが意図しないタイミングで維持されているためです。

session_write_close() は引数を取らず、現在のセッションデータを直ちにセッションストレージ（通常はファイル）に書き込み、同時にセッションファイルに対するロックを解除します。これにより、スクリプトがまだ実行中であっても、他のPHPスクリプトが同じセッションにアクセスできるようになり、並行処理が可能になります。この関数は、処理の成功時に true、失敗時に false を戻り値として返します。ただし、一度 session_write_close() を呼び出すと、その後 $_SESSION 変数を変更しても、その変更はセッションに保存されませんので注意が必要です。