Documentation

Zend_Http_Client - 接続アダプタ - Zend_Http

Zend_Http_Client - 接続アダプタ

概要

Zend_Http_Client は、接続アダプタとして設計されています。 接続アダプタは実際にサーバへの接続を行うオブジェクトで、 リクエストの書き込みやレスポンスの読み込みも行います。 この接続アダプタは置き換えることができます。 つまり、デフォルトの接続アダプタを継承して自分の好みにあうように変更できます。 HTTP クライアントクラス全体を書き換える必要はありません。 同じインターフェイスを実装しているだけでいいのです。

現在、Zend_Http_Client クラスは四つの組み込み接続アダプタを提供しています。

  • Zend_Http_Client_Adapter_Socket (デフォルト)

  • Zend_Http_Client_Adapter_Proxy

  • Zend_Http_Client_Adapter_Curl

  • Zend_Http_Client_Adapter_Test

Zend_Http_Client オブジェクトの接続アダプタを指定するには、 設定オプション 'adapter' を使用します。 クライアントオブジェクトのインスタンスを作成する際に、オプション 'adapter' にアダプタの名前 (たとえば 'Zend_Http_Client_Adapter_Socket' など) を指定できます。あるいは、アダプタオブジェクトの変数 (たとえば new Zend_Http_Client_Adapter_Test など) を指定することもできます。 Zend_Http_Client->setConfig() メソッドを使用し、 アダプタを後で設定することも可能です。

ソケットアダプタ

デフォルトの接続アダプタは Zend_Http_Client_Adapter_Socket です。明示的に接続アダプタを指定しない場合は、これが使用されます。 Socket アダプタは PHP の組み込み関数 fsockopen() を使用しており、特別な拡張モジュールやコンパイルオプションは必要ありません。

ソケットアダプタには、追加の設定オプションを指定できます。これは Zend_Http_Client->setConfig() で指定するか、 あるいはクライアントのコンストラクタに渡します。

Zend_Http_Client_Adapter_Socket の設定パラメータ
パラメータ 説明 予期する型 デフォルト値
persistent 持続的な TCP 接続を使用するかどうか boolean FALSE
ssltransport SSL トランスポート層 (たとえば 'sslv2'、'tls') 文字列 ssl
sslcert PEM でエンコードした、SSL 証明書ファイルへのパス 文字列 NULL
sslpassphrase SSL 証明書ファイルのパスフレーズ 文字列 NULL
sslusecontext プロキシ接続そのものが行わないとしても、 プロキシされた接続でSSLを使用できるようにします。 boolean FALSE

Note: 持続的な TCP 接続
持続的な TCP 接続を使用すると、HTTP リクエストの処理速度が向上する可能性があります。 しかし、たいていの場合はその効果はごくわずかで、 接続先の HTTP サーバにかかる負荷が大きくなります。
持続的な TCP 接続を使用するのは、 同じサーバに頻繁に接続する場合で そのサーバが同時に多数の接続を処理できることがわかっている場合のみにすることを推奨します。 いずれにせよ、このオプションを使用する前には クライアント側の速度だけでなくサーバ側の負荷についてもベンチマークをとるようにしましょう。
さらに、持続的な接続を使用するときには 構成セクション で説明した Keep-Alive HTTP リクエストも有効にしておくことを推奨します。 そうしないと、持続的な接続の効果はほとんどといっていいほどなくなってしまいます。

Note: HTTPS SSL ストリームパラメータ
ssltransport, sslcert および sslpassphrase は、HTTPS 接続で使用する SSL レイヤーにのみ関連するものです。
たいていの場合はデフォルトの SSL 設定でうまく動作するでしょうが、 接続先のサーバが特別なクライアント設定を要求している場合は それにあわせた設定をする必要があるかもしれません。 その場合は、 » ここSSL トランスポート層やオプションについての説明を参照ください。

Example #1 HTTPS トランスポート層の変更

  1. // 設定パラメータを指定します
  2. $config = array(
  3.     'adapter'      => 'Zend_Http_Client_Adapter_Socket',
  4.     'ssltransport' => 'tls'
  5. );
  6.  
  7. // クライアントオブジェクトのインスタンスを作成します
  8. $client = new Zend_Http_Client('https://www.example.com', $config);
  9.  
  10. // これ以降のリクエストは、TLS セキュア接続上で行われます
  11. $response = $client->request();

上の例の結果は、次の PHP コマンドで TCP 接続をオープンした場合と同じになります。

fsockopen('tls://www.example.com', 443)

ソケットアダプタのストリームコンテキストへのアクセスとカスタマイズ

Zend Framework 1.9 以降、Zend_Http_Client_Adapter_Socket は、リモートサーバへの接続に使用している » ストリームコンテキスト に直接アクセスできるようになります。これを使用すると、 TCP ストリーム (HTTPS 接続の場合は SSL ラッパー) 固有のオプションやパラメータを渡せるようになります。

ストリームコンテキストにアクセスするには、 Zend_Http_Client_Adapter_Socket のこれらのメソッドを使用します。

  • setStreamContext($context) アダプタが使用するストリームコンテキストを設定します。 PHP» stream_context_create() 関数で作成したストリームコンテキストリソースか、 この関数に渡すのと同じ形式のストリームコンテキストオプションの配列のいずれかを指定できます。 配列を渡すと、そのオプションを用いて新たなストリームコンテキストを作成し、 それを設定します。

  • getStreamContext() アダプタのストリームコンテキストを取得します。 ストリームコンテキストが設定されていない場合は、 デフォルトのストリームコンテキストを作成してそれを返します。 あとは、さまざまなコンテキストオプションの設定や取得を通常の PHP ストリームコンテキスト関数で行うことができます。

Example #2 ソケットアダプタのストリームコンテキストオプションの設定

  1. // オプションの配列
  2. $options = array(
  3.     'socket' => array(
  4.         // ソケットのローカル側を特定のインターフェイスにバインドします
  5.         'bindto' => '10.1.2.3:50505'
  6.     ),
  7.     'ssl' => array(
  8.         // サーバ側の証明書を検証します
  9.         // 無効な証明書や自己署名の SSL 証明書は拒否します
  10.         'verify_peer' => true,
  11.         'allow_self_signed' => false,
  12.  
  13.         // ピア証明書を捕捉します
  14.         'capture_peer_cert' => true
  15.     )
  16. );
  17.  
  18. // アダプタオブジェクトを作成し、HTTP クライアントにバインドします
  19. $adapter = new Zend_Http_Client_Adapter_Socket();
  20. $client = new Zend_Http_Client();
  21. $client->setAdapter($adapter);
  22.  
  23. // 方法 1: オプションの配列を setStreamContext() に渡します
  24. $adapter->setStreamContext($options);
  25.  
  26. // 方法 2: ストリームコンテキストを作成して setStreamContext() に渡します
  27. $context = stream_context_create($options);
  28. $adapter->setStreamContext($context);
  29.  
  30. // 方法 3: デフォルトのストリームコンテキストを取得してオプションを設定します
  31. $context = $adapter->getStreamContext();
  32. stream_context_set_option($context, $options);
  33.  
  34. // リクエストを処理します
  35. $response = $client->request();
  36.  
  37. // すべてがうまくいけば、これでまたコンテキストにアクセスできます
  38. $opts = stream_context_get_options($adapter->getStreamContext());
  39. echo $opts['ssl']['peer_certificate'];

Note: ストリームコンテキストのオプションは、 アダプタが実際にリクエストを処理しだす前に設定しなければならないことに注意しましょう。 コンテキストを設定せずにソケットアダプタで HTTP リクエストを処理すると、 デフォルトのストリームコンテキストが作成されます。 リクエストを処理した後にこのコンテキストリソースにアクセスするには getStreamContext() メソッドを使用します。

プロキシアダプタ

Zend_Http_Client_Adapter_Proxy アダプタはデフォルトのソケットアダプタとほぼ同じです。 ただし、対象となるサーバに直接接続するのではなく HTTP プロキシサーバを経由して接続するという点が異なります。 これにより、Zend_Http_Client をプロキシサーバの中から使用できるようになります。 セキュリティやパフォーマンス上の理由により、これが必要となる場合もあるでしょう。

プロキシアダプタを使用するには、 デフォルトの 'adapter' オプション以外に いくつか追加のパラメータを設定する必要があります。

Zend_Http_Client の設定パラメータ
パラメータ 説明 想定している型 値の例
proxy_host プロキシサーバのアドレス string 'proxy.myhost.com' あるいは '10.1.2.3'
proxy_port プロキシサーバの TCP ポート integer 8080 (デフォルト) あるいは 81
proxy_user 必要に応じて、プロキシのユーザ名 string 'shahar' あるいは指定しない場合は '' (デフォルト)
proxy_pass 必要に応じて、プロキシのパスワード string 'secret' あるいは指定しない場合は '' (デフォルト)
proxy_auth プロキシの HTTP 認証形式 string Zend_Http_Client::AUTH_BASIC (デフォルト)

proxy_host は常に設定しなければなりません。指定しなかった場合は、 自動的に Zend_Http_Client_Adapter_Socket による直接接続に切り替わります。 proxy_port のデフォルトは '8080' です。もし別のポートをプロキシで使用している場合は、 適切に設定する必要があります。

proxy_user および proxy_pass は、 プロキシサーバが認証を必要とする場合にのみ設定します。 これらを指定すると、'Proxy-Authentication' ヘッダがリクエストに追加されます。プロキシで認証を必要としない場合は、 このふたつのオプションはそのままにしておきます。

proxy_auth は、プロキシが認証を必要としている場合に、 その認証形式を指定します。設定できる値は Zend_Http_Client::setAuth() メソッドと同じです。現在はベーシック認証 (Zend_Http_Client::AUTH_BASIC) のみをサポートしています。

Example #3 プロキシサーバを使用した Zend_Http_Client の使用法

  1. // 接続パラメータを設定します
  2. $config = array(
  3.     'adapter'    => 'Zend_Http_Client_Adapter_Proxy',
  4.     'proxy_host' => 'proxy.int.zend.com',
  5.     'proxy_port' => 8000,
  6.     'proxy_user' => 'shahar.e',
  7.     'proxy_pass' => 'bananashaped'
  8. );
  9.  
  10. // クライアントオブジェクトのインスタンスを作成します
  11. $client = new Zend_Http_Client('http://www.example.com', $config);
  12.  
  13. // 作業を続けます...

説明したとおり、もし proxy_host を省略したり空文字列を設定したりすると、 自動的に直接接続に切り替わります。これにより、設定パラメータによって オプションでプロキシを使用できるようなアプリケーションを書けるようになります。

Note: プロキシアダプタは Zend_Http_Client_Adapter_Socket を継承しているので、ストリームコンテキストへのアクセスメソッド (このセクションを参照してください) を使用してプロキシ接続におけるストリームコンテキストオプションを設定できます。 その方法については上で説明しました。

cURL アダプタ

cURL は標準的な HTTP クライアントライブラリで、 多くの OS に含まれています。また PHP からは cURL 拡張モジュールで使用できます。 HTTP クライアントで起こりうる多くの特別な例にも対応することができるので、 HTTP アダプタとしては完璧な選択肢といえるでしょう。 セキュアな接続やプロキシ、そしてあらゆる種類の認証にも対応しており、 大きなファイルをサーバ間で移動させるときなどにも使用できます。

Example #4 cURL オプションの設定

  1. $config = array(
  2.     'adapter'   => 'Zend_Http_Client_Adapter_Curl',
  3.     'curloptions' => array(CURLOPT_FOLLOWLOCATION => true),
  4. );
  5. $client = new Zend_Http_Client($uri, $config);

デフォルトでは、cURL アダプタは Socket アダプタとまったく同じ挙動となるように設定されています。 また、Socket アダプタおよび Proxy アダプタと同じ設定パラメータを使えます。 cURL のオプションを変更するには、アダプタのコンストラクタでキー 'curloptions' を指定するか、あるいは setCurlOption($name, $value) をコールします。 $name は、cURL 拡張モジュールの CURL_* 定数に対応します。Curl ハンドルにアクセスするには $adapter->getHandle(); をコールします。

Example #5 ハンドルによるファイル転送

cURL を使用して、巨大なファイルを HTTP 越しに転送できます。

  1. $putFileSize   = filesize("filepath");
  2. $putFileHandle = fopen("filepath", "r");
  3.  
  4. $adapter = new Zend_Http_Client_Adapter_Curl();
  5. $client = new Zend_Http_Client();
  6. $client->setAdapter($adapter);
  7. $adapter->setConfig(array(
  8.     'curloptions' => array(
  9.         CURLOPT_INFILE => $putFileHandle,
  10.         CURLOPT_INFILESIZE => $putFileSize
  11.     )
  12. ));
  13. $client->request("PUT");

テストアダプタ

HTTP 接続に依存するテストコードを書くのは非常に難しいものです。 たとえば、リモートサーバから RSS を取得するアプリケーションをテストするには、 ネットワークにつながっている必要があります。常にネットワークが使用できるとは限りません。

このようなときのためにあるのが Zend_Http_Client_Adapter_Test アダプタです。 Zend_Http_Client を使用するアプリケーションを作成し、それをテストしたい場合には、 デフォルトのアダプタを Test アダプタ (モックオブジェクト) に変更します。 これで、サーバに接続せずにテストを行えるようになります。

Zend_Http_Client_Adapter_Test には setResponse() というメソッドがあります。 このメソッドのパラメータには、HTTP レスポンスをテキストか Zend_Http_Response オブジェクトで指定できます。 レスポンスを設定すると、Test アダプタは常にこのレスポンスを返すようになります。 実際の HTTP リクエストは行いません。

Example #6 HTTP レスポンススタブを使用したテスト

  1. // 新しいアダプタとクライアントのインスタンスを作成します
  2. $adapter = new Zend_Http_Client_Adapter_Test();
  3. $client = new Zend_Http_Client('http://www.example.com', array(
  4.     'adapter' => $adapter
  5. ));
  6.  
  7. // 想定するレスポンスを設定します
  8. $adapter->setResponse(
  9.     "HTTP/1.1 200 OK"        . "\r\n" .
  10.     "Content-type: text/xml" . "\r\n" .
  11.                                "\r\n" .
  12.     '<?xml version="1.0" encoding="UTF-8"?>' .
  13.     '<rss version="2.0" ' .
  14.     '     xmlns:content="http://purl.org/rss/1.0/modules/content/"' .
  15.     '     xmlns:wfw="http://wellformedweb.org/CommentAPI/"' .
  16.     '     xmlns:dc="http://purl.org/dc/elements/1.1/">' .
  17.     '  <channel>' .
  18.     '    <title>Premature Optimization</title>' .
  19.     // などなど...
  20.     '</rss>');
  21.  
  22. $response = $client->request('GET');
  23. // .. $response の処理を続けます...

上の例のようにすると、HTTP クライアントにお望みのレスポンスを返させることができます。 その際にネットワーク接続は使用しません。また、実際のサーバからのレスポンスも使用しません。 この場合、このテストでテストするのは、 レスポンス本文の XML をアプリケーションが正しくパースできるかどうかということです。

時には、オブジェクトに対するひとつのメソッド呼び出しの中で複数の HTTP トランザクションを行うこともあるでしょう。そのような場合は setResponse() を単独で使うことはできません。なぜなら、 結果が呼び出し元に返ってくるまで次のレスポンスを設定できないからです。

Example #7 複数の HTTP レスポンススタブを使用したテスト

  1. // 新しいアダプタおよびクライアントのインスタンスを作成します
  2. $adapter = new Zend_Http_Client_Adapter_Test();
  3. $client = new Zend_Http_Client('http://www.example.com', array(
  4.     'adapter' => $adapter
  5. ));
  6.  
  7. // 最初の応答として期待する値を設定します
  8. $adapter->setResponse(
  9.     "HTTP/1.1 302 Found"      . "\r\n" .
  10.     "Location: /"             . "\r\n" .
  11.     "Content-Type: text/html" . "\r\n" .
  12.                                 "\r\n" .
  13.     '<html>' .
  14.     '  <head><title>Moved</title></head>' .
  15.     '  <body><p>This page has moved.</p></body>' .
  16.     '</html>');
  17.  
  18. // それに続くレスポンスを設定します
  19. $adapter->addResponse(
  20.     "HTTP/1.1 200 OK"         . "\r\n" .
  21.     "Content-Type: text/html" . "\r\n" .
  22.                                 "\r\n" .
  23.     '<html>' .
  24.     '  <head><title>My Pet Store Home Page</title></head>' .
  25.     '  <body><p>...</p></body>' .
  26.     '</html>');
  27.  
  28. // HTTP クライアントオブジェクト ($client) をテスト対象の
  29. // オブジェクトに注入し、オブジェクトの動きを以下でテストします

setResponse() メソッドは、 Zend_Http_Client_Adapter_Test のバッファにあるレスポンスをすべて削除し、 最初に返されるレスポンスを設定します。addResponse() メソッドは、それに続くレスポンスを追加します。

レスポンスは、それを追加した順に再生されます。 登録したよりも多くのリクエストが発生した場合は、 返されるレスポンスは最初のものに戻り、そこからまた順に返されるようになります。

上の例で、このアダプタがテストするように設定されているのは、 302 リダイレクトが発生した場合のオブジェクトの挙動です。 アプリケーションの内容によって、リダイレクトさせるべきなのかそうでないのかは異なるでしょう。 この例ではリダイレクトさせることを想定しているので、 テストアダプタもそれにあわせて設定しています。 最初の 302 レスポンスを setResponse() メソッドで設定し、 次に返される 200 レスポンスを addResponse() メソッドで設定します。 テストアダプタを設定し終えたら、そのアダプタを含む HTTP クライアントをテスト対象オブジェクトに注入し、その挙動をテストします。

アダプタをわざと失敗させたい場合は setNextRequestWillFail($flag) を使用します。 このメソッドは、次に connect() をコールしたときに Zend_Http_Client_Adapter_Exception を発生させます。これは、外部のサイトのコンテンツをキャッシュするアプリケーションで、 (外部サイトがダウンしていたときの) 挙動をテストする際に有用です。

Example #8 アダプタを失敗させる

  1. // 新たなアダプタとクライアントを作成します
  2. $adapter = new Zend_Http_Client_Adapter_Test();
  3. $client = new Zend_Http_Client('http://www.example.com', array(
  4.     'adapter' => $adapter
  5. ));
  6.  
  7. // 次のリクエストでわざと例外を発生させます
  8. $adapter->setNextRequestWillFail(true);
  9.  
  10. try {
  11.     // これは Zend_Http_Client_Adapter_Exception となります
  12.     $client->request();
  13. } catch (Zend_Http_Client_Adapter_Exception $e) {
  14.     // ...
  15. }
  16.  
  17. // これ以降の処理は、 setNextRequestWillFail(true) を次に呼び出すまで
  18. //通常通りに行います

独自の接続アダプタの作成

独自の接続アダプタを作成し、それを使用することもできます。 たとえば持続的なソケットを使用するアダプタを作成したり、 キャッシュ機能を追加したアダプタを作成したりなど、 作成するアプリケーションの要件にあわせたものを作成することが可能です。

そのためには、Zend_Http_Client_Adapter_Interface を実装したクラスを作成する必要があります。 以下の例は、ユーザ定義のアダプタクラスの雛形となります。 この例で定義されているすべてのパブリック関数を、 アダプタで定義する必要があります。

Example #9 独自の接続アダプタの作成

  1. class MyApp_Http_Client_Adapter_BananaProtocol
  2.     implements Zend_Http_Client_Adapter_Interface
  3. {
  4.     /**
  5.      * アダプタの設定配列を設定する
  6.      *
  7.      * @param array $config
  8.      */
  9.     public function setConfig($config = array())
  10.     {
  11.         // ここはほとんど変更することはありません -
  12.         // 通常は Zend_Http_Client_Adapter_Socket の実装をコピーします
  13.     }
  14.  
  15.     /**
  16.      * リモートサーバに接続する
  17.      *
  18.      * @param string  $host
  19.      * @param int     $port
  20.      * @param boolean $secure
  21.      */
  22.     public function connect($host, $port = 80, $secure = false)
  23.     {
  24.         // リモートサーバとの接続を確立します
  25.     }
  26.  
  27.     /**
  28.      * リクエストをリモートサーバに送信する
  29.      *
  30.      * @param string        $method
  31.      * @param Zend_Uri_Http $url
  32.      * @param string        $http_ver
  33.      * @param array         $headers
  34.      * @param string        $body
  35.      * @return string Request as text
  36.      */
  37.     public function write($method,
  38.                           $url,
  39.                           $http_ver = '1.1',
  40.                           $headers = array(),
  41.                           $body = '')
  42.     {
  43.         // リクエストをリモートサーバに送信します。
  44.         // この関数は、リクエスト全体 (ヘッダおよび本文)
  45.         // を文字列で返します。
  46.     }
  47.  
  48.     /**
  49.      * サーバからのレスポンスを読み込む
  50.      *
  51.      * @return string
  52.      */
  53.     public function read()
  54.     {
  55.         // リモートサーバからのレスポンスを読み込み、それを文字列で返します。
  56.     }
  57.  
  58.     /**
  59.      * サーバとの接続を閉じる
  60.      *
  61.      */
  62.     public function close()
  63.     {
  64.         // リモートサーバとの接続を閉じます。最後にコールされます。
  65.     }
  66. }
  67.  
  68. // そして、このアダプタを使用します
  69. $client = new Zend_Http_Client(array(
  70.     'adapter' => 'MyApp_Http_Client_Adapter_BananaProtocol'
  71. ));

Copyright

© 2006-2018 by Zend, a Rogue Wave Company. Made with by awesome contributors.

This website is built using zend-expressive and it runs on PHP 7.

Contacts