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

Copy
1<?php
2
3/**
4 * 複数のURLに対してcURLマルチリクエストを実行し、同時に開かれる接続の総数を制限します。
5 *
6 * この関数は、libcurlのマルチインターフェースを使用して複数のHTTPリクエストを並行して処理します。
7 * CURLMOPT_MAX_TOTAL_CONNECTIONS オプションにより、libcurlがアクティブに保つ接続の総数が
8 * 指定された数に制限され、システムリソースの消費を抑え、サーバーへの負荷を管理できます。
9 *
10 * @param array<string> $urls リクエストを送信するURLの配列。
11 * @param int $maxTotalConnections 同時に開く接続の最大総数。
12 * @return array<string, string|false> 各URLに対するレスポンス本文、または失敗した場合はfalse。
13 */
14function performMultiCurlWithConnectionLimit(array $urls, int $maxTotalConnections): array
15{
16    // cURLマルチハンドルを初期化します。
17    // これは複数のcURLリクエストを並行して管理するための「コンテナ」のようなものです。
18    $multiHandle = curl_multi_init();
19
20    if ($multiHandle === false) {
21        error_log("エラー: cURLマルチハンドルを初期化できませんでした。cURL拡張機能が有効か確認してください。");
22        return [];
23    }
24
25    // CURLMOPT_MAX_TOTAL_CONNECTIONS オプションを設定します。
26    // この定数は、libcurlが同時に維持するTCP/IP接続の最大数を定義します。
27    // 例えば、`$maxTotalConnections` が2の場合、5つのURLがあっても同時に接続されるのは2つまでです。
28    // これは、クライアント側のリソース（メモリ、ファイルディスクリプタ）消費を抑えたり、
29    // ターゲットサーバーへの接続負荷を調整したりするのに役立ちます。
30    if (curl_multi_setopt($multiHandle, CURLMOPT_MAX_TOTAL_CONNECTIONS, $maxTotalConnections) !== CURLM_OK) {
31        error_log("エラー: CURLMOPT_MAX_TOTAL_CONNECTIONS の設定に失敗しました。詳細: " . curl_multi_strerror(curl_multi_errno($multiHandle)));
32        curl_multi_close($multiHandle);
33        return [];
34    }
35
36    $chMap = []; // 個々のcURLハンドルをURLと関連付けて保存するマップ
37    foreach ($urls as $url) {
38        // 各URLに対して個別のcURLハンドルを初期化します。
39        // これは単一のHTTPリクエストを表します。
40        $ch = curl_init();
41        if ($ch === false) {
42            error_log("警告: URL '{$url}' のcURLハンドルを初期化できませんでした。スキップします。");
43            continue;
44        }
45
46        // cURLオプションを設定します。
47        curl_setopt($ch, CURLOPT_URL, $url);                  // リクエスト先のURL
48        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);       // レスポンスデータを文字列として取得
49        curl_setopt($ch, CURLOPT_HEADER, false);              // レスポンスヘッダを含めない
50        // 注意: 本番環境では推奨されません。開発・テスト環境でのみ使用してください。
51        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);      // SSL証明書の検証を無効にする
52        curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);          // 接続試行の最大秒数
53        curl_setopt($ch, CURLOPT_TIMEOUT, 10);                // cURL関数の実行を許可する最大秒数
54
55        // 個々のcURLハンドルをマルチハンドルに追加します。
56        // これにより、マルチハンドルを通じてこのリクエストが並行処理の対象となります。
57        curl_multi_add_handle($multiHandle, $ch);
58        $chMap[(int)$ch] = ['handle' => $ch, 'url' => $url];
59    }
60
61    $runningHandles = null; // アクティブな転送（まだ完了していないリクエスト）の数を追跡する変数
62    $responses = [];        // 各URLからのレスポンスを格納する配列
63
64    // 全てのリクエストが完了するまでループを続けます。
65    do {
66        // cURLマルチハンドルを実行し、アクティブな転送の数を更新します。
67        // この関数が実際にリクエストの送受信をバックグラウンドで処理します。
68        curl_multi_exec($multiHandle, $runningHandles);
69
70        // アクティブな転送が残っている場合、CPUを占有しすぎないように、
71        // イベントが発生する（リクエストが完了するなど）まで一時的に待機します。
72        if ($runningHandles > 0) {
73            curl_multi_select($multiHandle, 1.0); // 最大1秒間待機します
74        }
75    } while ($runningHandles > 0);
76
77    // 各cURLハンドルから結果を取得し、リソースを解放します。
78    foreach ($chMap as $chData) {
79        $ch = $chData['handle'];
80        $url = $chData['url'];
81
82        // リクエストのレスポンス本文を取得します。
83        $responseContent = curl_multi_getcontent($ch);
84
85        if ($responseContent !== false) {
86            $responses[$url] = $responseContent;
87        } else {
88            // エラーが発生した場合、そのURLに対するエラーメッセージを記録します。
89            $responses[$url] = false;
90            error_log("警告: URL '{$url}' のコンテンツ取得に失敗しました。cURLエラー: " . curl_error($ch));
91        }
92
93        // マルチハンドルから個々のcURLハンドルを削除します。
94        curl_multi_remove_handle($multiHandle, $ch);
95        // 個々のcURLハンドルをクローズし、関連するリソースを解放します。
96        curl_close($ch);
97    }
98
99    // 全ての処理が完了したら、cURLマルチハンドルをクローズし、関連する全てのシステムリソースを解放します。
100    curl_multi_close($multiHandle);
101
102    return $responses;
103}
104
105// --- サンプルコードの実行 ---
106// cURL拡張機能が有効になっているかを確認します。
107if (!extension_loaded('curl')) {
108    echo "エラー: PHP cURL拡張機能が有効になっていません。php.iniを確認してください。\n";
109    exit(1); // スクリプトを終了
110}
111
112// テスト用のURLリスト。実際にアクセス可能なURLに置き換えてください。
113// 例えば、httpbin.org はテストに適したHTTPリクエスト/レスポンスサービスです。
114$targetUrls = [
115    'https://www.example.com/',
116    'https://www.php.net/',
117    'https://www.google.com/',
118    'https://httpbin.org/delay/3', // 3秒遅延するダミーAPI
119    'https://httpbin.org/get',
120];
121
122// 同時に確立される接続の最大総数を2に制限します。
123// これにより、上記の5つのURLがあっても、libcurlは同時に最大2つまでしか接続しません。
124$maxAllowedConnections = 2;
125
126echo "--- cURLマルチリクエスト開始 ---\n";
127echo "対象URL数: " . count($targetUrls) . "件\n";
128echo "同時接続の最大総数: {$maxAllowedConnections}に制限します。\n";
129echo "================================\n";
130
131$startTime = microtime(true); // 処理開始時刻を記録
132
133// 制限付きマルチcURLリクエストを実行
134$results = performMultiCurlWithConnectionLimit($targetUrls, $maxAllowedConnections);
135
136$endTime = microtime(true); // 処理終了時刻を記録
137$totalDuration = round($endTime - $startTime, 2);
138
139echo "\n================================\n";
140echo "全てのcURLリクエストが完了しました。\n";
141echo "合計処理時間: {$totalDuration}秒\n";
142echo "--- 各リクエストの結果 ---\n";
143
144foreach ($results as $url => $content) {
145    if ($content !== false) {
146        // レスポンスの最初の100文字のみ表示し、見やすくします。
147        echo "URL: {$url}\n";
148        echo "  ステータス: 成功\n";
149        echo "  レスポンスの抜粋: " . substr($content, 0, 100) . "...\n";
150        echo "--------------------------------\n";
151    } else {
152        echo "URL: {$url}\n";
153        echo "  ステータス: 失敗 (ログで詳細を確認してください)\n";
154        echo "--------------------------------\n";
155    }
156}

PHPのCURLMOPT_MAX_TOTAL_CONNECTIONSは、cURLのマルチインターフェースを利用して複数のHTTPリクエストを並行して実行する際に、同時に開かれるTCP/IP接続の最大総数を制限するための定数です。この定数を使用することで、多数のリクエストを処理する際でも、クライアント側のシステムリソース（メモリやファイルディスクリプタなど）の消費を効率的に管理し、また、リクエスト先のサーバーへの急激な負荷集中を防ぐことができます。

提供されたサンプルコードのperformMultiCurlWithConnectionLimit関数は、指定された複数のURLに対し、この定数を用いて同時接続数に制限を設けながら並行してcURLリクエストを実行します。具体的には、curl_multi_setopt()関数でCURLMOPT_MAX_TOTAL_CONNECTIONSに任意の整数値を設定することで、libcurlが一度にアクティブに保つ接続の数を制御します。例えば、5つのURLにリクエストがあっても、この設定値が2であれば、同時に通信を行うのは最大2つの接続までとなります。これにより、安全かつ効率的に大量のリクエストを処理することが可能になります。

この関数の引数$urlsはリクエストを送信するURLのリストを配列で受け取り、$maxTotalConnectionsは同時に許可する接続の最大総数を整数で指定します。関数の戻り値は、各URLをキーとし、そのURLからのレスポンス本文を文字列として持つ連想配列です。もしリクエストが失敗した場合は、該当するURLの値はfalseとなります。

Copy
1<?php
2
3/**
4 * 複数のURLを並行して取得し、同時に開かれるネットワーク接続数を制限します。
5 *
6 * @param array $urls 取得するURLの配列
7 * @param int $maxConnections 同時に開かれる最大ネットワーク接続数
8 * @return array 各URLのコンテンツまたはエラーメッセージを含む配列
9 */
10function fetchMultipleUrlsConcurrently(array $urls, int $maxConnections = 5): array
11{
12    // 1. cURLマルチハンドルの初期化
13    $multiHandle = curl_multi_init();
14    if ($multiHandle === false) {
15        error_log("Failed to initialize cURL multi handle.");
16        return [];
17    }
18
19    // 2. CURLMOPT_MAX_TOTAL_CONNECTIONS オプションを設定
20    // このオプションは、同時に開かれるネットワーク接続の総数を制限します。
21    // 例: $urls に10個のURLがあっても、$maxConnections が5なら、同時に最大5つの接続しか行われません。
22    if (curl_multi_setopt($multiHandle, CURLMOPT_MAX_TOTAL_CONNECTIONS, $maxConnections) !== CURLM_OK) {
23        error_log("Failed to set CURLMOPT_MAX_TOTAL_CONNECTIONS option.");
24        curl_multi_close($multiHandle);
25        return [];
26    }
27
28    $curlHandles = [];
29    $results = [];
30
31    // 3. 各URLのcURLハンドルを作成し、マルチハンドルに追加
32    foreach ($urls as $index => $url) {
33        $ch = curl_init();
34        if ($ch === false) {
35            error_log("Failed to initialize cURL handle for URL: {$url}");
36            continue; // このハンドルはスキップ
37        }
38
39        curl_setopt($ch, CURLOPT_URL, $url);
40        curl_setopt($ch, CURLOPT_HEADER, 0); // レスポンスヘッダーを含めない
41        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // 結果を文字列で返す
42
43        curl_multi_add_handle($multiHandle, $ch);
44        $curlHandles[$index] = $ch;
45        $results[$index] = null; // 結果のプレースホルダー
46    }
47
48    // 4. すべてのリクエストが完了するまで実行
49    $active = null; // アクティブなハンドルの数
50    do {
51        $mrc = curl_multi_exec($multiHandle, $active);
52    } while ($mrc == CURLM_CALL_MULTI_PERFORM); // 複数回の呼び出しが必要な場合がある
53
54    while ($active && $mrc == CURLM_OK) {
55        // cURLアクティビティがあるまで待機
56        if (curl_multi_select($multiHandle) == -1) {
57            // エラーが発生した場合、少し待機して再試行
58            usleep(100);
59        }
60        do {
61            $mrc = curl_multi_exec($multiHandle, $active);
62        } while ($mrc == CURLM_CALL_MULTI_PERFORM);
63    }
64
65    // 5. 各ハンドルの結果を取得し、ハンドルをクローズ
66    foreach ($curlHandles as $index => $ch) {
67        if (curl_errno($ch) == 0) {
68            $results[$index] = curl_multi_getcontent($ch);
69        } else {
70            $results[$index] = "Error: " . curl_error($ch) . " (URL: " . $urls[$index] . ")";
71        }
72        curl_multi_remove_handle($multiHandle, $ch); // マルチハンドルからシングルハンドルを削除
73        curl_close($ch); // シングルハンドルをクローズ
74    }
75
76    // 6. マルチハンドルをクローズ
77    curl_multi_close($multiHandle);
78
79    return $results;
80}
81
82// --- 使用例 ---
83// 取得したいURLのリスト
84$urlsToFetch = [
85    'https://www.google.com',
86    'https://www.php.net',
87    'https://www.bing.com',
88    'https://www.yahoo.com',
89    'https://www.example.com',
90    'https://httpbin.org/delay/2', // 意図的に2秒遅延するURL
91    'https://httpbin.org/delay/1', // 意図的に1秒遅延するURL
92    'https://nonexistent-domain-12345.com', // エラーを発生させるURL
93];
94
95// 最大同時接続数を3に制限してURLを取得
96// この場合、8つのURLがあっても、同時に最大3つのネットワーク接続しか行われません。
97$maxConcurrentConnections = 3;
98$fetchedContents = fetchMultipleUrlsConcurrently($urlsToFetch, $maxConcurrentConnections);
99
100echo "--- Fetched Contents (Limited to {$maxConcurrentConnections} concurrent connections) ---\n";
101foreach ($fetchedContents as $index => $content) {
102    echo "URL: " . ($urlsToFetch[$index] ?? 'N/A') . "\n";
103    if (str_starts_with((string)$content, "Error:")) {
104        echo "Status: " . $content . "\n";
105    } else {
106        echo "Status: Success, Content Length: " . strlen((string)$content) . " characters\n";
107        // 必要であれば、コンテンツの一部を表示することも可能
108        // echo "Content Snippet: " . substr($content, 0, 100) . "...\n";
109    }
110    echo "-----------------------------------------------------------\n";
111}
112
113?>

PHPのCURLMOPT_MAX_TOTAL_CONNECTIONSは、cURLマルチハンドルを使って複数のネットワークリクエストを並行処理する際に、同時に確立されるネットワーク接続の総数を制限するための定数です。これにより、多数のURLを同時に取得する際に、サーバーへの過度な負荷を避けたり、クライアント側のリソース消費を制御したりすることができます。

サンプルコードのfetchMultipleUrlsConcurrently関数は、この定数を利用して複数のURLを効率的に取得する処理を実装しています。この関数は、取得したいURLの配列である$urlsと、同時に開く最大ネットワーク接続数を指定する整数$maxConnections（デフォルトは5）を引数として受け取ります。そして、各URLの取得結果（コンテンツ文字列またはエラーメッセージ）を格納した配列を戻り値として返します。

関数内では、まずcurl_multi_init()でマルチハンドルを初期化し、その後にcurl_multi_setopt()関数を用いてCURLMOPT_MAX_TOTAL_CONNECTIONS定数に$maxConnectionsで指定された値を設定しています。この設定により、たとえ多数のURLを処理する場合でも、常に指定された数以上の接続が同時に行われることはありません。その後、個々のURLに対してcURLハンドルを作成し、マルチハンドルに追加して並行して実行します。すべてのリクエストが完了すると、各ハンドルの結果が収集され、処理済みのデータが返されます。この機能は、多数の外部サービスからデータを効率的に収集する際に非常に役立ちます。