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

Copy
1<?php
2
3/**
4 * CURLMOPT_MAXCONNECTS の使用例を示します。
5 * 複数のHTTPリクエストを並行して処理し、同時に開かれる接続の最大数を制御します。
6 *
7 * @param array<string> $urls 取得するURLの配列
8 * @return array<string, string> 各URLをキー、そのレスポンスデータを値とする配列
9 * @throws RuntimeException CURLハンドルの初期化またはオプション設定に失敗した場合
10 */
11function fetchMultipleUrls(array $urls): array
12{
13    // 1. マルチCURLハンドルを初期化します。
14    // これにより、複数のCURLリクエストを同時に管理できるようになります。
15    $multiHandle = curl_multi_init();
16    if ($multiHandle === false) {
17        throw new RuntimeException("Failed to initialize multi CURL handle.");
18    }
19
20    // 2. CURLMOPT_MAXCONNECTS オプションを設定します。
21    // この定数を使って、同時にオープンできるTCP接続の最大数を設定します。
22    // 例えば、5を設定した場合、たとえ10個のURLを処理しようとしても、
23    // 同時にアクティブなTCP接続は最大5つに制限されます。
24    // これは、サーバーへの過度な負荷を避けたり、クライアント側のリソース消費を抑えたりするのに役立ちます。
25    if (curl_multi_setopt($multiHandle, CURLMOPT_MAXCONNECTS, 5) === false) {
26        // 通常、このオプション設定は失敗しにくいですが、エラーハンドリングを考慮します。
27        throw new RuntimeException("Failed to set CURLMOPT_MAXCONNECTS option.");
28    }
29
30    $curlHandles = []; // 個々のCURLハンドル（リクエスト）を格納する配列
31    $responses = [];   // 各URLのレスポンスを格納する配列
32
33    // 3. 各URLに対して個別のCURLハンドルを作成し、マルチハンドルに追加します。
34    foreach ($urls as $index => $url) {
35        $ch = curl_init();
36        if ($ch === false) {
37            error_log("Failed to initialize CURL handle for URL: {$url}");
38            continue; // このURLはスキップして次へ進みます
39        }
40        curl_setopt($ch, CURLOPT_URL, $url);
41        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // レスポンスを文字列として取得するように設定
42        curl_setopt($ch, CURLOPT_HEADER, false);        // レスポンスヘッダを含めないように設定
43        // 必要に応じて他のオプションを設定することもできます（例: タイムアウトなど）
44        // curl_setopt($ch, CURLOPT_TIMEOUT, 10); // 10秒でタイムアウト
45
46        curl_multi_add_handle($multiHandle, $ch); // 個別のCURLハンドルをマルチハンドルに追加
47        $curlHandles[$index] = $ch; // 後で結果を取得するためにハンドルを保存
48    }
49
50    if (empty($curlHandles)) {
51        curl_multi_close($multiHandle);
52        return []; // 処理すべきハンドルがなければ空配列を返します
53    }
54
55    // 4. 全てのリクエストが完了するまでマルチCURLハンドルを実行します。
56    $active = null; // 現在アクティブな転送の数を追跡する変数
57    do {
58        // curl_multi_exec は、保留中のすべてのCURLリクエストを可能な限り処理します。
59        // キーワード "curlm_call_multi_perform" は、この一連のマルチリクエスト処理を指していると解釈できます。
60        $mrc = curl_multi_exec($multiHandle, $active);
61
62        if ($mrc != CURLM_OK) {
63            // curl_multi_exec 自体のエラーが発生した場合
64            error_log("CURL multi exec error: " . curl_multi_strerror($mrc));
65            break;
66        }
67
68        // アクティブな転送が残っている場合は、次のデータが利用可能になるまで待機します。
69        // これにより、CPU使用率を不必要に高くすることなく、効率的に処理を進めることができます。
70        if ($active > 0) {
71            // curl_multi_select は、指定された時間（秒）イベントを待機します。
72            // タイムアウト値は必要に応じて調整してください（例: 1秒 = 1.0）
73            curl_multi_select($multiHandle, 1.0);
74        }
75    } while ($active > 0); // アクティブな転送がある限りループを続けます
76
77    // 5. 各CURLハンドルの結果を取得し、クリーンアップします。
78    foreach ($curlHandles as $index => $ch) {
79        $error = curl_error($ch); // エラーメッセージを取得
80        $errno = curl_errno($ch); // エラーコードを取得
81
82        if ($errno === 0) {
83            // エラーがない場合、レスポンス内容を取得
84            $responses[$urls[$index]] = curl_multi_getcontent($ch);
85        } else {
86            // エラーが発生した場合
87            $responses[$urls[$index]] = "Error fetching {$urls[$index]}: {$error} (Error Code: {$errno})";
88            error_log($responses[$urls[$index]]); // エラーログに出力
89        }
90        curl_multi_remove_handle($multiHandle, $ch); // マルチハンドルから個別のハンドルを削除
91        curl_close($ch); // 個別のCURLハンドルをクローズ（リソース解放）
92    }
93
94    // 6. マルチCURLハンドルをクローズします。
95    curl_multi_close($multiHandle); // マルチCURLハンドルのリソースを解放
96
97    return $responses;
98}
99
100// --- 以下は、この関数が単体で動作することを示すためのサンプルコードです ---
101// コマンドラインから実行された場合のみ、以下のコードが実行されます。
102if (php_sapi_name() === 'cli') {
103    // テスト用のURLリスト
104    // 実際の使用では、動作確認しやすいURLを指定してください。
105    $testUrls = [
106        "https://www.example.com",
107        "https://httpbin.org/get?param=test1",
108        "https://httpbin.org/delay/2?param=test2", // 2秒遅延するURL
109        "https://httpbin.org/status/500",           // 500エラーを返すURL
110        "https://www.google.com",
111        "https://httpbin.org/get?param=test3",
112    ];
113
114    echo "--- CURLMOPT_MAXCONNECTS を 5 に設定して複数のURLを並行取得中 ---\n";
115    try {
116        $results = fetchMultipleUrls($testUrls);
117
118        foreach ($results as $url => $content) {
119            echo "\n--- レスポンス for {$url} ---\n";
120            // 内容が長い場合を考慮し、最初の200文字だけ表示
121            echo substr($content, 0, 200) . (strlen($content) > 200 ? '...' : '') . "\n";
122        }
123    } catch (RuntimeException $e) {
124        echo "エラー: " . $e->getMessage() . "\n";
125    }
126}

このサンプルコードは、PHPのCURL拡張機能を用いて複数のHTTPリクエストを並行して処理する際に、CURLMOPT_MAXCONNECTS定数を使って同時に開かれるTCP接続の最大数を制御する方法を示しています。fetchMultipleUrls関数は、取得したいURLの配列を引数として受け取り、各URLをキーとし、そのURLから取得したレスポンスデータを値とする連想配列を返します。リクエスト中にエラーが発生した場合は、レスポンスデータの代わりにエラーメッセージが格納されます。

関数内部では、まずマルチCURLハンドルを初期化し、続けてCURLMOPT_MAXCONNECTSオプションを例えば「5」のように設定します。これは、たとえ多くのURLを処理する場合でも、同時にアクティブなTCP接続数を指定した値に制限することで、サーバーへの過度な負荷を避け、クライアント側のリソース消費を抑えるのに役立ちます。その後、引数で渡された各URLに対して個別のCURLハンドルを作成し、それらをマルチハンドルに追加します。全ての準備が整ったら、curl_multi_exec関数を繰り返し呼び出し、全ての並行リクエストが完了するまで処理を進めます。この一連のマルチリクエストの実行と待機処理が、キーワード「curlm_call_multi_perform」が指す動作です。最終的に、各リクエストの結果を取得し、使用したCURLハンドルやマルチハンドルといったリソースを適切に解放します。この仕組みは、多数の外部APIやウェブサイトからデータを効率的に収集する際に非常に有効です。

Copy
1<?php
2
3/**
4 * CURLMOPT_MAXCONNECTS 定数を使用して、CURLマルチハンドルの最大同時接続数を設定する方法を示すサンプルコード。
5 *
6 * この関数は、複数のHTTPリクエストを並行して実行する際に、同時に開かれる接続の数を
7 * 制限する方法をシステムエンジニアを目指す初心者向けに示します。
8 */
9function demonstrateCurlMultiMaxConnects(): void
10{
11    echo "CURLMOPT_MAXCONNECTS の使用例を開始します。\n";
12
13    // 1. CURLマルチハンドルを初期化します。
14    //    これは複数のCURLリクエストを効率的に並行処理するためのコンテナです。
15    $multiHandle = curl_multi_init();
16    if ($multiHandle === false) {
17        echo "エラー: curl_multi_init() に失敗しました。CURL拡張が有効になっているか確認してください。\n";
18        return;
19    }
20
21    echo "CURLマルチハンドルを初期化しました。\n";
22
23    // 2. CURLMOPT_MAXCONNECTS オプションを使って、マルチハンドルが同時に開くことができる
24    //    接続の最大数を設定します。ここでは、最大2つの接続に制限します。
25    //    これにより、一度に多くのリクエストがあっても、システムリソースを過剰に消費するのを防ぎます。
26    $maxConnections = 2;
27    if (curl_multi_setopt($multiHandle, CURLMOPT_MAXCONNECTS, $maxConnections)) {
28        echo "CURLMOPT_MAXCONNECTS を " . $maxConnections . " に設定しました。\n";
29    } else {
30        // 設定に失敗した場合（通常は発生しにくいですが、念のため）
31        echo "警告: CURLMOPT_MAXCONNECTS の設定に失敗しました。\n";
32    }
33
34    // 3. 複数のCURLハンドルを作成し、それらをマルチハンドルに追加します。
35    //    これらのリクエストは、設定された最大同時接続数に基づいて並行して実行されます。
36    $urls = [
37        "https://www.example.com",
38        "https://www.google.com",
39        "https://www.php.net",
40        "https://www.bing.com",
41    ];
42    $handles = []; // 個々のCURLハンドルを格納する配列
43    foreach ($urls as $index => $url) {
44        $ch = curl_init($url); // 新しいCURLハンドルを初期化
45        if ($ch === false) {
46            echo "エラー: curl_init() に失敗しました。URL: " . $url . "\n";
47            continue;
48        }
49        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // サーバーからの応答を文字列として返すように設定
50        curl_setopt($ch, CURLOPT_TIMEOUT, 5);         // 各リクエストのタイムアウトを5秒に設定
51
52        curl_multi_add_handle($multiHandle, $ch); // 個々のハンドルをマルチハンドルに追加
53        $handles[$index] = $ch;
54        echo "URL '" . $url . "' のCURLハンドルをマルチハンドルに追加しました。\n";
55    }
56
57    // 4. 全てのリクエストが完了するまでマルチハンドルを実行します。
58    $running = null; // 実行中のハンドルの数を追跡するための変数
59    do {
60        // アクティブなCURLリクエストの実行を試みます。
61        // $running には、まだ完了していないリクエストの数が格納されます。
62        $mrc = curl_multi_exec($multiHandle, $running);
63
64        // curl_multi_exec() がまだ実行する必要があることを示す場合
65        if ($mrc === CURLM_CALL_MULTI_PERFORM) {
66            continue; // 再度 curl_multi_exec() を呼び出す
67        }
68
69        // curl_multi_exec() でエラーが発生した場合
70        if ($mrc !== CURLM_OK) {
71            echo "エラー: curl_multi_exec() が失敗しました。コード: " . $mrc . "\n";
72            break;
73        }
74
75        // まだ実行中のリクエストがある場合、I/Oアクティビティを待機します。
76        // これにより、CPUリソースを節約し、効率的にリクエストを処理できます。
77        if ($running > 0) {
78            curl_multi_select($multiHandle, 1.0); // 最大1秒間、I/Oイベントを待機
79        }
80
81    } while ($running > 0); // 実行中のリクエストがなくなるまでループを続ける
82
83    echo "全てのリクエストの実行が完了しました。\n";
84
85    // 5. 各CURLハンドルの結果を取得し、表示します。
86    foreach ($handles as $ch) {
87        $content = curl_multi_getcontent($ch); // 取得したページコンテンツ
88        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE); // HTTPステータスコード
89        $url = curl_getinfo($ch, CURLINFO_EFFECTIVE_URL); // 最終的にアクセスしたURL
90
91        echo "\n--- リクエスト結果 for " . $url . " ---\n";
92        echo "HTTPステータス: " . $httpCode . "\n";
93        if ($content === false) {
94            echo "エラー: コンテンツの取得に失敗しました。\n";
95        } elseif (strlen($content) > 100) {
96            echo "コンテンツの冒頭 (" . strlen($content) . "バイト): " . substr($content, 0, 100) . "...\n";
97        } else {
98            echo "コンテンツ (" . strlen($content) . "バイト): " . $content . "\n";
99        }
100    }
101
102    // 6. 全てのCURLハンドルとマルチハンドルを閉じ、システムリソースを解放します。
103    foreach ($handles as $ch) {
104        curl_multi_remove_handle($multiHandle, $ch); // マルチハンドルから個々のハンドルを削除
105        curl_close($ch); // 個々のCURLハンドルを閉じる
106    }
107    curl_multi_close($multiHandle); // マルチハンドルを閉じる
108
109    echo "\n全てのCURLリソースを解放しました。\n";
110    echo "CURLMOPT_MAXCONNECTS の使用例を終了します。\n";
111}
112
113// 関数を実行して、CURLMOPT_MAXCONNECTS の動作を確認します。
114demonstrateCurlMultiMaxConnects();
115
116?>

CURLMOPT_MAXCONNECTSは、PHPのCURL拡張機能で利用される定数で、CURLマルチハンドルが同時に開くことができるネットワーク接続の最大数を設定するために使用します。この定数を使うことで、複数のHTTPリクエストを並行して実行する際に、システムが一度に処理する接続数を制限し、サーバーやネットワークへの負荷を適切に制御してリソースの過剰な消費を防ぐことが可能になります。

サンプルコードでは、まずCURLマルチハンドルを初期化し、curl_multi_setopt()関数にCURLMOPT_MAXCONNECTSを指定して最大同時接続数を2に設定しています。これにより、複数のURLに対するリクエストが作成されても、同時にアクティブな接続は2つまでに制限されます。その後、複数のリクエストを並行して実行し、それぞれのHTTPステータスコードやコンテンツを取得する方法、そして最終的に使用したCURLリソースを適切に解放するまでの一連の流れを示しています。

CURLMOPT_MAXCONNECTS定数自体に引数や戻り値はありませんが、curl_multi_setopt()関数の第2引数として渡すことで、第3引数で指定した数値（この場合は最大接続数）が適用されます。curl_multi_setopt()関数は設定の成功可否を真偽値で返します。この定数を用いることで、効率的かつ安定したWebリクエスト処理を実現できます。