JAX-RSを使用したApacheCXF

この章に進む前に、JavaでRESTfulWebサービスを作成する方法を知っていることを前提としています。このJAX-RS（RESTfulWebサービス用のJavaAPI）上でCXFを使用する方法を紹介します。最新の映画のリストを管理するWebサービスを作成します。ユーザーが映画をリクエストすると、リクエストで映画IDを指定すると、サーバーが映画を見つけてクライアントに返します。些細なケースでは、実際のバイナリMP4ファイルではなく、単にムービー名をクライアントに返します。それでは、JAX-RSアプリケーションの作成を始めましょう。

映画要素の宣言

特定の映画のIDと名前を格納するためのMovieというXMLルート要素を宣言します。この要素は、Movie.javaというファイルで宣言されています。ファイルの内容はここに表示されます-

//Movie.java
package com.tutorialspoint.cxf.jaxrs.movie;
import javax.xml.bind.annotation.XmlRootElement;
@XmlRootElement(name = "Movie")
public class Movie {
   private long id;
   private String name;
   public long getId() {
      return id;
   }
   public void setId(long id) {
      this.id = id;
   }
   public String getName() {
      return name;
   }
   public void setName(String name) {
      this.name = name;
   }
}

の使用に注意してください XmlRootElement のXML要素を宣言するタグ Movie鬼ごっこ。次に、データベースに映画のリストを保持するサービスを作成します。

映画サービスデータベースの作成

提供されているJavaを使用して映画のリストを保存します Mapキーと値のペアを格納します。リストが大きい場合は、管理が容易な外部データベースストレージを使用します。些細なケースでは、データベースに保存する映画は5つだけです。MovieServiceクラスのコードを以下に示します-

//MovieService.java
package com.tutorialspoint.cxf.jaxrs.movie;
import java.util.HashMap;
import java.util.Map;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
@Path("/movieservice/")
@Produces("text/xml")
public class MovieService {
   long currentId = 123;
   Map<Long, Movie> movies = new HashMap<>();
   public MovieService() {
      init();
   }
   @GET
   @Path("/movie/{id}/")
   public Movie getMovie(@PathParam("id") String id) {
      long idNumber = Long.parseLong(id);
      return movies.get(idNumber);
   }
   final void init() {
      Movie c1 = new Movie();
      c1.setName("Aquaman");
      c1.setId(1001);
      movies.put(c1.getId(), c1);
      
      Movie c2 = new Movie();
      c2.setName("Mission Imposssible");
      c2.setId(1002);
      movies.put(c2.getId(), c2);
      
      Movie c3 = new Movie();
      c3.setName("Black Panther");
      c3.setId(1003);
      movies.put(c3.getId(), c3);
      
      Movie c4 = new Movie();
      c4.setName("A Star is Born");
      c4.setId(1004);
      movies.put(c4.getId(), c4);
      
      Movie c5 = new Movie();
      c5.setName("The Meg");
      c5.setId(1005);
      movies.put(c5.getId(), c5);
   }
}

次の2つのアノテーションを使用して、映画サービスのURLパスとその戻り値の型を指定していることに注意してください-

@Path("/movieservice/")
@Produces("text/xml")

@GETアノテーションと@Pathアノテーションを使用して、GETリクエストのURLを次のように指定します-

@GET
@Path("/movie/{id}/")

映画データベース自体はinitメソッドで初期化され、5つの映画アイテムがデータベースに追加されます。

次のタスクは、サーバーアプリケーションを作成することです。

サーバーの開発

サーバーを作成するには、提供されているCXFを使用します JAXRSServerFactoryBean クラス。

JAXRSServerFactoryBean factory = new JAXRSServerFactoryBean();

を呼び出すことでリソースクラスを設定します setResourceClasses 方法。

factory.setResourceClasses(Movie.class);
factory.setResourceClasses(MovieService.class);

を呼び出してサービスプロバイダーを設定します setResourceProvider 方法。

factory.setResourceProvider(MovieService.class,
new SingletonResourceProvider(new MovieService()));

希望を設定します publish を呼び出すことによってアドレス aetAddress 方法−

factory.setAddress("http://localhost:9000/");

最後に、でcreateメソッドを呼び出してサーバーを公開します。 factory インスタンス。

factory.create();

サーバーアプリケーションのコード全体を以下に示します-

//Server.java
package com.tutorialspoint.cxf.jaxrs.movie;
import org.apache.cxf.jaxrs.JAXRSServerFactoryBean;
import org.apache.cxf.jaxrs.lifecycle.SingletonResourceProvider;
public class Server {
   public static void main(String[] args) throws Exception {
      JAXRSServerFactoryBean factory = new JAXRSServerFactoryBean();
      factory.setResourceClasses(Movie.class);
      factory.setResourceClasses(MovieService.class);  
      factory.setResourceProvider(MovieService.class,
         new SingletonResourceProvider(new MovieService()));
      factory.setAddress("http://localhost:9000/");
      factory.create();
      
      System.out.println("Server ready...");
      Thread.sleep(5 * 60 * 1000);
      
      System.out.println("Server exiting ...");
      System.exit(0);
   }
}

最終的な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-jaxrs</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.jaxrs.movie.Server
                           </mainClass>
                        </configuration>
                     </execution>
                  </executions>
               </plugin>
            </plugins>
         </build>
         <dependencies>
            <dependency>
               <groupId>org.apache.cxf</groupId>
               <artifactId>cxf-rt-transports-http-jetty</artifactId>
               <version>3.3.0</version>
            </dependency>
         </dependencies>
      </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.jaxrs.movie.Client
                           </mainClass>
                        </configuration>
                     </execution>
                  </executions>
               </plugin>
            </plugins>
         </build>
      </profile>
   </profiles>
   <dependencies>
      <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-transports-http-jetty</artifactId>
         <version>3.3.0</version>
      </dependency>
      <dependency>
         <groupId>org.apache.cxf</groupId>
         <artifactId>cxf-rt-frontend-jaxrs</artifactId>
         <version>3.3.0</version>
         </dependency>
      <dependency>
         <groupId>jakarta.ws.rs</groupId>
         <artifactId>jakarta.ws.rs-api</artifactId>
         <version>2.1.5</version>
      </dependency>
      <dependency>
         <groupId>org.apache.httpcomponents</groupId>
         <artifactId>httpclient</artifactId>
         <version>4.5.7</version>
      </dependency>
   </dependencies>
</project>

クライアントの開発

RSクライアントの作成は簡単です。URLオブジェクトを作成し、そのストリームを開くだけです。CXFが提供するIOUtilsクラスを使用して、入力ストリームの内容をローカルストリームにコピーします。

URL url = new URL("http://localhost:9000/movieservice/movie/1002");
try (InputStream instream = url.openStream();
CachedOutputStream outstream = new CachedOutputStream()) {
   IOUtils.copy(instream, outstream);
}

クライアントアプリケーションのコード全体を以下に示します-

//Client.java
package com.tutorialspoint.cxf.jaxrs.movie;
import java.io.InputStream;
import java.net.URL;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.io.CachedOutputStream;
public class Client {
   public static void main(String[] args) throws Exception {
      URL url = new URL("http://localhost:9000/movieservice/movie/1002");
      try (InputStream instream = url.openStream();
      CachedOutputStream outstream = new CachedOutputStream()) {
         IOUtils.copy(instream, outstream);
         String str = outstream.getOut().toString();
         System.out.println(str);
      }
   }
}

JAX-RSアプリケーションのテスト

コマンドラインウィンドウで次のコマンドを使用してサーバーを実行します-

mvn -Pserver

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

INFO: Setting the server's publish address to be http://localhost:9000

次に、ブラウザを開いて、次のURLを入力します-

http://localhost:9000/movieservice/movie/1002

ブラウザウィンドウに次のように表示されます。

別のコマンドラインウィンドウで次のコマンドを実行して開発したJavaクライアントアプリケーションを使用して、サービスを呼び出すことができます。

mvn -Pclient

次の出力が表示されます-

<?xml version="1.0" encoding = "UTF-8" standalone="yes"?>
<Movie><id>1002</id><name>Mission Imposssible</name></Movie>

CXFサンプルは、JAX-RSでCXFを使用する方法に関するいくつかの例を提供します。興味のある読者は、これらのサンプルを研究することをお勧めします。