［PHP］flush関数徹底解説 – 出力バッファリングの制御テクニック

PHPの出力処理を制御する重要な関数であるflush()について、実践的な使い方から内部動作まで詳しく解説します。

flush関数の基本
1. 基本構文
出力バッファリングの仕組み
基本的な使用例
実践的なユースケース
flush()の制限と注意点
1. サーバー設定の影響
2. 主な制限事項
効果的な使用方法
1. ob_flush()とflush()の組み合わせ
2. Apache固有の最適化
パフォーマンスへの影響
よくある問題とトラブルシューティング
1. 問題: flush()が効果を発揮しない
まとめ

flush関数の基本

flush()は、PHPの出力バッファに蓄積されたデータをクライアントに送信するよう、PHPに指示する関数です。

基本構文

void flush ( void )

出力バッファリングの仕組み

PHPは通常、出力を一度にまとめて送信するために内部バッファを使用します。flush()関数は、このバッファの内容を強制的に送信するよう試みます。

基本的な使用例

<?php
echo "処理を開始します...<br>";
flush();
sleep(2);
echo "2秒経過しました...<br>";
flush();
sleep(2);
echo "処理が完了しました!";

このコードは、メッセージを表示して2秒待機するという処理を、進行状況をリアルタイムに表示しながら実行します。

実践的なユースケース

例1: 長時間実行処理の進捗表示

<?php
// 出力バッファリングを無効化（flush()をより効果的にするため）
ob_implicit_flush(true);
ob_end_flush();

echo "<div id='progress'>処理を開始します...</div>\n";
flush();

$total_items = 100;
for ($i = 1; $i <= $total_items; $i++) {
    // 時間のかかる処理をシミュレート
    usleep(100000); // 0.1秒

    // 進捗状況を更新
    $percent = round(($i / $total_items) * 100);
    echo "<script>document.getElementById('progress').innerHTML = 
          '処理中... {$percent}% 完了 ({$i}/{$total_items})';</script>\n";
    flush();
}

echo "<script>document.getElementById('progress').innerHTML = 
      '処理が完了しました!';</script>\n";

例2: ファイルダウンロードの進捗表示

<?php
$file = 'large_file.dat';
$filesize = filesize($file);

header('Content-Description: File Transfer');
header('Content-Type: application/octet-stream');
header('Content-Disposition: attachment; filename="'.basename($file).'"');
header('Expires: 0');
header('Cache-Control: must-revalidate');
header('Pragma: public');
header('Content-Length: ' . $filesize);

// 出力バッファリングを無効化
ob_clean();
flush();

$handle = fopen($file, 'rb');
$buffer = 1024 * 8;
$bytes_sent = 0;

while (!feof($handle) && ($bytes_sent < $filesize)) {
    $contents = fread($handle, $buffer);
    $bytes_sent += strlen($contents);
    echo $contents;
    flush();
}

fclose($handle);
exit;

例3: CLIのプログレスバー

<?php
// CLI環境用のシンプルなプログレスバー
function display_progress($current, $total) {
    $bar_length = 50;
    $percent = round(($current / $total) * 100);
    $bar = round(($current / $total) * $bar_length);

    echo "\r[";
    echo str_repeat("=", $bar);
    if ($bar < $bar_length) {
        echo ">";
        echo str_repeat(" ", $bar_length - $bar - 1);
    } else {
        echo "=";
    }
    echo "] {$percent}%";

    flush();
}

echo "大量データ処理中...\n";
$total_items = 100;

for ($i = 0; $i <= $total_items; $i++) {
    display_progress($i, $total_items);
    usleep(100000); // 0.1秒待機
}

echo "\n処理完了!\n";

flush()の制限と注意点

サーバー設定の影響

フラッシュが効果的に機能するかどうかは、PHPの設定やWebサーバーの設定に依存します。

<?php
// flush()が効果的に動作するか確認
echo "サーバー設定情報:<br>";
echo "output_buffering: " . ini_get('output_buffering') . "<br>";
echo "implicit_flush: " . ini_get('implicit_flush') . "<br>";
echo "PHP SAPI: " . php_sapi_name() . "<br>";

if (function_exists('apache_get_modules')) {
    echo "mod_deflate/mod_gzip: " . 
         (in_array('mod_deflate', apache_get_modules()) || 
          in_array('mod_gzip', apache_get_modules()) ? "有効" : "無効");
}

主な制限事項

Webサーバーのバッファリング: Apache、Nginxなどのサーバーは独自のバッファリングを行うことがあります
圧縮: gzipなどの圧縮機能が有効な場合、バッファリングが必要なため効果が減少します
プロキシサーバー: プロキシサーバーがバッファリングを行う場合があります
ブラウザの動作: ブラウザによっては、十分なデータが届くまで表示しない場合があります

効果的な使用方法

ob_flush()とflush()の組み合わせ

出力バッファリングが有効な場合は、ob_flush()とflush()を組み合わせると効果的です。

<?php
ob_start();
echo "これはバッファに格納されます...<br>";
ob_flush(); // 出力バッファをフラッシュ
flush();    // PHPのバッファをフラッシュ

sleep(2);
echo "2秒後の出力です";
ob_flush();
flush();

Apache固有の最適化

<?php
// Apacheモジュールの場合、出力バッファリングを無効化
if (function_exists('apache_setenv')) {
    apache_setenv('no-gzip', '1');
    apache_setenv('dont-vary', '1');
}

// 圧縮を無効化
ini_set('zlib.output_compression', 'Off');

// 標準的なヘッダー設定
header('Content-Type: text/html; charset=utf-8');
header('Cache-Control: no-cache, must-revalidate');
header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');

// バッファリングを設定
ob_implicit_flush(true);
ob_end_flush();

// 以下、通常の出力処理...

パフォーマンスへの影響

flush()の過剰な使用はパフォーマンスに悪影響を与える可能性があります。

<?php
// パフォーマンステスト
function test_flush_performance($use_flush, $iterations = 1000) {
    $start = microtime(true);

    for ($i = 0; $i < $iterations; $i++) {
        echo ".";
        if ($use_flush) {
            flush();
        }
    }

    $end = microtime(true);
    return $end - $start;
}

echo "flush()なし: " . test_flush_performance(false) . "秒<br>";
echo "flush()あり: " . test_flush_performance(true) . "秒<br>";

よくある問題とトラブルシューティング

問題: flush()が効果を発揮しない

<?php
// flush()の効果を高めるための対策
// 1. 十分なデータ量を確保する
echo str_repeat(" ", 1024);
flush();

// 2. JavaScript を使用して更新を強制
echo "<script>document.body.innerHTML += 'データを更新しました...';</script>";
flush();

// 3. チャンク転送エンコーディングを使用
header('Content-Type: text/html; charset=utf-8');
header('Transfer-Encoding: chunked');
echo "初期データ";
flush();