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

Copy
1<?php
2
3/**
4 * CURLリクエストでDNSキャッシュと全体のリクエストタイムアウトを設定するサンプルです。
5 *
6 * CURLOPT_DNS_CACHE_TIMEOUTはDNSの名前解決キャッシュの有効期間を設定し、
7 * CURLOPT_TIMEOUTはCURLリクエスト全体の実行時間制限を設定します。
8 */
9function executeCurlRequestWithTimeoutOptions(): void
10{
11    // 1. CURLセッションを初期化
12    $ch = curl_init();
13
14    if ($ch === false) {
15        echo "エラー: CURLセッションの初期化に失敗しました。\n";
16        return;
17    }
18
19    // 2. リクエスト対象のURLを設定
20    $url = 'https://www.example.com/'; // 例として一般的なウェブサイトを使用
21
22    // 3. CURLオプションを設定
23    // CURLOPT_URL: リクエストを送信するURL
24    curl_setopt($ch, CURLOPT_URL, $url);
25    // CURLOPT_RETURNTRANSFER: 実行結果を文字列として受け取る（true）か、直接出力（false）するか
26    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
27
28    // CURLOPT_DNS_CACHE_TIMEOUT: DNSの名前解決キャッシュを保持する期間（秒）を設定。
29    // この例では、DNS情報を60秒間キャッシュします。0に設定するとキャッシュ機能が無効になります。
30    curl_setopt($ch, CURLOPT_DNS_CACHE_TIMEOUT, 60);
31
32    // CURLOPT_TIMEOUT: CURLリクエスト全体の最大実行時間（秒）を設定。
33    // 名前解決、接続、データ転送のすべてを含め、この時間を超えるとタイムアウトエラーとなります。
34    // この例では、リクエスト全体が10秒を超えた場合、タイムアウトします。
35    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
36
37    echo "CURLリクエストを開始します: {$url}\n";
38    echo "  - DNSキャッシュタイムアウト設定: 60秒\n";
39    echo "  - 全体リクエストタイムアウト設定: 10秒\n";
40
41    // 4. リクエストを実行
42    $response = curl_exec($ch);
43
44    // 5. 結果の確認とエラーハンドリング
45    if ($response === false) {
46        echo "エラー: CURLリクエスト中に問題が発生しました。\n";
47        echo "  メッセージ: " . curl_error($ch) . "\n";
48        echo "  エラーコード: " . curl_errno($ch) . "\n";
49    } else {
50        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
51        echo "CURLリクエストが成功しました。HTTPステータスコード: {$httpCode}\n";
52        // レスポンスの内容は非常に長くなる場合があるため、ここでは表示を省略します。
53        // echo "レスポンスの一部:\n" . substr($response, 0, 200) . "...\n";
54    }
55
56    // 6. CURLセッションを終了し、リソースを解放
57    curl_close($ch);
58    echo "CURLセッションを閉じました。\n";
59}
60
61// 関数を実行して動作を確認
62executeCurlRequestWithTimeoutOptions();

このPHPサンプルコードは、CURLリクエストにおいてDNSキャッシュの有効期間とリクエスト全体のタイムアウトを設定する方法を示しています。

CURLOPT_DNS_CACHE_TIMEOUTは、CURLがDNSの名前解決結果を保持する期間（秒数）を指定する定数です。これにより、同じホスト名への後続のリクエストでDNS解決を省略し、処理速度を向上させることができます。サンプルコードでは60秒に設定しており、この期間内に同じホストへのリクエストがあればキャッシュされたDNS情報が利用されます。値が0の場合、DNSキャッシュは無効になります。この定数自体は引数を取らず、戻り値もありません。

一方、CURLOPT_TIMEOUTは、DNSの名前解決、接続、データ転送といったCURLリクエストの全工程にかかる最大実行時間（秒数）を設定する定数です。この時間を超えると、リクエストはタイムアウトエラーとなります。サンプルコードでは10秒に設定されており、リクエスト全体が10秒を超過した場合に処理が中断されます。この定数も引数を取らず、戻り値はありません。

コードではまずcurl_init()でCURLセッションを初期化し、CURLOPT_URLでリクエスト先URLを設定します。その後、curl_setopt()関数を使ってCURLOPT_DNS_CACHE_TIMEOUTとCURLOPT_TIMEOUTなどのオプションを設定し、curl_exec()でリクエストを実行します。最後にcurl_close()でセッションを閉じ、リソースを解放する一般的なCURLリクエストの流れを確認できます。エラー発生時には、curl_error()とcurl_errno()で詳細な情報を取得しています。

Copy
1<?php
2
3/**
4 * 指定されたURLに対してHTTP GETリクエストを実行し、
5 * 接続タイムアウトとDNSキャッシュタイムアウトを設定する例です。
6 *
7 * この関数は、ウェブサーバーへの接続確立時間と、DNS解決結果のキャッシュ期間を制御する方法を示します。
8 *
9 * @param string $url リクエストを送信するURL。
10 * @return string|false 成功した場合はレスポンスボディ（HTMLなど）、失敗した場合はfalseを返します。
11 */
12function fetchUrlWithTimeout(string $url): string|false
13{
14    // cURLセッションを初期化します。
15    // cURLはPHPでHTTPリクエストを送信するための強力なライブラリです。
16    $ch = curl_init();
17
18    // cURLオプションを設定します。
19    // ----------------------------------------------------
20    // CURLOPT_URL: リクエストを送信する対象のURLを設定します。
21    curl_setopt($ch, CURLOPT_URL, $url);
22
23    // CURLOPT_RETURNTRANSFER: サーバーからのレスポンスを直接出力せず、
24    // curl_exec() 関数の戻り値として文字列で取得するように設定します。
25    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
26
27    // CURLOPT_CONNECTTIMEOUT: サーバーへの接続を確立するまでの最大秒数を設定します。
28    // この秒数内にTCP/IP接続が確立できない場合、cURLはタイムアウトエラーを発生させます。
29    // 例えば、ターゲットサーバーが存在しない、ネットワークが混雑しているなどの場合に役立ちます。
30    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5); // 5秒の接続タイムアウトを設定
31
32    // CURLOPT_DNS_CACHE_TIMEOUT: DNS解決結果をキャッシュする秒数を設定します。
33    // この値は、指定されたホスト名（例: example.com）のIPアドレスをcURLが
34    // どれだけの期間キャッシュするかを決定します。
35    // キャッシュ期間が過ぎると、cURLは再度DNS解決を試みます。
36    // 0を設定するとDNSキャッシュは無効になり、毎回DNS解決が行われます。
37    // 長い時間を設定することで、同じホストへの連続したリクエストでDNS解決のオーバーヘッドを減らすことができますが、
38    // IPアドレスが頻繁に変わる場合は注意が必要です。
39    curl_setopt($ch, CURLOPT_DNS_CACHE_TIMEOUT, 600); // 10分 (600秒) のDNSキャッシュタイムアウトを設定
40    // ----------------------------------------------------
41
42    // 設定したオプションでHTTPリクエストを実行し、レスポンスを取得します。
43    $response = curl_exec($ch);
44
45    // cURL実行中にエラーが発生したかを確認します。
46    if (curl_errno($ch)) {
47        // エラーがある場合、エラーメッセージを表示します。
48        echo 'cURL エラー: ' . curl_error($ch) . PHP_EOL;
49        $response = false; // エラー時はfalseを返します。
50    }
51
52    // cURLセッションを閉じ、使用したリソースを解放します。
53    curl_close($ch);
54
55    return $response;
56}
57
58// --- 以下は上記の関数を実際に使用するサンプルコードです ---
59
60// 接続テスト用のサンプルURLを指定します。
61$targetUrl = 'https://www.example.com';
62
63echo "URL: {$targetUrl} からデータを取得中...\n";
64
65// 定義した関数を呼び出し、URLからデータを取得します。
66$data = fetchUrlWithTimeout($targetUrl);
67
68// データの取得が成功したかを確認し、結果を表示します。
69if ($data !== false) {
70    echo "データの取得に成功しました。取得したデータの最初の200文字:\n";
71    // 取得したデータの一部（最初の200文字）を表示します。
72    echo substr($data, 0, 200) . "...\n";
73} else {
74    echo "データの取得に失敗しました。\n";
75}

このPHPサンプルコードは、指定されたURLへHTTP GETリクエストを送信する際に、接続の確立時間とDNS解決結果のキャッシュ期間を制御する方法を示しています。fetchUrlWithTimeout関数は、リクエスト先のURLを文字列として受け取り、成功した場合はウェブサーバーからのレスポンスボディを文字列で返します。リクエストの実行中にエラーが発生した場合はfalseを返します。

関数内では、まずHTTP通信を行うためのcURLセッションが初期化され、様々なオプションが設定されます。CURLOPT_URLにはリクエストを送信する対象のURLを指定し、CURLOPT_RETURNTRANSFERをtrueに設定することで、サーバーからの応答を直接出力せず、関数の戻り値として文字列で取得するようにしています。

特に重要なのは、CURLOPT_CONNECTTIMEOUTとCURLOPT_DNS_CACHE_TIMEOUTの二つの設定です。CURLOPT_CONNECTTIMEOUTは、PHPがターゲットサーバーへのTCP/IP接続を確立するまでの最大秒数を設定します。このサンプルでは5秒が設定されており、この時間内に接続できない場合、cURLはタイムアウトエラーを発生させ、プログラムが不要な待機状態に陥ることを防ぎます。

一方、CURLOPT_DNS_CACHE_TIMEOUTは、ホスト名（例: www.example.com）から対応するIPアドレスを解決した結果（DNS解決結果）をcURLがどれくらいの期間キャッシュするかを秒単位で指定します。この例では600秒（10分）が設定されており、このキャッシュ期間内であれば、同じホスト名への次のリクエスト時にDNS解決が省略され、処理の高速化が期待できます。0を設定するとDNSキャッシュは無効になり、リクエストごとに毎回DNS解決が行われます。ただし、ターゲットサーバーのIPアドレスが頻繁に変わる環境では、古いキャッシュ情報によって接続エラーが発生する可能性があるため、注意が必要です。

オプション設定後、curl_exec()でHTTPリクエストが実行され、取得したレスポンスやエラー情報が処理されます。最後にcurl_close()でcURLセッションが閉じられ、使用したリソースが解放されます。関数の呼び出し例では、https://www.example.comからデータを取得し、その結果の成否と取得データの一部を表示しています。