Apache CXF 与 JAX-RS
在继续本章之前，我们假设您知道如何用 Java 编写 RESTful Web 服务。我将向您展示如何在 JAX-RS（RESTful Web 服务的 Java API）之上使用 CXF。我们将创建一个网络服务来维护最新电影的列表。当用户请求电影时，他在请求中指定电影ID，服务器将找到该电影并将其返回给客户端。在我们的小例子中，我们将简单地将电影名称返回给客户端，而不是实际的二进制 MP4 文件。那么让我们开始创建一个 JAX-RS 应用程序。
声明电影元素
我们将声明一个名为 Movie 的 XML 根元素，用于存储给定电影的 id 和名称。该元素在名为 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标记来声明Movie标记的 XML 元素。接下来，我们将创建一个在其数据库中保存电影列表的服务。
创建电影服务数据库
为了存储电影列表，我们使用 Java 提供的Map来存储键值对。如果列表很大，您将使用外部数据库存储，这也更易于管理。在我们的小例子中，我们将在数据库中仅存储五部电影。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);
}
}
请注意，我们使用以下两个注释来指定电影服务的 URL 路径及其返回类型 -
@Path("/movieservice/")
@Produces("text/xml")
我们使用 @GET 和 @Path 注释来指定 GET 请求的 URL，如下所示 -
@GET
@Path("/movie/{id}/")
电影数据库本身在 init 方法中初始化，我们在该方法中向数据库添加了五个电影项。
我们的下一个任务是编写一个服务器应用程序。
开发服务器
为了创建服务器，我们使用 CXF 提供的JAXRSServerFactoryBean类。
JAXRSServerFactoryBean factory = new JAXRSServerFactoryBean();
我们通过调用setResourceClasses方法来设置其资源类。
factory.setResourceClasses(Movie.class); factory.setResourceClasses(MovieService.class);
我们通过调用setResourceProvider方法来设置服务提供者。
factory.setResourceProvider(MovieService.class, new SingletonResourceProvider(new MovieService()));
我们通过调用aetAddress方法设置所需的发布地址-
factory.setAddress("http://localhost:9000/");
最后，我们通过调用工厂实例的 create 方法来发布服务器。
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 示例提供了几个有关如何将 CXF 与 JAX-RS 结合使用的示例。鼓励感兴趣的读者研究这些样本。