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

Copy
1<?php
2
3/**
4 * CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE 定数を使用した cURL リクエストの例。
5 *
6 * この定数は、CURLOPT_HTTP_VERSION オプションに設定することで、
7 * HTTP/2 Prior Knowledge (事前知識) モードを有効にします。
8 * クライアントがサーバーがHTTP/2をサポートしていることを事前に知っている場合に、
9 * TLS (暗号化) なしで直接HTTP/2 (h2c) で接続を試みます。
10 * 主に暗号化されていないHTTP接続 (http://) でHTTP/2を使用する際に利用されますが、
11 * 実際にHTTP/2が使われるかはサーバー側の対応に依存します。
12 */
13function demonstrateCurlHttp2PriorKnowledge(): void
14{
15    // cURLセッションを初期化します。
16    $ch = curl_init();
17
18    // cURL初期化に失敗した場合の処理。
19    if ($ch === false) {
20        echo "エラー: cURLセッションの初期化に失敗しました。\n";
21        return;
22    }
23
24    // リクエスト先のURLを設定します。
25    // 一般的なHTTPサイトはHTTP/1.1を使用していることが多いため、
26    // このオプションを設定してもHTTP/1.1で接続される可能性が高いです。
27    $url = 'http://example.com';
28    curl_setopt($ch, CURLOPT_URL, $url);
29
30    // CURLOPT_HTTP_VERSION オプションに CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE 定数を設定します。
31    // これにより、cURLはHTTP/2 Prior Knowledgeモードでの接続を試みます。
32    curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE);
33
34    // リクエストの結果を文字列として取得するように設定します。
35    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
36
37    echo "URL: {$url} へのcURLリクエストを開始します (HTTP/2 Prior Knowledgeモード指定)。\n\n";
38
39    // cURLリクエストを実行します。
40    $response = curl_exec($ch);
41
42    // cURL実行時のエラーをチェックします。
43    if (curl_errno($ch)) {
44        echo 'cURLエラーが発生しました: ' . curl_error($ch) . "\n";
45    } else {
46        echo "リクエストが完了しました。\n";
47
48        // 実際に使用されたHTTPバージョンなどの情報を取得します。
49        $info = curl_getinfo($ch);
50
51        echo "  - 接続先URL: " . $info['url'] . "\n";
52        // `http_version`の値は整数で、2の場合がHTTP/2、11の場合がHTTP/1.1、10の場合がHTTP/1.0を示します。
53        echo "  - 実際に使用されたHTTPバージョン: ";
54        if ($info['http_version'] === 2) {
55            echo "HTTP/2\n";
56        } elseif ($info['http_version'] === 11) {
57            echo "HTTP/1.1\n";
58        } elseif ($info['http_version'] === 10) {
59            echo "HTTP/1.0\n";
60        } else {
61            echo "不明 (値: " . $info['http_version'] . ")\n";
62        }
63        echo "  - HTTPステータスコード: " . $info['http_code'] . "\n";
64    }
65
66    // cURLセッションを閉じ、リソースを解放します。
67    curl_close($ch);
68}
69
70// 関数を実行してデモンストレーションを開始します。
71demonstrateCurlHttp2PriorKnowledge();

この定数はPHPのcURLエクステンションに属し、HTTPリクエストのバージョン指定に関するものです。CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGEは、curl_setopt()関数でCURLOPT_HTTP_VERSIONオプションに設定することで、HTTP/2 Prior Knowledgeモードを有効にします。これは、クライアントがサーバーがHTTP/2をサポートしていることを事前に知っている場合に、暗号化なしで直接HTTP/2 (h2c) で接続を試みる機能です。主にhttp://のような暗号化されていないHTTP接続でHTTP/2を利用したい場合に指定されます。

サンプルコードでは、まずcurl_init()でcURLセッションを開始し、リクエスト先のURLを設定しています。次に、curl_setopt()関数を使いCURLOPT_HTTP_VERSIONオプションにこのCURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE定数を設定することで、HTTP/2 Prior Knowledgeモードでの接続を試みるようcURLに指示しています。その後、curl_exec()でリクエストを実行し、curl_getinfo()で接続情報を取得して、実際にどのHTTPバージョンが使用されたかを確認しています。この定数自体には引数はなく、特定の値を表すため戻り値もありません。このモードを設定しても、接続先のサーバーがHTTP/2 Prior Knowledgeモードに対応していなければ、HTTP/1.1など他のバージョンで接続される可能性がある点に注意が必要です。

Copy
1<?php
2
3/**
4 * CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE 定数を使用して
5 * HTTP/2 リクエストを試行するサンプル関数です。
6 *
7 * この定数を CURLOPT_HTTP_VERSION オプションに設定すると、
8 * cURL はサーバが HTTP/2 に対応しているという「事前知識」に基づき、
9 * ALPN (Application-Layer Protocol Negotiation) を待たずに
10 * HTTP/2 での接続を直ちに試みます。
11 * これは、特定の環境下でHTTP/2接続を確立したい場合に役立ちます。
12 *
13 * @param string $url リクエストを送信するURL。
14 * @return string|false リクエストのレスポンス本文、またはエラー時にfalse。
15 */
16function sendCurlHttp2RequestWithPriorKnowledge(string $url): string|false
17{
18    // cURL セッションを初期化します。
19    $ch = curl_init();
20
21    if ($ch === false) {
22        echo "cURL セッションの初期化に失敗しました。\n";
23        return false;
24    }
25
26    // cURL オプションを設定します。
27    // 1. リクエスト対象のURL。
28    curl_setopt($ch, CURLOPT_URL, $url);
29    // 2. レスポンスデータを文字列として取得するように設定します。
30    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
31
32    // 3. CURLOPT_HTTP_VERSION オプションに CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE を設定します。
33    //    これにより、cURL は HTTP/2 で接続を試みます。
34    curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE);
35
36    // cURL リクエストを実行し、結果を取得します。
37    $response = curl_exec($ch);
38
39    // cURL エラーが発生したか確認します。
40    if (curl_errno($ch)) {
41        echo 'cURL エラー: ' . curl_error($ch) . "\n";
42        $response = false;
43    } else {
44        // 実際に使用された HTTP バージョンを確認します。（オプション）
45        // CURLINFO_HTTP_VERSION は、実際に通信に使用されたHTTPプロトコルのバージョンを示します。
46        $httpVersionCode = curl_getinfo($ch, CURLINFO_HTTP_VERSION);
47        $httpVersion = match ($httpVersionCode) {
48            CURL_HTTP_VERSION_1_0 => 'HTTP/1.0',
49            CURL_HTTP_VERSION_1_1 => 'HTTP/1.1',
50            CURL_HTTP_VERSION_2_0 => 'HTTP/2',
51            CURL_HTTP_VERSION_3   => 'HTTP/3',
52            default => '不明',
53        };
54        echo "ターゲットURL ({$url}) へのリクエストで、使用されたHTTPバージョン: {$httpVersion}\n";
55    }
56
57    // cURL セッションを閉じます。
58    curl_close($ch);
59
60    return $response;
61}
62
63// ----------------------------------------
64// サンプルコードの実行部分
65// ----------------------------------------
66
67// HTTP/2 に対応している可能性のあるURLを指定します。
68// 例: 多くの主要なWebサイトはHTTP/2に対応しています。
69$targetUrl = 'https://www.google.com/';
70
71echo "URL: {$targetUrl} へ HTTP/2 事前知識オプションを使用したリクエストを送信します。\n";
72
73$result = sendCurlHttp2RequestWithPriorKnowledge($targetUrl);
74
75if ($result !== false) {
76    echo "\nリクエストは成功しました。レスポンスの一部を表示します:\n";
77    echo substr($result, 0, 500) . "...\n"; // レスポンスの最初の500文字を表示
78} else {
79    echo "\nリクエストの実行中にエラーが発生しました。\n";
80}
81
82?>

このサンプルコードは、PHPのcURLライブラリを用いてHTTP/2プロトコルでのリクエストを試行する方法を示しています。特にCURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE定数を使用することで、サーバーがHTTP/2に対応しているという「事前知識」に基づいて、ALPN（Application-Layer Protocol Negotiation）と呼ばれるプロトコルネゴシエーションを待たずに、即座にHTTP/2での接続を試みる点が特徴です。

関数sendCurlHttp2RequestWithPriorKnowledgeは、引数としてリクエストを送信する$url（文字列型）を受け取ります。内部では、curl_init()でcURLセッションを初期化し、CURLOPT_URLで対象URL、CURLOPT_RETURNTRANSFERで結果の文字列取得を設定します。そして、核心となるCURLOPT_HTTP_VERSIONオプションにCURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE定数を設定し、cURLにHTTP/2での接続を促します。

その後、curl_exec()でリクエストを実行し、curl_errno()でエラーが発生していないかを確認します。エラーが発生しなかった場合、curl_getinfo()とCURLINFO_HTTP_VERSIONを使って実際に使用されたHTTPバージョンを確認し、その結果を表示しています。これにより、意図したHTTP/2接続が成功したかどうかの確認が可能です。最後にcurl_close()でcURLセッションを閉じます。

この関数の戻り値は、リクエストが成功した場合にはサーバーからのレスポンス本文を文字列として返し、失敗した場合にはfalseを返します。これにより、呼び出し元でリクエストの成否と結果を判断することができます。この方法は、特定の環境下でHTTP/2接続を迅速に確立したい場合に特に有効です。