Apache cxf 学习笔记

学习笔记(仅供内部使用)

修订记录

目录

1CXF简介 (4)

1.1CXF概述 (4)

1.2CXF支持 (4)

1.2.1协议标准 (4)

1.2.2传输方式 (4)

1.3CXF特点 (5)

1.3.1灵活部署 (5)

1.3.2支持多种编程语言 (5)

1.3.3代码生成 (6)

1.4CXF环境要求 (6)

2实践讲解 (6)

2.1CXF 开发例子 (6)

2.1.1步骤图 (6)

2.1.2步骤详解 (8)

2.2CXF与Spring集成例子 (11)

2.2.1步骤图 (11)

2.2.2步骤详解 (13)

3附录 (16)

3.1cxf如何生成客户端 (16)

3.2cxf会用到的注解 (还未完善) (17)

导语：该文档主要讲解CXF的实践例子，包括纯CXF和Spring集成的两个例子。理论方面的知识还有待各位的完善。

1CXF简介

本章主要简介CXF的理论知识。

1.1CXF概述

CXF 是Celtix + Xfire的结合体，Apache CXF 的前身叫Apache CeltiXfire，现

在已经正式更名为Apache CXF 了。CXF 继承了Celtix 和XFire 两大开源

项目的精华，提供了对JAX-WS 全面的支持，并且提供了多种Binding 、

DataBinding、Transport 以及各种Format 的支持，并且可以根据实际项目的

需要，采用代码优先（Code First）或者WSDL 优先（WSDL First）来轻松地

实现Web Services 的发布和使用。Apache CXF已经是一个正式的Apache顶

级项目。

1.2CXF支持

1.2.1协议标准

CXF支持多种协议标准：JAX-WS、JAX-WSA、JSR-181 和SAAJ；支持SOAP

1.1、1.2、WS-I BasicProfile、WS-Security、WS-Addressing、WS-RM 和

WS-Policy；支持WSDL 1.1 、2.0；支持MTOM；

1.2.2传输方式

CXF支持多种协议传输方式：

Bindings：SOAP、REST/HTTP；

Data Bndings：目前支持JAXB 2.0、Aegis 两种，默认是JAXB 2.0。

XMLBeans、Castor 和JiBX 数据绑定方式将在CXF 2.1 版本中得到支持；

格式（Format）：XML、JSON；

传输方式：HTTP、Servlet、JMS 和Jabber；

可扩展API ：允许为CXF 增加其它的Bindings，以能够支持其它的消息格

式，比如：CSV 和固定记录长度。

1.3CXF特点

1.3.1灵活部署

轻量级容器：可在Tomcat 或基于Spring 的容器中部署Services；集成JBI：

可以在如ServiceMix, OpenESB or Petals 等等的JBI 容器中将它部署为一

个服务引擎；集成SCA：可以部署在如Tuscany 之类的SCA 容器中；集成

J2EE：可以在J2EE 应用服务器中部署Services，比如：Geronimo、JOnAS、

JBoss、WebSphere Application Server 和WebLogic Application Server，以

及Jetty 和Tomcat；独立的Java 客户端／服务器。

1.3.2支持多种编程语言

全面支持JAX-WS 2.0 客户端／服务器编程模型；支持JAX-WS 2.0

synchronous、asynchronous 和one-way API's；支持JAX-WS 2.0 Dynamic

Invocation Interface (DII) API；支持wrapped and non-wrapped 风格；支持

XML messaging API；支持JavaScript 和ECMAScript 4 XML (E4X) ，客户

端与服务端均支持；通过Yoko 支持CORBA；通过Tuscany 支持SCA；通

过ServiceMix 支持JBI ；

1.3.3代码生成

Java to WSDL；WSDL to Java；XSD to WSDL；WSDL to XML；WSDL to SOAP；

WSDL to Service；

1.4CXF环境要求

CXF 框架是一种基于Servlet 技术的SOA 应用开发框架，要正常运行CXF，

除了CXF 框架本身之外，还需要JDK 和Servlet 容器的支持。

2实践讲解

本章讲解使用CXF框架发布Web Services服务的两个例子。

2.1CXF 开发例子

讲解使用CXF框架发布Web Services的例子。

2.1.1步骤图

2.1.2步骤详解

下载CXF最新发布包

下载地址

https://www.360docs.net/doc/aa17359772.html,/download.html

创建一个Web工程

引入CXF jar包

把前面下载的CXF包解压，进入lib目录。把所有jar包拷贝到刚创建的Web工程

的lib目录。

配置CXFServlet

打开web.xml配置CXF的接入Servlet。

样例如下：

CXFServlet

org.apache.cxf.transport.servlet.CXFServlet

lass>

1

CXFServlet

/cxftest/*

编写待发布的接口

下面编写一个简单的登录接口。

样例如下：

import javax.jws.WebService;

@WebService

public interface Login {

String login(String name, String password);

}

编写接口的实现类

样例如下：

import javax.jws.WebService;

@WebService(endpointInterface = "com.test.service.cxf.Login", serviceName = "Login")

public class LoginImpl implements Login {

public String login(String name, String password) {

String result = "登录CXF 服务端成功!";

if (!"cxf".equalsIgnoreCase(name)

|| !"cxf".equalsIgnoreCase(password)) {

result = "用户名或密码不正确，请重新登录!";

}

return result;

}

}

编写发布服务类

样例如下：

import javax.servlet.ServletException;

import javax.servlet.http.HttpServlet;

import org.apache.cxf.jaxws.JaxWsServerFactoryBean;

public class InitServlet extends HttpServlet {

@Override

public void init() throws ServletException {

LoginImpl loginImpl = new LoginImpl();

JaxWsServerFactoryBean jwpFactory = new JaxWsServerFactoryBean();

jwpFactory.setAddress("/Login");

jwpFactory.setServiceClass(LoginImpl.class);

jwpFactory.setServiceBean(loginImpl);

jwpFactory.create();

}

}

配置启动发布服务类

前面我们把发布服务的类实现在一个Servlet里，所以把该类配置到web.xml里这

样启动工程时就会发布Web Services。

样例如下：

import javax.servlet.ServletException;

import javax.servlet.http.HttpServlet;

import org.apache.cxf.jaxws.JaxWsServerFactoryBean;

public class InitServlet extends HttpServlet {

@Override

public void init() throws ServletException {

LoginImpl loginImpl = new LoginImpl();

JaxWsServerFactoryBean jwpFactory = new JaxWsServerFactoryBean();

jwpFactory.setAddress("/Login");

jwpFactory.setServiceClass(LoginImpl.class);

jwpFactory.setServiceBean(loginImpl);

jwpFactory.create();

}

}

发布工程并启动

获取发布的WSDL

访问发布的工程再拼加上CXF监听路径。如：

http://localhost:8080/StudyCXF/cxftest/Login?wsdl

生成客户端代码

查看3.1 如何生成客户端代码。

然后把生成的客户端代码放到客户端工程。

提示：从生成的客户端代码中会有很多实际上我们用不到的源文件，可根据实际情况进行

清理，这里只需要Login.java。

编写客户端调用代码

客户端一般是其它的系统，这里只讲解客户端在调用服务端的代码编写。

样例如下：

import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;

public class CXFClient {

public static void main(String[] args) {

JaxWsProxyFactoryBean jwpFactory = new JaxWsProxyFactoryBean();

jwpFactory

.setAddress("http://localhost:8080/StudyCXF/cxftest/Login?wsdl");

jwpFactory.setServiceClass(Login.class);

Login login = (Login) jwpFactory.create();

String result = login.login("cxf", "cxf");

System.out.println("登录结果：" + result);

}

}

2.2CXF与Spring集成例子

讲解CXF与Spring集成发布Web Services的例子。

2.2.1步骤图

2.2.2步骤详解

下载CXF最新发布包

下载地址

https://www.360docs.net/doc/aa17359772.html,/download.html

创建一个Web工程

引入CXF jar包

把前面下载的CXF包解压，进入lib目录。把所有jar包拷贝到刚创建的Web工程

的lib目录。

配置web.xml

打开web.xml配置CXF的接入Servlet，和Spring的接入Listener。

样例如下：

contextConfigLocation

WEB-INF/conf/beans.xml

org.springframework.web.context.ContextLoaderListener

CXFServlet

org.apache.cxf.transport.servlet.CXFServlet

lass>

1

CXFServlet

/cxftest/*

提示：beans.xml是Spring的配置文件，请根据实际情况配置所在路径。后面配置服务端是

在该文件里配置。

编写待发布的接口

下面编写一个简单的订单接口。

样例如下：

import javax.jws.WebParam;

import javax.jws.WebService;

@WebService

public interface OrderProcess {

String processOrder(@WebParam(name = "Order") Order order);

}

提示：更多的注解描述请查看 3.2 见下方。

编写接口的实现类

样例如下：

import javax.jws.WebService;

@WebService(endpointInterface = "com.test.service.spring", serviceName = "OrderProcess")

public class OrderProcessImpl implements OrderProcess {

public String processOrder(Order order) {

String userName = order.getUserName();

return userName + " 您好：订单处理成功，生成的订单号是：88888888";

}

}

提示：更多的注解描述请查看 3.2 见下方。

配置服务端

编辑beans.xml文件，配置服务端接口类。

样例如下：

-->

class="com.test.service.spring.OrderProcessImpl">

提示：这里给出二种发布服务端接口的方式，随便哪一种都可以

发布工程并启动

获取发布的WSDL

访问发布的工程再拼加上CXF监听路径。如：

http://localhost:8080/StudyCXFSpring/cxftest/OrderProcess?wsdl

生成客户端代码

查看3.1 如何生成客户端代码。

然后把生成的客户端代码放到客户端工程。

客户端工程应该也是一个引入了CXF集成Spring包的工程，创建步骤同服务端工

程。

提示：从生成的客户端代码中会有很多实际上我们用不到的源文件，可根据实际情况进行

清理，这里只需要Order.java，OrderProcess.java

配置客户端

在客户端工程中找到Spring的配置文件并配置如下内容。

样例如下：

factory-bean="clientFactory" factory-method="create" />

class="org.apache.cxf.jaxws.JaxWsProxyFactoryBean">

value="com.test.service.spring.OrderProcess">

value="http://localhost:8080/StudyCXFSpring/cxftest/OrderProcess"

>

编写客户端调用代码

客户端一般是其它的系统，这里只讲解客户端在调用服务端的代码编写。

样例如下：

import org.springframework.context.support.FileSystemXmlApplicationContext;

public class CXFClient {

public static void main(String[] args) {

FileSystemXmlApplicationContext context = new

FileSystemXmlApplicationContext(

"WebRoot/WEB-INF/conf/client-bean.xml");

OrderProcess orderProcess = (OrderProcess)

context.getBean("client");

Order order = new Order();

order.setUserName("yihuajun");

String result = orderProcess.processOrder(order);

System.out.println(result);

}

}

3附录

3.1cxf如何生成客户端

dos命令下进入cxf解压目录的bin路径，输入如下命令：

wsdl2java -d src

-client http://localhost:8060/soa/services/otherTrackedVehicleSoapService?w

sdl

wsdl2java在cxf包中的bin路径下

另外里面的src为生成代码存放路径，src必须手动创建。

使用cxf wsdl2java或javax wsimport工具的时候，可能会遇到关于生成的

Response类文件名冲突的问题

WSDLToJava Error: Thrown by JAXB : A class/interface with the same name

"XXX**" is already in use. Use a class customization to resolve this conflict.

目前可选择的方案：

1.使用-autoNameResolution自动处理

wsdl2java -autoNameResolution

http://localhost:8060/soa/services/otherTrackedVehicleSoapService?wsdl

or

wsimport -p com.test.client

-keep http://localhost:8060/soa/services/otherTrackedVehicleSoapService?w

sdl-B-XautoNameResolution

3.2cxf会用到的注解 (还未完善)