【PHP8.x】CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE定数の使い方

Copy
1<?php
2
3/**
4 * CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE を設定し、複数の URL を並行して取得する関数。
5 *
6 * この定数は PHP 8 以降で利用可能です。HTTP/2 のプッシュストリームが中断された際に、
7 * ペナルティとして追加されるバイト数を定義します。この値は、プッシュされたストリームが
8 * 親ストリームよりも短い場合に適用されます。
9 *
10 * @param array $urls 取得する URL の配列
11 * @return array 各 URL のコンテンツをキーとしてURL、値としてコンテンツを格納した配列
12 */
13function fetchMultipleUrlsConcurrently(array $urls): array
14{
15    // cURL マルチハンドルを初期化します。これにより、複数の cURL リクエストを並行して処理できます。
16    $multi_handle = curl_multi_init();
17    if ($multi_handle === false) {
18        error_log("Error: Failed to initialize cURL multi handle.");
19        return [];
20    }
21
22    // CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE オプションを設定します。
23    // このオプションは HTTP/2 のサーバープッシュ機能に関連し、
24    // プッシュされたストリームが親ストリームよりも短い場合のペナルティサイズを設定します。
25    // 例えば、1024 バイトを設定します。この値は実際のユースケースによって調整してください。
26    // 設定に失敗した場合でも、処理は続行されますが、エラーログに警告が記録されます。
27    if (!curl_multi_setopt($multi_handle, CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE, 1024)) {
28        error_log("Warning: Failed to set CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE option. Error: " . curl_multi_strerror(curl_multi_errno($multi_handle)));
29    }
30
31    $curl_handles = [];
32    // 各URLに対して個別の cURL ハンドルを作成し、マルチハンドルに追加します。
33    foreach ($urls as $index => $url) {
34        $ch = curl_init(); // 個別の cURL ハンドルを初期化します。
35        if ($ch === false) {
36            error_log("Error: Failed to initialize cURL handle for URL: {$url}");
37            continue;
38        }
39
40        curl_setopt($ch, CURLOPT_URL, $url);                  // 取得するURLを設定します。
41        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);       // 戻り値を文字列として取得するように設定します。
42        curl_setopt($ch, CURLOPT_HEADER, 0);                  // レスポンスヘッダをコンテンツに含めないように設定します。
43
44        curl_multi_add_handle($multi_handle, $ch); // 個別の cURL ハンドルをマルチハンドルに追加します。
45        $curl_handles[$index] = $ch;               // 後で結果を取得するためにハンドルを保存します。
46    }
47
48    // すべてのリクエストが完了するまで cURL マルチハンドルを実行します。
49    $running_handles_count = null;
50    do {
51        // curl_multi_exec() は、並行処理を管理し、実行中のリクエスト数を更新します。
52        // これは、キーワードに示されるマルチパフォ―ムの主な処理部分です。
53        $status = curl_multi_exec($multi_handle, $running_handles_count);
54
55        // 実行中のハンドルがある場合、新しいイベントを待機してCPUサイクルを節約します。
56        // これにより、不必要なCPU使用を避け、効率的に処理を進めます。
57        if ($running_handles_count > 0) {
58            curl_multi_select($multi_handle, 1.0); // 1秒のタイムアウトを設定してイベントを待ちます。
59        }
60    } while ($running_handles_count > 0 && $status === CURLM_OK);
61
62    $results = [];
63    // 各 cURL ハンドルの結果を取得し、リソースをクリーンアップします。
64    foreach ($curl_handles as $index => $ch) {
65        $results[$urls[$index]] = curl_multi_getcontent($ch); // 個々のリクエストのコンテンツを取得します。
66        curl_multi_remove_handle($multi_handle, $ch);        // マルチハンドルから個別のハンドルを削除します。
67        curl_close($ch);                                     // 個別の cURL ハンドルをクローズし、リソースを解放します。
68    }
69
70    // すべての処理が完了したら、cURL マルチハンドルをクローズします。
71    curl_multi_close($multi_handle);
72
73    return $results;
74}
75
76// スクリプトがCLI (コマンドラインインターフェース) から実行された場合のサンプル利用例です。
77// このブロックは、phpコマンドでこのファイルを実行した場合にのみ動作します。
78if (php_sapi_name() === 'cli') {
79    // 複数のターゲットURLを定義します。
80    $example_urls = [
81        "https://www.example.com/",
82        "https://httpbin.org/get", // テスト用のHTTP GETリクエスト応答サービス
83        "https://jsonplaceholder.typicode.com/todos/1" // テスト用のREST APIエンドポイント
84    ];
85
86    echo "--- PHP cURL マルチリクエストの実行開始 (CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE 設定済み) ---" . PHP_EOL;
87    // 定数を設定した上で、複数のURLを並行して取得します。
88    $fetched_data = fetchMultipleUrlsConcurrently($example_urls);
89
90    // 取得した各URLのコンテンツを表示します。
91    foreach ($fetched_data as $url => $content) {
92        echo "URL: " . $url . PHP_EOL;
93        echo "コンテンツ長: " . strlen((string)$content) . " バイト" . PHP_EOL;
94        // コンテンツが長すぎる場合を考慮し、最初の150文字のみ表示します。
95        echo "コンテンツの一部: " . substr((string)$content, 0, 150) . "..." . PHP_EOL . PHP_EOL;
96    }
97    echo "--- PHP cURL マルチリクエストの実行終了 ---" . PHP_EOL;
98}

このサンプルコードは、PHP 8で導入されたCURLMOPT_CHUNK_LENGTH_PENALTY_SIZE定数を利用し、複数のURLからコンテンツを並行して取得する方法を示しています。CURLMOPT_CHUNK_LENGTH_PENALTY_SIZEは、HTTP/2のサーバープッシュ機能に関連するオプションで、プッシュされたストリームが親ストリームよりも短い場合にペナルティとして追加されるバイト数を設定するために使用されます。これにより、HTTP/2の挙動をより細かく制御できます。

fetchMultipleUrlsConcurrently関数は、取得したいURLの配列（$urls）を引数として受け取ります。この関数は内部でcURLマルチハンドルを初期化し、配列内の各URLに対して個別のcURLハンドルを作成してマルチハンドルに追加します。複数のリクエストはcurl_multi_exec関数によって並行して実行されます。この処理は、キーワードであるcurlm_call_multi_performが示すように、複数のcURLリクエストを同時に管理し、効率的にデータの取得を進める主要な部分です。すべてのリクエストが完了すると、関数はキーとしてURL、値として取得したコンテンツを持つ連想配列を返します。処理の終了後には、使用したcURLハンドルとマルチハンドルは適切にクローズされ、リソースが解放されます。スクリプトがコマンドラインから実行された場合の具体的な利用例も示されており、定義されたURLから並行してデータを取得し、その結果を表示しています。

Copy
1<?php
2
3/**
4 * 複数のURLに対して並行にHTTPリクエストを実行し、
5 * CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE オプションの使用例を示します。
6 *
7 * このオプションは、HTTP/2環境でContent-Lengthヘッダーがない場合に、
8 * チャンクエンコードされたボディの長さをlibcurlが推測する際のヒントとして使用されます。
9 * 主にHTTP/2のパフォーマンス調整において意味を持ちます。
10 *
11 * @param array<string> $urls リクエスト対象のURLの配列
12 * @return array<string> 各URLのレスポンス本文、またはエラーメッセージ
13 */
14function fetchUrlsConcurrentlyWithChunkPenalty(array $urls): array
15{
16    // cURLマルチハンドルを初期化
17    $multiHandle = curl_multi_init();
18    if ($multiHandle === false) {
19        // 初期化に失敗した場合はエラーを報告
20        error_log('Failed to initialize cURL multi handle.');
21        return [];
22    }
23
24    // CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE オプションを設定
25    // このオプションは、HTTP/2でContent-Lengthヘッダーが送信されない場合に、
26    // libcurlがチャンクボディの長さを推測する際のペナルティサイズ (バイト単位) を指定します。
27    // 値が大きいほど、libcurlはチャンクの区切りを少なくし、より大きなチャンクを試みます。
28    // ここでは例として 16384 (16KB) を設定していますが、実際の利用では
29    // アプリケーションやネットワークの特性に合わせて調整が必要です。
30    if (!curl_multi_setopt($multiHandle, CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE, 16384)) {
31        // オプション設定に失敗した場合は警告を報告
32        error_log('Failed to set CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE. This might not be critical but check configuration.');
33    }
34
35    $handles = []; // 各URL用のcURLハンドルを格納する配列
36    foreach ($urls as $key => $url) {
37        $ch = curl_init(); // 個々のcURLハンドルを初期化
38        if ($ch === false) {
39            error_log("Failed to initialize cURL handle for URL: {$url}");
40            continue;
41        }
42
43        // cURLオプションを設定
44        curl_setopt($ch, CURLOPT_URL, $url);                   // リクエストするURL
45        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);        // レスポンスを文字列として返す
46        curl_setopt($ch, CURLOPT_HEADER, false);               // レスポンスヘッダーを含めない
47        curl_setopt($ch, CURLOPT_TIMEOUT, 10);                 // タイムアウトを10秒に設定
48
49        // このオプションが主にHTTP/2で関連性が高いため、HTTP/2を有効にします。
50        // サーバーがHTTP/2をサポートしている場合にのみ有効です。
51        curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_2_0);
52
53        // 個々のcURLハンドルをマルチハンドルに追加
54        curl_multi_add_handle($multiHandle, $ch);
55        $handles[$key] = $ch; // 後で参照できるように保存
56    }
57
58    $running = null; // 実行中のハンドル数を示す変数
59    // すべてのリクエストが完了するまでループ
60    do {
61        // cURLマルチリクエストを実行
62        curl_multi_exec($multiHandle, $running);
63        // この間に他の処理を挟むことも可能 (例: sleep(1))
64    } while ($running > 0);
65
66    $results = []; // 各リクエストの結果を格納する配列
67    foreach ($handles as $key => $ch) {
68        $error = curl_error($ch); // エラー情報を取得
69        if ($error === "") {
70            // エラーがない場合、レスポンス内容を取得
71            $results[$key] = curl_multi_getcontent($ch);
72        } else {
73            // エラーがある場合、エラーメッセージを保存
74            $results[$key] = "Error fetching {$urls[$key]}: " . $error;
75        }
76        // マルチハンドルから個々のハンドルを削除し、閉じる
77        curl_multi_remove_handle($multiHandle, $ch);
78        curl_close($ch);
79    }
80
81    // マルチハンドルを閉じる
82    curl_multi_close($multiHandle);
83
84    return $results;
85}
86
87// --- 使用例 ---
88// 実際にアクセス可能なURLを指定してください。
89// ここでは例として、一般的なサイトとテスト用のHTTPサービスを使用しています。
90$targetUrls = [
91    'https://example.com/',
92    'https://www.google.com/',
93    'https://httpbin.org/get', // テスト用: GETリクエスト情報を返すサービス
94];
95
96echo "複数のURLへ並行リクエストを実行中 (CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE設定済み)...\n\n";
97
98// 定義した関数を呼び出し、並行リクエストを実行
99$responses = fetchUrlsConcurrentlyWithChunkPenalty($targetUrls);
100
101// 結果を表示
102foreach ($responses as $url_key => $content) {
103    echo "--- URL: {$targetUrls[$url_key]} のレスポンス ---\n";
104    // 初心者にも分かりやすいよう、レスポンスが長すぎる場合は一部を省略して表示
105    if (strlen($content) > 500) {
106        echo substr($content, 0, 500) . "...\n";
107    } else {
108        echo $content . "\n";
109    }
110    echo "--------------------------------------------------\n\n";
111}
112
113?>

このサンプルコードは、PHPのcURL拡張機能を利用し、複数のHTTPリクエストを並行して実行する方法を示すものです。特に、CURLMOPT_CHUNK_LENGTH_PENALTY_SIZEという定数の使用例を解説しています。

この定数は、HTTP/2プロトコルでの通信において、サーバーがレスポンスにContent-Lengthヘッダーを含まない場合に、libcurlがチャンクエンコードされたボディの長さを推測する際の挙動を調整するために用いられます。指定する値はバイト単位のペナルティサイズを示し、この値が大きいほどlibcurlはデータのチャンク（塊）を少なく、大きく推測しようとします。これにより、ネットワークの特性に応じたHTTP/2のパフォーマンス最適化を図ることができます。

サンプルコード内のfetchUrlsConcurrentlyWithChunkPenalty関数は、引数としてリクエスト対象のURLの文字列配列を受け取ります。この関数は、受け取ったURL群に対して非同期的にリクエストを実行し、それぞれのURLに対するHTTPレスポンスの本文、またはエラーが発生した場合はそのメッセージを格納した配列を戻り値として返します。関数内部ではcurl_multi_initでマルチハンドルを作成し、CURLMOPT_CHUNK_LENGTH_PENALTY_SIZEオプションを適切な値に設定してから、各URLへのリクエスト処理を行っています。