Spring-WSを使用したSOAP Webサービス

彼らは私にWebサービスの開発を開始するタスクを設定し、説明のない単純なプロジェクトのようなものをくれました。 もちろん、プロジェクトは開始されませんでした。 Springとは何か、それがどのように機能するのか、私にもわからなかった。 ロシア語または英語のSpringツールを使用したWebサービスの開発に関する適切な記事が見つかりませんでした。 私は自分ですべてを理解しなければならなかった、それはすべてがそれほど怖くないことが判明した。

そして最近、Springに追加された新しい機能を調べ、古いサービスを更新することにしました。その結果、この記事を書くようになりました。



この記事は、Spring-WSを使用してSOAPプロトコルを使用する単純なWebサービスを開発するためのガイドです。



そして、ユーザー名を受け入れ、サーバー上で挨拶と現在時刻を送信する簡単なサービスを作成します。

何が必要ですか？

• IDE Eclipseを使用しています 。
• アリ
• soapUI
• Jdk
• Jre
• Spring Framework 3.1.2
• Spring-WS 2.1.0
• XMLBeans 2.5.0
• wsdl4j
• commons-logging-1.1.1

仕事の準備

新しいWebアプリケーションプロジェクトを作成します。 Eclipseでは、これは「ファイル=>新規=>動的Webプロジェクト」です。

プロジェクトをHelloServiceと呼びました。

次に、ライブラリをSpring、XMLBean、wsdl4j、commons-loggingからプロジェクトディレクトリWEB-INF / libにコピーします。

必要に応じて、すべてのアプリケーションでドラッグしないように、サーバーライブラリに追加できます。

WSDLスキーマの作成

本質的に、WSDLスキームはサービスを記述することを目的としています。

もちろん、手動で行うことはありません。 このスキームはSpringによって自動的に生成されますが、それについては後で詳しく説明します。

入力データと出力データを決定します

入力データ：

• ストリング名。

出力データ：

• ストリンググリーティング;
• 現在時刻。

入力データと出力データの説明を作成する

WEB-INFディレクトリで、HelloService.xsdファイルを作成します。 このファイルは、WSDLスキームを生成し、対応するJavaクラスを作成するために必要になります。

ファイルテキスト：

<?xml version="1.0" encoding="UTF-8"?> <schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.example.org/HelloService" elementFormDefault="qualified"> <element name="ServiceRequest"> <complexType> <sequence> <element name="name" type="string" maxOccurs="1" minOccurs="1"/> </sequence> </complexType> </element> <element name="ServiceResponse"> <complexType> <sequence> <element name="hello" type="string" maxOccurs="1" minOccurs="1"/> <element name="currentTime" type="time" maxOccurs="1" minOccurs="1"/> </sequence> </complexType> </element> </schema>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

targetNamespace属性は、使用される名前空間です。 つまり 作成されたすべてのオブジェクトは、パッケージorg.example.helloServiceに配置されます。

ServiceRequest要素とServiceResponse要素は、それぞれ入力データと出力データ（要求/応答）を記述します。

minOccursおよびmaxOccurs属性は、1つの要素内でのこのコンポーネントの繰り返し数を決定します。 これらのパラメーターが指定されていない場合、デフォルトでは1と等しいと見なされます。オプションのコンポーネントの場合、minOccurs = 0を指定する必要があります。 コンポーネントの数に制限はありません：maxOccurs = unbounded。

XMLスキーマの詳細については、 こちらをご覧ください 。

JavaBeansを作成する

作成されたスキームに基づいて、Javaクラスを作成します。 これを行うには、build.xmlファイルを作成します。

 <?xml version="1.0" encoding="UTF-8"?> <project name="imsjob" default="build" basedir="."> <property name="WS_HOME" value="C:\AST\lib\standart"/> <property name="encoding" value="UTF-8"/> <path id="xbean.classpath"> <fileset dir="${WS_HOME}"> <include name="*.jar"/> </fileset> </path> <taskdef name="xmlbean" classname="org.apache.xmlbeans.impl.tool.XMLBean" classpathref="xbean.classpath" /> <target name="init"> <echo message="Start init"/> </target> <target name="build" depends="init"> <xmlbean schema="HelloService.xsd" destfile="lib\helloservice.jar" classpathref="xbean.classpath"/> </target> </project>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

WS_HOMEパラメーターは、XMLBeansが配置されているディレクトリを指している必要があります。

HelloService.xsd-作成されたスキームへのパス。

lib \ helloservice.jar-作成されたjava-library。



次に、Ant-buildを実行します（既にインストールされていることを望みます）。

Eclipseでは、次のように実行できます。ファイルbuild.xml => Run As => Ant Buildを使用してRMB。

コマンドライン経由の場合：

ant -buildfile build.xml





さて、私たちは建設の完了を待っています。 その後、プロジェクトディレクトリWEB-INF \ libで適切なライブラリ（helloservice.jar）の存在を確認できます。

サービス実装

インターフェイスとサービスクラスを作成します

サービスインターフェイス：HelloService.java：

 package org.example; import java.util.Calendar; public interface HelloService { public String getHello(String name) throws Exception; public Calendar getCurrentTime(); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

サービスの実装：HelloServiceImpl.java：

 package org.example; import java.util.Calendar; import org.springframework.stereotype.Service; @Service public class HelloServiceImpl implements HelloService { public String getHello(String name) throws Exception { return "Hello, " + name + "!"; } public Calendar getCurrentTime() { return Calendar.getInstance(); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このコードにはコメントは必要ないと思います。 これまでSpringに出会ったことがない人が質問を投げかける可能性があるのは、@ Serviceアノテーションだけです。 しかし、私は同じことについて少し後で説明します。

エンドポイント

エンドポイント-着信要求（一種のエントリポイント）の処理を担当するクラス。



ファイルHelloServiceEndpoint.javaを作成します。

 package org.example; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.ws.server.endpoint.annotation.Endpoint; import org.springframework.ws.server.endpoint.annotation.PayloadRoot; import org.example.helloService.ServiceRequestDocument; import org.example.helloService.ServiceRequestDocument.ServiceRequest; import org.example.helloService.ServiceResponseDocument; import org.example.helloService.ServiceResponseDocument.ServiceResponse; @Endpoint public class HelloServiceEndpoint{ private static final String namespaceUri = "http://www.example.org/HelloService"; private HelloService helloService; @Autowired public void HelloService (HelloService helloService) { this.helloService = helloService; } @PayloadRoot(localPart = "ServiceRequest", namespace = namespaceUri) public ServiceResponseDocument getService(ServiceRequestDocument request) throws Exception { ServiceRequestDocument reqDoc = request; ServiceRequest req = reqDoc.getServiceRequest(); ServiceResponseDocument respDoc = ServiceResponseDocument.Factory.newInstance(); ServiceResponse resp = respDoc.addNewServiceResponse(); String userName = req.getName(); String helloMessage = testNewService.getHello(userName); Calendar currentTime = testNewService.getCurrentTime(); resp.setHello(helloMessage); resp.setCurrentTime(currentTime); return respDoc; } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ここで何が行われましたか？

@Endpointアノテーションは、このクラスが着信要求を処理することを決定するだけです。

namespaceUri -xml-schemeの作成時に指定されたのと同じネームスペース。



では、少し戻って@ Serviceアノテーションを思い出しましょう。 不必要な情報で読者に負担をかけすぎないように詳細に入らない場合、この注釈は適切なオブジェクトを作成するようSpringに指示します。 また、 @ Autowiredアノテーションは、対応するオブジェクトを挿入（自動的に置換）するのに役立ちます。 もちろん、これらの注釈を使用して単純なアプリケーションを構築する場合、意味はありませんが、この例ではそれらを除外しないことにしました。



それでは、先に進みましょう。

メソッドの前の@PayloadRootアノテーションは、このメソッドが呼び出されるというリクエストがいつ受信されるかを決定します。 この例では、「ServiceRequest」です。



そうでなければ、再び、すべてが明確になります。 ServiceRequest、ServiceResponseなどに注意してください。 -これらは、xml-schemeに基づいて作成されたクラスです。

Springサービスの構成

そのため、完成に近づいています。

service-ws-servlet.xmlファイルを作成します。

 <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xmlns:sws="http://www.springframework.org/schema/web-services" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd http://www.springframework.org/schema/web-services http://www.springframework.org/schema/web-services/web-services-2.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd"> <context:component-scan base-package="org.example" /> <sws:annotation-driven /> <bean class="org.springframework.ws.server.endpoint.adapter.GenericMarshallingMethodEndpointAdapter"> <property name="marshaller" ref="marshaller" /> <property name="unmarshaller" ref="marshaller" /> </bean> <bean id="marshaller" class="org.springframework.oxm.xmlbeans.XmlBeansMarshaller"/> <sws:dynamic-wsdl id="HelloService" portTypeName="service" locationUri="/HelloService" > <sws:xsd location="/WEB-INF/HelloService.xsd" /> </sws:dynamic-wsdl> </beans>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

sws：注釈駆動型 -このプロジェクトでは注釈が使用されていることを示しています。

コンテキスト：component-scanは、アノテーションの検索が実行されるパッケージを示しますが、検索はサブパッケージでも実行されます。



次の2つのBeanは常に変更されません。 それらの本質は、XmlからJavaオブジェクトへのリクエストの受信と変換、さらに逆変換です。



sws：dynamic-wsdlは、生成されたXmlスキームに基づいてWSDLドキュメントを自動的に生成します。

locationは、スキーマへのパスを示します。

locationUri -WSDLスキームを使用できるアドレス（コンテナを基準とする）。

私の場合、WSDLは次のアドレスで入手できます。

localhost / HelloService / HelloService.wsdl

デプロイメント記述子

そして最後に、最後。

WEB-INFディレクトリで、web.xmlファイルを変更または作成します。

 <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd"> <web-app> <display-name>HelloService</display-name> <description>HelloService</description> <servlet> <servlet-name>service-ws</servlet-name> <servlet-class>org.springframework.ws.transport.http.MessageDispatcherServlet</servlet-class> <init-param> <param-name>transformWsdlLocations</param-name> <param-value>true</param-value> </init-param> <servlet-mapping> <servlet-name>service-ws</servlet-name> <url-pattern>/*</url-pattern> </servlet-mapping> </web-app>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このファイルについてはもう説明しません。ほとんどの人はすでに知っているはずです。 単純なプロジェクトの場合、本質的に変更しないでください。 サーブレットの名前（servlet-name）がservice-ws -servlet.xmlのSpring構成ファイルの名前と一致しなければならないことに注意してください。



それでは、アプリケーションをサーバーにデプロイします。

これで、サービスの作成が完了しました。 何も見逃さない場合、サービスは機能するはずです。

ヘルスチェック

正しい操作の最初の兆候は、作成されたWSDLスキームです。

確認するには、このスキームのアドレス（http：//localhost/HelloService/HelloService.wsdl）に移動して、次を参照してください：xmlファイルが表示されるはずです。 何も表示されない場合やエラーが表示された場合は、記事全体を注意深く読み直し、間違ったことを探します。



さらに検証するには、soapUIが必要です（バージョン3.0.1があります）。

インストールして実行します。

新しいプロジェクトを作成します。File=> New soapUI Project。 [初期WSDL / WADL]フィールドに、WSDLスキームへのリンクを挿入します（http：//localhost/HelloService/HelloService.wsdl）。

作成されたプロジェクトで、必要なリクエストを開きます。



[名前]フィールドで名前を入力し、[要求を送信]ボタンをクリックします



結果として、挨拶と現在の時刻を含むサーバーから応答を受け取ります。



何か問題が発生した場合は、この記事をもう一度お読みください。

次は？

それでは、このWebサービスのクライアントを作成する必要があります。 しかし、これはすでに別の記事の資料であり、誰かが興味を持っているのであれば、後で書くかもしれません。