PHP SOAP 拡張機能

はじめに

PHP の SOAP 拡張機能を使用して、Web サービスを提供および使用できます。つまり、PHP 開発者は、この PHP 拡張機能を使用して独自の Web サービスを作成したり、特定の Web サービスを使用するクライアントを作成したりできます。

PHP5 のこの SOAP 拡張機能の目的は、Web サービスに対する PHP のサポートを実装することです。 Web サービスの PHP サポートを実装する他の方法とは異なり、SOAP 拡張機能は C で記述されているため、他の方法よりも速度に優れています。

SOAP拡張機能は以下の仕様をサポートしています。

* SOAP 1.1
* SOAP 1.2
* WSDL 1.1

SOAP 拡張機能は主に RPC 形式で Web サービスを処理するために使用されます。ただし、テキストベースの WSDL ファイルを WSDL モードのサーバーおよびクライアントで使用することもできます。

この拡張機能は、GNOME XML ライブラリを使用して XML を処理します。

拡張機能内のクラス
この拡張機能は 6 つのクラスを実装します。 SoapClient、SoapServer、SoapFault という便利なメソッドを備えた 3 つの高レベル クラスがあります。他の 3 つのクラスには、コンストラクター以外のメソッドはありません。これら 3 つは、SoapHeader、SoapParam、および SoapVar です。

SoapClientクラス

このクラスはWebサービスを利用するために使用されます。 SoapClient クラスは、特定の Web サービスのクライアントとして機能します。
2 つの操作形式があります:

* WSDL モード
* 非 WSDL モード

WSDL モードでは、コンストラクターは WSDL ファイル名をパラメーターとして使用し、サービスで使用される情報を WSDL から抽出できます。

非WSDLモードでパラメータを使用して、使用する情報を渡します。このクラスには、サービスを使用するために使用できる便利なメソッドが多数あります。その中で、SoapClient::__soapCall() が最も重要です。このメソッドを使用して、サービス内の操作を呼び出すことができます。

SoapServer クラス

このクラスは、Web サービスを提供するために使用できます。 SoapClient と同様に、SoapServer にも WSDL モードと非 WSDL モードという 2 つの動作モードがあります。これら 2 つのモードの意味は、SoapClient の 2 つのモードと同じです。 WSDL モードでは、サービスは WSDL によって提供されるインターフェイスを実装します。非 WSDL モードでは、パラメータを使用してサービスの動作を管理します。

SoapServer クラスの多くのメソッドの中で、より重要なメソッドが 3 つあります。それらは、SoapServer::setClass()、SoapServer::addFunction()、および SoapServer::handle() です。

SoapServer::setClass() メソッドは、Web サービスの実装に使用されるクラスを設定します。 SoapServer::setClass によって設定されたクラス内のすべてのパブリック メソッドは、Web サービスのオペレーションになります。

SoapServer::addFunction() メソッドは、1 つ以上の関数を Web サービス操作として追加するために使用されます。

SoapServer::handle() メソッドは、Web サービス スクリプトに受信リクエストの処理を開始するように指示します。 Web サービス スクリプトは、PHP スクリプトで記述された 1 つ以上の SoapServer オブジェクトのインスタンスです。複数の SoapServer オブジェクトを持つことができますが、一般的な規則では、スクリプトごとに SoapServer インスタンスを 1 つだけ持つことになります。 SoapServer::handle() メソッドを呼び出す前に、Web サービス スクリプトは SoapServer オブジェクト インスタンスに設定されている情報を使用して、受信リクエストと送信応答を処理します。

SoapFault クラス

このクラスは Exception クラスを継承し、エラーの処理に使用できます。 SoapFault インスタンスは、Soap エラーに関する情報をスローまたは取得し、プログラマの要求に応じてそれらを処理できます。

SoapHeaderクラス

このクラスはSOAPヘッダーを記述するために使用できます。これは、コンストラクター メソッドのみを含む単なるデータ コンテナーです。

SoapParam クラス

SoapParam も、コンストラクター メソッドのみを含むデータ コンテナーです。このメソッドは、Web サービス操作に渡されるパラメータを記述するために使用できます。これは、非 WSDL モードでパラメーター情報を目的の形式で渡す場合に便利なクラスです。

SoapVar クラス

SoapVar も、SoapHeader クラスや SoapParam クラスと同様、コンストラクターのみを含む低レベルのクラスです。このクラスを使用して、エンコードされたパラメータを Web サービス操作に渡すことができます。このクラスは、非 WSDL で型情報を伝達するのに役立ちます。

WSDL VS. 非 WSDL モード

Web サービスには、Contract First モードと Code First モードの 2 つの実装モードがあります。

Contract-first モードでは、XML でサービス インターフェイスを定義する WSDL ファイルを使用します。 WSDL ファイルは、サービスが実装する必要があるインターフェイス、またはクライアントが使用する必要があるインターフェイスを定義します。 SoapServer および SoapClient の WSDL スキーマは、この概念に基づいています。

コードファースト モードでは、まずサービスを実装するコードを記述する必要があります。ほとんどの場合、コードはコントラクト、つまり WSDL を生成します。その後、クライアントはサービスの使用時にその WSDL を使用してサービス インターフェイスを取得できます。ただし、PHP5 拡張機能には、コードから WSDL を出力するための機能が用意されていないため、SoapServer と SoapClient を非 WSDL モードで使用できます。
SOAP 拡張機能と Hello World

このセクションでは、WSDL モードと非 WSDL モードを使用してサービスとクライアントを実装する方法を紹介します。比較的に、インターフェイスを定義する WSDL ファイルがすでに存在すると仮定すると、WSDL パターンを使用してサービスとクライアントを実装する方が簡単です。したがって、このセクションではまず、WSDL パターンを使用して Web サービスを実装する方法を紹介します。

この Hello World サンプルのサービスには、greet という名前の操作があります。この操作は名前を文字列として受け取り、挨拶を文字列として返します。使用される WSDL は次のとおりです:

xmlns:impl='http://wso2.org/wsf/php/helloService'
xmlns:intf='http://wso2.org/wsf/php/helloService'
xmlns:wsdl ='http://schemas.xmlsoap.org/wsdl/'
xmlns:wsdlsoap='http://schemas.xmlsoap.org/wsdl/soap/'
xmlns:xsd='http://www.w3. org/2001/XMLSchema'
targetNamespace='http://wso2.org/wsf/php/helloService'> 

xmlns:impl='http://wso2.org/wsf/php/helloService'
xmlns:intf='http://wso2.org/ wsf/php/helloService'
xmlns:wsdl='http://schemas.xmlsoap.org/wsdl/'
xmlns="http://www.w3.org/2001/XMLSchema"
targetNamespace='http:/ /wso2.org/wsf/php/helloservice '＆gt;
＆lt;要素名=' Greet '＆gt;
＆lt; complexType＆gt;＆lt; sequence＆gt; />






<要素名='greetReturn ' type='xsd:string' />









< ;wsdl:part name='parameters' element='impl:greetResponse' />


























WSDLモードのサービス

以下はWSDLモードのサービスで使用されるSOAP扩展API代：

functiongreet($param) {
$retval = 'Hello '.$param->name;
$result = array('greetReturn' => $retval);
return $result;
}

$server = new SoapServer('hello.wsdl');
$server->addFunction('greet');
$server->handle();
?>

これの実装ではservice このプロセスでは、関数は WSDL で定義されたサービス操作を実装します。greet 操作には、WSDL で指定されたパラメーターがあります。このパラメーターは、ユーザーの名前です。最後に、ハンドルはリクエスト処理をトリガーするサービス オブジェクトを呼び出します。

WSDLモードクライアント

クライアントコードは以下の通りです

try {
$client = new SoapClient('hello.wsdl');
$result = $client->__soapCall('greet ' , array(array('name' => 'Sam')));
printf("Result = %s", $result->greetReturn);
} catch (Exception $e) {
printf(" Message = %s",$e->__toString());
}
?>

クライアント コードでは、まず WSDL ファイルをパラメータとして使用する SoapClient インスタンスを作成します。次に、__soapCall() は、パラメーターとして渡された操作、つまり、greet と受信操作のパラメーターを呼び出します。
リクエストとレスポンス

Web サーバー ディレクトリ内のドキュメントに上記の PHP スクリプトを配置し、WEB ブラウザまたは PHP パーサーのコマンド ラインを使用してスクリプトを呼び出すと、クライアントは SOAP リクエストをサーバー スクリプトに送信します。サーバーはクライアントのリクエストに応じて SOAP レスポンスをクライアントに送信します。

以下は、クライアントによって送信された SOAP リクエストです:

サム



以下は、リクエストをアピールするために送信されたサーバー応答 SOAP 応答です:

ns1:greetReturn>こんにちは、サム wsdlの使用モードのサーバーとクライアントが取得されます。非 WSDL モードのサーバーおよびクライアントを使用して、上記と同じ SOAP メッセージを生成することもできます。ただし、PHP コードを少し変更する必要があります。次のセクションでは、非 WSDL モードの使用方法について説明します。

非WSDLモードサーバー

function welcome($param) {
$retval = 'Hello '.$param;
return new SoapParam($retval, 'greetReturn');
}

$ server = new SoapServer(null, array('uri' => 'http://wso2.org/wsf/php/helloService'));

$server->addFunction('greet');$ サーバー->handle();

?>

非WSDLモードでは、WSDLモードと同様にまずgreet関数の機能が実装されますが、関数の実装方法がWSDLモードとは若干異なります。非 WSDL モードでは、応答として配列ではなく SoapParam オブジェクトを返す必要があります。サービスを作成するとき、最初のパラメータは null に設定され、WSDL が提供されないことを示します。その後、オプションがパラメータとして渡されます。このオプション パラメータはサービスの URI です。最後に、WSDL パターンと同様に残りのメソッドを呼び出します。

非WSDLモードクライアント

try {
$client = new SoapClient(null,
array('location' => 'http://localhost/hello/hello_service_nonwsdl.php',
'uri' => 'http: //wso2.org/wsf/php/helloService'));
$result = $client->__soapCall('greet', array(new SoapParam('Sam', 'name'))); = %s", $result);
} catch (Exception $e) {
printf("Message = %s",$e->__toString());
}
?>

非 WSDL の場合このパターンでは、WSDL が使用されないため、サービスの場所とサービス URI を含むパラメーター配列がパラメーターとして渡されます。次に __soapCall() メソッドが WSDL スキーマと同様に呼び出されますが、SoapParam クラスを使用してパラメーターを指定された形式にパックします。返された結果は、greet で応答を取得します。

結論

この記事では、PHP で Web サービスを提供および使用するために使用できる SOAP 拡張機能を紹介します。 PHP 拡張機能の強みは、そのシンプルさと速度です。 C で書かれた SOAP 拡張機能を使用してサーバーとクライアントを実行するのは非常に簡単です。 SOAP 拡張機能は、いくつかの単純な Web サービスを処理する場合には便利ですが、すべての Web サービスを処理するために使用すると制限が生じます。 WSO WSF/PHP は、PHP 拡張機能の欠点を補うために開発されました。オープン ソースであり、SOAP のような機能を実装でき、MTOM、WS-Addressing、WS-Security、および WS-RelaiableMessaging をサポートします。 WSO2 WSF/PHP は、SOAP 拡張機能と同様の API をサポートします。 C で記述される SOAP 拡張機能と同じ API を提供するために API をパッケージ化する予定です。