Apache CXF 快速使用
Apache CXF 是一个开源的 Web Services 框架。如果需要轻松实现 Web Services 的发布和使用,可以将其作为其中一种解决方案。本文主要记录了作者本人在一个Java Web项目中使用CXF的历程。
目录
文章目录
1. 引入CXF依赖包
由于项目采用Maven作为项目管理工具,所以在项目的pom.xml文件中加入以下内容,引入相关依赖包
<!-- cxf版本号 -->
<cxf.version>3.2.4</cxf.version>
<!-- cxf start -->
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-frontend-jaxws</artifactId>
<version>${cxf.version}</version>
</dependency>
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-transports-http</artifactId>
<version>${cxf.version}</version>
</dependency>
<!-- Jetty is needed if you're are not using the CXFServlet -->
<!-- <dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-transports-http-jetty</artifactId>
<version>${cxf.version}</version>
</dependency> -->
<!-- cxf end -->
2. 创建 Web Service 服务接口类
代表对外提供的、暴露的服务
package webservice;
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebService;
/**
* Demo演示Web Service接口
*/
@WebService
public interface DemoWebService {
/**
* 计算两个整数的和
* @param a
* @param b
* @return
*/
@WebMethod(operationName="add")
int add(@WebParam(name="firstArg") int a, @WebParam(name="secondArg") int b);
/**
*
* @param name
* @return
*/
String sayHello(String name);
}
3. Web Service 服务接口相应实现类
代表服务的真正实现,即真正去干活的对象
package webservice.impl;
import webservice.DemoWebService;
/**
* Demo演示Web Service接口的实现类
*/
public class DemoWebServiceImpl implements DemoWebService {
@Override
public int add(int a, int b) {
int result = a + b;
System.out.println(a + " 与 " + b + " 的和为:" + result);
return result;
}
@Override
public String sayHello(String name) {
System.out.println("sayHello....");
return "Hello! " + name;
}
}
4. 与Spring整合
与Axis2(另一款 Web Service 框架)相比,CXF对Spring的支持比较友好。这里创建一个名为spring-cxf.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:jaxws="http://cxf.apache.org/jaxws"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://cxf.apache.org/jaxws
http://cxf.apache.org/schemas/jaxws.xsd">
<!-- 发布服务 -->
<bean id="demoWebService" class="com.talent.aire.webservice.impl.DemoWebServiceImpl"></bean>
<jaxws:server address="/demoWebService" serviceClass="webservice.DemoWebService" >
<jaxws:serviceBean>
<ref bean="demoWebService"/>
</jaxws:serviceBean>
</jaxws:server>
</beans>
将spring-cxf.xml文件import到项目的Spring总配置文件spring.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:p="http://www.springframework.org/schema/p"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd ">
<!-- CXF -->
<import resource="spring-cxf.xml"/>
</beans>
5. 与Web应用整合
不管要与谁(如Spring、Web应用等)进行整合,都得通过一种方式使两者能够互动。而与Web应用整合时,一般会通过配置Web应用的web.xml文件进行。如下所示,在web.xml 文件中添加相关配置,通过Servlet 容器进行服务暴露,完成整合
<!-- Apache CXF Web Service 配置拦截 -->
<servlet>
<servlet-name>CXFServlet</servlet-name>
<servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>CXFServlet</servlet-name>
<url-pattern>/webservice/*</url-pattern>
</servlet-mapping>
6. 发布服务
通过应用服务器Tomcat,启动相应Java Web项目。启动后,使用浏览器访问WSDL地址(http://localhost:8080/demo/webservice/demoWebService?wsdl),如出现下图所示的访问,表明相关服务已经发布成功
7. 使用(消费)服务
有(服务的)生产者,就得有(服务的)消费者,不然生产出来没多大意义。服务发布成功后,可以编写简单客户端进行测试,测试服务能否正常使用(消费)。下面的示例代码只是使用服务的其中一种方式。实质上,Web Service 服务由于基于HTTP协议,所以其可以做到跟平台、跟编程语言无关。
package test;
import org.apache.cxf.endpoint.Client;
import org.apache.cxf.jaxws.endpoint.dynamic.JaxWsDynamicClientFactory;
/**
* 创建一个WebService客户端,测试WebService服务端的可用性
*/
public class WebServiceTest {
public static void main(String[] args) {
// CXF动态客户端工厂
JaxWsDynamicClientFactory dcf = JaxWsDynamicClientFactory.newInstance();
// WSDL文档url配置()
String wsdlUrl = "http://localhost:8080/demo/webservice/demoWebService?wsdl";
Object[] objects = null;
try {
// 获取CXF客户端
Client client = dcf.createClient(wsdlUrl);
// 调用Web Service方法
objects = client.invoke("add", 1, 2);
} catch (Exception e) {
e.printStackTrace();
}
// 获取调用结果
System.out.println("调用结果:" + objects[0]);
System.out.println("=========>");
try {
// 获取CXF客户端
Client client = dcf.createClient(wsdlUrl);
// 调用Web Service方法
objects = client.invoke("sayHello", "World!");
} catch (Exception e) {
e.printStackTrace();
}
// 获取调用结果
System.out.println("调用结果:" + objects[0]);
}
}
客户端测试运行结果: