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

Copy
1<?php
2
3/**
4 * CURLOPT_ENCODING を使用してHTTP GETリクエストを送信する関数。
5 *
6 * CURLOPT_ENCODING は、HTTPリクエストの Accept-Encoding ヘッダを設定するために使用されます。
7 * これにより、サーバーはレスポンスをgzipなどの圧縮形式で送信できるようになり、
8 * データ転送量を削減し、通信速度を向上させることが期待できます。
9 *
10 * @param string $url リクエストを送信するターゲットURL。
11 * @return string|false 成功した場合はレスポンス本文、失敗した場合は false。
12 */
13function fetchContentWithEncoding(string $url): string|false
14{
15    // 1. cURLセッションを初期化
16    $ch = curl_init();
17
18    // 2. cURLオプションを設定
19    // リクエスト先のURL
20    curl_setopt($ch, CURLOPT_URL, $url);
21
22    // サーバーからのレスポンスを文字列として取得するように設定（trueにすると curl_exec() が結果を返す）
23    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
24
25    // HTTPステータスコードが400以上の場合、curl_exec() が false を返すように設定
26    curl_setopt($ch, CURLOPT_FAILONERROR, true);
27
28    // Accept-Encoding ヘッダを設定する。これが CURLOPT_ENCODING の主な役割。
29    // 空文字列 "" を指定すると、cURLがサポートするすべてのエンコーディング
30    // (例: gzip, deflate, br) を Accept-Encoding ヘッダに自動的に追加します。
31    // これにより、サーバーがサポートする最適な圧縮形式でデータを受信できます。
32    // 特定のエンコーディングのみを要求する場合は "gzip" や "deflate" のように指定できます。
33    curl_setopt($ch, CURLOPT_ENCODING, "");
34
35    // 3. cURLセッションを実行し、レスポンスを取得
36    $response = curl_exec($ch);
37
38    // 4. エラーチェック
39    if (curl_errno($ch)) {
40        echo 'cURLエラー (' . curl_errno($ch) . '): ' . curl_error($ch) . PHP_EOL;
41        curl_close($ch);
42        return false;
43    }
44
45    // HTTPステータスコードの確認 (CURLOPT_FAILONERROR があるため厳密には不要な場合もあるが、確認は良い習慣)
46    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
47    if ($httpCode >= 400) {
48        echo "HTTPエラー: レスポンスコード " . $httpCode . PHP_EOL;
49        curl_close($ch);
50        return false;
51    }
52
53    // 5. cURLセッションを終了
54    curl_close($ch);
55
56    return $response;
57}
58
59// 使用例:
60// httpbin.org は、送信されたHTTPリクエストヘッダをレスポンスの一部として返すため、
61// Accept-Encoding ヘッダが正しく設定されているかを確認するのに便利です。
62$targetUrl = 'http://httpbin.org/get';
63
64echo "URL: " . $targetUrl . PHP_EOL;
65echo "CURLOPT_ENCODING を使用してリクエストを送信中..." . PHP_EOL;
66
67$content = fetchContentWithEncoding($targetUrl);
68
69if ($content !== false) {
70    echo "リクエスト成功！レスポンスの一部を表示します。" . PHP_EOL;
71    
72    // httpbin.orgからのレスポンスはJSON形式であると仮定してデコード
73    $data = json_decode($content, true);
74
75    if (json_last_error() === JSON_ERROR_NONE && isset($data['headers'])) {
76        echo "----------------------------------------" . PHP_EOL;
77        echo "リクエストヘッダ (サーバーが受け取ったもの):" . PHP_EOL;
78        // Accept-Encoding が含まれていることを確認
79        print_r($data['headers']);
80        echo "----------------------------------------" . PHP_EOL;
81    } else {
82        echo "レスポンスのデコードに失敗したか、予期せぬ形式です。" . PHP_EOL;
83        // JSONでない場合や非常に長い場合は一部のみ表示
84        echo substr($content, 0, 500) . (strlen($content) > 500 ? '...' : '') . PHP_EOL;
85    }
86} else {
87    echo "リクエスト失敗。" . PHP_EOL;
88}
89
90?>

PHPのCURLOPT_ENCODINGは、cURLセッションでHTTPリクエストを送信する際に、サーバーからのレスポンスを圧縮形式で受け取ることを要求するためのオプション定数です。この定数をcurl_setopt関数で使用すると、HTTPヘッダのAccept-Encodingフィールドが設定されます。これにより、サーバーはレスポンスデータをgzipやdeflateといった形式で圧縮して送信できるようになり、データ転送量の削減と通信速度の向上が期待できます。

サンプルコードでは、curl_setopt($ch, CURLOPT_ENCODING, ""); のように利用されています。ここで空文字列 "" を指定することが重要で、これはcURLがサポートするすべてのエンコーディング形式（例: gzip, deflate, br）を自動的にAccept-Encodingヘッダに含めるよう指示するものです。これにより、サーバーはクライアントが対応可能な最適な圧縮方式でレスポンスを返すことが可能になります。もし特定のエンコーディングのみを要求したい場合は、"gzip"のように直接文字列で指定できます。CURLOPT_ENCODING自体は、cURLの挙動を定義する定数であり、それ自身が引数や戻り値を持つものではありませんが、curl_setopt関数の第三引数に渡す値がその挙動を決定します。

Copy
1<?php
2
3/**
4 * 指定されたURLに対してcURLリクエストを実行し、エンコーディングオプションを設定します。
5 *
6 * CURLOPT_ENCODING を空文字列に設定することで、cURL はサーバーがサポートするすべてのエンコーディング
7 * (例: gzip, deflate, br) を受け入れ、圧縮されたレスポンスを自動的に解凍します。
8 *
9 * @param string $url リクエストを送信するURL
10 * @return string|false リクエストのレスポンス本文、またはエラー発生時は false
11 */
12function makeCurlRequestWithEncoding(string $url): string|false
13{
14    // cURLセッションを初期化します
15    $ch = curl_init();
16
17    // cURLセッションのオプションを設定します
18    // リクエスト先のURL
19    curl_setopt($ch, CURLOPT_URL, $url);
20
21    // CURLOPT_ENCODING オプションを設定します。
22    // 空文字列 "" を指定すると、cURL は "Accept-Encoding: gzip, deflate, br"
23    // のようなヘッダーを送信し、サーバーからの圧縮されたレスポンスを自動的に解凍します。
24    curl_setopt($ch, CURLOPT_ENCODING, "");
25
26    // curl_exec() が文字列として結果を返すように設定します (標準出力には出力しません)
27    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
28
29    // HTTPSリクエストの場合、SSL証明書の検証をスキップします (開発・テスト目的。本番環境では通常、有効にすべきです)
30    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
31    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
32
33    // cURLリクエストを実行します
34    $response = curl_exec($ch);
35
36    // cURLエラーが発生したかチェックします
37    if (curl_errno($ch)) {
38        echo 'cURL エラー (' . curl_errno($ch) . '): ' . curl_error($ch) . PHP_EOL;
39        curl_close($ch);
40        return false;
41    }
42
43    // cURLセッションを閉じます
44    curl_close($ch);
45
46    return $response;
47}
48
49// 使用例: Googleのトップページにリクエストを送信
50$targetUrl = "https://www.example.com"; // アクセスしたいURLに置き換えてください
51
52echo "--- cURL リクエスト開始 ---" . PHP_EOL;
53
54$content = makeCurlRequestWithEncoding($targetUrl);
55
56if ($content !== false) {
57    echo "--- レスポンスの一部 (最初の500文字) ---" . PHP_EOL;
58    // レスポンスが長すぎる場合を考慮し、最初の500文字のみ表示
59    echo mb_substr($content, 0, 500) . "..." . PHP_EOL;
60} else {
61    echo "リクエストに失敗しました。" . PHP_EOL;
62}
63
64echo "--- cURL リクエスト終了 ---" . PHP_EOL;
65
66?>

このサンプルコードは、PHPのcURL拡張機能を利用してWebサーバーへHTTPリクエストを送信する際に、データの圧縮と解凍を効率的に行う方法を示しています。

CURLOPT_ENCODING は、cURLリクエストのオプションを設定するための定数です。この定数自体は引数を取らず、戻り値もありませんが、curl_setopt() 関数と組み合わせて使用することで、cURLがサーバーからの圧縮されたレスポンスをどのように扱うかを指示します。

サンプルコードでは、curl_setopt($ch, CURLOPT_ENCODING, "") と設定しています。ここに空文字列 "" を指定すると、cURLはリクエストヘッダーに "Accept-Encoding: gzip, deflate, br" のようにサーバーがサポートする様々な圧縮形式を受け入れることを自動で通知します。これにより、サーバーが圧縮されたデータ（例：gzip形式）を返した場合、cURLはそのデータを自動的に解凍してからアプリケーションに渡します。この仕組みによって、ネットワーク転送量を削減し、通信を高速化する効果が期待できます。

makeCurlRequestWithEncoding 関数は、リクエストを送信するURL（文字列）を引数に取ります。処理が成功した場合は、サーバーからのレスポンス本文を文字列として返し、何らかのエラーが発生した際には false を返します。関数内では、cURLセッションの初期化から、URLやエンコーディングを含む各種オプション設定、リクエストの実行、エラーチェック、そしてセッションの終了までの一連の流れが実装されています。特に、CURLOPT_RETURNTRANSFER は、レスポンスを直接出力せず、関数の戻り値として取得するために重要な設定です。