百度360必应搜狗淘宝本站头条
docker systemdzabbix微信报警脚本loadjsqt5.5pagination.js
当前位置：网站首页 > 技术教程 > 正文

Spring整合CXF 发布webservice接口服务器和客户端，WSDL简单解析

suiw9 2025-03-14 20:31 12 浏览 0 评论

在垮平台通讯中有很多的接口方式，这里做个简单的webservice接口。发布webservice接口的方式也多种多样，这里做个基于CXF的webservice接口。首先做点知识储备，javax.jws包中常用的注解，参考链接：
http://blog.csdn.net/w410589502/article/details/51742004

下面开始，这里Spring用的4.2的，CXF用的3.2的，JDK是1.8的，这里只要是1.6及以后的就没问题了，主要是要用javax.jws的包

服务端webservice接口

package com.lovo.webservice;

import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import javax.jws.soap.SOAPBinding;
import javax.jws.soap.SOAPBinding.Style;

/**
 * SOAP协议的webservice接口
 * @author WZH
 *服务器端，服务提供者
 */

/*
 * @WebService 标记为一个webservice接口
 * 1.targetNamespace：指定你想要的名称空间，默认认是使用接口实现类的包名的反缀，
 * 但是在实际测试中发现cxf+spring编写webservice的时候，targetNamespace要指向
 * 服务类的接口所在的包名而不是实现类的包名，否则，在客户端将不能识别可用的服务
 * 2.serviceName： 对外发布的服务名，指定 Web Service 的服务名称：wsdl:service。
 * 缺省值为 Java 类的简单名称 + Service。（字符串）
 * 3.portName：  wsdl:portName。缺省值为 WebService.name+Port。
 * 
 * @SOAPBinding 消息绑定， 这个标记怎么说，我这里测试的时候加不加都无所谓，但是有同仁说过
 * 不加这个有时候会出现客户端无法识别，有的人又报错，所以还是加上吧
 * Exception in thread "main" com.sun.xml.internal.ws.model.RuntimeModelerException: 
 * runtime modeler error: Wrapper class org.soap.service.jaxws.Add is not found. Have you run APT to generate them?
 */
@WebService(targetNamespace ="http://webservice.lovo.com/",serviceName="HelloService",portName="HellowServicePort")
@SOAPBinding(style=Style.RPC)
public interface IHelloService {
    
    /*
     * @WebResult 注释用于定制从返回值至 WSDL 部件或 XML 元素的映射。将此注释应用于客户机或服务器服务端点接口（SEI）上的方法，
     * 或者应用于 JavaBeans 端点的服务器端点实现类
     * 1.name：当返回值列示在 WSDL 文件中并且在连接上的消息中找到该返回值时，指定该返回值的名称。对于 RPC 绑定，这是用于表示返回值的
     * 2.targetNamespace：指定返回值的 XML 名称空间。仅当操作类型为 RPC 或者操作是文档类型并且参数类型为 BARE 时才使用此参数。（字符串）
     * 
     * @WebMethod 注释表示作为一项 Web Service 操作的方法，将此注释应用于客户机或服务器服务端点接口（SEI）上的方法，
     * 或者应用于 JavaBeans 端点的服务器端点实现类。
     * 1.operationName：指定与此方法相匹配的wsdl:operation 的名称。缺省值为 Java 方法的名称。（字符串）
     * 
     * @WebParam 注释用于定制从单个参数至 Web Service 消息部件和 XML 元素的映射
     * 1.name ：参数的名称。如果操作是远程过程调用（RPC）类型并且未指定partName 属性，
     * 那么这是用于表示参数的 wsdl:part 属性的名称。如果操作是文档类型或者参数映射至某个头，那么 -name 是用于表示该参数的 XML 元素的局部名称。
     * 如果操作是文档类型、参数类型为 BARE 并且方式为 OUT 或 INOUT，那么必须指定此属性。（字符串）
     */
    
    @WebResult(name="helloRequest",targetNamespace="http://webservice.lovo.com/")
    @WebMethod(operationName="sayHello1")
    public String hello(@WebParam(name="msg")String message);
}

服务端接口实现类

package com.lovo.webservice.impl;

import javax.jws.WebService;
import javax.jws.soap.SOAPBinding;
import javax.jws.soap.SOAPBinding.Style;

import org.springframework.stereotype.Service;

import com.lovo.webservice.IHelloService;

/*
 * endpointInterface： 服务接口全路径, 指定做SEI（Service EndPoint Interface）服务端点接口,简单的说就写接口的全路径
 */
@WebService(endpointInterface="com.lovo.webservice.IHelloService")
@SOAPBinding(style=Style.RPC)
public class HelloServiceImpl implements IHelloService {

    @Override
    public String hello(String message) {
        
        return "你好" + message;
    }

}

前面的两段代码只是简单的java加上一些注解，下面把代码整合入Spring的web工程
web.xml 配置
需在web.xml中配置CXF

 
  
    cxf
    org.apache.cxf.transport.servlet.CXFServlet
    1
  
  
  
    cxf
    /webservice/*

完整的xml文件：



  Spring
  
    
    webAppRootKey
    Spring.root
  



  
    contextConfigLocation
    /WEB-INF/classes/applicationContext.xml
  
    
 
    log4jConfigLocation
    /WEB-INF/log4j.xml
  
  
  
  
    log4jRefreshInterval
    60000
    
    
       
    org.springframework.web.util.Log4jConfigListener


    org.springframework.web.context.ContextLoaderListener
  


  
    index.jsp  
  



  
    characterEncodingFilter  
    org.springframework.web.filter.CharacterEncodingFilter  
      
        encoding  
        UTF-8  
      
      
        forceEncoding  
        true  
      
  
  
    characterEncodingFilter  
    /*  




 
  
    cxf
    org.apache.cxf.transport.servlet.CXFServlet
    1
  
  
  
    cxf
    /webservice/*
  
  
  

    Spring
    org.springframework.web.servlet.DispatcherServlet
  
  
    Spring
    /

配置cxf的配置文件，这个也可以直接配置在Spring的配置文件中，看项目风格吧




    
    <import resource="classpath:META-INF/cxf/cxf.xml" />

在application.xml中引入cxf.xml


<import resource="classpath:META-INF/cxf/cxf.xml"/>
<import resource="classpath:/cxf-beans.xml"/>

完整的application.xml




    
    
    
    


    
    
        
        
        
        
        
        
        
        
        
        
        
    

    
    
        
        
        
    

    
    
        
        
    

    
    
        
    


    

    
    
        
            
            
            
            

            
            
            

            
            
            
            

            
            
            


        
    

    
        
        
    



    
    

    
    <import resource="classpath:META-INF/cxf/cxf.xml"/>
    <import resource="classpath:/cxf-beans.xml"/>

下面来测试下发布是否成功，我这里是tomcat 工程名是Spring,拦截的是webservice，所以访问的地址是：
http://localhost:8080/Spring/webservice?wsdl

出现界面

右键连接地址可以下载wsdl

这样就发布了一个简单的webservice接口，下面在发布一个接口以便wsdl的时候做对比，然后再发布一个rest风格的接口

package com.lovo.webservice;

import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import javax.jws.soap.SOAPBinding;
import javax.jws.soap.SOAPBinding.Style;

/**
 * SOAP协议的webservice接口
 * @author WZH
 *服务器端，服务提供者
 */

/*
 * @WebService 标记为一个webservice接口
 * 1.targetNamespace：指定你想要的名称空间，默认认是使用接口实现类的包名的反缀，
 * 但是在实际测试中发现cxf+spring编写webservice的时候，targetNamespace要指向
 * 服务类的接口所在的包名而不是实现类的包名，否则，在客户端将不能识别可用的服务
 * 2.serviceName： 对外发布的服务名，指定 Web Service 的服务名称：wsdl:service。
 * 缺省值为 Java 类的简单名称 + Service。（字符串）
 * 3.portName：  wsdl:portName。缺省值为 WebService.name+Port。
 * 
 * @SOAPBinding 消息绑定， 这个标记怎么说，我这里测试的时候加不加都无所谓，但是有同仁说过
 * 不加这个有时候会出现客户端无法识别，有的人又报错，所以还是加上吧
 * Exception in thread "main" com.sun.xml.internal.ws.model.RuntimeModelerException: 
 * runtime modeler error: Wrapper class org.soap.service.jaxws.Add is not found. Have you run APT to generate them?
 */
@WebService(targetNamespace ="http://webservice.lovo.com/",serviceName="HelloService",portName="HellowServicePort")
@SOAPBinding(style=Style.RPC)
public interface IHelloService {
    
    /*
     * @WebResult 注释用于定制从返回值至 WSDL 部件或 XML 元素的映射。将此注释应用于客户机或服务器服务端点接口（SEI）上的方法，
     * 或者应用于 JavaBeans 端点的服务器端点实现类
     * 1.name：当返回值列示在 WSDL 文件中并且在连接上的消息中找到该返回值时，指定该返回值的名称。对于 RPC 绑定，这是用于表示返回值的
     * 2.targetNamespace：指定返回值的 XML 名称空间。仅当操作类型为 RPC 或者操作是文档类型并且参数类型为 BARE 时才使用此参数。（字符串）
     * 
     * @WebMethod 注释表示作为一项 Web Service 操作的方法，将此注释应用于客户机或服务器服务端点接口（SEI）上的方法，
     * 或者应用于 JavaBeans 端点的服务器端点实现类。
     * 1.operationName：指定与此方法相匹配的wsdl:operation 的名称。缺省值为 Java 方法的名称。（字符串）
     * 
     * @WebParam 注释用于定制从单个参数至 Web Service 消息部件和 XML 元素的映射
     * 1.name ：参数的名称。如果操作是远程过程调用（RPC）类型并且未指定partName 属性，
     * 那么这是用于表示参数的 wsdl:part 属性的名称。如果操作是文档类型或者参数映射至某个头，那么 -name 是用于表示该参数的 XML 元素的局部名称。
     * 如果操作是文档类型、参数类型为 BARE 并且方式为 OUT 或 INOUT，那么必须指定此属性。（字符串）
     */
    
    @WebResult(name="helloRequest",targetNamespace="http://webservice.lovo.com/")
    @WebMethod(operationName="sayHello1")
    public String hello(@WebParam(name="msg")String message);
    
    @WebResult(name="loginRequest",targetNamespace="http://webservice.lovo.com/")
    @WebMethod(operationName="login")
    public String login(@WebParam(name="userName")String userName,@WebParam(name="password")String password);
}

这里需要特别注意，targetNamespace中路径结尾需写反斜杠/不然会出现问题

package com.lovo.webservice.impl;

import javax.jws.WebService;
import javax.jws.soap.SOAPBinding;
import javax.jws.soap.SOAPBinding.Style;

import org.springframework.stereotype.Service;

import com.lovo.webservice.IHelloService;

/*
 * endpointInterface： 服务接口全路径, 指定做SEI（Service EndPoint Interface）服务端点接口,简单的说就写接口的全路径
 */
@WebService(endpointInterface="com.lovo.webservice.IHelloService")
@SOAPBinding(style=Style.RPC)
public class HelloServiceImpl implements IHelloService {

    @Override
    public String hello(String message) {
        
        return "你好" + message;
    }

    @Override
    public String login(String userName, String password) {
        String req = null;
        //这里做个假的登录验证
        if("小明".equals(userName)&&"123456".equals(password))
        {
            req = "登录成功";
        }else
        {
            req = "登录失败";
        }
        return req;
    }

}

这个时候再访问wsdl的网址就看见有两个方法了

下载wsdl

阅读wsdl的方法详细的阅读方式方式可以看这篇文章：
http://blog.csdn.net/liuchunming033/article/details/41210151

拿到一个wsdl，个人一般是先看最后，也就是wsdl:service部分。wsdl:service：存放接口名和接口地址

然后再看binding部分，也就是wsdl:binding
wsdl:binding：每个端口定义消息格式和协议细节

再看portType部分，wsdl:portType
wsdl:portType：描述webservice可被执行的操作，以及相关的消息，通过binding指向portType

在看message，wsdl:message
wsdl:message：定义一个操作（方法）的数据参数（可有多个参数）

最后还是需要看看开始部分

这么一个简单的xml就解析完了
完整的xml文档

wsdl阅读完成了，需要的参数都明白了，下面就可以做个简单的客户端进行调用，webService客户端调用的方法有很多，我们这里简单的做几个。
一：Service编程方式
特点：可以自定义关键元素，方便以后维护，是一种标准的开发方式
首先写一个客户端调用对象

package com.lovo.client;

import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import javax.jws.soap.SOAPBinding;
import javax.jws.soap.SOAPBinding.Style;

/**
 * 客户端调用者，根据wsdl初始化接口对象
 * @author WZH
 *
 *targetNamespace 对应wsdl抬头 targetNamespace，serviceName和portName分别对应wsdl结尾的wsdl:service name="HelloService"
 *和wsdl:port binding="tns:HelloServiceSoapBinding" name="HellowServicePort">
 *因为wsdl文档中有指定SOAP类型,所以需书写类型 
 */
@WebService(targetNamespace="http://webservice.lovo.com/",serviceName="HelloService",portName="HellowServicePort")
@SOAPBinding(style=Style.RPC)
public interface HellowService {
    /**
     * 方法名对应wsdl wsdl:operation name="login"
     * @param username 参数名对应 wsdl:part name="userName" type="xsd:string"
     * @param password
     * @return
     * 
     * 方法名映射 
     *  地址映射
     * 参数映射： 
     */
    @WebResult(name="login",targetNamespace="http://webservice.lovo.com/")
    @WebMethod(operationName = "login")
    public String login(@WebParam(name = "userName")String username , @WebParam(name = "password")String password);
    
    @WebResult(name="helloRequest",targetNamespace="http://webservice.lovo.com/")
    @WebMethod(operationName="sayHello1")
    public String hello(@WebParam(name="msg")String msg);
    
}

这里需要特别注意，targetNamespace中路径结尾需写反斜杠/不然会出现问题

准备工作做好了，可以做个客户端的调用了

package com.lovo.client;

import java.net.URL;

import javax.xml.namespace.QName;
import javax.xml.ws.Service;
import javax.xml.ws.soap.SOAPBinding;

public class wsClient {
    
    /**
     * XML 类 第一个参数表示地址，第二个参数表示端口名
     * 这里第一个参数是wsdl 表头targetNamespace
     * 第二个参数是service name
     */
    private static final QName SERVICE_NAME =  new QName("http://webservice.lovo.com/", "HelloService");
    private static final QName PORT_NAME = new QName("http://webservice.lovo.com/", "HellowServicePort");
    
    //编程方式一 begin -----------------------
    public static void testSayHello()
    {
        try {
            //创建Serivce业务类
            Service service = Service.create(SERVICE_NAME);
            //连接地址  
            String endPointAddress = "http://localhost:8080/Spring/webservice/HelloService";
            //配置业务访问参数 portName, bindingId, endpointAddress,
            //这里因为是SOPA11的所有配置11，SOAP现在有11和12两种 可通过xmlns:ns1="http://schemas.xmlsoap.org/soap/http" 判断
            service.addPort(PORT_NAME, SOAPBinding.SOAP11HTTP_BINDING, endPointAddress);
            
            //把本地客户端的接口与网络上的WSDL连接起来
            HellowService hs = service.getPort(HellowService.class);
            System.out.println(hs.hello("小明"));
        } catch (Exception e) {
            e.printStackTrace();
        }
        
    }
    
    //end-------------------------------------
    
    
    //编程方式二 begin  不知道为什么 Service.create报错，可能是jar原因-----------------------
    public static void testSayHello2()
    {
        try 
        {
            //创建WSDL的URL，注意不是服务地址  
            URL url = new URL("http://localhost:8080/Spring/webservice?wsdl");
            //创建服务名，代码有写成了静态常量，这里直接引用
            
            //创建服务视图
            javax.xml.ws.Service service = Service.create(url, SERVICE_NAME);
            //获取服务实例
            HellowService hs = service.getPort(new QName("http://webservice.lovo.com/", "HellowServicePort"), HellowService.class);
            System.out.println(hs.hello("小明"));
            
        } catch (Exception e) 
        {
            e.printStackTrace();
        }
    }
    
    
    //end-------------------------------------
    
    public static void main(String[] args) {
        //testSayHello();
        testSayHello2();
    }

}

剩下的等有空的再完善

相关推荐

Apicloud功能模块使用customToast

[toast](#a1)概述customToast弹出一个定时自动关闭的提示框，自定义Toast，自定义提示框颜色、透明度、字体大小、字体颜色、圆角幅度，显示时间；让Toast更完美的融入应用，不...

wxPython - 在程序中使用拖放（wxpython设置滚动条）

实战wxPython系列-052在GUI程序中，拖放是单击虚拟对象并将其拖到不同位置或另一个虚拟对象上的操作(或对该操作的支持)。一般来说，它可用于调用多种类型的操作，或在两个抽象对象之间创建各种类型...

美化Python GUI界面!让你的窗口拥有Win11般的质感 | pywinstyles

1.PythonGUI外观个性化的福音在使用Python开发GUI时，我们经常会使用如Tkinter、PyQt等常见的库，然而这些库的默认界面总显得有些...普通。而如果你想让你的PythonG...

5月BestBuy（5月英文）

Intel处理器排行榜No.1Intel酷睿i511600KF1799元No.2Intel酷睿i511400F1249元No.3Intel酷睿i711700K2899元酷睿i511...

手把手教您使用Python+Flutter开发在线教育系统(上)，纯干货!

一、系统架构设计...

Python开发GUI运维工具具体案列（python运维开发做什么）

在Python开发GUI运维工具的具体实践中，不同GUI库的案例各有特色，以下是结合运维场景的典型实现案例及技术方案：一、基础运维工具案例...

开发图形界面Tkinter、wxPython、PyQt、PySide选哪一个?

　　学习Python，就不得不提一下Python的图形界面开发，如果只用命令行写程序，用户体验不太好，难以胜任复杂的人机交互场景。Python的图形界面开发库常用的有：Tkinter、wxPython...

wxPython和PyQt谁才是最赞的Python GUI库

Python是一种解释型、面向对象、动态数据类型的高级程序设计语言，PythonGUI图形库允许Python程序员很方便的创建完整的、功能键全的GUI用户界面。作为Python开发者，你迟早都会用到...

wxpython入门第五步(组件)（wxpython怎么用）

Widgets在本节中，我们将介绍wxPython中的基本widgets。每个组件都会有一个小的代码示例。wxPython中有很多不同的组件，包括按钮、复选框、滑块和列表框。wx.Buttonwx....

wxpython简介（python的wxpython）

PythonPython是一种成功的脚本语言，它最初是由GuidovanRossum开发的。它于1991年首次发布。Python的灵感来自于ABC和Haskell编程语言。Python是一种高级...

所见即所得，跨平台快速GUI界面RAD设计

Linux一路走来，界面组件很多，TK、gtk、Qt、wxWidget等。Tk古老而又厚重，不失motif风格，gtk+glade别具特色，Qt轻快时尚，许多语言本身没有gui可用，于是做接口加wra...

Spring Security权限控制系列(二)

环境：Springboot2.4.12+SpringSecurity5.4.9本篇主要内容：请求拦截及自定义登录页面上一篇：《...

Spring整合CXF 发布webservice接口服务器和客户端，WSDL简单解析

在垮平台通讯中有很多的接口方式，这里做个简单的webservice接口。发布webservice接口的方式也多种多样，这里做个基于CXF的webservice接口。首先做点知识储备，javax.jws...

聊聊如何对eureka管理界面进行定制化改造

前言在nacos还未面世之前，eureka基本上就是springcloud全家桶体系注册中心的首选，随着nacos的横空出世，越来越多基于springcloud的微服务项目采用nacos作为注册中心，...

Spring Boot 四大核心组件，你知道几个?

前言...

取消回复欢迎 你 发表评论:

一周热门
最近发表
标签列表
Copyright Your WebSite.Some Rights Reserved.