Apache CXF 是一个功能强大的开源框架,用于构建和开发 Web 服务,它支持多种 Web 服务标准,如 SOAP、WS-*、RESTful HTTP 服务等,并提供了丰富的扩展功能,使其成为企业级应用开发的理想选择,本文将详细介绍 Apache CXF 的核心概念、环境搭建、服务端与客户端开发,以及常用配置和最佳实践。

Apache CXF 简介
Apache CXF 的前身是 Celtix 和 XFire,两者合并后形成了现在的 CXF,它旨在提供一个灵活、高性能且易于集成的 Web 服务框架,CXF 的核心架构基于 Spring,支持通过 Spring 配置文件来管理组件和依赖,同时也支持非 Spring 环境下的独立使用,其主要特点包括:
- 多协议支持:支持 SOAP 1.1、SOAP 1.2、XML/HTTP、RESTful HTTP、CORBA 等。
- 多种数据绑定:支持 JAXB、Aegis、XMLBeans 等数据绑定技术,简化 XML 与 Java 对象的转换。
- 丰富的扩展性:提供拦截器、特性(Features)、绑定(Bindings)等机制,便于功能扩展。
- 集成 Spring:与 Spring 框架无缝集成,支持依赖注入和 AOP。
- 工具支持:提供 wsdl2java 和 java2wsdl 等工具,用于生成客户端和服务端代码。
环境搭建
在使用 Apache CXF 之前,需要完成环境准备工作,以下是基本步骤:
- 安装 JDK:确保已安装 JDK 1.7 或更高版本,并配置好环境变量
JAVA_HOME。 - 下载 Apache CXF:从 Apache 官网(https://cxf.apache.org/)下载最新版本的 CXF 压缩包,并解压到指定目录。
- 配置环境变量:将 CXF 的
bin目录添加到系统的PATH变量中,以便直接使用 CXF 提供的工具。
以下是 CXF 依赖的核心库(以 3.4.0 版本为例):
| 依赖库 | 说明 |
|---|---|
| cxf-core | CXF 核心库 |
| cxf-rt-frontend-jaxws | JAX-WS 前端实现 |
| cxf-rt-transports-http | HTTP 传输协议 |
| cxf-rt-transports-http-jetty | Jetty 服务器(用于测试) |
通过 Maven 引入依赖的示例代码如下:

<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-core</artifactId>
<version>3.4.0</version>
</dependency>
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-frontend-jaxws</artifactId>
<version>3.4.0</version>
</dependency>
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-transports-http</artifactId>
<version>3.4.0</version>
</dependency>服务端开发
服务端开发是 CXF 应用的核心部分,以下是基于 JAX-WS 的服务端开发步骤:
- 定义服务接口:使用 JAX-WS 注解定义 Web 服务的接口。
import javax.jws.WebService;
import javax.jws.WebMethod;
@WebService
public interface UserService {
@WebMethod
String sayHello(String name);
}- 实现服务接口:编写接口的实现类。
import javax.jws.WebService;
@WebService(endpointInterface = "com.example.UserService")
public class UserServiceImpl implements UserService {
@Override
public String sayHello(String name) {
return "Hello, " + name + "!";
}
}- 发布服务:通过 CXF 的
JaxWsServerFactoryBean或 Spring 配置发布服务。
以下是使用 JaxWsServerFactoryBean 发布服务的代码:
import org.apache.cxf.jaxws.JaxWsServerFactoryBean;
public class ServerMain {
public static void main(String[] args) {
JaxWsServerFactoryBean factory = new JaxWsServerFactoryBean();
factory.setServiceClass(UserService.class);
factory.setAddress("http://localhost:8080/userService");
factory.create();
System.out.println("Service published at http://localhost:8080/userService");
}
}客户端开发
CXF 提供了多种方式调用 Web 服务,以下是基于 JAX-WS 的客户端开发步骤:
- 使用
JaxWsProxyFactoryBean创建客户端:通过动态代理生成客户端代码。
import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;
public class ClientMain {
public static void main(String[] args) {
JaxWsProxyFactoryBean factory = new JaxWsProxyFactoryBean();
factory.setServiceClass(UserService.class);
factory.setAddress("http://localhost:8080/userService");
UserService userService = factory.create(UserService.class);
String response = userService.sayHello("CXF");
System.out.println(response);
}
}- 使用
wsdl2java工具生成客户端代码:如果已有 WSDL 文件,可以使用 CXF 提供的wsdl2java工具生成客户端代码。
wsdl2java -p com.example.client -d src/main/java http://localhost:8080/userService?wsdl
生成的客户端代码可以直接调用服务方法。

常用配置与最佳实践
- 配置拦截器:CXF 的拦截器机制可以对请求和响应进行处理,添加日志拦截器:
factory.getInInterceptors().add(new LoggingInInterceptor()); factory.getOutInterceptors().add(new LoggingOutInterceptor());
- 使用 Spring 配置:通过 Spring 配置文件管理 CXF 服务,实现依赖注入和生命周期管理。
<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">
<jaxws:endpoint id="userService"
implementor="com.example.UserServiceImpl"
address="/userService"/>
</beans>性能优化:合理使用 CXF 的线程池、缓存机制,以及减少不必要的拦截器,可以提高服务性能。
安全性配置:通过 WS-Security 等标准实现服务的身份验证和数据加密,确保服务安全。
Apache CXF 作为一个成熟的 Web 服务框架,提供了丰富的功能和灵活的配置选项,能够满足企业级应用的需求,通过本文的介绍,读者可以快速上手 CXF 的开发,包括服务端和客户端的实现,以及常用的配置技巧,在实际开发中,建议结合 Spring 框架和 CXF 的扩展功能,构建高效、可维护的 Web 服务系统。
图片来源于AI模型,如侵权请联系管理员。作者:酷小编,如若转载,请注明出处:https://www.kufanyun.com/ask/39106.html
