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

Copy
1<?php
2
3/**
4 * 指定されたURLに対してCURLリクエストを再試行付きで実行します。
5 *
6 * この関数は、ネットワークエラーや一時的なサーバーエラー(5xx系)が発生した場合に、
7 * 指定された回数だけリクエストを自動的に再試行します。
8 *
9 * @param string $url リクエストを送信するURL。
10 * @param array $options CURLオプションの配列 (例: [CURLOPT_POST => true, CURLOPT_POSTFIELDS => 'data=value'])。
11 * @param int $maxRetries 最大再試行回数 (初回試行を除く)。
12 * @param int $delaySeconds 再試行間の遅延時間 (秒)。
13 * @return string|false 成功した場合はレスポンスボディ、失敗した場合はfalseを返します。
14 */
15function makeCurlRequestWithRetry(
16    string $url,
17    array $options = [],
18    int $maxRetries = 3,
19    int $delaySeconds = 1
20) {
21    $attempt = 0; // 現在の試行回数 (0から開始し、初回試行)
22
23    while ($attempt <= $maxRetries) {
24        $ch = curl_init($url);
25
26        // 基本的なCURLオプションを設定
27        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // レスポンスを文字列として返す
28        curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); // リダイレクトを追跡
29        curl_setopt($ch, CURLOPT_TIMEOUT, 10);          // 全体のタイムアウトを10秒に設定
30        curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);    // 接続タイムアウトを5秒に設定
31
32        // ユーザー指定のCURLオプションをマージ
33        foreach ($options as $opt => $val) {
34            curl_setopt($ch, $opt, $val);
35        }
36
37        $response = curl_exec($ch);
38        $error = curl_error($ch);
39        $errno = curl_errno($ch);
40        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
41
42        curl_close($ch);
43
44        // レスポンスが成功 (エラーがなく、HTTPステータスコードが2xx) の場合
45        if ($response !== false && $errno === 0 && $httpCode >= 200 && $httpCode < 300) {
46            return $response;
47        }
48
49        // CURLエラー (タイムアウト、DNS解決失敗、接続拒否など) または 5xx系サーバーエラーの場合に再試行
50        if ($errno !== 0 || ($httpCode >= 500 && $httpCode < 600)) {
51            // エラーログ出力 (本番環境では適切なロギングシステムを使用)
52            error_log(sprintf(
53                "CURL Request failed (Attempt: %d/%d) for URL: %s, HTTP Code: %d, CURL Error: (%d) %s",
54                $attempt + 1, $maxRetries + 1, $url, $httpCode, $errno, $error
55            ));
56
57            $attempt++;
58            if ($attempt <= $maxRetries) {
59                // 再試行が必要な場合、指定された秒数待機
60                sleep($delaySeconds);
61            }
62        } else {
63            // その他のエラー（例: 4xxクライアントエラーなど、再試行しても解決しない可能性が高いエラー）は再試行せず終了
64            error_log(sprintf(
65                "CURL Request failed permanently (HTTP Code: %d, CURL Error: (%d) %s) for URL: %s",
66                $httpCode, $errno, $error, $url
67            ));
68            return false;
69        }
70    }
71
72    // 最大再試行回数を超えても成功しなかった場合
73    error_log(sprintf(
74        "CURL Request failed after %d attempts for URL: %s",
75        $maxRetries + 1, $url
76    ));
77    return false;
78}

このPHPサンプルコードは、makeCurlRequestWithRetry関数を通じて、外部サービスへのCURLリクエストを信頼性高く実行する仕組みを提供します。ネットワークの不安定さや一時的なサーバーエラー（5xx系）などが発生した場合でも、自動的に指定された回数だけリクエストを再試行し、システムの安定性と堅牢性を向上させます。

この関数は、$urlでリクエストを送信する宛先を指定し、$optionsには追加のCURL設定を配列で渡すことができます。$maxRetriesで最大再試行回数を設定でき、デフォルトは3回です。$delaySecondsは再試行を行う前に何秒待つかを指定します。

初回のリクエストが成功すればその結果を返しますが、CURLエラー（接続タイムアウトなど）や5xx系サーバーエラーが発生した場合は、指定された秒数待機した後に再試行を繰り返します。ただし、4xx系クライアントエラーなど、再試行しても解決しないと判断されるエラーでは、無駄な再試行をせず即座に処理を終了します。最終的にリクエストが成功した場合、サーバーからのレスポンス内容を文字列で返します。全ての再試行が失敗した場合はfalseを返して、呼び出し元に失敗を通知します。

Copy
1<?php
2
3/**
4 * 指定されたURLにcURL GETリクエストを送信し、レスポンスを取得します。
5 *
6 * @param string $url リクエストを送信するURL
7 * @return string|null 成功した場合はレスポンス本文、失敗した場合はnull
8 */
9function performCurlGetRequest(string $url): ?string
10{
11    // cURLセッションを初期化します。
12    $ch = curl_init();
13
14    // cURLが利用可能か、初期化が成功したかを確認します。
15    if ($ch === false) {
16        // cURLセッションの初期化に失敗した場合の処理
17        // error_log("cURL initialization failed."); // 実際にはエラーログなどに記録
18        return null;
19    }
20
21    // リクエスト先のURLを設定します。
22    curl_setopt($ch, CURLOPT_URL, $url);
23
24    // レスポンスを文字列として受け取るように設定します（trueにするとechoではなく変数に格納されます）。
25    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
26
27    // CURLPX_RECV_REQACK について:
28    // この定数 (CURLPX_RECV_REQACK) はPHPの標準CURL拡張には存在しません。
29    // もし特定のカスタムCURL拡張で定義されている場合、
30    // リクエストの受信確認など、特殊な動作を設定するために使用される可能性があります。
31    // このサンプルコードは標準CURL機能に基づいているため、直接使用はしません。
32    // 例: if (defined('CURLPX_RECV_REQACK')) { curl_setopt($ch, CURLOPT_SOME_CUSTOM_OPTION, CURLPX_RECV_REQACK); }
33
34    // cURLリクエストを実行し、レスポンスを取得します。
35    $response = curl_exec($ch);
36
37    // リクエストが失敗した場合のエラー処理
38    if ($response === false) {
39        // cURLリクエストの実行に失敗した場合の処理
40        // error_log("cURL error: " . curl_error($ch)); // 実際にはエラーログなどに記録
41        $response = null; // 失敗としてnullを返します。
42    }
43
44    // cURLセッションを閉じ、リソースを解放します。
45    curl_close($ch);
46
47    return $response;
48}
49
50// --- サンプル使用例 ---
51// 公開されているダミーAPIのURLをターゲットとします。
52$targetUrl = 'https://jsonplaceholder.typicode.com/posts/1';
53
54// cURLリクエストを実行し、レスポンスを取得します。
55$responseData = performCurlGetRequest($targetUrl);
56
57// レスポンスが取得できたかを確認し、結果を出力します。
58if ($responseData !== null) {
59    echo "cURLリクエスト成功。\n";
60    echo "取得したレスポンスデータ:\n";
61    echo $responseData . "\n";
62
63    // 一般的に、JSON形式のレスポンスはjson_decode関数でPHPの配列やオブジェクトに変換して利用します。
64    $decodedData = json_decode($responseData, true); // trueで連想配列に変換
65    if (json_last_error() === JSON_ERROR_NONE) {
66        echo "\nJSONデコード成功:\n";
67        print_r($decodedData);
68    } else {
69        echo "\nJSONデコード失敗: " . json_last_error_msg() . "\n";
70    }
71} else {
72    echo "cURLリクエストが失敗しました。\n";
73}

PHPのCURL拡張は、プログラムからHTTPリクエストを送信し、ウェブサービスと通信するツールです。このサンプルコードは、外部のウェブサービスからデータを取得する基本的な方法を示しています。

performCurlGetRequest関数は、引数としてリクエスト先のURL（$url: string）を受け取ります。まずcurl_init()でcURLセッションを開始し、curl_setopt()でURL設定やレスポンスを文字列で受け取る設定を行います。その後、curl_exec()でリクエストを実行し、レスポンスを取得します。成功すればレスポンス本文（string）を返し、失敗した場合はエラー処理を行いnullを返します。最後にcurl_close()でセッションを閉じます。

リファレンス情報にあるCURLPX_RECV_REQACK定数についてですが、この定数はPHPの標準CURL拡張には存在しません。特定のカスタムCURL拡張で定義される可能性があり、リクエストの受信確認のような特殊な動作に使用されることが考えられますが、このサンプルコードの標準的なcURL処理では使用されていません。

後半のサンプル使用例では、performCurlGetRequest関数を呼び出し、取得したレスポンスを表示します。JSON形式のレスポンスはjson_decode関数を用いることで、PHPの連想配列やオブジェクトとして簡単に利用できます。