JAX-WSを使用したApacheCXF

このJAX-WSアプリケーションでは、以前のPOJOアプリケーションと同様にApacheCXFファーストのアプローチを使用します。したがって、最初にWebサービスのインターフェースを作成します。

サービスインターフェイスの宣言

前の場合と同様に、グリーティングと呼ばれるインターフェイスメソッドが1つしかない簡単なサービスを作成します。サービスインターフェースのコードを以下に示します-

//HelloWorld.java
package com.tutorialspoint.cxf.jaxws.helloworld;
import javax.jws.WebService;

@WebService
public interface HelloWorld {
   String greetings(String text);
}

インターフェイスに注釈を付けます @WebService鬼ごっこ。次に、このインターフェースを実装します。

Webインターフェイスの実装

Webインターフェースの実装をここに示します-

//HelloWorldImpl.java
package com.tutorialspoint.cxf.jaxws.helloworld;
public class HelloWorldImpl implements HelloWorld {
   @Override
   public String greetings(String name) {
      return ("hi " + name);
   }
}

あいさつメソッドには注釈が付けられています @Override鬼ごっこ。このメソッドは、「hi」メッセージを呼び出し元に返します。

次に、サーバーを開発するためのコードを記述します。

サーバーの開発

POJOアプリケーションとは異なり、CXFが提供するEndpointクラスを使用してサービスを公開することにより、インターフェイスを分離します。これは、次の2行のコードで実行されます-

HelloWorld implementor = new HelloWorldImpl();
Endpoint.publish(
   "http://localhost:9090/HelloServerPort",
   implementor,
   new LoggingFeature()
);

公開メソッドの最初のパラメーターは、クライアントがサービスを利用できるようにするURLを指定します。2番目のパラメーターは、サービスの実装クラスを指定します。サーバーのコード全体を以下に示します-

//Server.java
package com.tutorialspoint.cxf.jaxws.helloworld;
import javax.xml.ws.Endpoint;
import org.apache.cxf.ext.logging.LoggingFeature;
public class Server {
   public static void main(String[] args) throws Exception {
      HelloWorld implementor = new HelloWorldImpl();
      Endpoint.publish("http://localhost:9090/HelloServerPort",
      implementor,
      new LoggingFeature());
      System.out.println("Server ready...");
      Thread.sleep(5 * 60 * 1000);
      System.out.println("Server exiting ...");
      System.exit(0);
   }
}

サーバーをデプロイするには、以下に示すように、プロジェクトにさらにいくつかの変更を加える必要があります。

サーバーの展開

最後に、サーバーアプリケーションをデプロイするには、pom.xmlにもう1つ変更を加えて、アプリケーションをWebアプリケーションとしてセットアップする必要があります。追加する必要のあるコードpom.xml 以下に示します-

<profiles>
   <profile>
      <id>server</id>
      <build>
         <defaultGoal>test</defaultGoal>
         <plugins>
            <plugin>
               <groupId>org.codehaus.mojo</groupId>
               <artifactId>exec-maven-plugin</artifactId>
               <version>1.6.0</version>
               <executions>
                  <execution>
                     <phase>test</phase>
                     <goals>
                        <goal>java</goal>
                     </goals>
                     <configuration>
                        <mainClass>
                           com.tutorialspoint.cxf.jaxws.helloworld.Server
                        </mainClass>
                     </configuration>
                  </execution>
               </executions>
            </plugin>
         </plugins>
      </build>
   </profile>
</profiles>

アプリケーションをデプロイする前に、プロジェクトにさらに2つのファイルを追加する必要があります。これらは以下のスクリーンショットに示されています-

これらのファイルは、のマッピングを定義するCXF標準ファイルです。 CXFServlet。内のコードweb.xml クイックリファレンスとしてファイルをここに示します-

//Web.xml
<?xml version = "1.0" encoding = "UTF-8"??>
<web-app xmlns = "http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.5"
xsi:schemaLocation = "http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
   <display-name>cxf</display-name>
   <servlet>
      <description>Apache CXF Endpoint</description>
      <display-name>cxf</display-name>
      <servlet-name>cxf</servlet-name>
      <servlet-class>
         org.apache.cxf.transport.servlet.CXFServlet
      </servlet-class>
      <load-on-startup>
         1
      </load-on-startup>
   </servlet>
   <servlet-mapping>
      <servlet-name>
         cxf
      </servlet-name>
      <url-pattern>
         /services/*
      </url-pattern>
   </servlet-mapping>
   <session-config>
      <session-timeout>60</session-timeout>
   </session-config>
</web-app>

の中に cxf-servlet.xml,サービスのエンドポイントのプロパティを宣言します。これは、以下のコードスニペットに示されています-

<beans ...>
   <jaxws:endpoint xmlns:helloworld = "http://tutorialspoint.com/"
      id = "helloHTTP"
      address = "http://localhost:9090/HelloServerPort"
      serviceName = "helloworld:HelloServiceService"
      endpointName = "helloworld:HelloServicePort">
   </jaxws:endpoint>
</beans>

ここでは、サービスエンドポイントのID、サービスを利用できるアドレス、サービス名、エンドポイント名を定義します。ここで、CXFサーブレットによってサービスがルーティングおよび処理される方法を学習しました。

最終的なpom.xml

ザ・ pom.xmlさらにいくつかの依存関係が含まれています。すべての依存関係を説明するのではなく、pom.xmlの最終バージョンを以下に含めました-

<?xml version = "1.0" encoding = "UTF-8"??>
<project xmlns = "http://maven.apache.org/POM/4.0.0"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0
   http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.tutorialspoint</groupId>
   <artifactId>cxf-jaxws</artifactId>
   <version>1.0</version>
   <packaging>jar</packaging>
   <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <maven.compiler.source>1.8</maven.compiler.source>
      <maven.compiler.target>1.8</maven.compiler.target>
   </properties>
   <profiles>
      <profile>
         <id>server</id>
         <build>
            <defaultGoal>test</defaultGoal>
            <plugins>
               <plugin>
                  <groupId>org.codehaus.mojo</groupId>
                  <artifactId>exec-maven-plugin</artifactId>
                  <version>1.6.0</version>
                  <executions>
                     <execution>
                        <phase>test</phase>
                        <goals>
                           <goal>java</goal>
                        </goals>
                        <configuration>
                           <mainClass>
                              com.tutorialspoint.cxf.jaxws.helloworld.Server
                           </mainClass>
                        </configuration>
                     </execution>
                  </executions>
               </plugin>
            </plugins>
         </build>
      </profile>
      <profile>
         <id>client</id>
         <build>
            <defaultGoal>test</defaultGoal>
            <plugins>
               <plugin>
                  <groupId>org.codehaus.mojo</groupId>
                  <artifactId>exec-maven-plugin</artifactId>
                  <executions>
                     <execution>
                        <phase>test</phase>
                        <goals>
                           <goal>java</goal>
                        <goals>
                        <configuration>
                           <mainClass>
                              com.tutorialspoint.cxf.jaxws.helloworld.Client
                           </mainClass>
                        </configuration>
                     </execution>
                  </executions>
               </plugin>
            </plugins>
         </build>
      </profile>
   </profiles>
   <dependencies>
      <dependency>
         <groupId>org.apache.cxf</groupId>
         <artifactId>cxf-rt-frontend-jaxws</artifactId>
         <version>3.3.0</version>
      </dependency>
      <dependency>
         <groupId>org.apache.cxf</groupId>
         <artifactId>cxf-rt-transports-http</artifactId>
         <version>3.3.0</version>
      </dependency>
      <dependency>
         <groupId>org.apache.cxf</groupId>
         <artifactId>cxf-rt-features-logging</artifactId>
         <version>3.3.0</version>
      </dependency>
      <dependency>
         <groupId>org.apache.cxf</groupId>
         <artifactId>cxf-rt-transports-http-jetty</artifactId>
         <version>3.3.0</version>
      </dependency>
   </dependencies>
</project>

このチュートリアルの後半のセクションで学習するクライアントを構築するためのプロファイルも含まれていることに注意してください。

HelloWorldサービスの実行

これで、Webアプリを実行する準備が整いました。コマンドウィンドウで、次のコマンドを使用してビルドスクリプトを実行します。

mvn clean install
mvn -Pserver

コンソールに次のメッセージが表示されます-

INFO: Setting the server's publish address to be http://localhost:9090/HelloServerPort
Server ready…

以前と同様に、ブラウザでサーバーのURLを開くことでサーバーをテストできます。

操作を指定しなかったため、アプリケーションからブラウザに返されるのは障害メッセージのみです。

今、追加してみてください ?wsdl URLにアクセスすると、次の出力が表示されます-

したがって、サーバーアプリケーションは期待どおりに実行されています。次のようなSOAPクライアントを使用できますPostman サービスをさらにテストするために前述しました。

次のセクションでは、サービスを使用するクライアントを作成する方法を学習します。

クライアントの開発

CXFアプリケーションでクライアントを作成することは、サーバーを作成することと同じくらい簡単です。これがクライアントの完全なコードです-

//Client.java
package com.tutorialspoint.cxf.jaxws.helloworld;
import javax.xml.namespace.QName;
import javax.xml.ws.Service;
import javax.xml.ws.soap.SOAPBinding;
public final class Client {
   private static final QName SERVICE_NAME
   = new QName("http://helloworld.jaxws.cxf.tutorialspoint.com/",
   "HelloWorld");
   private static final QName PORT_NAME
   = new QName("http://helloworld.jaxws.cxf.tutorialspoint.com/",
   "HelloWorldPort");
   private Client() {
   }
   public static void main(String[] args) throws Exception {
      Service service = Service.create(SERVICE_NAME);
      System.out.println("service created");
      String endpointAddress = "http://localhost:9090/HelloServerPort";
      service.addPort(PORT_NAME, SOAPBinding.SOAP11HTTP_BINDING,
      endpointAddress);
      HelloWorld hw = service.getPort(HelloWorld.class);
      System.out.println(hw.greetings("World"));
   }
}

ここでは、提供されているCXFを使用します Service既知のサービスにバインドするクラス。私たちはcreate 上の方法 Serviceサービスのインスタンスを取得するクラス。を呼び出すことにより、既知のポートを設定しますaddPort 上の方法 service インスタンス。

これで、サービスを利用する準備が整いました。これは、最初にを呼び出してサービスインターフェイスを取得することで行います。 getPort 上の方法 serviceインスタンス。最後に、私たちはgreetings コンソールにグリーティングメッセージを出力するメソッド。

これで、Apache CXF-Firstアプローチを使用してCXFの基本を学習したので、次の章で、WSDL-FirstアプローチでCXFを使用する方法を学習します。