Clever Geek Handbook

Zend_Soap_AutoDiscoverおよびeAccelerator



みなさんこんにちは！ 最近出会った問題についてお話したいと思います。 この記事で説明した私の経験が、Zend Framework、特にZend_Soap_AutoDiscoverクラスを使用してSOAPサービスを開発している人々の時間と神経細胞の節約に役立つことを願っています。

問題は、Zend_Soap_AutoDiscoverが正しく動作せず、よく知られているコードオプティマイザーeAcceleratorと組み合わされていることです。 つまり、正確には、 ReflectionClass :: getDocComment（）メソッドは正しく機能しません。 しかし...まず最初に。



ケースの99％でSOAPサービスを開発する場合、プログラマーは、サービスの説明として使用される膨大なWSDLドキュメントを自動的に生成するタスクに直面します。 このようなWSDLには、サービスによって提供されるデータ型とメソッドの説明が含まれています。 私の知る限り、多くのプログラマーはこの問題を解決するためにZend Frameworkが提供するツール、つまりZend_Soap_AutoDiscoverを使用しています（ PEAR SOAPライブラリを使用してこのような問題を解決できるという噂がありますが、この場合、私は特定のことは言えないので、それを使用しました）。



Zend_Soapの使用方法については説明しません。これらのすべては、 公式ドキュメントまたはこのサイトの記事（たとえば、ここ）で完全に説明されています 。



Zend_Soap_AutoDiscoverを使用する主な利点は何ですか？ このクラスを使用すると、パラメーターとして指定したクラスに基づいてWSDLを自動的に構築できます。 したがって、WSDLは、クラスの変更に基づいて（ビルドの基礎に基づいて）動的に再構築されます。 ただし、重要な点が1つあります。Zend_Soap_AutoDiscoverは、PHPDocのスタイルで記述されたコメントを使用して、メソッドパラメーターのデータ型を決定します。 したがって、コードは十分に文書化する必要があります。



以下は、単純なクライアント/サーバー相互作用の例です。

3つのスクリプトがあるとします。

soap-client.php-SOAPサービスクライアント

soap-server.php-SOAPサービスの実装

soap-server-model.php-SOAPサービスが構築される基礎となるクラス



各スクリプトのコードリストはシンプルでわかりやすく、以下に示します。



soap-client.php ：

  1. require_once 'Zend / Soap / Client.php' ;
  3. $ wsdlUri = 'http：//localhost/soap-server.php？wsdl' ;
  5. {
  6. $ client = new Zend_Soap_Client（$ wsdlUri）;
  7. echo $ client-> showSomething（ 'test' 、46）;
  8. echo '<br />' ;
  9. echo 'the end' ;
  10. } catch （例外$ e）{
  11. echo 'エラー：' 。 $ e-> getMessage（）;
  12. }
*このソースコードは、 ソースコードハイライターで強調表示されました。




soap-server.php ：

  1. require_once 'soap-server-model.php' ;
  3. $ wsdlUri = 'http：//localhost/soap-server.php？wsdl' ;
  5. if （isset（$ _ GET [ 'wsdl' ]））{
  6. require_once 'Zend / Soap / AutoDiscover.php' ;
  7. $ autodiscover = new Zend_Soap_AutoDiscover（）;
  8. $ autodiscover-> setClass（ 'SoapModel' ）;
  9. $ autodiscover-> handle（）;
  10. } else {
  11. require_once 'Zend / Soap / Server.php' ;
  12. $ soap = new Zend_Soap_Server（$ wsdlUri）;
  13. $ soap-> setClass（ 'SoapModel' ）;
  14. $ soap->ハンドル（）;
  15. }
*このソースコードは、 ソースコードハイライターで強調表示されました。




soap-server-model.php ：

  1. クラス SoapModel
  2. {
  3. / **
  4. * Zend_Soap_AutoDiscoverを使用してSOAPサーバーをテストする方法
  5. *
  6. * param string $ word
  7. * param int $ num
  8. * 戻り文字列
  9. * /
  10. パブリック 関数 showSomething（$ word、$ num）
  11. {
  12. 「サーバーが言った：」を 返し ます 。 $単語。 」 $ num;
  13. }
  14. }
*このソースコードは、 ソースコードハイライターで強調表示されました。




php.iniでは、SOAP設定（クライアント側）は次のとおりです。

[石鹸]

soap.wsdl_cache_enabled = 0

soap.wsdl_cache_dir = "/ tmp"

soap.wsdl_cache_ttl = 18000

soap.wsdl_cache_limit = 0



つまり、テスト目的で、WSDLキャッシングを無効にします



クライアントスクリプトを実行すると、期待どおりの "サーバーが言った：テスト46"ではなく、 "最後"だけが表示されます。 返されたWSDLを確認し（この例では、URLで利用可能です： localhost / soap-server.php？Wsdl＆a = 1 ）、表示されるのは予想されたものではありません ：



  1. <？ xml バージョン = "1.0" ？ >
  2. < 定義 xmlns = " schemas.xmlsoap.org/wsdl " xmlns：tns = " localhost / soap-server.php " xmlns：soap = " schemas.xmlsoap.org/wsdl/soap " xmlns：xsd = " www.w3。 org / 2001 / XMLSchema " xmlns：soap-enc =" schemas.xmlsoap.org/soap/encoding " xmlns：wsdl =" schemas.xmlsoap.org/wsdl " name =" SoapModel " targetNamespace =" localhost / soap-server。 php " >
  3. < タイプ >
  4. < xsd：schema targetNamespace = " localhost / soap-server.php " />
  5. </ タイプ >
  6. < portType name = "SoapModelPort" >
  7. < 操作 名 = "showSomething" >
  8. < documentation > Zend_Soap_AutoDiscoverを使用してSOAPサーバーをテストする方法</ documentation >
  9. < 入力 メッセージ = "tns：showSomethingIn" />
  10. < 出力 メッセージ = "tns：showSomethingOut" />
  11. </ 操作 >
  12. </ portType >
  13. < バインディング 名 = "SoapModelBinding" タイプ = "tns：SoapModelPort" >
  14. < soap：バインディング スタイル = "rpc" transport = " schemas.xmlsoap.org/soap/http " />
  15. < 操作 名 = "showSomething" > < soap：操作 soapAction = " localhost / soap-server.php＃showSomething " />
  16. < 入力 >
  17. < soap：body use = "encoded" encodingStyle = " schemas.xmlsoap.org/soap/encoding " namespace = " localhost / soap-server.php " />
  18. </ 入力 >
  19. < 出力 >
  20. < soap：body use = "encoded" encodingStyle = " schemas.xmlsoap.org/soap/encoding " namespace = " localhost / soap-server.php " />
  21. </ 出力 >
  22. </ 操作 >
  23. </ バインディング >
  24. < サービス 名 = "SoapModelService" >
  25. < ポート 名 = "SoapModelPort" binding = "tns：SoapModelBinding" >
  26. < soap：アドレスの 場所 = " localhost / soap-server.php " />
  27. </ ポート >
  28. </ サービス >
  29. < メッセージ 名 = "showSomethingIn" >
  30. < パーツ 名 = "単語" タイプ = "xsd：文字列" />
  31. < パーツ 名 = "num" タイプ = "xsd：int" />
  32. </ メッセージ >
  33. < メッセージ 名 = "showSomethingOut" >
  34. < パーツ 名 = "return" type = "xsd：string" />
  35. </ メッセージ >
  36. </ 定義 >
*このソースコードは、 ソースコードハイライターで強調表示されました。




次のコードが発行されます。



  1. <？ xml バージョン = "1.0" ？ >
  2. < 定義 xmlns = " schemas.xmlsoap.org/wsdl " xmlns：tns = " localhost / soap-server.php " xmlns：soap = " schemas.xmlsoap.org/wsdl/soap " xmlns：xsd = " www.w3。 org / 2001 / XMLSchema " xmlns：soap-enc =" schemas.xmlsoap.org/soap/encoding " xmlns：wsdl =" schemas.xmlsoap.org/wsdl " name =" SoapModel " targetNamespace =" localhost / soap-server。 php " >
  3. < タイプ >
  4. < xsd：schema targetNamespace = " localhost / soap-server.php " />
  5. </ タイプ >
  6. < portType name = "SoapModelPort" >
  7. < 操作 名 = "showSomething" >
  8. < ドキュメント > showSomething </ ドキュメント >
  9. < 入力 メッセージ = "tns：showSomethingIn" />
  10. </ 操作 >
  11. </ portType >
  12. < バインディング 名 = "SoapModelBinding" タイプ = "tns：SoapModelPort" >
  13. < soap：バインディング スタイル = "rpc" transport = " schemas.xmlsoap.org/soap/http " />
  14. < 操作 名 = "showSomething" >
  15. < soap：operation soapAction = " localhost / soap-server.php＃showSomething " />
  16. < 入力 >
  17. < soap：body use = "encoded" encodingStyle = " schemas.xmlsoap.org/soap/encoding " namespace = " localhost / soap-server.php " />
  18. </ 入力 >
  19. </ 操作 >
  20. </ バインディング >
  21. < サービス 名 = "SoapModelService" >
  22. < ポート 名 = "SoapModelPort" binding = "tns：SoapModelBinding" >
  23. < soap：アドレスの 場所 = " localhost / soap-server.php " />
  24. </ ポート >
  25. </ サービス >
  26. < メッセージ 名 = "showSomethingIn" >
  27. < パーツ 名 = "単語" タイプ = "xsd：anyType" />
  28. < パーツ 名 = "num" タイプ = "xsd：anyType" />
  29. </ メッセージ >
  30. </ 定義 >
*このソースコードは、 ソースコードハイライターで強調表示されました。




一般に、WTF oOのマニュアルと悲鳴を調べて、誤動作を長時間検索した後、eAcceleratorをオフにするとすべてが正常に機能することが判明しました。 なぜこれが起こっているのですか？ 内部実装のZend_Soap_AutoDiscoverは、 Reflectionsメカニズム（正確にはZend_Server_Reflectionクラスがこれを担当しています）を使用して、メソッドコメントからパラメーターを取得します。 eAcceleratorは、バイトコードの作成中にスクリプトを最初に呼び出した後、すべてのコメントを削除します。その結果、上記の以下の問題が発生します。 論理的ですが、非常に重要です。



解決策は何ですか？

1. eAcceleratorを拒否します。 そして、たとえばAPCを使用します（私は個人的にチェックしました-APCにはそのような問題はありませんでした）。

2.コメントが重要なファイルを最適化しないために、eAcceleratorフィルターを使用します。 これは次のように行われます。

ini_set（ 'eaccelerator.filter'、 '！soap-server-model.php'）;


3. red_pilotユーザーからの解決策：インストール中に、with-eaccelerator-doc-comment-inclusionキーを使用してeAcceleratorを構成します。

./configure -–with-eaccelerator-doc-comment-inclusion




PS一般に、指摘された問題は、「ある種のZendクラスがeAcceleratorで動作しない」よりも少し深いです。 これはあまり頻繁ではありませんが、開発ではReflectionsメカニズム（ ReflectionClass :: getDocComment（） ）が使用され、多くの場合、クラスに関するコメントが開発された機能に関与します。



PSSよくあることですが、eAcceleratorのようなツールは本番サーバーで使用されます。誰かがロケールにインストールするときはめったにありません。 その結果、ロケールで完全に機能するコードは、完全に非自明な方法で本番環境で機能しない場合があります。



PSSS Zend_Soapは、他のほとんどのZendコンポーネントと同様に、フレームワーク自体とは別に使用できます。 そのため、たとえば、現在の開発プロジェクトでは、Zend_Db、Zend_Form、Zend_Soapの3つのZFコンポーネントのみを使用しています。 また、たとえば、誰かがZend_Soap_AutoDiscoverに参加したい場合、プロジェクト全体がZFにある必要はありません。 必要なすべてのZFクラスを転送するだけで十分です。 実際、非常に便利なZend_Soap_AutoDiscoverを使用することに加えて、Zend_Soapは組み込みのSoap機能を弱く拡張します。 したがって、Soapサービスの作成に困惑していない場合、ネイティブSoapClientをZend_Soap_Clientに変更することはあまり有用ではありません。


More articles:


All Articles