webservie和soap和wsdl教程 OS

admin 2019-8-6 136

资料收集

使用天气调用的webservice进行学习
http://www.webxml.com.cn/WebServices/WeatherWebService.asmx
http://www.webxml.com.cn/WebServices/WeatherWebService.asmx?WSDL

1.简介

最近因为一些特殊的需求需要提供一个基于 soap 的 webservice服务,之前没有经验,也不知道该怎么做,于是从网上查了很多东西,资料很多,但是大多不够详细,后来查到天气预报的webservice服务说明,算是看懂了一些,写在这里权做给大家做一个入门引导好了。

  

2.什么是webservice,什么是soap,什么是 wsdl

  • SOAP:Simple Object Access Protocol
  • WSDL:Web Services Description Language
    一开始接触这个东西的时候完全把我搞晕了。真的是坑,各种概念。我这里根据我的采坑经验给一些自己的见解,当然也要避免误导参考的人,所以力求准确吧。

2.1 什么是webservice

  我觉得这个webservice有着狭义和广义的定义.
  广义的来说,webservice差不多就是字面意思:web + service,也就是 服务(service)网络(web)化的意思。他力求的是跨语言,跨平台的,基于web传输的远程调用能力。他没有强调远程调用使用什么协议,所以你可以自由选择,比如soap 协议(可与基于http,smtp,等各种传输协议),或者常见的基于http的json化的数据传输协议,基于dubbo协议的dubbo服务调用都属于web service的一种实现。
  狭义的来说,这个首先声明,是我参考网上的资料已经自身的一些经历的解读哈。我认为大家经常谈的webservice是指基于soap协议实现的远程服务调用模型。

2.2 什么是soap

  saop定义了数据交互中如何传递消息的规则。比如在http中规定了post请求的传参方式,在数据类型不同的情况下可以使用不同的参数方式。在form格式下是 key=v&key1=v1  ,同样soap也是定义这些东西的。

2.3 什么是wsdl

  同样的,当我们用http方式去调用一个服务的时候我们只是知道通用的http协议的传参方式还是不够的,我们仍然需要知道目标服务的接口文档,对了,这就是wsdl,每个服务都有的接口文档,在http上可能就是我们手写的一个wiki文档,在soap中就是一个用wsdl规范编写的wsdl文档,每个服务是有能力自动生成这个文档的。wsdl规范了这个文档应该怎么写。

综上所述:soap可以类比http协议,wsdl可以类比一个http服务的接口文档。

3.结合比较常用的soap服务的wsdl文档来了解一下wsdl

这次用的一个比较常用的文档就是天气预报的webservice服务来进行学习
链接:http://www.webxml.com.cn/WebServices/WeatherWebService.asmx
对应的是这个文档的可读性更强的介绍,他的实际接口文档是
http://www.webxml.com.cn/WebServices/WeatherWebService.asmx?WSDL
这篇接口文档实际上是有多个接口的描述,当然,我们这里只取一个来进行描述,取的接口是
getWeatherbyCityName
http://www.webxml.com.cn/WebServices/WeatherWebService.asmx?op=getWeatherbyCityName
这个页面有详细的请求体和返回结果,很具体。下面我们就从他的实际接口文档wsdl中来分析一下都有什么东西。
我们知道wsdl文档包含了这么几个部分

<definitions>
<types>
   definition of types........
数据类型定义的容器,它使用某种类型系统(一般地使用XML Schema中的类型系统)
</types>
<message>
   definition of a message....
通信消息的数据结构的抽象类型化定义。使用Types所定义的类型来定义整个消息的数据结构。
</message>
<portType>
   definition of a port.......
对于某个访问入口点类型所支持的操作的抽象集合,这些操作可以由一个或多个服务访问点来支持。
</portType>
<binding>
   definition of a binding....
特定端口类型的具体协议和数据格式规范的绑定。
</binding>
<service>
相关服务访问点的集合。
</servie>
</definitions>

下面我们使用getWeatherbyCityName这个接口在总的xml对应的部分做说明,将xml提取出来如下
还请学习下面的文档的时候参考 对应的可视化文档
进行对比

<wsdl:definitions xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
                  xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:tns="http://WebXml.com.cn/"
                  xmlns:s="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/"
                  xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
                  targetNamespace="http://WebXml.com.cn/">
    <!-- types元素-->
    <wsdl:types>
        <s:schema elementFormDefault="qualified" targetNamespace="http://WebXml.com.cn/">
        <!--  可以看到,types 定义的是数据类型,可以在message元素中进行引用,他的存在形式可能是type也可能是element-->
            <s:complexType name="ArrayOfString">
                <s:sequence>
                    <s:element minOccurs="0" maxOccurs="unbounded" name="string" nillable="true" type="s:string"/>
                </s:sequence>
            </s:complexType>
            <s:element name="getWeatherbyCityName">
                <s:complexType>
                    <s:sequence>
                        <s:element minOccurs="0" maxOccurs="1" name="theCityName" type="s:string"/>
                    </s:sequence>
                </s:complexType>
            </s:element>
            <s:element name="getWeatherbyCityNameResponse">
                <s:complexType>
                    <s:sequence>
                        <s:element minOccurs="0" maxOccurs="1" name="getWeatherbyCityNameResult"
                                   type="tns:ArrayOfString"/>
                    </s:sequence>
                </s:complexType>
            </s:element>
            <s:element name="ArrayOfString" nillable="true" type="tns:ArrayOfString"/>
            <s:element name="DataSet" nillable="true">
                <s:complexType>
                    <s:sequence>
                        <s:element ref="s:schema"/>
                        <s:any/>
                    </s:sequence>
                </s:complexType>
            </s:element>
        </s:schema>
    </wsdl:types>
    <!--  message元素-->
    message 用来定义每个soap服务的入参和出参,包括参数名,参数类型信息。当引用了types  当中定义的element元素的时候,name只是有占位意义,并不具备实际的意义
当引用了types中定义的 type型元素的时候,name 是有意义的,这里的每个message定义并不是针对某个接口的,而是作为基础元素,在portType中描述接口的时候使用。
    <wsdl:message name="getWeatherbyCityNameSoapIn">
        name只是有占位意义,并不具备实际的意义
        <wsdl:part name="parameters" element="tns:getWeatherbyCityName"/>
    </wsdl:message>
    <wsdl:message name="getWeatherbyCityNameSoapOut">
        <wsdl:part name="parameters" element="tns:getWeatherbyCityNameResponse"/>
    </wsdl:message>
    <wsdl:message name="getWeatherbyCityNameHttpGetIn">
        name 是有意义的
        <wsdl:part name="theCityName" type="s:string"/>
    </wsdl:message>
    <wsdl:message name="getWeatherbyCityNameHttpGetOut">
        <wsdl:part name="Body" element="tns:ArrayOfString"/>
    </wsdl:message>
    <wsdl:message name="getWeatherbyCityNameHttpPostIn">
        name 是有意义的
        <wsdl:part name="theCityName" type="s:string"/>
    </wsdl:message>
    <wsdl:message name="getWeatherbyCityNameHttpPostOut">
        <wsdl:part name="Body" element="tns:ArrayOfString"/>
    </wsdl:message>
    <!-- portType 元素-->
    定义了一个接口的入参和出参,每个portType元素实际上对应了一个接口,就像springMVC当中controller当中定义的一个有@RequestMapping注解的方法一样,他描述了这个方法的入参和出参。
    <wsdl:portType name="WeatherWebServiceSoap">
        <wsdl:operation name="getWeatherbyCityName">
            <wsdl:input message="tns:getWeatherbyCityNameSoapIn"/>
            <wsdl:output message="tns:getWeatherbyCityNameSoapOut"/>
        </wsdl:operation>
    </wsdl:portType>
    <wsdl:portType name="WeatherWebServiceHttpGet">
        <wsdl:operation name="getWeatherbyCityName">
            <wsdl:input message="tns:getWeatherbyCityNameHttpGetIn"/>
            <wsdl:output message="tns:getWeatherbyCityNameHttpGetOut"/>
        </wsdl:operation>
    </wsdl:portType>
    <wsdl:portType name="WeatherWebServiceHttpPost">
        <wsdl:operation name="getWeatherbyCityName">
            <wsdl:documentation xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">...</wsdl:documentation>
            <wsdl:input message="tns:getWeatherbyCityNameHttpPostIn"/>
            <wsdl:output message="tns:getWeatherbyCityNameHttpPostOut"/>
        </wsdl:operation>
    </wsdl:portType>
   <!-- bingding元素 -->
    仔细观察下面的配置的话可以发现,这几个bingding元素的差异是很大的。
   在bingding的第二行说明的是 该bingding使用的协议,是 soap或者soap12 或者是 http-get 或者是 http-post 
   这里的 bingding 元素对应的type属性标识了对应的portType元素
   这里的operation对应了上面对应bingding元素中的operation,同时,这里可以岁输入输出做一些处理,比如urlEncoded。use="literal"表示不做特殊处理。
    <wsdl:binding name="WeatherWebServiceSoap" type="tns:WeatherWebServiceSoap">
        <soap:binding transport="http://schemas.xmlsoap.org/soap/http"/>
        <wsdl:operation name="getWeatherbyCityName">
            <soap:operation soapAction="http://WebXml.com.cn/getWeatherbyCityName" style="document"/>
            <wsdl:input>
                <soap:body use="literal"/>
            </wsdl:input>
            <wsdl:output>
                <soap:body use="literal"/>
            </wsdl:output>
        </wsdl:operation>
    </wsdl:binding>
    <wsdl:binding name="WeatherWebServiceSoap12" type="tns:WeatherWebServiceSoap">
        <soap12:binding transport="http://schemas.xmlsoap.org/soap/http"/>
        <wsdl:operation name="getWeatherbyCityName">
            <soap12:operation soapAction="http://WebXml.com.cn/getWeatherbyCityName" style="document"/>
            <wsdl:input>
                <soap12:body use="literal"/>
            </wsdl:input>
            <wsdl:output>
                <soap12:body use="literal"/>
            </wsdl:output>
        </wsdl:operation>
    </wsdl:binding>
    <wsdl:binding name="WeatherWebServiceHttpGet" type="tns:WeatherWebServiceHttpGet">
        <http:binding verb="GET"/>
        <wsdl:operation name="getWeatherbyCityName">
          在http类型中还会增加具体的location信息,这个在对应的http请求里面是可以区分出来的,比如,
          soap对应的请求是 POST /WebServices/WeatherWebService.asmx HTTP/1.1 
          http-get对应的请求是  GET /WebServices/WeatherWebService.asmx/getWeatherbyCityName?theCityName=string HTTP/1.1
            <http:operation location="/getWeatherbyCityName"/>
            <wsdl:input>
                <http:urlEncoded/>
            </wsdl:input>
            <wsdl:output>
                <mime:mimeXml part="Body"/>
            </wsdl:output>
        </wsdl:operation>
    </wsdl:binding>
    <wsdl:binding name="WeatherWebServiceHttpPost" type="tns:WeatherWebServiceHttpPost">
        <http:binding verb="POST"/>
        <wsdl:operation name="getWeatherbyCityName">
            <http:operation location="/getWeatherbyCityName"/>
            <wsdl:input>
                <mime:content type="application/x-www-form-urlencoded"/>
            </wsdl:input>
            <wsdl:output>
                <mime:mimeXml part="Body"/>
            </wsdl:output>
        </wsdl:operation>
    </wsdl:binding>
   <!-- service 元素-->
    这里定义的是每个方法具体的访问地址,指向了每个bingding具体绑定的服务地址。
    <wsdl:service name="WeatherWebService">
        <wsdl:port name="WeatherWebServiceSoap" binding="tns:WeatherWebServiceSoap">
            <soap:address location="http://www.webxml.com.cn/WebServices/WeatherWebService.asmx"/>
        </wsdl:port>
        <wsdl:port name="WeatherWebServiceSoap12" binding="tns:WeatherWebServiceSoap12">
            <soap12:address location="http://www.webxml.com.cn/WebServices/WeatherWebService.asmx"/>
        </wsdl:port>
        <wsdl:port name="WeatherWebServiceHttpGet" binding="tns:WeatherWebServiceHttpGet">
            <http:address location="http://www.webxml.com.cn/WebServices/WeatherWebService.asmx"/>
        </wsdl:port>
        <wsdl:port name="WeatherWebServiceHttpPost" binding="tns:WeatherWebServiceHttpPost">
            <http:address location="http://www.webxml.com.cn/WebServices/WeatherWebService.asmx"/>
        </wsdl:port>
    </wsdl:service>
</wsdl:definitions>

4. 干脆把对应的请求信息也摘录下来好了

截取自 这里

getWeatherbyCityName

4.1 SOAP 1.1

以下是 SOAP 1.2 请求和响应示例。所显示的占位符需替换为实际值。

POST /WebServices/WeatherWebService.asmx HTTP/1.1
Host: www.webxml.com.cn
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://WebXml.com.cn/getWeatherbyCityName"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getWeatherbyCityName xmlns="http://WebXml.com.cn/">
      <theCityName>string</theCityName>
    </getWeatherbyCityName>
  </soap:Body>
</soap:Envelope
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getWeatherbyCityNameResponse xmlns="http://WebXml.com.cn/">
      <getWeatherbyCityNameResult>
        <string>string</string>
        <string>string</string>
      </getWeatherbyCityNameResult>
    </getWeatherbyCityNameResponse>
  </soap:Body>
</soap:Envelope

4.2 SOAP 1.2

以下是 SOAP 1.2 请求和响应示例。所显示的占位符需替换为实际值。

POST /WebServices/WeatherWebService.asmx HTTP/1.1
Host: www.webxml.com.cn
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getWeatherbyCityName xmlns="http://WebXml.com.cn/">
      <theCityName>string</theCityName>
    </getWeatherbyCityName>
  </soap12:Body>
</soap12:Envelope
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getWeatherbyCityNameResponse xmlns="http://WebXml.com.cn/">
      <getWeatherbyCityNameResult>
        <string>string</string>
        <string>string</string>
      </getWeatherbyCityNameResult>
    </getWeatherbyCityNameResponse>
  </soap12:Body>
</soap12:Envelope

4.3 HTTP GET

以下是 HTTP GET 请求和响应示例。所显示的占位符需替换为实际值。

GET /WebServices/WeatherWebService.asmx/getWeatherbyCityName?theCityName=string HTTP/1.1
Host: www.webxml.com.cn
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfString xmlns="http://WebXml.com.cn/">
  <string>string</string>
  <string>string</string>
</ArrayOfStrin

4.4 HTTP POST

以下是 HTTP POST 请求和响应示例。所显示的占位符需替换为实际值。

POST /WebServices/WeatherWebService.asmx/getWeatherbyCityName HTTP/1.1
Host: www.webxml.com.cn
Content-Type: application/x-www-form-urlencoded
Content-Length: length
theCityName=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfString xmlns="http://WebXml.com.cn/">
  <string>string</string>
  <string>string</string>
</ArrayOfString

少客联盟- 版权声明 1、本主题所有言论和图片纯属会员个人意见,与少客联盟立场无关。
2、本站所有主题由该帖子作者发表,该帖子作者admin少客联盟享有帖子相关版权。
3、少客联盟管理员和版主有权不事先通知发贴者而删除本文。
4、其他单位或个人使用、转载或引用本文时必须同时征得该帖子作者admin少客联盟的同意。
5、帖子作者须承担一切因本文发表而直接或间接导致的民事或刑事法律责任。
6、本帖部分内容转载自其它媒体,但并不代表本站赞同其观点和对其真实性负责。
7、如本帖侵犯到任何版权问题,请立即告知本站,本站将及时予与删除并致以最深的歉意。
8、官方反馈邮箱:chinasuc@chinasuc.cn


上一篇:TP-Link无线路由器怎么修改WiFi无线网络名称?
下一篇:渗透测试中常用的工具插件
Whatever is worth doing is worth doing well. juvenile hacker league
最新回复 (0)
    • 少客联盟
      2
        登录 注册 QQ登录(停用)
返回