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

Copy
1<?php
2
3/**
4 * CURLOPT_DNS_SHUFFLE_ADDRESSES を使用した cURL リクエストの例。
5 * DNS 解決で複数の IP アドレスが返された場合に、それらのアドレスをシャッフルして接続を試行します。
6 * これにより、複数の IP アドレスを持つホストへの接続時におけるロードバランシングや
7 * フェイルオーバーの改善に役立つことがあります。
8 */
9function makeCurlRequestWithDnsShuffle(): void
10{
11    // cURL セッションを初期化します。
12    $ch = curl_init();
13
14    if ($ch === false) {
15        echo "cURL セッションの初期化に失敗しました。\n";
16        return;
17    }
18
19    // リクエスト先の URL を設定します。
20    // このオプションの効果を確認するには、複数の IP アドレスを持つドメインへのリクエストが理想的です。
21    curl_setopt($ch, CURLOPT_URL, 'http://www.example.com');
22
23    // CURLOPT_DNS_SHUFFLE_ADDRESSES を true に設定することで、
24    // DNS 解決で複数の IP アドレスが返された場合に、それらの順序をシャッフルします。
25    // デフォルトは false (シャッフルしない) です。
26    curl_setopt($ch, CURLOPT_DNS_SHUFFLE_ADDRESSES, true);
27
28    // 戻り値を文字列として取得するように設定します。
29    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
30
31    // cURL リクエストを実行します。
32    $response = curl_exec($ch);
33
34    if ($response === false) {
35        // エラーが発生した場合、エラーメッセージを表示します。
36        echo "cURL エラー: " . curl_error($ch) . "\n";
37    } else {
38        // リクエストが成功した場合。
39        echo "cURL リクエストが成功しました。\n";
40        // 必要に応じて $response の内容を処理します。
41        // 例: echo "レスポンスの先頭部分: " . mb_substr($response, 0, 100) . "...\n";
42    }
43
44    // cURL セッションを閉じ、リソースを解放します。
45    curl_close($ch);
46}
47
48// 関数を実行します。
49makeCurlRequestWithDnsShuffle();
50

PHP 8のCURLOPT_DNS_SHUFFLE_ADDRESSESは、cURL拡張機能で利用される定数です。この定数は、DNS解決によって、あるドメイン名に対し複数のIPアドレスが返された際に、それらのアドレスの順序をランダムにシャッフルして接続を試みるようにcURLの動作を設定するために使用されます。これにより、複数のIPアドレスを持つサーバーへの接続において、特定のIPアドレスへの集中を避け、負荷の分散や、障害時のフェイルオーバー能力の向上に寄与します。ロードバランシングやシステムの信頼性向上に役立つオプションと言えます。

サンプルコードでは、まずcurl_init()でcURLセッションを初期化し、接続先のURLをCURLOPT_URLで指定しています。次に、curl_setopt()関数を用いてCURLOPT_DNS_SHUFFLE_ADDRESSESにtrueを設定することで、DNSアドレスのシャッフル機能を有効にしています。この定数自体に引数や戻り値はありませんが、curl_setopt()の第3引数にtrueを設定することで、その機能が有効になり、デフォルトの「シャッフルしない」動作から変更されます。設定後、curl_exec()でHTTPリクエストが実行され、結果が取得されます。最後に、curl_close()でセッションを終了し、使用したリソースを解放します。

Copy
1<?php
2
3/**
4 * 指定されたURLに対して cURL リクエストを実行し、CURLOPT_DNS_SHUFFLE_ADDRESSES オプションの動作を示します。
5 *
6 * このオプションは、DNS解決で複数のIPアドレスが返された場合に、
7 * 接続を試みるIPアドレスの順序をシャッフルするかどうかを制御します。
8 *
9 * @param string $url リクエストを送信するURL
10 * @param bool $shuffle DNSアドレスをシャッフルするかどうか (true: シャッフル, false: シャッフルしない)
11 * @return string|false リクエストの応答ボディ、またはエラーが発生した場合は false
12 */
13function fetchUrlWithDnsShuffle(string $url, bool $shuffle = true)
14{
15    // cURLセッションを初期化
16    $ch = curl_init();
17
18    if (false === $ch) {
19        echo "cURLセッションの初期化に失敗しました。\n";
20        return false;
21    }
22
23    // 基本的なcURLオプションを設定
24    curl_setopt($ch, CURLOPT_URL, $url);
25    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // 応答を文字列として取得
26    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);   // 接続試行のタイムアウトを10秒に設定
27    curl_setopt($ch, CURLOPT_TIMEOUT, 30);          // 実行全体のタイムアウトを30秒に設定
28
29    // CURLOPT_DNS_SHUFFLE_ADDRESSES オプションを設定
30    // DNS解決で複数のIPアドレスが返された際、cURLが接続を試みるIPアドレスの順序を制御します。
31    // true (デフォルト): 返されたIPアドレスをランダムにシャッフルして試します。
32    //                   これにより、負荷分散や特定のIPへの集中回避、障害時の切り替え促進に役立つことがあります。
33    // false: DNSサーバーから返された順序でIPアドレスを試します。
34    curl_setopt($ch, CURLOPT_DNS_SHUFFLE_ADDRESSES, $shuffle);
35
36    echo "URL: '{$url}' にリクエストを送信中 (DNSアドレスシャッフル設定: " . ($shuffle ? '有効' : '無効') . ")...\n";
37
38    // cURLリクエストを実行
39    $response = curl_exec($ch);
40
41    // エラーチェック
42    if (false === $response) {
43        echo "cURLエラーが発生しました: " . curl_error($ch) . "\n";
44        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
45        echo "HTTPステータスコード: " . $httpCode . "\n";
46        $response = false;
47    } else {
48        echo "リクエストが正常に完了しました。\n";
49        // 応答が非常に大きい場合があるので、一部のみ表示するか、表示しない
50        // echo "応答内容の一部: " . substr($response, 0, 200) . "...\n";
51    }
52
53    // cURLセッションを閉じる
54    curl_close($ch);
55
56    return $response;
57}
58
59// --- サンプル使用例 ---
60
61// 複数のIPアドレスを持つ可能性のある一般的なウェブサイトURLを使用
62// 実際のサイトのDNS設定によっては、常に複数のIPが返されるとは限りません。
63$targetUrl = 'https://www.example.com';
64
65echo "--- DNSアドレスシャッフルを無効にしてリクエスト (CURLOPT_DNS_SHUFFLE_ADDRESSES = false) --- \n";
66$resultNoShuffle = fetchUrlWithDnsShuffle($targetUrl, false);
67if ($resultNoShuffle !== false) {
68    // 取得した応答データをここで処理できます
69    // 例: echo "取得バイト数: " . strlen($resultNoShuffle) . "\n";
70}
71echo "\n";
72
73echo "--- DNSアドレスシャッフルを有効にしてリクエスト (CURLOPT_DNS_SHUFFLE_ADDRESSES = true, デフォルトの挙動) --- \n";
74$resultWithShuffle = fetchUrlWithDnsShuffle($targetUrl, true);
75if ($resultWithShuffle !== false) {
76    // 取得した応答データをここで処理できます
77    // 例: echo "取得バイト数: " . strlen($resultWithShuffle) . "\n";
78}
79
80?>

PHPのCURLOPT_DNS_SHUFFLE_ADDRESSESは、cURLでウェブサイトへ接続する際、DNS解決によって複数のIPアドレスが返された場合に、どのIPアドレスから接続を試みるかの順序を制御する定数です。

この定数をtrueに設定すると（これがデフォルトの動作です）、cURLはDNSから返されたIPアドレスのリストをランダムにシャッフルし、その順序で接続を試みます。これは、サーバー間の負荷を分散させたり、障害発生時に別のIPアドレスへの切り替えを促進するのに役立ちます。一方、falseに設定すると、DNSサーバーから返された順序そのままにIPアドレスを試します。

サンプルコードのfetchUrlWithDnsShuffle関数は、指定された$urlへcURLリクエストを送信し、$shuffle引数（真偽値）でIPアドレスのシャッフルを有効・無効にします。この関数は、成功時にウェブサーバーからの応答内容を文字列で返し、失敗時にはfalseを返します。この設定は、ネットワークの安定性向上や負荷分散に貢献します。