WebService (二)WSDL的介绍
1、WSDL语法分析
获取web的发布信息是通过wsimport 来解析wsdl文件得到Java类来实现的. 如论是获取发布的服务,还是调用发布的服务.都需要参考wsdl文件.接下面我们就来分析wsdl文件的结构
分析服务类相关信息
// HelloWorldService 就是我们注册的服务,默认在原来的类名后面加上Service <service name="HelloWorldService"> // 可以通过getHelloWroldPort()获取基于soap1.1的服务,此服务接受的类型取决, // HelloWorldServiceSoapBinding绑定的类型 <port name="HelloWorldPort" binding="tns:HelloWorldPortBinding"> // 提供服务的地址,和端口,SOAP后面介绍 <soap:address location="http://127.0.0.1:9999/helloworld" /> </port> </service> |
分析如何调用服务方法
// 上图中的HelloWorldPortBinding参照的就是此HelloWorldPortBinding它的类型为HelloWorld接口类型. <binding name="HelloWorldPortBinding" type="tns:HelloWorld"> // SOAP1.1协议 http://schemas.xmlsoap.org/soap/http <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document" /> <operation name="sayHi"> <soap:operation soapAction="" /> <input> <soap:body use="literal" /> </input> <output> <soap:body use="literal" /> </output> </operation> </binding> |
2、WSDL详解
WSDL 文档的组成部分
元素 | 定义 |
<portType> | web service 执行的操作 |
<message> | web service 使用的消息 |
<types> | web service 使用的数据类型 |
<binding> | web service 使用的通信协议 |
WSDL 文档的主要结构:
<definitions> <types> definition of types........ </types> <message> definition of a message.... </message> <portType> definition of a port....... </portType> <binding> definition of a binding.... </binding> </definitions> |
WSDL元素介绍
定义一个功能,在Java中叫做方法,在C中叫做函数;在Java中叫类,在C语言中叫做结构体。这些名词都不一样。
WSDL规范为了不会产生歧义,就定义了一些新的名词来表述功能与服务。
<portType>(WSDL端口)
<portType> 元素是最重要的 WSDL 元素。 它可描述一个 web service、可被执行的操作,以及相关的消息。 可以把 <portType> 元素比作传统编程语言中的一个函数库(或一个模块、或一个类)。
<operation>子元素:
对服务中所支持的操作的抽象描述,一般单个Operation描述了一个访问入口的请求/响应消息对。
<message> (WSDL消息)
<message> 元素定义一个操作的数据元素。 每个消息均由一个或多个部件组成。可以把这些部件比作传统编程语言中一个函数调用的参数。
通信消息的数据结构的抽象类型化定义。使用Types所定义的类型来定义整个消息的数据结构。
<types>(WSDL types)
<types> 元素定义 web service 使用的数据类型。 为了最大程度的平台中立性,WSDL 使用 XML Schema 语法来定义数据类型。
<binding> (WSDL Bindings)
<binding> 元素为每个端口定义消息格式和协议细节。
示例
这是某个 WSDL 文档的简化的片段:
<message name="getTermRequest"> <part name="term" type="xs:string"/> </message>
<message name="getTermResponse"> <part name="value" type="xs:string"/> </message>
<portType name="glossaryTerms"> <operation name="getTerm"> <input message="getTermRequest"/> <output message="getTermResponse"/> </operation> </portType> |
在这个例子中,<portType> 元素把 "glossaryTerms" 定义为某个端口的名称,把 "getTerm" 定义为某个操作的名称。
操作 "getTerm" 拥有一个名为 "getTermRequest" 的输入消息,以及一个名为 "getTermResponse" 的输出消息。
<message> 元素可定义每个消息的部件,以及相关联的数据类型。
对比传统的编程,glossaryTerms 是一个函数库,而 "getTerm" 是带有输入参数 "getTermRequest" 和返回参数 getTermResponse 的一个函数。
说明
Types、Message、PortType、Opration为抽象定义。
Binding、Port、Service是实现。
Port:
定义为协议/数据格式绑定与具体web访问地址组合的单个服务访问点。
Service:
相关服务访问点的集合。
3、使用WebService注解来修改WSDL文件
WSDL文件的内容,一般由服务默认生成,但为了更好的向开发人员提供使用说明书,一般应做一些简单的修改。至少不应该暴露我们的包结构。而targetNamespace默认情况下为倒置的包名,这已经暴露了我们的包结构。通过在类文件上添加以下注解,可以修改wsdl生成的各元素,而不是直接去修改wsdl文件,直接去修改wsdl文件是无效的。
WebService的注解包括:
1. @WebService-定义服务 --类上
2. @WebMethod-定义方法 - 方法
3. @WebResult-定义返回值 – 返回值
4. @WebParam-定义参数 – 参数
WebService注解的使用
1. 通过WebService的注解,可以更加形像的描述Web服务。从而生成WSDL文档。
2. 当修改了WebService注解之后,同时会影响客户端生成的代码。
3. 调用的方法名和参数名也发生了变化。
4. 即使是没有修改源代码,只修改了注解,客户端的代码也必须要重新生成(注意是生成而不是下载)。否则调用将会失败。
5. 生成本地调用代码,依然使用wsimport工具
@WebService注解:
1. @WebService 标注要暴露为Web Services的类或接口 ,用于修饰类或接口,包含的属性有:
2. targetNamespace属性:定义命名空间,默认为”http://”+”包名倒排”
3. name属性:Web Service 的名称,默认为发布服务的类名。
4. serviceName: ws服务的名词,默认在类名后面添加了service
5. endpointInterface属性:定义服务抽象 Web Service 协定的服务端点接口的完整名称,接口也必须声明WebService注解,包括方法的注解必须也要添加到接口中,否则会无效, 而且WS在没有注解的情况下.生成WS的时候会自动生成一个注解.所以可以不用指定接口
@WebMethod
1. 此注解用在方法上,用于修改对外暴露的方法
2. operationName属性:与此方法匹配的 wsdl:operation 的名称
3. exclude属性:标注此方法是否被暴露,默认为false
注意:如果所有方法上都没有指定@WebMethod,则默认是所有的方法都是对外暴露的方法。如果有任一方法指定了@WebMethod,则只有指定这个注解的才是对外暴露的方法。
@WebResult
@WebResult 定义返回值,返回值类型不能为接口类或抽象类,而且必须有个不带参的构造函数,包含属性
name属性:返回值的名称
一个添加注解的案例:
// 修改web服务的名称,和命名空间 @WebService(name="Hello",targetNamespace="http://icast.cn") public class HelloWorld { @WebMethod(operationName="aaa") // 修改webResult 和 webParam会影响到JS的调用模式 public @WebResult(name="returnName") String sayHi(@WebParam(name="yourname") String name){ return "Hello" + name; } public static void main(String[] args){ // 发布一个web服务,指定IP和实现者 Endpoint end=Endpoint.publish("http://127.0.0.1:4567/hello",new HelloWorld()); } } |