Apache CXF - 快速指南

Apache CXF - 简介

在当今的环境中，您可以使用多个选项来创建 Web 服务应用程序。您可以使用多种标准且广泛接受的协议中的一种或多种进行通信。例如SOAP、 XML/HTTP 、RESTful HTTP和CORBA（通用对象请求代理架构），它在过去非常流行，但现在不那么常用了。

您还可以选择不同的传输，例如 HTTP、JMS、JBI，以及选择前端 API，例如JAX-RS和JAX-WS。Web 服务开发有如此多的选项，因此需要一个开源服务框架将所有上述选项粘合在一起，这就是Apache CXF所做的。

在本教程中，您将学习如何使用 CXF 创建 Web 服务和使用该服务的客户端，并使用我们上面列出的一个或多个选项。本教程将引导您完成服务器和客户端的整个代码开发。由于每个应用程序只能使用每个类别中的一个选项，即前端、传输和协议，考虑到这三者的所有排列和组合，应用程序的数量将非常高。

本教程详细讨论以下项目的开发 -

  • 带有普通旧式 Apache CXF 对象 (POJO) 的 CXF

  • 带有 JAX-WS 的 CXF

  • 带有 WSDL 的 CXF

  • CXF 与 JAX-RS

  • 带有 JMS 的 CXF

为了简单起见，我们使用 Maven 及其命令行界面。您可以使用您喜欢的 IDE 来创建 Maven 项目。

在下一章中，让我们从第一章开始。

Apache CXF 与 POJO

在本章中，您将学习如何开发一个简单的 Web 应用程序来向用户发送问候消息。Web 服务项目使用WSDL模型。CXF 允许您通过提供一个简单的前端将 Apache CXF API 映射到底层 WSDL 来隐藏此 WSDL 模型。

在这个最简单的项目中，Web 服务的接口将直接暴露给客户端，客户端将使用本机 Apache CXF API 来调用 Web 服务。

首先，我们将创建一个 Web 服务。每个服务都有一个暴露给客户端的接口。我们可以将此接口编写为简单的 Apache CXF 接口或 WSDL 文档。在这种 Apache CXF-First 方法中，我们将通过 Apache CXF 接口公开我们的服务。

开发网络服务

我们要在 Web 上创建的服务将有一个名为Greetings的 Web 方法。该方法采用字符串类型参数，我们将在其中发送用户名。该服务将向呼叫者发回一条问候消息，消息中包含收到的用户名。

网络服务接口

为了公开我们的 Web 服务的接口，我们将创建一个 Apache CXF 接口，如下所示 -

//HelloWorld.java
package com.tutorialspoint.cxf.pojo;
public interface HelloWorld {
   String greetings(String text);
}

该接口只有一种方法，称为greetings。服务器将实现该接口。在我们的简单应用程序中，该接口直接暴露给客户端。通常，在 Web 服务应用程序中，您使用 WSDL 来描述 Web 服务接口。在这个简单的应用程序中，我们将向客户端开发人员提供这个直接接口。然后，客户端将调用服务器对象上的问候消息。首先让我们创建 Web 服务。

网络服务实施

HelloWorld接口在HelloWorldImpl Apache CXF 类中实现，如下所示 -

//HelloWorldImpl.java
package com.tutorialspoint.cxf.pojo;
public class HelloWorldImpl implements HelloWorld {
   @Override
   public String greetings(String text) {
      return "Hi " + text;
   }
}

greetings方法接收字符串类型的参数，将其附加到问候消息并将结果字符串返回给调用者。

接下来，我们编写服务器应用程序来托管HelloWorld服务。

创建服务器

服务器应用程序由两部分组成 -

  • 第一部分为我们的 Web 服务创建一个工厂，并且

  • 第二部分编写了实例化它的主要方法。

服务器使用CXF 库提供的ServerFactoryBean类向远程客户端公开我们的HelloWorld接口。因此，我们首先实例化ServerFactoryBean类，然后设置其各种属性 -

ServerFactoryBean factory = new ServerFactoryBean();

我们通过调用工厂对象上的setServiceClass方法来设置要调用的服务类-

factory.setServiceClass(HelloWorld.class);

我们通过调用工厂的setAddress方法来设置调用服务的 URL 。请注意，该服务将在此 URL 发布。

factory.setAddress("http://localhost:5000/Hello");

在这种情况下，该服务部署在嵌入式服务器上，并将侦听端口 5000。您可以选择您选择的任何端口号。

在创建工厂之前，需要告诉工厂我们的服务实现类。这是通过调用工厂对象上的setServiceBean方法来完成的，如下所示 -

factory.setServiceBean(new HelloWorldImpl());

服务 bean 设置为我们的服务实现类的实例。最后，我们通过调用工厂的create方法来创建工厂-

factory.create();

现在，我们已经开发了工厂来运行我们的 Web 服务，接下来我们将编写一个main方法来实例化它并保持它运行一段时间。

现在，编写一个main方法来实例化HelloServer类，如下所示 -

public static void main(String[] args) throws Exception {
   new HelloServer();
   System.out.println("Listening on port 5000 ...");
}

一旦实例化，HelloServer类将无限期地保持运行。对于生产部署，您肯定会让服务器永远运行。在当前情况下，我们将在预定时间后终止服务器，如下所示 -

Thread.sleep(5 * 60 * 1000);
System.out.println("Server exiting ...");
System.exit(0);

HelloServer类的完整代码如下：

//HelloServer.java

//HelloServer.java
package com.tutorialspoint.cxf.pojo;
import org.apache.cxf.frontend.ServerFactoryBean;
public class HelloServer {
   protected HelloServer() throws Exception {
      ServerFactoryBean factory = new ServerFactoryBean();
      factory.setServiceClass(HelloWorld.class);
      factory.setAddress("http://localhost:5000/Hello");
      factory.setServiceBean(new HelloWorldImpl());
      factory.create();
   }
   public static void main(String[] args) throws Exception {
      new HelloServer();
      System.out.println("Listening on port 5000 ...");
      Thread.sleep(5 * 60 * 1000);
      System.out.println("Server exiting ...");
      System.exit(0);
   }
}

我们创建的服务器应用程序使用CXF 库中的ServerFactoryBean类。现在，我们必须将这些库包含在我们的项目中才能成功编译HelloServer类。我们将使用Maven来设置项目依赖项。

设置 Maven 项目

要创建 Maven 项目，请在命令行窗口中键入以下命令。请注意，我们已在 Mac 计算机上对此进行了测试。对于 Windows 和 Linux 安装，说明在一些地方可能有所不同。

mvn archetype:generate

当询问属性时，输入以下值 -

Define value for property 'groupId': : com.tutorialspoint
Define value for property 'artifactId': : cxf-pojo
Define value for property 'version': 1.0-SNAPSHOT: : 1.0
Define value for property 'package': com.tutorialspoint: : com.tutorialspoint.cxf.pojo

完成 maven 命令后，您将发现在当前文件夹中创建了适当的文件夹结构以及 pom.xml 文件。

生成的目录结构如下所示 -

目录结构

您将在pom.xml中添加 CXF 依赖项，并将上面创建的 Apache CXF 文件复制到 maven 创建的结构的相应文件夹中。为了方便您参考，我们在下面给出了我们在计算机上创建的项目的 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-pojo</artifactId>
   <version>1.0</version>
   <packaging>jar</packaging>
   
   <profiles>
      <profile>
         <id>server</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.pojo.HelloServer
                           </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.pojo.HelloClient
                           </mainClass>
                        </configuration>
                     </execution>
                  </executions>
               </plugin>
            </plugins>
         </build>
      </profile>
   </profiles>

   <dependencies>
      <dependency>
         <groupId>org.apache.cxf</groupId>
         <artifactId>cxf-rt-features-logging</artifactId>
         <version>3.3.0</version>
         <type>jar</type>
      </dependency>
      <dependency>
         <groupId>org.apache.cxf</groupId>
         <artifactId>cxf-rt-frontend-simple</artifactId>
         <version>3.3.0</version>
         <type>jar</type>
      </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-frontend-jaxws</artifactId>
         <version>3.3.0</version>
      </dependency>
      <!-- Jetty is needed if you're using the CXFServlet -->
      <dependency>
         <groupId>org.apache.cxf</groupId>
         <artifactId>cxf-rt-transports-http-jetty</artifactId>
         <version>3.3.0</version>
      </dependency>
   </dependencies>
   <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>
</project>

上面的 pom.xml 可能包含与该项目无关的其他依赖项，但本教程中的下一个项目需要这些依赖项。无论如何，包含额外的依赖项并没有什么坏处。

项目文件夹结构

放置服务器和客户端 Apache CXF 文件后，我的计算机上的项目文件夹结构如下所示，供您快速参考 -

项目文件夹结构

运行服务器

要构建项目，请在命令行窗口中使用以下命令 -

mvn clean install

您可以使用以下命令启动服务器 -

mvn -Pserver

这将启动服务器，您将在控制台上看到以下提示 -

INFO: Creating Service {http://pojo.cxf.tutorialspoint.com/}HelloWorld from class com.tutorialspoint.cxf.pojo.HelloWorld
INFO: Setting the server's publish address to be http://localhost:5000/Hello
Listening on port 5000 ...

现在，在您的浏览器窗口中指定我们发布的服务的 URL。您将看到以下输出 -

输出文档树

这确认我们的服务正在本地主机上的指定端口上运行。由于我们没有在调用中指定问候消息，因此将向浏览器返回一条 SOAP 错误消息。

您可以使用您选择的 SOAP 客户端进一步测试您的 Web 服务。这里我们使用Postman来测试我们的服务器。

输出如下所示 -

运行服务器输出

请注意，SOAP 请求是手工编码的。发布请求后，服务器发送一条SOAP 响应消息，如屏幕截图的底部所示。

由此，您可以了解到 CXF 在请求和响应方面都保留了 SOAP 协议的使用，同时为您提供了当今世界上确实存在的各种 Web 技术的统一视图。这极大地简化了 Web 应用程序的开发。

我们的下一个任务是创建一个客户端来使用您创建的 Web 服务。

创建客户端

在服务器应用程序中，HelloWorld是公开我们的 Web 服务的接口。Web 服务本身只是向客户端提供一条简单的问候消息。通常，Web服务接口使用WSDL（Web服务描述语言）向外界公开。在这个简单的应用程序中，我们将通过直接公开服务接口（即 HelloWorld.class ）来向客户端公开我们的 Web服务。

为此，CXF 提供了一个名为ClientProxyFactoryBean的工厂类，它允许我们将所需的接口附加到创建的工厂实例。

首先，我们创建一个工厂 bean 实例，如下所示 -

ClientProxyFactoryBean factory = new ClientProxyFactoryBean();

我们在工厂 bean 实例上调用setAddress方法来设置可以调用 Web 服务的 URL。在我们的例子中，我们将使用在前面的步骤中创建服务器时使用的 URL -

factory.setAddress("http://localhost:5000/Hello");

接下来，我们调用工厂实例上的create方法将我们的服务接口HelloWorld.class附加到它。

HelloWorld helloServer = factory.create(HelloWorld.class);

最后，我们调用greetings方法来调用远程Web服务。

System.out.println(helloServer.greetings(System.getProperty("user.name")));

这将在您的控制台上打印一条问候消息。

客户端应用程序的完整源代码如下所示 -

//HelloClient.java
package com.tutorialspoint.cxf.pojo;
import org.apache.cxf.frontend.ClientProxyFactoryBean;
public class HelloClient {
   public static void main(String[] args) throws Exception {
      ClientProxyFactoryBean factory = new ClientProxyFactoryBean();
      factory.setAddress("http://localhost:5000/Hello");
      HelloWorld helloServer = factory.create(HelloWorld.class);
      System.out.println(helloServer.greetings(System.getProperty("user.name")));
   }
}

运行客户端

确保服务器仍在您的计算机上运行。如果超时，请使用以下命令重新启动服务器 -

mvn -Pserver

您将在控制台上看到以下消息 -

Listening on port 5000 ...

现在，在服务器超时（我们设置为 5 分钟）之前，打开另一个命令行窗口并使用以下命令启动客户端 -

mvn -Pclient

您将在命令行上看到类似于以下内容的消息 -

Hi tutorialspoint

请注意，tutorialspoint是我们的用户名。您将收到一条带有您自己名字的问候语。

在下一章中，我们将学习如何在 JAX-WS（Apache CXF API for XML Web Services）项目中使用 CXF。

Apache CXF 与 JAX-WS

在此 JAX-WS 应用程序中，我们将像早期的 POJO 应用程序一样使用 Apache CXF-first 方法。首先我们将为我们的网络服务创建一个界面。

声明服务接口

与前面的情况一样，我们将创建一个简单的服务，它只有一个名为greetings 的接口方法。服务接口的代码如下所示 -

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

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

我们使用@WebService标签来注释该接口。接下来我们就来实现这个接口。

实施网页界面

Web 界面的实现如下所示 -

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

该greetings方法使用@Override标签进行注释。该方法向调用者返回一条“hi”消息。

接下来，我们将编写开发服务器的代码。

开发服务器

与 POJO 应用程序不同，我们现在将通过使用 CXF 提供的 Endpoint 类来解耦接口来发布我们的服务。这是通过以下两行代码完成的 -

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

发布方法的第一个参数指定向客户端提供我们的服务的 URL。第二个参数指定我们服务的实现类。服务器的完整代码如下所示 -

//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 中再进行一项修改，以将您的应用程序设置为 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>

在部署应用程序之前，您需要向项目中添加两个文件。这些如下面的屏幕截图所示 -

部署 JAXWS 应用程序之前

这些文件是 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 = "https://www.tutorialspoint.com/"
      id = "helloHTTP"
      address = "http://localhost:9090/HelloServerPort"
      serviceName = "helloworld:HelloServiceService"
      endpointName = "helloworld:HelloServicePort">
   </jaxws:endpoint>
</beans>

在这里，我们定义服务端点的 ID、服务可用的地址、服务名称和端点名称。现在，您了解了 CXF servlet 如何路由和处理您的服务。

最终的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类来绑定到已知服务。我们调用Service类的create方法来获取服务的实例。我们通过调用服务实例上的addPort方法来设置已知端口。

现在，我们准备使用该服务，首先通过调用服务实例上的getPort方法来获取服务接口。最后，我们调用greetings方法在控制台上打印问候消息。

现在，您已经通过使用 Apache CXF-First 方法了解了 CXF 的基础知识，接下来您将在下一章中学习如何通过 WSDL-First 方法使用 CXF。

首先使用 WSDL 的 Apache CXF

您开发的 CXF-POJO 应用程序导致客户端和服务器之间的耦合非常紧密。直接访问服务接口也会带来严重的安全威胁。因此，通常需要客户端和服务器之间的解耦，这可以通过使用 WSDL（Web 服务描述语言）来实现。

我们在基于 XML 的 WSDL 文档中编写 Web 服务接口。我们将使用一个工具将此 WSDL 映射到 Apache CXF 接口，然后由我们的客户端和服务器应用程序实现和使用。为了提供解耦，从 WSDL 开始是首选方法。为此，您需要首先学习一门新语言——WSDL。编写 WSDL 需要谨慎的方法，如果您在开始编写之前能够对此有所了解，那就更好了。

在本课中，我们将首先在 WSDL 文档中定义 Web 服务接口。我们将学习如何使用 CXF 从 WSDL 开始创建服务器和客户端应用程序。我们将保持应用程序简单，以保持对 CXF 使用的关注。创建服务器应用程序后，我们将使用内置 CXF 类将其发布到所需的 URL。

首先，让我们描述一下我们将要使用的 WSDL。

HelloWorld 的 WSDL

我们要实现的 Web 服务将有一个名为greetings的 Web 方法，该方法接受保存用户名的字符串参数，并在将问候消息附加到用户名后向调用者返回一条字符串消息。完整的 wsdl 如下所示 -

//Hello.wsdl
<?xml version = "1.0" encoding = "UTF-8"?>
<wsdl:definitions xmlns:soap = "http://schemas.xmlsoap.org/wsdl/soap/"
   xmlns:tns = "http://helloworld.tutorialspoint.com/"
   xmlns:wsdl = "http://schemas.xmlsoap.org/wsdl/"
   xmlns:xsd = "http://www.w3.org/2001/XMLSchema"
   name = "HelloWorld"
   targetNamespace = "http://helloworld.tutorialspoint.com/">
   <wsdl:types>
      <xsd:schema attributeFormDefault = "unqualified"
         elementFormDefault = "qualified"
         targetNamespace = "http://helloworld.tutorialspoint.com/">
         <xsd:element name = "greetings" type = "tns:greetings"/>
         <xsd:complexType name = "greetings">
            <xsd:sequence>
               <xsd:element minOccurs = "0" name = "arg0" type = "xsd:string"/>
            </xsd:sequence>
         </xsd:complexType>
         <xsd:element name = "greetingsResponse"
         type = "tns:greetingsResponse"/>
         <xsd:complexType name = "greetingsResponse">
            <xsd:sequence>
               <xsd:element minOccurs = "0" name = "return" type = "xsd:string"/>
            </xsd:sequence>
         </xsd:complexType>
      </xsd:schema>
   </wsdl:types>
   <wsdl:message name = "greetings">
      <wsdl:part element = "tns:greetings" name = "parameters"> </wsdl:part>
   </wsdl:message>
   <wsdl:message name = "greetingsResponse">
      <wsdl:part element = "tns:greetingsResponse" name = "parameters"> </wsdl:part>
   </wsdl:message>
   <wsdl:portType name = "HelloWorldPortType">
      <wsdl:operation name = "greetings">
         <wsdl:input message = "tns:greetings" name = "greetings">  </wsdl:input>
         <wsdl:output message = "tns:greetingsResponse" name = "greetingsResponse">
         </wsdl:output>
      </wsdl:operation>
   </wsdl:portType>
   <wsdl:binding name = "HelloWorldSoapBinding" type = "tns:HelloWorldPortType">
      <soap:binding style = "document"
      transport = "http://schemas.xmlsoap.org/soap/http"/>
      <wsdl:operation name = "greetings">
         <soap:operation soapAction = "" style = "document"/>
         <wsdl:input name = "greetings"></wsdl:input>
         <wsdl:output name = "greetingsResponse">
            <soap:body use = "literal"/>
         </wsdl:output>
         </wsdl:operation>
   </wsdl:binding>
   <wsdl:service name = "HelloWorldService">
      <wsdl:port binding = "tns:HelloWorldSoapBinding" name = "HelloWorldPort">
         <soap:address location = "http://localhost:9090/HelloServerPort"/>
      </wsdl:port>
   </wsdl:service>
</wsdl:definitions>

请注意，编写语法正确的 wsdl 一直是开发人员面临的挑战；有许多工具和在线编辑器可用于创建 wsdl。这些编辑器询问您想要实现的消息名称以及您希望在消息中传递的参数以及您希望客户端应用程序接收的返回消息的类型。如果您了解 wsdl 语法，您可以手动编写整个文档的代码或使用其中一个编辑器来创建您自己的文档。

在上面的 wsdl 中，我们定义了一条名为greetings的消息。该消息将传递到在 http://localhost:9090/HelloServerPort 上运行的名为HelloWorldService的服务。

至此，我们现在将继续进行服务器开发。在开发服务器之前，我们需要为我们的 Web 服务生成 Apache CXF 接口。这是从给定的 wsdl 完成的。为此，您可以使用名为wsdl2java的工具。

wsdl2java 插件

由于我们将使用 Maven 构建项目，因此您需要将以下插件添加到pom.xml文件中。

<plugins>
   <plugin>
      <groupId>org.apache.cxf</groupId>
      <artifactId>cxf-codegen-plugin</artifactId>
      <version>3.3.0</version>
      <executions>
         <execution>
            <id>generate-sources</id>
            <phase>generate-sources</phase>
            <configuration>
               <wsdlOptions>
                  <wsdlOption>
                     <wsdl>src/main/resources/hello.wsdl</wsdl>
                     <faultSerialVersionUID> 1 </faultSerialVersionUID>
                  </wsdlOption>
               </wsdlOptions>
            </configuration>
            <goals>
               <goal>wsdl2java</goal>
            </goals>
         </execution>
      </executions>
   </plugin>
</plugins>

请注意，我们将wsdl文件的位置指定为src/main/resources/Hello.wsdl。您必须确保为您的项目创建适当的目录结构，并将前面显示的hello.wsdl文件添加到指定的文件夹中。

wsdl2java插件将编译此 wsdl 并在预定义的文件夹中创建 Apache CXF 类。此处显示了完整的项目结构，供您参考。

WSDL2Apache CXF 预定义文件夹

现在，您已准备好使用wsdl2java生成的类创建服务器。wsdl2java 创建的类如下图所示 -

WSDL2Apache CXF 生成的类

生成的服务接口

在生成的类列表中，您一定已经注意到其中之一是 Apache CXF 接口 - 这是HelloWorldPortType.java。在代码编辑器中检查此文件。文件内容如下所示，供您参考 -

//HelloWorldPortType.java
package com.tutorialspoint.helloworld;
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.ws.RequestWrapper;
import javax.xml.ws.ResponseWrapper;
/**
* This class was generated by Apache CXF 3.3.0
* 2019-02-11T12:05:55.220+05:30
* Generated source version: 3.3.0
*
*/

@WebService(targetNamespace = "http://helloworld.tutorialspoint.com/",
   name = "HelloWorldPortType")
@XmlSeeAlso({ObjectFactory.class})
public interface HelloWorldPortType {
   @WebMethod
   @RequestWrapper(localName = "greetings", targetNamespace =
      "http://helloworld.tutorialspoint.com/", className =
      "com.tutorialspoint.helloworld.Greetings")
      @ResponseWrapper(localName = "greetingsResponse", targetNamespace =
         "http://helloworld.tutorialspoint.com/", className =
         "com.tutorialspoint.helloworld.GreetingsResponse")
   @WebResult(name = "return", targetNamespace =
      "http://helloworld.tutorialspoint.com/")
   public java.lang.String greetings(
      @WebParam(name = "arg0", targetNamespace =
      "http://helloworld.tutorialspoint.com/")
      java.lang.String arg0
   );
}

请注意，该接口包含一个名为greetings的方法。这是我们的 wsdl 中的消息类型。wsdl2java工具已将此方法添加到生成的接口中。现在，您可以理解，无论您在 wsdl 中编写什么消息，接口中都会生成相应的方法。

现在，您的任务是实现与您在 wsdl 中定义的各种消息相对应的所有这些方法。请注意，在前面的 Apache CXF-First 示例中，我们从 Web 服务的 Apache CXF 接口开始。在本例中，Apache CXF 接口是从 wsdl 创建的。

实现服务接口

服务接口的实现很简单。完整的实现如下面的清单所示 -

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

该代码实现了名为greetings的唯一接口方法。该方法采用一个字符串类型的参数，在其前面添加一条“hi”消息，并将结果字符串返回给调用者。

接下来，我们将编写服务器应用程序。

开发服务器

开发服务器应用程序再次变得微不足道。在这里，我们将使用 CXF 提供的Endpoint类来发布我们的服务。这是通过以下两行代码完成的 -

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

首先，我们创建服务实现类的对象 - HelloWorldImpl。然后，我们将此引用作为第二个参数传递给发布方法。第一个参数是服务发布到的地址 - 客户端将使用此 URL 来访问服务。服务器应用程序的完整源代码在这里给出 -

//Server.java
package com.tutorialspoint.helloworld;
import javax.xml.ws.Endpoint;
import org.apache.cxf.ext.logging.LoggingFeature;
public class Server {
   public static void main(String[] args) throws Exception {
      HelloWorldPortType 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中添加构建配置文件。如下所示 -

<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.helloworld.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>

请注意，服务器类的完全限定名称是在配置中指定的。此外，依赖标签指定我们将使用嵌入式 jetty Web 服务器来部署我们的服务器应用程序。

部署服务器

最后，要部署服务器应用程序，您需要在 pom.xml 中再进行一项修改，以将您的应用程序设置为 Web 应用程序。下面给出了您需要添加到pom.xml中的代码-

<defaultGoal>install</defaultGoal>
<pluginManagement>
   <plugins>
      <plugin>
         <artifactId>maven-war-plugin</artifactId>
         <version>3.2.2</version>
         <configuration>
            <webXml>src/main/webapp/WEB-INF/web.xml</webXml>
            <webResources>
               <resource>
                  <directory>src/main/resources</directory>
                  <targetPath>WEB-INF</targetPath>
                  <includes>
                     <include>*.wsdl</include>
                  </includes>
               </resource>
            </webResources>
         </configuration>
      </plugin>
   </plugins>
</pluginManagement>

在部署应用程序之前，您需要向项目中添加两个文件。这些如下面的屏幕截图所示 -

部署 WSDL 应用程序之前

这些文件是 CXF 标准文件，定义CXFServlet的映射。web.xml文件中的代码如下所示，供您快速参考 -

//cxf-servlet.xml
<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 = "https://www.tutorialspoint.com/"
      id="helloHTTP"
      address = "http://localhost:9090/HelloServerPort"
      serviceName = "helloworld:HelloServiceService"
      endpointName = "helloworld:HelloServicePort">
   </jaxws:endpoint>
</beans>

在这里，我们定义服务端点的 ID、服务可用的地址、服务名称和端点名称。现在，您了解了 CXF servlet 如何路由和处理您的服务。

最终的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-wsdl</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>
   <build>
      <defaultGoal>install</defaultGoal>
      <pluginManagement>
         <plugins>
            <plugin>
               <artifactId>maven-war-plugin</artifactId>
               <version>3.2.2</version>
               <configuration>
                  <webXml>src/main/webapp/WEB-INF/web.xml</webXml>
                  <webResources>
                     <resource>
                        <directory>src/main/resources</directory>
                        <targetPath>WEB-INF</targetPath>
                        <includes>
                           <include>*.wsdl</include>
                        </includes>
                     </resource>
                  </webResources>
               </configuration>
            </plugin>
         </plugins>
      </pluginManagement>
      <plugins>
         <plugin>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-codegen-plugin</artifactId>
            <version>3.3.0</version>
            <executions>
               <execution>
                  <id>generate-sources</id>
                  <phase>generate-sources</phase>
                  <configuration>
                     <wsdlOptions>
                        <wsdlOption>
                           <wsdl>src/main/resources/Hello.wsdl</wsdl>
                           <faultSerialVersionUID>1</faultSerialVersionUID>
                        </wsdlOption>
                     </wsdlOptions>
                  </configuration>
                  <goals>
                     <goal>wsdl2java</goal>
                  </goals>
               </execution>
            </executions>
         </plugin>
      </plugins>
   </build>
   <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.helloworld.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.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-management</artifactId>
         <version>3.3.0</version>
      </dependency>
      
      <dependency>
         <groupId>org.apache.cxf</groupId>
         <artifactId>cxf-rt-features-metrics</artifactId>
         <version>3.3.0</version>
      </dependency>
      
      <dependency>
         <groupId>org.apache.cxf.xjc-utils</groupId>
         <artifactId>cxf-xjc-runtime</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.codehaus.mojo</groupId>
         <artifactId>exec-maven-plugin</artifactId>
         <version>1.6.0</version>
      </dependency>
      
      <dependency>
         <groupId>org.slf4j</groupId>
         <artifactId>slf4j-api</artifactId>
         <version>1.8.0-beta2</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

这将从您的 wsdl 生成适当的 Apache CXF 类，编译您的 Apache CXF 类，在嵌入式 jetty 服务器上部署服务器并运行您的应用程序。

您将在控制台上看到以下消息 -

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

和以前一样，您可以通过在浏览器中打开服务器 URL 来测试服务器。

打开服务器网址

由于我们没有指定任何操作，因此我们的应用程序仅向浏览器返回一条错误消息。现在，尝试将?wsdl添加到您的 URL，您将看到以下输出 -

WSDL 输出

所以我们的服务器应用程序正在按预期运行。您可以使用 SOAP 客户端（例如前面描述的Postman）来进一步测试您的服务。

本教程的下一部分是编写一个使用我们服务的客户端。

开发客户

在 CXF 应用程序中编写客户端与编写服务器一样重要。这是客户端的完整代码，基本上只包含三行，其余行只是将服务信息打印给用户。

//Client.java
package com.tutorialspoint.helloworld;
public class Client {
   public static void main(String[] args) throws Exception {
      //Create the service client with its default wsdlurl
      HelloWorldService helloServiceService = new HelloWorldService();
      System.out.println("service: " +
         helloServiceService.getServiceName());
      System.out.println("wsdl location: " +
         helloServiceService.getWSDLDocumentLocation());
      HelloWorldPortType helloService =
         helloServiceService.getHelloWorldPort();
      System.out.println(helloService.greetings
      (System.getProperty("user.name")));
   }
}

在这里，我们简单地创建服务HelloWorldService的一个实例，通过调用getHelloWorldPort方法获取其端口，然后将问候消息传递给它。运行客户端，您将看到以下输出 -

service: {http://helloworld.tutorialspoint.com/}HelloWorldService
wsdl location: file:/Users/drsarang/Desktop/tutorialpoint/cxf-
wsdl/src/main/resources/Hello.wsdl
hi drsarang

到目前为止，您已经了解了如何将 CXF 与 Apache CXF-First 和 WSDL-First 架构结合使用。在 Apache CXF-First 方法中，您使用 POJO 和CXF 库中的ServerFactoryBean类来创建服务器。要创建客户端，您使用了CXF 库中的ClientProxyFactoryBean类。在 WSDL-First 方法中，您使用Endpoint类在所需的 URL 和指定的实现者处发布服务。您现在可以扩展这些技术以集成不同的协议和传输。

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);
   }
}

请注意，我们使用