Web服务是系统与系统之间通信的重要方式。本文将结合Apache CXF和Spring，详细讲解如何创建和配置Web服务，并给出具体的示例，帮助读者快速上手。
什么是Web服务？
Web服务是一种允许不同应用程序通过网络进行互操作的技术，特别是在不同的平台或编程语言之间。Web服务可以被远程客户端调用，提供了一种标准的方式来处理跨系统的数据交换。
Apache CXF框架
Apache CXF是一个强大且灵活的框架，旨在简化Web服务的创建和使用。它支持多种Web服务标准，包括SOAP和RESTful API，使得开发人员能够快速构建可重用的服务。
创建Web服务
1. 使用@WebService注解
要将某个类标记为Web服务接口，您需要使用@WebService注解。此注解标识该类可能被远程客户端调用。需要注意的是，@WebService注解需要在JDK 1.6及以上版本中使用。
import javax.jws.WebService;
@WebService
public interface UserService {
String getUserName(String userId);
}
2. 实现接口
接下来，您需要创建接口的实现类：
public class UserServiceImpl implements UserService {
@Override
public String getUserName(String userId) {
// 模拟获取用户的逻辑
return "UserName for " + userId;
}
}
3. 发布Web服务
现在，我们将使用JaxWsServerFactoryBean创建和发布Web服务。在main方法中，我们将执行以下步骤：
import org.apache.cxf.jaxws.JaxWsServerFactoryBean;
public class ServerDemo {
public static void main(String[] args) {
// 1. 创建工厂对象
JaxWsServerFactoryBean factory = new JaxWsServerFactoryBean();
// 2. 设置参数
// 2.1 设置访问地址（让客户端访问）
factory.setAddress("http://localhost:8888/userservice");
// 2.2 设置接口类型
factory.setServiceClass(UserService.class);
// 2.3 设置实现类对象
factory.setServiceBean(new UserServiceImpl());
// 3. 发布接口（阻塞方式）
factory.create();
System.out.println("Webservice服务程序发布成功…");
}
}
在这个示例中，我们完成了Web服务的发布。服务将侦听 http://localhost:8888/userservice 地址，客户端可以通过这个地址访问服务。
4. 开发客户端
在Web服务发布后，您需要开发客户端代码来调用这个服务。客户端的代码可能如下：
import javax.xml.namespace.QName;
import javax.xml.ws.Service;
import java.net.URL;
public class ClientDemo {
public static void main(String[] args) throws Exception {
// 定义服务的WSDL地址
URL url = new URL("http://localhost:8888/userservice?wsdl");
// 创建服务名称和服务
QName qname = new QName("http://impl.service.example.com/", "UserServiceImplService");
Service service = Service.create(url, qname);
// 获取远程接口的代理
UserService userService = service.getPort(UserService.class);
// 调用远程方法
String userName = userService.getUserName("123");
System.out.println("获取到的用户名称: " + userName);
}
}
在这个示例中，客户端使用指定的WSDL地址来查找服务，并获取代理对象，然后调用方法 getUserName。
5. Spring整合JAX-WS开发
为了更好地管理Web服务的生命周期，通常会将Web服务与Spring框架集成。接下来，我们将结合Spring Boot和Apache CXF来实现一个Web服务。
5.1 CxfConfig 类
下面是一个典型的Spring配置类 CxfConfig，它配置了Apache CXF Web服务：
package com.xxx.config;
import javax.xml.ws.Endpoint;
import org.apache.cxf.Bus;
import org.apache.cxf.bus.spring.SpringBus;
import org.apache.cxf.jaxws.EndpointImpl;
import org.apache.cxf.transport.servlet.CXFServlet;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.XXX.server.AddrServer;
import lombok.RequiredArgsConstructor;
@Configuration
@RequiredArgsConstructor
public class CxfConfig {
private final AddrServer addrServer;
@Bean
public ServletRegistrationBean
return new ServletRegistrationBean
}
@Bean(name = Bus.DEFAULT_BUS_ID)
public SpringBus springBus() {
return new SpringBus();
}
@Bean
public Endpoint endpoint() {
EndpointImpl endpoint = new EndpointImpl(springBus(), addrServer);
endpoint.publish("/addr");
return endpoint;
}
}
5.2 CxfConfig 类的详细解析
Servlet的注册：通过 cxfServlet 方法注册了CXF的Servlet。当浏览器或客户端访问 /webservice/* 时，CXFServlet将处理这些请求。
创建SpringBus：通过 springBus 方法创建并配置CXF的Bus。Bus 是CXF的核心，用于管理服务和请求。
发布Web服务：在 endpoint 方法中，我们创建并发布了一个Web服务端点。使用 addrServer 作为实现类，通过 endpoint.publish("/addr") 暴露服务。
6. 整体工作流程
结合上面的内容，我们可以总结出Web服务的整体工作流程：
定义接口：使用@WebService注解标识接口，定义需要提供的服务方法。
实现业务逻辑：创建实现类实现接口中的方法，编写具体的业务逻辑。
发布Web服务：通过 JaxWsServerFactoryBean 在特定地址上发布Web服务。
开发客户端：使用SOAP方式调用远程Web服务的方法，获取返回结果。
整合Spring：在Spring环境下配置Web服务，使得服务的管理更为简单高效。