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

Copy
1<?php
2
3/**
4 * 複数のURLに非同期でリクエストを送信し、結果を処理します。
5 * CURLPX_USER_REJECTED 定数は、PHP 8で追加された定数で、
6 * 並列CURL処理において、リクエストがシステムによって拒否された場合に発生しうるエラーコードを示します。
7 * 「レスポンスを待たない」というキーワードは、複数のリクエストを並列実行し、
8 * 個々のリクエストの完了をブロックせず効率的に処理するCURLマルチハンドル機能と関連付けられます。
9 *
10 * @param array $urls リクエストを送信するURLの配列
11 * @return array 各URLに対するレスポンスの配列。エラーの場合はエラーメッセージ文字列を格納。
12 */
13function fetchMultipleUrlsAsync(array $urls): array
14{
15    $multiHandle = curl_multi_init();
16    $handles = []; // 個々のCURLハンドルを格納
17    $responses = []; // 各URLのレスポンスを格納
18
19    foreach ($urls as $index => $url) {
20        $ch = curl_init();
21        curl_setopt($ch, CURLOPT_URL, $url);
22        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // レスポンスを文字列として取得
23        curl_setopt($ch, CURLOPT_HEADER, false);        // HTTPヘッダーを含めない
24
25        curl_multi_add_handle($multiHandle, $ch);
26        $handles[$index] = $ch;
27        $responses[$index] = null; // 初期値
28    }
29
30    $runningHandles = null; // 実行中のハンドル数
31    do {
32        // CURLリクエストを並列実行
33        $status = curl_multi_exec($multiHandle, $runningHandles);
34
35        // ソケットアクティビティを待機（CPUを占有しないための最適化）
36        if ($runningHandles > 0) {
37            curl_multi_select($multiHandle, 0.5); // 最大0.5秒待機
38        }
39
40        // 完了したリクエストの情報を取得
41        while ($info = curl_multi_info_read($multiHandle)) {
42            $ch = $info['handle'];
43            $resultCode = $info['result']; // CURLM_OK またはエラーコード
44
45            // どのURLのハンドルか特定
46            $urlIndex = array_search($ch, $handles, true);
47
48            if ($urlIndex !== false) {
49                if ($resultCode === CURLM_OK) {
50                    // 成功した場合はレスポンスを取得
51                    $responses[$urlIndex] = curl_multi_getcontent($ch);
52                } elseif ($resultCode === CURLPX_USER_REJECTED) {
53                    // CURLPX_USER_REJECTED定数：並列処理中にシステム的な理由でリクエストが拒否されたことを示します。
54                    error_log("CURLPX_USER_REJECTEDエラー: URL " . curl_getinfo($ch, CURLINFO_EFFECTIVE_URL) . " のリクエストが拒否されました。");
55                    $responses[$urlIndex] = 'ERROR: USER_REJECTED';
56                } else {
57                    // その他のCURLエラー
58                    $error = curl_error($ch);
59                    error_log("CURLエラー (Code: $resultCode): " . $error . " for URL " . curl_getinfo($ch, CURLINFO_EFFECTIVE_URL));
60                    $responses[$urlIndex] = 'ERROR: ' . $error;
61                }
62            }
63            curl_multi_remove_handle($multiHandle, $ch); // 完了したハンドルをマルチハンドルから削除
64            curl_close($ch); // 個別のCURLハンドルを閉じる
65        }
66
67    } while ($runningHandles > 0 && $status === CURLM_OK); // 全てのリクエストが完了するか、エラーが発生するまでループ
68
69    curl_multi_close($multiHandle); // マルチハンドルを閉じる
70
71    return $responses;
72}
73
74// --- 関数使用例 ---
75
76$targetUrls = [
77    'https://www.google.com',
78    'https://www.example.com',
79    'https://invalid.domain.xyz', // 存在しないドメインでDNSエラーを発生させる可能性
80    'https://php.net'
81];
82
83$results = fetchMultipleUrlsAsync($targetUrls);
84
85foreach ($results as $index => $response) {
86    echo "URL: {$targetUrls[$index]}\n";
87    if (str_starts_with((string)$response, 'ERROR:')) {
88        echo "  ステータス: エラー - " . substr((string)$response, 7) . "\n";
89    } elseif ($response !== null) {
90        echo "  ステータス: 成功\n";
91        echo "  レスポンスの一部: " . substr((string)$response, 0, 100) . "...\n";
92    } else {
93        echo "  ステータス: 未処理または不明なエラー\n";
94    }
95    echo "--------------------\n";
96}

このサンプルコードは、PHPのCURL機能を利用して複数のURLへ同時にリクエストを送信し、その結果を効率的に取得する方法を示しています。「レスポンスを待たない」というキーワードは、個々のリクエストの完了をブロックせずに並行して処理を行う、CURLマルチハンドル機能の非同期的な性質を指します。

fetchMultipleUrlsAsync関数は、リクエストを送信するURLの配列（$urls）を引数として受け取ります。この関数は、受け取ったURLごとにCURLリクエスト（ハンドル）を生成し、それらをcurl_multi_initで初期化された一つのマルチハンドルに追加します。その後、curl_multi_execを使って全てのリクエストを並列に実行します。

リクエストが完了するたびにその結果が確認され、成功した場合はレスポンス本文を取得し、エラーが発生した場合はその情報を記録します。特に、PHP 8で導入されたCURLPX_USER_REJECTED定数は、並列CURL処理においてシステム的な理由でリクエストが拒否されたことを示すエラーコードです。このエラーが発生した場合、関数は特定のメッセージを返します。

curl_multi_selectは、CPUを不必要に消費することなく、次のネットワークアクティビティを待機するために使われ、処理の効率を高めます。最終的に、関数は各URLに対するレスポンスまたはエラーメッセージを格納した配列を戻り値として返します。このコードは、多数の外部リソースへ同時にアクセスする場面で、パフォーマンスを向上させるために役立ちます。

Copy
1<?php
2
3// PHPの標準CURL拡張機能では 'CURLPX_USER_REJECTED' 定数は定義されていません。
4// ここでは、指定されたリファレンス情報に基づき、この定数が存在するものとして
5// 例示のために仮の値を定義しています。
6// 実際のシステムでこの定数を使用する場合は、それが利用可能な環境であることを確認してください。
7if (!defined('CURLPX_USER_REJECTED')) {
8    define('CURLPX_USER_REJECTED', 101); // 例として、`CURLE_OK` (0) ではない任意の整数値
9}
10
11/**
12 * 指定されたURLへのcURLリクエストを実行し、その結果を処理します。
13 * cURL操作が成功したか、特定のカスタムエラーが発生したかを確認する例を示します。
14 *
15 * @param string $url リクエストを送信するURL
16 * @return string|false リクエストが成功した場合はレスポンスデータ、失敗した場合はfalse
17 */
18function fetchDataFromUrl(string $url)
19{
20    // cURLセッションを初期化します。
21    $ch = curl_init();
22
23    // cURLオプションを設定します。
24    // CURLOPT_URL: リクエストを送信するURL。
25    // CURLOPT_RETURNTRANSFER: レスポンスを文字列として返すように設定します (true)。
26    //                        falseの場合、直接出力されます。
27    curl_setopt($ch, CURLOPT_URL, $url);
28    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
29
30    // cURLリクエストを実行し、レスポンスを取得します。
31    $response = curl_exec($ch);
32
33    // cURL操作で発生したエラーコードを取得します。
34    $errorCode = curl_errno($ch);
35
36    // cURLセッションを閉じ、リソースを解放します。
37    curl_close($ch);
38
39    // エラーコードをチェックします。
40    // CURLE_OK はcURL操作が成功したことを示す定数です (値は0)。
41    if ($errorCode === CURLE_OK) {
42        // リクエストが成功した場合
43        echo "URL '{$url}' からのデータ取得に成功しました。\n";
44        return $response;
45    } else {
46        // リクエストが失敗した場合
47        $errorMessage = curl_error($ch);
48        echo "URL '{$url}' からのデータ取得に失敗しました。";
49        echo "エラーコード: {$errorCode}, エラーメッセージ: '{$errorMessage}'\n";
50
51        // CURLPX_USER_REJECTED 定数とエラーコードを比較する例。
52        // これは、特定のカスタムエラーコードとして利用されるケースを想定しています。
53        // 標準のcURLエラーとしてこの値が直接返されることは稀です。
54        if ($errorCode === CURLPX_USER_REJECTED) {
55            echo "注意: このエラーは、ユーザーによって操作が拒否されたことを示唆するカスタムエラーです。\n";
56            // ここにCURLPX_USER_REJECTEDエラーに特化した処理を追加できます。
57        }
58        return false;
59    }
60}
61
62// --- サンプル使用例 ---
63
64echo "--- 1. 成功する可能性のあるリクエスト --- \n";
65// 実際にアクセス可能なURLを指定してください。
66// 例: 'https://example.com' や 'https://api.github.com/zen' など。
67$successfulUrl = 'https://example.com';
68$successfulResponse = fetchDataFromUrl($successfulUrl);
69if ($successfulResponse !== false) {
70    echo "成功処理: 取得したデータの一部: " . substr($successfulResponse, 0, 100) . "...\n\n";
71} else {
72    echo "成功処理: データの取得に失敗しました。詳細は上記のメッセージを確認してください。\n\n";
73}
74
75echo "--- 2. 失敗する可能性のあるリクエスト (存在しないホスト名) --- \n";
76// 存在しないホスト名や無効なURLを指定すると、通常は接続エラーが発生します。
77$failedUrl = 'http://nonexistent.example.invalid';
78$failedResponse = fetchDataFromUrl($failedUrl);
79if ($failedResponse !== false) {
80    echo "失敗処理: 取得したデータの一部: " . substr($failedResponse, 0, 100) . "...\n\n";
81} else {
82    echo "失敗処理: データの取得に失敗しました。詳細は上記のメッセージを確認してください。\n\n";
83}
84
85// CURLPX_USER_REJECTED の定数値を表示します。
86// これがcURL操作のエラーコードとして直接返されることは稀です。
87echo "--- CURLPX_USER_REJECTED の定数値 --- \n";
88echo "CURLPX_USER_REJECTED の値: " . CURLPX_USER_REJECTED . "\n";
89

このPHPサンプルコードは、cURL拡張機能を利用して指定されたURLからデータを取得し、その結果を処理する方法を解説しています。fetchDataFromUrl関数は、まずcurl_init()でcURLセッションを開始し、curl_setopt()を用いてリクエストを送信するURLと、レスポンスを文字列として返す設定を行います。その後、curl_exec()で実際にウェブサーバーへリクエストを送信し、応答を取得します。

関数の引数である$urlには、アクセスしたいウェブサイトやAPIのエンドポイントのURLを文字列で指定します。戻り値は、リクエストが成功した場合は取得したウェブページのコンテンツなどのデータが文字列として返され、失敗した場合はfalseが返されます。

リクエスト実行後には、curl_errno()でcURL操作のエラーコードを取得します。このエラーコードがCURLE_OK（cURL操作の成功を示す定数で、値は0）であれば、リクエストは成功です。それ以外の場合はエラーが発生しており、curl_error()で詳細なエラーメッセージも確認できます。なお、サンプルコード中に示されているCURLPX_USER_REJECTEDは、標準のcURL拡張機能には存在しない定数であり、特定のカスタムエラーコードを処理する例として仮に定義されたものです。最後に、curl_close()でcURLセッションを終了し、使用したリソースを解放することが重要です。このコードは、ウェブサービスとの連携における基本的なエラーハンドリングの考え方を学ぶのに役立ちます。