网站备案:蜀ICP备2026035467号-3 | 网址:www.xservx.com

java创建webservice

全面解析Java平台下Web Service开发技术体系,涵盖Axis2、JAX-WS、CXF三大主流框架的完整实现流程,提供可运行代码示例与实战经验总结

立即了解

1. Web Service核心概念与技术体系

1.1 什么是Web Service?

Web Service是一种基于网络的、平台无关的、可编程的应用组件,它通过标准的XML格式和通用的网络协议(如HTTP、HTTPS)实现跨平台、跨语言的数据交互与服务调用。Java创建webservice技术是实现企业级系统集成的关键手段,广泛应用于ERP、CRM、支付网关、物联网平台等场景。

其核心特征包括:

  • 使用SOAP(Simple Object Access Protocol)作为消息协议,基于XML封装请求与响应数据
  • 通过WSDL(Web Services Description Language)描述服务接口,供客户端自动生成代理
  • 支持UDDI(Universal Description, Discovery and Integration)服务注册与发现(现代系统中多被RESTful API取代)
  • 具备松耦合特性:服务提供者与消费者仅依赖接口契约,无需共享实现细节

1.2 Java创建webservice主流技术栈对比

截至2024年,Java生态中构建Web Service主要有三大技术方案,各具特点:

框架 标准规范 适用场景 部署复杂度 社区支持
Axis2 JSR-101(过时) 传统SOAP系统迁移、遗留集成 中等(需配置axis2.xml) 较弱(Apache已停止维护)
JAX-WS RI(Metro) JSR-224(JAX-WS 2.3) 标准J2EE应用、Spring Boot集成 低(内置于Java EE 8) 中(Oracle维护)
Apache CXF JSR-224 + JSR-339(JAX-RS) 现代微服务、混合REST/SOAP架构 低(Spring Boot starter) 强(Apache顶级项目)

推荐实践:新项目优先选择CXF或JAX-WS;仅维护旧系统时使用Axis2;RESTful服务建议直接采用JAX-RS(如Jersey、Spring MVC)。

1.3 SOAP vs REST:何时选择Web Service?

尽管RESTful API已成为主流,但Java创建webservice(特指SOAP-based Web Service)在以下场景仍不可替代:

  • 需要WS-Security标准级安全控制(数字签名、加密、时间戳、SAML断言)
  • 要求WS-ReliableMessaging保证消息可靠传递(金融交易、订单处理)
  • 需支持WS-AtomicTransaction分布式事务(跨系统ACID操作)
  • 企业级ESB(企业服务总线)集成(如Mule、WSO2)
  • 遗留系统对接(如IBM mainframe、SAP R3)

典型行业应用:

  • 银行支付系统:SWIFT G1、银联跨境支付接口
  • 医疗信息交换:HL7 v2 over SOAP
  • 政府政务平台:国家企业信用信息公示系统对接
  • 航空订票系统:Amadeus、SITA SOAP服务

2. Axis2框架实现Java创建webservice详解

2.1 Axis2架构与核心组件

Axis2是Apache开源的Web Service引擎,采用模块化设计,包含以下关键模块:

  • Axis2 Core:消息处理引擎,实现SOAP消息解析/序列化
  • Axis2 Kernel:服务部署与生命周期管理
  • WS-Security:安全扩展模块
  • WSDL4J:WSDL文档解析与生成
  • AXIOM:异步XML对象模型(OM),内存效率高于DOM

部署方式支持:POJO(Plain Old Java Object)模式、AXIOM模式、DOM模式。

2.2 Axis2服务发布完整流程(POJO模式)

步骤1:创建Java服务类

package com.example.axis2;
public class UserService {
    public String getUserInfo(String userId) {
        if (userId == null || userId.isEmpty()) {
            throw new IllegalArgumentException("用户ID不能为空");
        }
        return "用户{" + userId + "}:张三,VIP会员";
    }
    public boolean updateUserProfile(String userId, String email) {
        if (userId == null || email == null) {
            return false;
        }
        System.out.println("更新用户[" + userId + "]邮箱:" + email);
        return true;
    }
}

步骤2:配置services.xml

在META-INF/services.xml中声明服务:

<service name="UserService" targetNamespace="http://axis2.example.com">
    <description>用户信息管理服务</description>
    <messageReceivers>
        <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-out"
                         class="org.apache.axis2.rpc.receivers.RPCMessageReceiver"/>
    </messageReceivers>
    <parameter name="ServiceClass">com.example.axis2.UserService</parameter>
</service>

步骤3:打包与部署

  • 将UserService.class与services.xml放入META-INF目录
  • 打包为UserService.aar(Axis Archive格式)
  • 部署至axis2/WEB-INF/services/目录
  • 重启Tomcat/Jetty容器

步骤4:验证服务

访问:http://localhost:8080/axis2/services/UserService?wsdl

将返回标准WSDL文档,包含getUserInfo和updateUserProfile两个操作。

2.3 Axis2客户端调用示例(Java)

使用Stub方式生成客户端代理:

import org.apache.axis2.client.ServiceClient;
import org.apache.axis2.context.ConfigurationContext;
import org.apache.axis2.context.ConfigurationContextFactory;
import org.apache.axis2.description.AxisOperation;
import org.apache.axis2.description.AxisService;
import org.apache.axis2.description.Parameter;
import org.apache.axis2.description.java2wsdl.Java2WS;
import org.apache.axis2.wsdl.WSDLConstants;
public class UserServiceClient {
    public static void main(String[] args) throws Exception {
        // 创建配置上下文
        ConfigurationContext ctx = ConfigurationContextFactory
            .createConfigurationContextFromFileSystem(null, null);
        // 创建服务客户端
        ServiceClient client = new ServiceClient(ctx, null);
        // 设置目标服务URL
        client.setTargetEPR("http://localhost:8080/axis2/services/UserService");
        // 构造SOAP请求(手动构建OMElement)
        OMElement payload = OMAbstractFactory.getOMFactory()
            .createOMElement("getUserInfo", "http://axis2.example.com");
        OMElement userId = OMAbstractFactory.getOMFactory()
            .createOMElement("userId", "http://axis2.example.com");
        userId.setText("U001");
        payload.addChild(userId);
        // 发送请求并接收响应
        OMElement response = client.sendReceive(payload);
        System.out.println("响应内容:" + response.toString());
    }
}

注意事项:

  • 需添加axis2-kernel-1.7.9.jar、axiom-api-1.2.22.jar等依赖
  • AXIOM使用延迟解析,内存占用低于DOM
  • 生产环境建议使用ServiceClient复用连接池

2.4 Axis2常见问题与解决方案

⚠️ 问题1:WSDL生成异常 - Missing namespace

症状:访问?wsdl返回空内容或报错java.lang.NullPointerException

原因:服务类缺少public修饰符,或方法签名含泛型/内部类

解决:

  1. 确保服务类为public class
  2. 方法参数使用基础类型或String、BigDecimal等可序列化类型
  3. 避免使用static、final方法

⚠️ 问题2:中文乱码

症状:返回XML中中文显示为?

解决:

  1. 在axis2.xml中设置:<parameter name="defaultEncoding">UTF-8</parameter>
  2. 服务方法返回前显式设置:response.setCharSetEncoding("UTF-8")
  3. 客户端请求头添加:Content-Type: text/xml; charset=UTF-8

3. JAX-WS标准实现:Java创建webservice的官方方案

3.1 JAX-WS核心注解解析

JAX-WS(Java API for XML Web Services)是Java EE标准规范,通过注解简化开发:

注解 用途 示例
@WebService 标记服务接口或实现类 @WebService(endpointInterface="com.example.UserService")
@WebMethod 暴露为Web服务的方法 @WebMethod(operationName="getUser")
@WebParam 自定义参数名(避免生成param1) String @WebParam(name="userId") id
@WebResult 自定义返回值名 @WebResult(name="userInfo") String result
@WebFault 定义服务异常映射 @WebFault(name="UserNotFoundException")

3.2 使用Metro(JAX-WS RI)发布服务

步骤1:定义服务接口

package com.example.jaxws;
import javax.jws.WebService;
import javax.jws.WebMethod;
import javax.jws.WebParam;
@WebService
public interface UserService {
    @WebMethod
    String getUserInfo(@WebParam(name = "userId") String userId);
    @WebMethod
    boolean updateUserProfile(
        @WebParam(name = "userId") String userId,
        @WebParam(name = "email") String email
    );
}

步骤2:实现服务类

package com.example.jaxws;
import javax.jws.WebService;
@WebService(endpointInterface = "com.example.jaxws.UserService")
public class UserServiceImpl implements UserService {
    @Override
    public String getUserInfo(String userId) {
        return "用户{" + userId + "}:李四,企业认证";
    }
    @Override
    public boolean updateUserProfile(String userId, String email) {
        // 真实业务逻辑:更新数据库
        System.out.println("更新用户[" + userId + "]邮箱:" + email);
        return true;
    }
}

步骤3:部署到Servlet容器

在web.xml中配置Metro Servlet:

<listener>
    <listener-class>com.sun.xml.ws.transport.http.servlet.WSServletContextListener</listener-class>
</listener>
<servlet>
    <servlet-name>UserServiceServlet</servlet-name>
    <servlet-class>com.sun.xml.ws.transport.http.servlet.WSServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>UserServiceServlet</servlet-name>
    <url-pattern>/userservice</url-pattern>
</servlet-mapping>

启动后访问:http://localhost:8080/app/userservice?wsdl

3.3 Spring Boot集成JAX-WS(推荐实践)

添加依赖(Maven):

<dependency>
    <groupId>javax.xml.ws</groupId>
    <artifactId>jaxws-api</artifactId>
    <version>2.3.1</version>
</dependency>
<dependency>
    <groupId>com.sun.xml.ws</groupId>
    <artifactId>jaxws-rt</artifactId>
    <version>2.3.6</version>
</dependency>

创建配置类:

@Configuration
public class JaxWsConfig {
    @Bean
    public ServletRegistrationBean<MessageDispatcherServlet> messageDispatcherServlet(
            ApplicationContext applicationContext) {
        MessageDispatcherServlet servlet = new MessageDispatcherServlet();
        servlet.setApplicationContext(applicationContext);
        servlet.setTransformWsdlLocations(true);
        return new ServletRegistrationBean<>(servlet, "/ws/*");
    }
    @Bean
    public WsdlDefinition userServiceWsdl() {
        SimpleWsdl11Definition wsdl = new SimpleWsdl11Definition();
        wsdl.setWsdl(new ClassPathResource("/wsdl/UserService.wsdl"));
        return wsdl;
    }
}

服务类自动扫描注册,无需额外配置。

3.4 客户端调用:wsimport工具自动生成

生成客户端代码:

wsimport -keep -p com.example.client \
  http://localhost:8080/app/userservice?wsdl

生成UserService、UserServiceService等代理类。

调用示例:

public class JaxWsClient {
    public static void main(String[] args) {
        UserServiceService service = new UserServiceService();
        UserService port = service.getUserServicePort();
        String info = port.getUserInfo("U002");
        System.out.println(info); // 输出:用户{U002}:李四,企业认证
    }
}

高级用法:动态客户端

import javax.xml.ws.BindingProvider;
import javax.xml.ws.Dispatch;
import javax.xml.ws.Service;
import javax.xml.transform.stream.StreamSource;
import java.net.URL;
public class DynamicClient {
    public static void main(String[] args) throws Exception {
        URL wsdlUrl = new URL("http://localhost:8080/app/userservice?wsdl");
        Service service = Service.create(wsdlUrl, new QName(
            "http://jaxws.example.com/", "UserServiceService"));
        Dispatch dispatch = service.createDispatch(
            new QName("http://jaxws.example.com/", "UserServicePort"),
            StreamSource.class, Service.Mode.PAYLOAD);
        String request = "<getUserInfo xmlns='http://jaxws.example.com/'>" +
                         "<userId>U002</userId>" +
                         "</getUserInfo>";
        StreamSource response = dispatch.invoke(new StreamSource(
            new StringReader(request)));
        System.out.println("响应:" + response.getInputStream());
    }
}

4. Apache CXF:现代Java创建webservice的最佳实践

4.1 CXF架构优势

Apache CXF是Apache顶级项目,融合了XFire和Celtix,具备以下优势:

  • 支持JAX-WS 2.2、JAX-RS 2.1、WS-*标准(WS-Security、WS-Policy)
  • 与Spring Boot无缝集成(cxf-spring-boot-starter-jaxws)
  • 支持REST/SOAP混合服务(同一接口同时暴露两种协议)
  • 内建拦截器机制(请求/响应日志、安全校验、性能监控)
  • 支持JSON、XML双协议

4.2 Spring Boot集成CXF示例

依赖配置(Maven):

<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-spring-boot-starter-jaxws</artifactId>
    <version>4.0.3</version>
</dependency>

服务接口定义:

@WebService
@SOAPBinding(style = SOAPBinding.Style.RPC)
public interface OrderService {
    @WebMethod
    String createOrder(@WebParam(name = "order") OrderDTO order);
    @WebMethod
    @WebResult(name = "status")
    String cancelOrder(@WebParam(name = "orderId") String orderId);
}

服务实现类:

@Component
@WebService(
    serviceName = "OrderService",
    endpointInterface = "com.example.cxf.OrderService",
    targetNamespace = "http://cxf.example.com/"
)
public class OrderServiceImpl implements OrderService {
    @Autowired
    private OrderDao orderDao;
    @Override
    public String createOrder(OrderDTO order) {
        String orderId = UUID.randomUUID().toString().substring(0, 8);
        order.setOrderId(orderId);
        orderDao.save(order);
        return "订单[" + orderId + "]创建成功";
    }
    @Override
    public String cancelOrder(String orderId) {
        if (orderDao.findById(orderId).isEmpty()) {
            throw new OrderNotFoundException("订单不存在:" + orderId);
        }
        orderDao.delete(orderId);
        return "订单[" + orderId + "]已取消";
    }
}

CXF配置类:

@Configuration
public class CxfConfig {
    @Autowired
    private Bus bus;
    @Bean
    public ServletRegistrationBean<CXFServlet> cxfServlet() {
        return new ServletRegistrationBean<>(new CXFServlet(), "/api/*");
    }
    @Bean
    public Endpoint orderServiceEndpoint() {
        EndpointImpl endpoint = new EndpointImpl(bus, new OrderServiceImpl());
        endpoint.publish("/orders");
        return endpoint;
    }
}

访问:http://localhost:8080/api/orders?wsdl

4.3 CXF拦截器实现安全控制

请求日志拦截器:

public class LoggingInInterceptor extends AbstractLoggingInterceptor {
    public LoggingInInterceptor() {
        super(Phase.RECEIVE);
    }
    @Override
    public void handleMessage(Message message) throws Fault {
        InputStream is = message.getContent(InputStream.class);
        if (is != null) {
            String request = IOUtils.readStringFromStream(is);
            System.out.println("收到请求:" + request);
            // 重置输入流
            message.setContent(InputStream.class,
                new ByteArrayInputStream(request.getBytes(StandardCharsets.UTF_8)));
        }
    }
}

安全校验拦截器:

public class SecurityInterceptor extends AbstractSoapInterceptor {
    public SecurityInterceptor() {
        super(Phase.PRE_INVOKE);
    }
    @Override
    public void handleMessage(SoapMessage message) throws Fault {
        List
headers = message.getHeaders(); for (Header header : headers) { if ("Security".equals(header.getName().getLocalPart())) { Element securityDoc = (Element) header.getObject(); // 解析WS-Security头 validateToken(securityDoc); return; } } throw new Fault(new RuntimeException("缺少安全凭证")); } }

注册拦截器:

@Bean
public Server cxfServer(EndpointImpl endpoint) {
    endpoint.getInInterceptors().add(new LoggingInInterceptor());
    endpoint.getInInterceptors().add(new SecurityInterceptor());
    return new ServerImpl(endpoint);
}

4.4 CXF客户端代理与动态调用

静态代理:

import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;
public class CxfClient {
    public static void main(String[] args) {
        JaxWsProxyFactoryBean factory = new JaxWsProxyFactoryBean();
        factory.setServiceClass(OrderService.class);
        factory.setAddress("http://localhost:8080/api/orders");
        OrderService service = (OrderService) factory.create();
        OrderDTO order = new OrderDTO();
        order.setUserId("U003");
        order.setAmount(199.0);
        String result = service.createOrder(order);
        System.out.println(result);
    }
}

动态客户端(无需生成代码):

import org.apache.cxf.endpoint.Client;
import org.apache.cxf.jaxws.endpoint.dynamic.JaxWsDynamicClientFactory;
public class DynamicClient {
    public static void main(String[] args) {
        JaxWsDynamicClientFactory dcf = JaxWsDynamicClientFactory.newInstance();
        Client client = dcf.createClient("http://localhost:8080/api/orders?wsdl");
        try {
            Object[] response = client.invoke("createOrder",
                new OrderDTO("U003", 199.0));
            System.out.println("响应:" + response[0]);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

5. Web Service安全机制深度解析

5.1 WS-Security标准协议栈

Web Service安全基于OASIS标准,核心组件包括:

  • WS-Security:定义安全令牌(UsernameToken、X.509、SAML)、加密、签名
  • WS-Policy:声明服务安全策略(如“必须加密”、“必须签名”)
  • WS-Trust:安全令牌服务(STS)与令牌颁发机制
  • WS-SecureConversation:会话安全上下文管理

典型安全场景:

  1. UsernameToken + 密码摘要:PasswordDigest防止明文传输
  2. X.509证书双向认证:客户端与服务端互验证书
  3. SAML断言:单点登录(SSO)集成

5.2 CXF实现UsernameToken安全

服务端配置:

@Bean
public WSS4JInInterceptor wss4jInInterceptor() {
    Map inProps = new HashMap<>();
    inProps.put(WSHandlerConstants.ACTION,
        WSHandlerConstants.USERNAME_TOKEN);
    inProps.put(WSHandlerConstants.PASSWORD_TYPE, "PasswordDigest");
    inProps.put(WSHandlerConstants.PW_CALLBACK_CLASS,
        CustomPasswordCallbackHandler.class.getName());
    return new WSS4JInInterceptor(inProps);
}

自定义密码校验:

public class CustomPasswordCallbackHandler implements CallbackHandler {
    @Override
    public void handle(Callback[] callbacks) throws IOException, UnsupportedCallbackException {
        for (Callback callback : callbacks) {
            if (callback instanceof WSPasswordCallback) {
                WSPasswordCallback pc = (WSPasswordCallback) callback;
                String username = pc.getIdentifier();
                // 从数据库查询用户密码
                String password = getUserPasswordFromDB(username);
                if (password == null) {
                    throw new SecurityException("用户不存在:" + username);
                }
                pc.setPassword(password);
            }
        }
    }
}

客户端添加凭证:

Map props = new HashMap<>();
props.put(WSHandlerConstants.ACTION, WSHandlerConstants.USERNAME_TOKEN);
props.put(WSHandlerConstants.USER, "admin");
props.put(WSHandlerConstants.PASSWORD_TYPE, "PasswordDigest");
props.put(WSHandlerConstants.PASSWORD_CALLBACK_CLASS,
    ClientPasswordCallback.class.getName());
Client client = ClientProxy.getClient(service);
client.getOutInterceptors().add(new WSS4JOutInterceptor(props));

5.3 HTTPS传输层安全

部署SSL证书后,服务地址改为:https://api.example.com/services/OrderService

客户端信任库配置:

System.setProperty("javax.net.ssl.trustStore", "/path/to/client.truststore");
System.setProperty("javax.net.ssl.trustStorePassword", "changeit");
// CXF客户端配置
HTTPConduit conduit = (HTTPConduit) client.getConduit();
TLSClientParameters tlsParams = new TLSClientParameters();
tlsParams.setTrustManagers(new TrustManager[]{new X509TrustManager() {...}});
conduit.setTlsClientParameters(tlsParams);

6. WSDL深度解析与生成工具

6.1 WSDL核心元素结构

标准WSDL文档包含以下关键部分:

元素 作用 示例
<types> 数据类型定义(XSD Schema) <xs:schema targetNamespace="...">
<message> 定义操作的输入/输出消息结构 <message name="getUserInfoRequest">
<portType> 服务操作接口定义 <operation name="getUserInfo">
<binding> 绑定协议与编码方式 <soap:binding style="document" transport="http://...">
<service> 服务端点地址 <port name="UserServicePort" binding="..."><soap:address location="..."/>

6.2 生成WSDL的三种方式

方式1:从Java代码生成(JAX-WS wsimport反向)

java2ws -cp . com.example.UserService -wsdl -o UserService.wsdl

方式2:从WSDL生成Java代码(推荐)

wsimport -keep -p com.example.client http://localhost:8080/service?wsdl

方式3:手动编写WSDL(仅用于特殊场景)

  • 需严格遵循W3C WSDL 2.0规范
  • 使用XML Schema定义复杂类型
  • 注意soap:binding的style(document/rpc)与use(literal/encoded)

6.3 WSDL优化技巧

  • 禁用WSDL缓存:添加?ns=false&wsdl参数避免旧缓存
  • 压缩WSDL:移除注释与空格,减少传输体积
  • 外部化XSD:将<types>拆分为独立XSD文件,便于复用
  • 添加文档说明:使用<documentation>标签描述服务用途

7. java创建webservice常见问题解答

Q1:为什么服务调用返回404?

A:检查以下几点:

  • 服务URL路径是否正确(注意上下文路径)
  • Servlet映射是否覆盖/*(应避免)
  • 服务类是否被Spring扫描到(@Component)
  • 端口是否被防火墙拦截

Q2:中文参数乱码如何解决?

A:统一设置编码:

  • Tomcat:server.xml添加URIEncoding="UTF-8"
  • CXF:Bus bus = BusFactory.newInstance().createBus(); bus.getInInterceptors().add(new EncodingInterceptor("UTF-8"));
  • 客户端请求头:Content-Type: text/xml; charset=UTF-8

Q3:如何调试SOAP消息?

A:使用以下工具:

  • tcpmon(Apache TCP Monitor):拦截并显示原始SOAP消息
  • 浏览器插件:RESTED或SoapUI
  • CXF拦截器:LoggingInInterceptor + LoggingOutInterceptor

Q4:服务性能瓶颈如何优化?

A:关键优化点:

  • 启用HTTP压缩(GZIP)
  • 使用AXIOM流式解析而非DOM
  • 连接池复用(CXF默认支持)
  • 避免在WSDL中嵌入大量XSD
  • 禁用不必要的安全策略(开发环境)