【PHP8.x】curl_multi_close()関数の使い方
curl_multi_close関数の使い方について、初心者にもわかりやすく解説します。
基本的な使い方
curl_multi_close関数は、複数のcURLセッションを同時に管理するために作成された「マルチcURLハンドル」を閉じ、そのハンドルに関連付けられているすべてのリソースを解放する関数です。
ウェブサイトへの並行リクエストなど、複数のネットワーク通信を効率的に行う場合、まず curl_multi_init() 関数でマルチcURLハンドルを作成し、そこに個々のcURLハンドルを追加して処理を行います。すべてのネットワーク通信が完了し、マルチcURLハンドルが不要になった際には、この curl_multi_close() 関数を呼び出してハンドルを明示的に閉じる必要があります。
この関数は、引数として閉じたいマルチcURLハンドルのリソースを受け取ります。関数が成功した場合は true を、失敗した場合は false を返します。リソースを適切に解放することは、メモリリークを防ぎ、システムリソースを効率的に利用するために非常に重要です。そのため、curl_multi_init() で作成したマルチcURLハンドルは、処理が終わった後、必ず curl_multi_close() で閉じるようにしてください。これは、プログラミングにおける基本的なリソース管理の原則に基づいています。
構文(syntax)
1<?php 2/** 3 * curl_multi_init() で作成されたマルチ cURL ハンドルを閉じます。 4 * 5 * @param resource $multi_handle curl_multi_init() が返す cURL マルチハンドル。 6 * @return void 7 */ 8function curl_multi_close(resource $multi_handle): void {} 9 10// 使用例: 11$mh = curl_multi_init(); 12// ... cURL マルチハンドルの操作 ... 13curl_multi_close($mh); 14?>
引数(parameters)
CurlMultiHandle $multi_handle
- CurlMultiHandle $multi_handle: クローズするマルチハンドルリソースを指定します。
戻り値(return)
void
curl_multi_close 関数は、curl_multi_init で初期化されたマルチハンドルリソースを解放します。戻り値はありません。
サンプルコード
PHP: curl_multi_initで複数URLを並行取得する
1<?php 2 3/** 4 * 複数のURLから並行してデータを取得し、その結果を表示する関数。 5 * curl_multi_init と curl_multi_close の基本的な使用方法を示します。 6 * 7 * @param array $urls 取得するURLの配列 8 * @return void 9 */ 10function fetchMultipleUrls(array $urls): void 11{ 12 // 1. マルチ cURL ハンドルを初期化します。 13 // これは複数の cURL リクエストを並行して管理するためのコンテナです。 14 $multiHandle = curl_multi_init(); 15 if ($multiHandle === false) { 16 echo "エラー: マルチ cURL ハンドルの初期化に失敗しました。\n"; 17 return; 18 } 19 20 $curlHandles = []; // 個々の cURL ハンドルを保持する配列 21 $requestCount = 0; // 実際にリクエストが追加された数 22 23 foreach ($urls as $url) { 24 // 2. 個々の cURL ハンドルを初期化します。 25 // 各URLに対する独立したリクエストを構成します。 26 $ch = curl_init(); 27 if ($ch === false) { 28 echo "警告: URL '{$url}' の cURL ハンドルの初期化に失敗しました。スキップします。\n"; 29 continue; 30 } 31 32 // 3. 各 cURL ハンドルのオプションを設定します。 33 // CURLOPT_URL: リクエスト先のURL 34 // CURLOPT_RETURNTRANSFER: 実行結果を文字列で返すように設定 (true) 35 curl_setopt($ch, CURLOPT_URL, $url); 36 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 37 curl_setopt($ch, CURLOPT_HEADER, false); // レスポンスヘッダをボディに含めない 38 39 // 4. 個々の cURL ハンドルをマルチ cURL ハンドルに追加します。 40 // これで、このリクエストが並行処理の対象となります。 41 curl_multi_add_handle($multiHandle, $ch); 42 $curlHandles[] = $ch; 43 $requestCount++; 44 } 45 46 if ($requestCount === 0) { 47 echo "処理する有効なURLがありませんでした。\n"; 48 // 有効なハンドルがなくても、初期化したマルチハンドルは閉じる必要があります。 49 curl_multi_close($multiHandle); 50 return; 51 } 52 53 // 5. すべてのリクエストが完了するまで待機し、実行します。 54 // $active には現在アクティブなハンドルの数が格納されます。 55 $active = null; 56 do { 57 $status = curl_multi_exec($multiHandle, $active); // リクエストを実行し、状態を更新 58 if ($status !== CURLM_OK) { // エラーが発生した場合 59 echo "エラー: curl_multi_exec が失敗しました (" . curl_multi_strerror($status) . ").\n"; 60 break; 61 } 62 // アクティブなハンドルがある場合、イベントを待機してCPU使用率を下げます。 63 if ($active > 0) { 64 curl_multi_select($multiHandle, 1.0); // 最大1秒間イベントを待機 65 } 66 } while ($active > 0); // アクティブなハンドルがなくなるまで繰り返す 67 68 echo "\n--- リクエスト結果 ---\n"; 69 70 // 6. 各 cURL ハンドルの結果を取得し、解放します。 71 foreach ($curlHandles as $ch) { 72 $url = curl_getinfo($ch, CURLINFO_EFFECTIVE_URL); // 最終的なURLを取得 73 $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE); // HTTPステータスコードを取得 74 $response = curl_multi_getcontent($ch); // レスポンスボディを取得 75 76 echo "URL: {$url}\n"; 77 echo "HTTPコード: {$httpCode}\n"; 78 echo "コンテンツ長: " . strlen($response) . " バイト\n"; 79 // 取得したコンテンツの一部を表示 (長すぎる場合は省略) 80 echo "コンテンツ冒頭: " . substr($response, 0, 100) . "...\n\n"; 81 82 // マルチ cURL ハンドルから個々の cURL ハンドルを削除します。 83 curl_multi_remove_handle($multiHandle, $ch); 84 // 個々の cURL ハンドルを閉じ、関連リソースを解放します。 85 curl_close($ch); 86 } 87 88 // 7. マルチ cURL ハンドルを閉じ、関連リソースを解放します。 89 // これが `curl_multi_close` の主な役割です。 90 curl_multi_close($multiHandle); 91 echo "すべての cURL マルチハンドルが閉じられました。\n"; 92} 93 94// 実際にリクエストを送るURLの例 95$targetUrls = [ 96 "https://www.google.com", 97 "https://www.php.net", 98 "https://www.example.com", 99 "https://httpbin.org/delay/2", // 2秒遅延するURL 100 "https://invalid.example.com" // 存在しないURL(エラーケースの例) 101]; 102 103// 関数を実行して、並行リクエストの動作を確認します 104fetchMultipleUrls($targetUrls); 105 106?>
PHPのcurl_multi_close関数は、複数のHTTPリクエストを並行して処理するために使用する「マルチcURLハンドル」を、適切に閉じて関連リソースを解放する役割を持つ関数です。この関数は、curl_multi_initで作成されたCurlMultiHandle型のオブジェクトを唯一の引数$multi_handleとして受け取ります。$multi_handleを指定することで、そのハンドルに関連付けられたメモリやネットワーク接続などのシステムリソースが解放され、プログラムが効率的に動作し続けることを保証します。もしこの関数を呼び出さないと、これらのリソースが解放されずに残り、メモリリークやパフォーマンスの低下を引き起こす可能性があります。戻り値はvoid型であり、処理が完了しても特に値は返しません。サンプルコードでは、複数のURLからのデータ取得がすべて完了した後、最後にcurl_multi_closeが呼び出されており、並行処理の終了処理におけるこの関数の重要性を示しています。これは、プログラムが使用したリソースを確実に解放するための、非常に重要なステップです。
curl_multi_closeは、curl_multi_initで初期化したマルチcURLハンドルを確実に閉じるために必須の関数です。これにより、並行リクエストに使用されたすべての関連リソースが適切に解放され、メモリリークなどの問題を防ぎます。サンプルコードのように、マルチハンドルを閉じる前に、個々のcURLハンドルもcurl_multi_remove_handleでマルチハンドルから外し、その後curl_closeで個別に閉じる手順を踏むことが重要です。初期化されたマルチハンドルは、処理が正常に完了した場合だけでなく、エラーが発生した場合でも必ずcurl_multi_closeで終了させるようにしてください。この丁寧なリソース管理が、安定したプログラム運用につながります。
PHP cURLマルチ: 非同期リクエストを効率化する
1<?php 2 3/** 4 * 複数のURLに非同期でHTTPリクエストを送信し、結果をまとめて取得します。 5 * この関数は、PHPのcURL multiインターフェースを使用して、複数のリクエストを効率的に並行処理します。 6 * curl_multi_select と curl_multi_close の使用例を含みます。 7 * 8 * @param array $urls キーにリクエストを識別するID(文字列または整数)、値にリクエスト対象のURLの配列。 9 * @return array 各リクエストIDに対応する結果の配列。 10 * 結果は連想配列で、以下のキーを含みます: 11 * - 'content': HTTPレスポンスボディ(文字列)。 12 * - 'error': cURL操作中に発生したエラーメッセージ(エラーがない場合は空文字列)。 13 * - 'errno': cURL操作中に発生したエラーコード(エラーがない場合は0)。 14 * - 'http_code': HTTPステータスコード(例: 200, 404, 500)。 15 * @throws RuntimeException curl_multi_init() の初期化に失敗した場合にスローされます。 16 */ 17function fetch_multiple_urls_concurrently(array $urls): array 18{ 19 // 1. マルチCURLハンドルを初期化します。 20 // これは複数の個々のCURLハンドルを管理するためのマスターハンドルです。 21 $multi_handle = curl_multi_init(); 22 if ($multi_handle === false) { 23 throw new RuntimeException("Failed to initialize curl_multi_init(). Please check your PHP cURL extension setup."); 24 } 25 26 $curl_handles = []; // 個々のCURLハンドル(識別IDと紐付け)を格納する配列 27 $results = []; // 最終的な結果を格納する配列 28 29 // 2. 各URLに対して個別のCURLハンドルを作成し、オプションを設定し、マルチCURLハンドルに追加します。 30 foreach ($urls as $id => $url) { 31 $ch = curl_init(); // 個別のCURLハンドルを初期化 32 if ($ch === false) { 33 error_log("Failed to initialize curl for URL: " . $url); 34 continue; // このURLはスキップして次のURLへ進む 35 } 36 37 // 個別のCURLハンドルにオプションを設定 38 curl_setopt($ch, CURLOPT_URL, $url); // リクエストするURL 39 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // レスポンスボディを戻り値として文字列で取得するように設定 40 curl_setopt($ch, CURLOPT_HEADER, false); // レスポンスヘッダーを含めない 41 curl_setopt($ch, CURLOPT_TIMEOUT, 10); // 接続と転送のタイムアウトを10秒に設定 42 curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); // HTTPリダイレクトを自動的に追跡する 43 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true); // SSL証明書の検証を行う(推奨されるセキュリティ設定) 44 45 // 個別のCURLハンドルをマルチCURLハンドルに追加 46 curl_multi_add_handle($multi_handle, $ch); 47 // 後で結果を関連付けるために、元のIDとCURLハンドルを紐付けて保存 48 $curl_handles[$id] = $ch; 49 } 50 51 $active = null; // アクティブな(処理中の)個々のCURLハンドルの数を追跡する変数 52 do { 53 // 3. 全てのCURLリクエストが完了するまで実行し続けます。 54 // curl_multi_exec() は、アクティブなハンドルがなくなるまで、可能な限り多くの転送を実行しようとします。 55 // $active には現在アクティブな転送の数が設定されます。 56 $status = curl_multi_exec($multi_handle, $active); 57 58 // 4. 何らかのアクティビティ(データ転送、接続確立など)があるまで待機します。 59 // これはキーワードである `curl_multi_select` の使用例です。 60 // $active が 0 より大きく、かつ curl_multi_exec が正常に動作している場合のみ待機します。 61 if ($active > 0 && $status === CURLM_OK) { 62 // アクティビティがあるまで最大1秒間待機します。 63 // タイムアウトを短くしすぎるとCPU使用率が高くなる可能性があるので注意が必要です。 64 // select の戻り値は、選択可能なファイルディスクリプタの数、または -1 (エラー) です。 65 $select_result = curl_multi_select($multi_handle, 1.0); // 1.0秒間待機 66 if ($select_result === -1) { 67 // エラーが発生した場合の処理 68 error_log("curl_multi_select failed: " . curl_multi_strerror($status)); 69 break; // ループを中断 70 } 71 // select_result が 0 の場合、指定された時間内にアクティビティはなかったことを意味します。 72 // この場合でも、ループの次の反復で curl_multi_exec が再度呼び出され、処理が続行されます。 73 } 74 75 // 5. 完了したCURLハンドルから結果を取得し、後処理を行います。 76 // curl_multi_info_read() は、完了したCURLハンドルに関する情報を返します。 77 while ($info = curl_multi_info_read($multi_handle)) { 78 if ($info['msg'] === CURLMSG_DONE) { 79 $ch = $info['handle']; // 完了した個別のCURLハンドルを取得 80 81 // どの元のリクエストに対応する結果か特定するために、保存しておいた配列から検索 82 $original_id = array_search($ch, $curl_handles, true); 83 if ($original_id === false) { 84 error_log("Completed handle could not be matched with original request ID."); 85 // 一致するIDが見つからなくても、ハンドルはクリーンアップする必要がある 86 curl_multi_remove_handle($multi_handle, $ch); 87 curl_close($ch); 88 continue; 89 } 90 91 // 完了したリクエストから結果情報を取得 92 $content = curl_multi_getcontent($ch); // 取得したレスポンスボディ 93 $error = curl_error($ch); // cURLのエラーメッセージ 94 $errno = curl_errno($ch); // cURLのエラーコード 95 $http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE); // HTTPステータスコード 96 97 // 結果配列に保存 98 $results[$original_id] = [ 99 'content' => $content, 100 'error' => $error, 101 'errno' => $errno, 102 'http_code' => $http_code, 103 ]; 104 105 // 完了した個別のCURLハンドルをマルチCURLハンドルから削除 106 curl_multi_remove_handle($multi_handle, $ch); 107 // 個別のCURLハンドルを閉じることでリソースを解放 108 curl_close($ch); 109 // `$curl_handles` 配列からも参照を削除し、メモリを解放 110 unset($curl_handles[$original_id]); 111 } 112 } 113 // ループは、まだアクティブな転送があるか ($active > 0)、 114 // または curl_multi_exec を再度呼び出す必要がある場合 ($status === CURLM_CALL_MULTI_PERFORM) に継続します。 115 } while ($active > 0 || $status === CURLM_CALL_MULTI_PERFORM); 116 117 // 6. 全ての処理が完了したので、マルチCURLハンドルを閉じます。 118 // これはキーワードである `curl_multi_close` の使用例です。 119 // これにより、マルチCURLハンドルに関連付けられたすべてのリソースが解放されます。 120 curl_multi_close($multi_handle); 121 122 return $results; 123} 124 125// === 使用例 === 126// テスト用のURLの配列を定義。配列のキーは各リクエストを識別するためのIDとして使用します。 127$urls_to_fetch = [ 128 'google_homepage' => 'https://www.google.com/', 129 'github_php_page' => 'https://github.com/php/', // PHP公式のGitHubページ 130 'php_manual_curl' => 'https://www.php.net/manual/ja/function.curl-multi-close.php', 131 'nonexistent_url' => 'http://this-domain-surely-does-not-exist-123.com/path', // 存在しないURL (エラー例) 132]; 133 134echo "複数のURLへ並行してリクエストを送信しています...\n\n"; 135 136try { 137 // 関数を呼び出し、並行してURLからデータを取得 138 $fetched_data = fetch_multiple_urls_concurrently($urls_to_fetch); 139 140 // 取得した結果を表示 141 foreach ($fetched_data as $id => $data) { 142 echo "--- リクエストID: '{$id}' の結果 ---\n"; 143 if (empty($data['error'])) { 144 // エラーが発生しなかった場合 145 echo " HTTPステータスコード: {$data['http_code']}\n"; 146 echo " 取得コンテンツ長: " . strlen($data['content']) . " バイト\n"; 147 // コンテンツが非常に長い可能性があるため、プレビューはコメントアウト 148 // echo " コンテンツの冒頭: " . substr($data['content'], 0, 100) . "...\n"; 149 } else { 150 // エラーが発生した場合 151 echo " エラー発生: {$data['error']} (エラーコード: {$data['errno']})\n"; 152 echo " HTTPステータスコード (もしあれば): {$data['http_code']}\n"; 153 } 154 echo "\n"; 155 } 156 157} catch (RuntimeException $e) { 158 // curl_multi_init() の初期化失敗などの実行時エラーをキャッチ 159 echo "エラーが発生しました: " . $e->getMessage() . "\n"; 160} catch (Exception $e) { 161 // その他の予期せぬエラーをキャッチ 162 echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n"; 163} 164 165?>
curl_multi_close関数は、複数のHTTPリクエストを並行処理するために使用される「マルチCURLハンドル」を閉じるためのPHP関数です。この関数を呼び出すことで、curl_multi_init()で作成されたマルチCURLハンドルに関連付けられたすべてのシステムリソース(メモリやファイルディスクリプタなど)が適切に解放されます。
引数には、閉じたいマルチCURLハンドルのインスタンスであるCurlMultiHandle $multi_handleを指定します。このハンドルは、複数の個別のCURLハンドルを管理する親のような存在です。
戻り値はvoidであり、この関数自体は特定の値を返しません。正常に実行されれば、指定されたマルチCURLハンドルがクリーンアップされることを意味します。
提供されたサンプルコードでは、fetch_multiple_urls_concurrently関数が複数のURLへのHTTPリクエストを非同期で処理する一連の操作の最後に、curl_multi_close($multi_handle);としてこの関数を使用しています。これは、すべてのデータ転送が完了し、個々のCURLハンドルも閉じられた後、マルチCURLハンドルが不要になった時点でリソースを解放するための重要なステップです。このクリーンアップ処理を適切に行うことで、アプリケーションの安定性を保ち、不要なリソース消費を防ぐことができます。サンプルコード全体は、curl_multi_selectを含むマルチCURLのワークフローを示しており、その締めくくりとしてcurl_multi_closeが使われています。
このサンプルコードは、複数のHTTPリクエストを効率的に並行処理する方法を示しています。重要なのは、curl_multi_initで開始し、各リクエスト用の個別のCURLハンドルをcurl_multi_add_handleで追加することです。curl_multi_execとcurl_multi_selectを組み合わせることで、CPU負荷を抑えつつリクエストの進行を待機し、完了したリクエストから順次結果を取得できます。
特に注意すべきはリソースの解放です。個々のCURLハンドルはcurl_closeで、そして最後にマルチCURLハンドルはcurl_multi_closeで必ず閉じ、メモリリークを防ぐ必要があります。また、ネットワークエラーやタイムアウトなどの例外処理を適切に行うことで、より堅牢なコードになります。curl_errorやcurl_errnoで詳細なエラー情報を確認してください。