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

Copy
1<?php
2
3/**
4 * cURLを使用して指定されたURLの事前転送時間（pre-transfer time）を測定します。
5 *
6 * 事前転送時間とは、cURLリクエストが開始されてから、
7 * 実際にデータ転送が開始されるまでの時間（DNS解決、TCP接続、SSLハンドシェイクなど）を指します。
8 * CURLINFO_PRETRANSFER_TIME_T 定数は、この時間をマイクロ秒単位の整数で返します。
9 * (PHP 8.0以降で利用可能)
10 *
11 * @param string $url 測定対象のURL
12 * @return void
13 */
14function measurePretransferTime(string $url): void
15{
16    // cURLセッションを初期化します。
17    $ch = curl_init();
18
19    // cURLの初期化に失敗した場合のエラー処理
20    if ($ch === false) {
21        echo "エラー: cURLの初期化に失敗しました。\n";
22        return;
23    }
24
25    // 転送するURLを設定します。
26    curl_setopt($ch, CURLOPT_URL, $url);
27    // 転送結果を文字列として返すように設定します。
28    // (ここでは時間計測が目的のため、結果自体は使用しません)
29    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
30    // ヘッダー情報を含まないように設定します。
31    curl_setopt($ch, CURLOPT_HEADER, false);
32
33    // cURL転送を実行します。
34    // 時間情報を取得するためには、実際に転送を試みる必要があります。
35    curl_exec($ch);
36
37    // 事前転送時間（マイクロ秒単位）を取得します。
38    // CURLINFO_PRETRANSFER_TIME_T を使用することで、より高精度な整数値を取得できます。
39    $pretransferTimeMicroseconds = curl_getinfo($ch, CURLINFO_PRETRANSFER_TIME_T);
40
41    // cURLセッションを閉じ、関連するリソースを解放します。
42    curl_close($ch);
43
44    // 取得した時間を表示します。
45    if ($pretransferTimeMicroseconds !== false) {
46        echo "URL: " . $url . "\n";
47        echo "事前転送時間 (マイクロ秒): " . $pretransferTimeMicroseconds . "\n";
48        // 初心者にも分かりやすいように秒単位に変換して表示します。
49        echo "事前転送時間 (秒): " . sprintf("%.6f", $pretransferTimeMicroseconds / 1_000_000) . "秒\n";
50    } else {
51        echo "エラー: 事前転送時間の取得に失敗しました。\n";
52    }
53}
54
55// サンプルとして、一般的なウェブサイトの事前転送時間を測定します。
56measurePretransferTime("https://www.example.com");
57
58?>

このサンプルコードは、PHPのcURL拡張機能を利用して、指定されたウェブサイトへの「事前転送時間」を計測する方法を示しています。

「事前転送時間」とは、cURLリクエストが開始されてから、実際にデータの転送が始まるまでの間にかかる時間のことです。具体的には、DNS（ドメイン名解決）、TCP（ネットワーク接続の確立）、SSL/TLS（暗号化通信のハンドシェイク）といった、データを送受信する前の準備にかかる時間を指します。CURLINFO_PRETRANSFER_TIME_Tは、この事前転送時間をマイクロ秒単位の整数として取得するためのcURL情報定数です。PHP 8.0以降で利用でき、従来の秒単位の浮動小数点数よりも高精度な時間情報を提供します。

measurePretransferTime関数は、測定したいURLを文字列（$url）で引数に受け取ります。関数内部では、まずcURLセッションを初期化し、指定されたURLに対するオプションを設定して転送を実行します。転送完了後、curl_getinfo関数にCURLINFO_PRETRANSFER_TIME_T定数を渡すことで、事前転送時間がマイクロ秒単位で取得されます。取得された時間は画面に表示されますが、関数自体は値を返しません（void）。このコードは、ウェブサイトへの接続準備にかかる時間を理解し、パフォーマンス改善の指標とする際に役立ちます。

Copy
1<?php
2
3/**
4 * 指定されたURLに対してcURLリクエストを実行し、
5 * HTTPステータスコードと転送前処理にかかった時間を表示します。
6 * この関数は、ウェブサイトへの接続状況や初期応答速度を測定する際の
7 * 基本的な情報を取得する方法を、システムエンジニアの初心者向けに示します。
8 *
9 * CURLINFO_PRETRANSFER_TIME_T 定数は、名前解決、TCP接続、SSLハンドシェイクなど、
10 * 実際にデータ転送が開始されるまでの処理にかかった時間をマイクロ秒単位で返します。
11 * CURLINFO_HTTP_CODE 定数は、リクエストに対するHTTPステータスコードを返します。
12 *
13 * @param string $url リクエストを送信するターゲットURL。
14 * @return bool cURLリクエストの実行と情報取得が成功した場合はtrue、失敗した場合はfalse。
15 */
16function getCurlTransferMetrics(string $url): bool
17{
18    // 1. cURLセッションを初期化します。
19    // curl_init() は新しいcURLセッションを開始し、ハンドルを返します。
20    $ch = curl_init();
21
22    // 初期化に失敗した場合のハンドリング
23    if ($ch === false) {
24        echo "エラー: cURLセッションの初期化に失敗しました。\n";
25        return false;
26    }
27
28    // 2. cURLオプションを設定します。
29    // CURLOPT_URL: リクエストを送信するURLを設定します。
30    curl_setopt($ch, CURLOPT_URL, $url);
31    // CURLOPT_RETURNTRANSFER: curl_exec() が結果を文字列として返すように設定します。
32    // これにより、結果が直接出力されず、変数に格納できます。
33    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
34    // CURLOPT_TIMEOUT: cURL操作の最大実行時間を秒単位で設定します。
35    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
36    // CURLOPT_CONNECTTIMEOUT: 接続確立の最大待機時間を秒単位で設定します。
37    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
38
39    // 3. cURLリクエストを実行します。
40    // curl_exec() は設定されたオプションに基づいてリクエストを実行します。
41    $response = curl_exec($ch);
42
43    // 4. エラーが発生したか確認します。
44    if ($response === false) {
45        // curl_error() は直近のcURL操作のエラーメッセージを返します。
46        echo "エラー: cURLリクエストの実行中に問題が発生しました: " . curl_error($ch) . "\n";
47        // curl_close() でcURLセッションを閉じ、リソースを解放します。
48        curl_close($ch);
49        return false;
50    }
51
52    // 5. 必要なcURL情報を取得します。
53    // curl_getinfo() はcURL転送に関する情報を取得するために使用されます。
54    // CURLINFO_HTTP_CODE: 最後に受信したHTTPステータスコードを取得します。
55    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
56    // CURLINFO_PRETRANSFER_TIME_T: 転送開始までの前処理時間（マイクロ秒単位）を取得します。
57    $pretransferTimeMicroseconds = curl_getinfo($ch, CURLINFO_PRETRANSFER_TIME_T);
58
59    // 6. 取得した情報を表示します。
60    echo "--- cURL転送メトリクス ---\n";
61    echo "URL: " . $url . "\n";
62    echo "HTTPステータスコード: " . $httpCode . "\n";
63    echo "転送前処理時間 (マイクロ秒): " . $pretransferTimeMicroseconds . "\n";
64    // マイクロ秒を秒に変換して表示すると、より分かりやすくなります。
65    echo "転送前処理時間 (秒): " . ($pretransferTimeMicroseconds / 1000000) . "秒\n";
66    echo "--------------------------\n";
67
68    // 7. cURLセッションを閉じ、リソースを解放します。
69    curl_close($ch);
70
71    return true;
72}
73
74// サンプル使用例: 実際のURLを指定して関数を呼び出します。
75getCurlTransferMetrics("https://www.example.com");
76
77// 存在しないURLやエラーが発生する可能性のあるURLでのテストも可能です。
78// getCurlTransferMetrics("https://nonexistent-domain-12345.com");

このPHPサンプルコードは、cURLという機能を使って、指定したウェブサイトにアクセスし、その応答状況に関する重要な情報を取得・表示する方法を示しています。システムエンジニアを目指す初心者の方が、ウェブサイトの接続状況や初期応答速度を測定する基礎を理解するのに役立ちます。

具体的には、getCurlTransferMetrics関数は、引数として受け取った$urlに対してcURLリクエストを送信します。リクエストの実行後、CURLINFO_HTTP_CODE定数を用いて、アクセスしたウェブサイトからの応答が「200 OK」のようなHTTPステータスコードとして正常だったかを確認します。さらに、CURLINFO_PRETRANSFER_TIME_T定数を使用することで、名前解決、TCP接続、SSLハンドシェイクなど、実際にデータの転送が始まるまでの準備にかかった時間をマイクロ秒単位で取得できます。これは、ウェブサイトの初期応答にどれくらいの時間がかかっているかを知る上で非常に重要な指標です。

コードの流れとしては、まずcurl_init()でcURLセッションを開始し、curl_setopt()でアクセス先のURLやデータ取得方法などの詳細な設定を行います。その後、curl_exec()でリクエストを実際に実行し、curl_getinfo()でHTTPステータスコードや転送前処理時間といった情報を取得します。もし処理中に問題が発生した場合はcurl_error()でエラーメッセージを表示し、最終的にはcurl_close()でcURLセッションを終了し、使用したリソースを解放します。この関数は、処理が成功した場合はtrueを、失敗した場合はfalseを戻り値として返します。