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

Copy
1<?php
2
3/**
4 * 指定されたURLにGETリクエストを送信し、パラメータをクエリ文字列として含めます。
5 *
6 * @param string $url 基本となるターゲットURL
7 * @param array $params 送信するGETパラメータの連想配列 (例: ['key' => 'value'])
8 * @return string|null 成功した場合はレスポンスボディ、失敗した場合はnullを返します。
9 */
10function sendGetRequestWithParams(string $url, array $params): ?string
11{
12    // 1. パラメータをURLエンコードしてクエリ文字列を作成します。
13    // 例: ['userId' => 1, '_limit' => 5] は "userId=1&_limit=5" に変換されます。
14    $queryString = http_build_query($params);
15
16    // 2. 基本URLにクエリ文字列を追加して、完全なURLを作成します。
17    // 例: "https://example.com/api?userId=1&_limit=5"
18    $fullUrl = $url;
19    if (!empty($queryString)) {
20        $fullUrl .= '?' . $queryString;
21    }
22
23    // 3. cURLセッションを初期化します。
24    $ch = curl_init();
25
26    // 4. cURLオプションを設定します。
27    // CURLOPT_URL: リクエストを送信する完全なURLを指定します。
28    curl_setopt($ch, CURLOPT_URL, $fullUrl);
29    // CURLOPT_RETURNTRANSFER: 実行結果を文字列として返すように設定します。
30    // trueにしない場合、結果は直接出力されます。
31    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
32
33    // 5. cURLリクエストを実行し、レスポンスを取得します。
34    $response = curl_exec($ch);
35
36    // 6. cURLリクエスト中にエラーが発生したか確認します。
37    if (curl_errno($ch)) {
38        // エラーが発生した場合、エラーメッセージをログに出力し、nullを返します。
39        error_log('cURL Error: ' . curl_error($ch));
40        $response = null;
41    }
42
43    // 7. cURLセッションを閉じ、リソースを解放します。
44    curl_close($ch);
45
46    return $response;
47}
48
49// -------------------------------------------------------------------------
50// 使用例:
51// この例では、公開されているJSONPlaceholder APIを利用してテストします。
52// -------------------------------------------------------------------------
53
54$targetUrl = 'https://jsonplaceholder.typicode.com/posts'; // 投稿データを取得するAPIエンドポイント
55$queryParams = [
56    'userId' => 1,   // userIdが1の投稿をフィルタリング
57    '_limit' => 3    // 結果を3件に制限
58];
59
60echo "GETリクエストを送信しています...\n";
61echo "URL: " . $targetUrl . "?" . http_build_query($queryParams) . "\n\n";
62
63$apiResponse = sendGetRequestWithParams($targetUrl, $queryParams);
64
65if ($apiResponse !== null) {
66    echo "GETリクエスト成功！ レスポンス:\n";
67    // 取得したJSON文字列を見やすいようにデコード・エンコードして出力
68    echo json_encode(json_decode($apiResponse, true), JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
69    echo "\n";
70} else {
71    echo "GETリクエストに失敗しました。\n";
72}
73

このPHPサンプルコードは、cURLライブラリを利用して、GETリクエストにパラメータを含めて特定のURLへデータをリクエストする方法を示しています。sendGetRequestWithParams関数は、ターゲットとなるURLと、送信したいGETパラメータの連想配列を引数に取ります。この関数は、成功した場合はAPIからのレスポンスボディを文字列として返し、失敗した場合はnullを返します。

関数内部では、まずhttp_build_query関数を使って、渡されたパラメータ配列を「key=value&key2=value2」のような形式のクエリ文字列に変換します。その後、このクエリ文字列を基本URLに付加して、完全なリクエストURLを作成します。

次に、curl_init()でcURLセッションを初期化し、CURLOPT_URLオプションで生成した完全なURLを設定します。CURLOPT_RETURNTRANSFERオプションをtrueに設定することで、リクエストの実行結果が直接出力されるのではなく、文字列として関数から返されるようになります。curl_exec()でリクエストを実行し、curl_errno()でエラーの有無を確認します。処理の最後にcurl_close()でcURLセッションを閉じ、リソースを解放します。

使用例では、JSONPlaceholderという公開APIに対し、ユーザーIDと取得件数を指定したGETリクエストを実行し、その結果のJSONデータを整形して表示しています。これにより、外部のWeb APIからデータを取得する基本的な手法を実践的に理解できます。

Copy
1<?php
2
3/**
4 * 指定されたURLからコンテンツをCURLで取得し、gzip圧縮を自動で処理します。
5 * システムエンジニアを目指す初心者向けに、PHP 8での基本的なCURLの使用方法とgzip対応を示します。
6 *
7 * @param string $url 取得するURL。
8 * @return string|false 取得したコンテンツの文字列、またはエラー発生時にfalse。
9 */
10function fetchContentWithGzipDecoding(string $url): string|false
11{
12    // cURLセッションを初期化します。
13    $ch = curl_init();
14
15    // cURLの初期化に失敗した場合は、エラーをログに記録してfalseを返します。
16    if ($ch === false) {
17        error_log('cURL initialization failed.');
18        return false;
19    }
20
21    // cURLオプションを設定します。
22    // 1. 取得するURLを設定します。
23    curl_setopt($ch, CURLOPT_URL, $url);
24
25    // 2. レスポンスを文字列として取得するように設定します。
26    //    これをtrueにしないと、curl_exec()は直接結果を出力します。
27    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
28
29    // 3. HTTPリダイレクトがあった場合に、自動でその先に追従するように設定します。
30    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
31
32    // 4. Accept-Encodingヘッダを自動的に設定し、サーバーから圧縮されたレスポンスを
33    //    cURLが自動的に解凍するように設定します。
34    //    'gzip' を指定すると、Accept-Encoding: gzip ヘッダが送信され、
35    //    サーバーがgzipで圧縮したレスポンスをcURLが自動的に解凍します。
36    //    空文字列 "" を指定すると、cURLがサポートする全てのエンコーディング（gzip, deflate, brotliなど）を
37    //    サーバーに通知し、自動で解凍します。
38    curl_setopt($ch, CURLOPT_ENCODING, 'gzip');
39
40    // 5. 接続確立までの最大待機時間（秒）を設定します。
41    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);
42
43    // 6. cURLの実行全体の最大待機時間（秒）を設定します。
44    curl_setopt($ch, CURLOPT_TIMEOUT, 30);
45
46    // 7. SSL証明書の検証を無効にするオプション（開発環境でのみ使用を検討し、
47    //    本番環境ではセキュリティのため有効にすることを強く推奨します）。
48    // curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
49    // curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
50
51    // cURLセッションを実行し、コンテンツを取得します。
52    $response = curl_exec($ch);
53
54    // cURLの実行中にエラーが発生したかチェックします。
55    if (curl_errno($ch)) {
56        // エラーが発生した場合は、エラーメッセージをログに記録し、falseを返します。
57        $error_msg = curl_error($ch);
58        error_log("cURL Error: {$error_msg} (URL: {$url})");
59        curl_close($ch);
60        return false;
61    }
62
63    // cURLセッションを終了し、リソースを解放します。
64    curl_close($ch);
65
66    // 取得したコンテンツを返します。
67    return $response;
68}

このサンプルコードは、PHP 8のCURL拡張機能を利用して、指定されたURLからWebコンテンツを取得する基本的な方法を示すものです。特に、gzipで圧縮されたレスポンスを自動的に解凍して処理する方法に焦点を当てています。システムエンジニアを目指す初心者の方にとって、外部のWebサイトやAPIからデータを取得する際の基礎的な知識となるでしょう。

fetchContentWithGzipDecoding関数は、取得したいWebコンテンツのURLを$url引数として受け取ります。処理が正常に完了した場合は取得したコンテンツの文字列を返し、途中でエラーが発生した場合はfalseを返します。

コードではまず、curl_init()でCURLセッションを初期化します。次に、curl_setopt()関数を使って、セッションの様々な挙動を設定します。例えば、CURLOPT_URLでコンテンツを取得するURLを設定し、CURLOPT_RETURNTRANSFERをtrueにすることで、取得結果を直接出力せずに関数の戻り値として受け取れるようにします。重要な点として、CURLOPT_ENCODING, 'gzip'を設定することで、CURLはサーバーにgzip圧縮形式のコンテンツを要求し、受け取った圧縮データを自動で解凍してくれます。これにより、開発者は圧縮処理を意識することなくコンテンツを利用できます。

設定後、curl_exec()で実際にリクエストを実行し、Webコンテンツを取得します。エラーが発生した場合はcurl_errno()でエラーの種類を判断し、エラーメッセージをログに出力します。最後に、curl_close()でCURLセッションを終了し、使用したリソースを解放します。この一連の流れを通じて、Webコンテンツ取得の基本的な仕組みと、gzip圧縮への対応方法を学ぶことができます。