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

Copy
1<?php
2
3/**
4 * 複数のURLに対してCURLリクエストを並行して実行します。
5 * 各リクエストでCURLALTSVC_H2定数を使用してAlternative ServicesのHTTP/2サポートを有効にします。
6 *
7 * @param array<string> $urls 取得するURLの配列
8 * @return array<string, string|false> URLをキーとし、レスポンスボディを値とする配列（エラー時はfalseまたはエラーメッセージ）
9 */
10function performMultiCurlRequests(array $urls): array
11{
12    // マルチCURLハンドルを初期化します。これにより、複数のCURLリクエストを同時に管理できます。
13    $multi_handle = curl_multi_init();
14    $curl_handles = [];
15    $results = [];
16
17    // 各URLに対して個別のCURLハンドルを作成し、設定を適用します。
18    foreach ($urls as $index => $url) {
19        $ch = curl_init(); // 個別のCURLハンドルを初期化
20
21        if ($ch === false) {
22            $results[$url] = "Error: Could not initialize cURL for " . $url;
23            continue;
24        }
25
26        // リクエストの基本設定
27        curl_setopt($ch, CURLOPT_URL, $url); // リクエストするURL
28        curl_setopt($ch, CURLOPT_HEADER, 0); // レスポンスヘッダーを含めない
29        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // レスポンスボディを文字列として返す
30        curl_setopt($ch, CURLOPT_TIMEOUT, 10); // 10秒でタイムアウト
31
32        // CURLALTSVC_H2定数を使用し、Alternative Services (Alt-SVC) のHTTP/2サポートを有効にします。
33        // これにより、もしサーバーがAlt-SVCヘッダを提供し、それがHTTP/2サービスを示していれば、
34        // cURLはその情報を使ってHTTP/2で通信を試みる可能性があります。
35        // CURLOPT_ALTSVC_CTRLは、Alternative Servicesの処理方法を制御するためのオプションです。
36        curl_setopt($ch, CURLOPT_ALTSVC_CTRL, CURLALTSVC_H2);
37
38        // 個別のCURLハンドルをマルチCURLハンドルに追加します。
39        // これにより、このハンドルが並行処理の対象となります。
40        curl_multi_add_handle($multi_handle, $ch);
41        $curl_handles[$index] = $ch;
42    }
43
44    // すべてのリクエストが完了するまでループします。
45    $running = null;
46    do {
47        // マルチCURLリクエストを実行し、まだ実行中のハンドル数を取得します。
48        // この関数は、データ転送を継続したり、新しい接続を確立したりします。
49        curl_multi_exec($multi_handle, $running);
50
51        // アクティブなハンドルがある場合、ソケットアクティビティを待ちます。
52        // これによりCPUを無駄に消費せず、イベント駆動で処理を進められます。
53        if ($running) {
54            curl_multi_select($multi_handle, 1.0); // 最大1秒間待機
55        }
56    } while ($running > 0); // 実行中のハンドルがなくなるまでループを続けます。
57
58    // 各CURLハンドルの結果を取得し、リソースを解放します。
59    foreach ($curl_handles as $index => $ch) {
60        $url = $urls[$index]; // 元のURLを取得
61        $response = curl_multi_getcontent($ch); // レスポンスボディを取得
62        $error = curl_error($ch); // エラー情報を取得
63
64        if ($error) {
65            $results[$url] = "Error for " . $url . ": " . $error;
66        } else {
67            $results[$url] = $response;
68        }
69
70        // マルチハンドルから個別のCURLハンドルを削除します。
71        curl_multi_remove_handle($multi_handle, $ch);
72        // 個別のCURLハンドルを閉じ、リソースを解放します。
73        curl_close($ch);
74    }
75
76    // マルチCURLハンドルを閉じ、関連するリソースをすべて解放します。
77    curl_multi_close($multi_handle);
78
79    return $results;
80}
81
82// このスクリプトがコマンドラインから直接実行された場合のテストコード
83// `$argv[0]` はスクリプト自身のパスを示します。
84// `$_SERVER['SCRIPT_FILENAME']` は実行中のスクリプトのフルパスを示します。
85// `realpath()` はシンボリックリンクなどを解決した実際のパスを返します。
86if (realpath($argv[0]) === realpath($_SERVER['SCRIPT_FILENAME'])) {
87    echo "Starting multi-cURL requests...\n";
88
89    // 取得したいURLのリスト
90    $urlsToFetch = [
91        'https://example.com',
92        'https://www.php.net',
93        'https://httpbin.org/delay/1', // 1秒遅延するURL (並行処理の確認用)
94        'https://invalid.example.com/nonexistent', // 存在しないURL (エラー処理の確認用)
95    ];
96
97    // マルチCURL関数を実行
98    $fetchedResults = performMultiCurlRequests($urlsToFetch);
99
100    echo "\n--- Results ---\n";
101    foreach ($fetchedResults as $url => $content) {
102        echo "URL: " . $url . "\n";
103        if (is_string($content) && str_starts_with($content, "Error")) {
104            echo "Status: " . $content . "\n";
105        } else {
106            echo "Status: Success\n";
107            // 取得したコンテンツの先頭100文字を表示
108            echo "Content snippet: " . substr((string)$content, 0, 100) . "...\n";
109        }
110        echo "-------------------\n";
111    }
112    echo "Multi-cURL requests finished.\n";
113}

このPHPサンプルコードは、CURL拡張機能を利用して複数のURLからデータを並行して取得する方法を示しています。performMultiCurlRequests関数は、引数として取得したいURLの配列（$urls）を受け取り、URLをキーとし、取得したレスポンスボディまたはエラーメッセージを値とする配列を返します。

このコードの重要な点は、CURLALTSVC_H2定数の使い方です。この定数はcurl_setopt関数でCURLOPT_ALTSVC_CTRLオプションと共に設定されます。これにより、もしWebサーバーがAlternative Services（代替サービス）という仕組みを提供し、それがHTTP/2サービスを示していれば、CURLはHTTP/2プロトコルでの通信を試みるようになります。これは通信の効率化や速度向上に貢献する可能性があります。

処理の流れとしては、まずcurl_multi_initで複数のCURLリクエストを管理するマルチハンドルを初期化します。次に、指定された各URLに対し、個別のCURLハンドル（curl_init）を作成し、URLやタイムアウトなどの基本設定に加えてCURLALTSVC_H2を設定します。これらの個別のハンドルはcurl_multi_add_handleでマルチハンドルに追加されます。すべてのリクエストが追加された後、curl_multi_execとcurl_multi_selectをループ内で呼び出し、すべての並行リクエストが完了するのを効率的に待ちます。最後に、各ハンドルの結果をcurl_multi_getcontentで取得し、エラー処理を行いながら、すべてのCURLハンドルを適切に閉じ、結果を返します。

Copy
1<?php
2
3/**
4 * PHP cURLでCURLALTSVC_H2定数を使用する方法を示すサンプルコードです。
5 * この定数は、cURLのAlternative Services (Alt-Svc) 機能において、
6 * HTTP/2 (H2) へのプロトコルアップグレードを許可するためのフラグとして使用されます。
7 *
8 * @param string $url リクエストを送信するターゲットURL。
9 * @return string|false 成功した場合はレスポンスボディ、失敗した場合はfalse。
10 */
11function demonstrateCurlAltSvcH2Usage(string $url): string|false
12{
13    // cURLハンドルの初期化
14    $ch = curl_init();
15
16    if ($ch === false) {
17        echo "エラー: cURLハンドルの初期化に失敗しました。\n";
18        return false;
19    }
20
21    // cURLオプションの設定
22    curl_setopt($ch, CURLOPT_URL, $url);
23    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // 実行結果を文字列として返す
24
25    // Alt-Svc機能を有効にし、Alt-Svc情報がキャッシュされるファイルパスを指定
26    // この例ではシステムの一時ディレクトリにファイルを生成します。
27    $altSvcCacheFile = sys_get_temp_dir() . '/curl_altsvc_cache.txt';
28    curl_setopt($ch, CURLOPT_ALTSVC, $altSvcCacheFile);
29
30    // CURLALTSVC_H2定数を使用して、Alt-SvcにおけるHTTP/2の利用を許可
31    // この定数はCURLOPT_ALTSVC_FLAGSオプションの値として設定します。
32    // これにより、もしサーバーがAlt-Svcヘッダーを通じてHTTP/2を提供している場合、
33    // cURLはその情報を使ってHTTP/2にアップグレードできるようになります。
34    curl_setopt($ch, CURLOPT_ALTSVC_FLAGS, CURLALTSVC_H2);
35
36    // cURLリクエストの実行
37    $response = curl_exec($ch);
38
39    // エラーチェック
40    if (curl_errno($ch)) {
41        echo 'cURLエラー: ' . curl_error($ch) . "\n";
42        $response = false;
43    }
44
45    // cURLハンドルのクローズ
46    curl_close($ch);
47
48    // (注意: このサンプルでは一時ファイルを削除していません。
49    //  本番環境では、アプリケーションの終了時などに適切に管理または削除することが推奨されます。)
50
51    return $response;
52}
53
54// --- サンプルコードの実行例 ---
55// 実際にAlt-Svcヘッダーを送信するサーバーでなくても、
56// このオプションを設定するデモンストレーションとしては機能します。
57$targetUrl = "https://www.google.com"; // 動作確認のため、HTTPSサイトを指定
58
59echo "指定されたURL (" . $targetUrl . ") へcURLリクエストを送信しています...\n";
60echo "CURLALTSVC_H2定数により、Alt-SvcでのHTTP/2利用を許可する設定が適用されます。\n\n";
61
62$result = demonstrateCurlAltSvcH2Usage($targetUrl);
63
64if ($result !== false) {
65    echo "cURLリクエスト成功。\n";
66    // レスポンスの最初の200文字を表示（レスポンスが長い場合があるため）
67    echo "--- レスポンス抜粋 ---\n";
68    echo substr($result, 0, 200) . (strlen($result) > 200 ? '...' : '') . "\n";
69    echo "-----------------------\n";
70} else {
71    echo "cURLリクエスト失敗。\n";
72}
73
74?>

PHPのCURLALTSVC_H2定数は、Webサーバーとの通信を行うcURL拡張機能で使用される特別な値です。この定数は、cURLの「Alternative Services（Alt-Svc）」という機能において、HTTP/2プロトコルを利用した通信へのアップグレードを許可するために使われます。Alt-Svcは、クライアントが異なるプロトコルやポートを通じて同じサービスにアクセスできることをサーバーが通知する仕組みです。

提供されたサンプルコードのdemonstrateCurlAltSvcH2Usage関数は、この定数の使用方法を示しています。この関数は引数に$url（リクエストを送信するターゲットURL）を受け取ります。内部では、まずcurl_init()でcURLハンドルを初期化し、CURLOPT_URLでURLを設定します。重要な点として、CURLOPT_ALTSVCオプションでAlt-Svc情報をキャッシュするファイルパスを指定し、CURLOPT_ALTSVC_FLAGSオプションにCURLALTSVC_H2定数を設定することで、Alt-Svc経由でのHTTP/2の利用をcURLに許可します。これにより、もしサーバーがAlt-Svcヘッダーを通じてHTTP/2を提供していれば、cURLはその情報を使って効率的な通信を行うことができます。

関数はcurl_exec()でリクエストを実行し、成功した場合はWebサーバーからのレスポンスボディを文字列として返します。通信に失敗した場合はfalseを返します。この定数を使用することで、cURLがサーバーから提示されたより効率的なHTTP/2プロトコルへ自動的に切り替える可能性が生まれ、パフォーマンスの向上が期待できます。