一、什么是webService?
Web Service也叫XML Web Service WebService是一种可以接收从Internet或者Intranet上的其它系统中传递过来的请求,轻量级的独立的通讯技术。是:通过SOAP在Web上提供的软件服务,使用WSDL文件进行说明,并通过UDDI进行注册。
几个基本概念:
SOAP:简单对象存取协议,是webService的通信协议,是针对xml文档形式的调用方法的规范,可支持不同的底层接口,如http;
WSDL:是一个xml文档, 用于说明一组soap消息,以及如何交换这些消息;
UDDI:是一个主要针对Web服务供应商和使用者的新项目,是一种根据wsdl文件(描述文档)来引导客户端查找响应服务的机制。它是利用SOAP消息机制(标准的XML/HTTP)来发布,编辑,浏览以及查找注册信息。它采用XML格式来封装各种不同类型的数据,并且发送到注册中心或者由注册中心来返回需要的数据。
一言以蔽之:webService是一种典型,成熟的远程服务调用技术规范。如网站对天气预报接口的接入,对列车时刻表、航班的接口接入等。
二、服务端简单示例
1)服务端服务接口模拟
看之前网上的示例,都是一个接口服务对应一个wsdl文件的,然而我考虑到:如果会有不止一个接口呢?该咋办?——其实,当然我可以一个接口实现类对应一个wsdl文件,并且也测试过没问题,但现在我想要发布多个接口服务,但只生成一个wsdl文件。
实现这种效果很简单,只需用一个实现类,该实现类同时实现若干个接口即可。但这样会造成耦合(下面就来测试这种,具体应用中,一般是某一类服务对应于一个接口,此时还是要用到一个接口对应一个wsdl文件的模式。)
接口一:
@WebService public interface IService { public void sayHello(@WebParam(name="username") String name); public int calculatr(int m, int n); }
接口二:
@WebService public interface IService2 { public void getInfo(@WebParam(name="person") Person person); }
其中,Person类是一个pojo,
public class Person implements Serializable{//因为要用于远程传输,所以需要序列化 private static final long serialVersionUID = 1L; private String name; private int age; private String gender; public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } public String getGender() { return gender; } public void setGender(String gender) { this.gender = gender; } @Override public String toString() { return "Pserson [name=" + name + ", age=" + age + ", gender=" + gender + "]"; } }
接口的实现类(这里我测试2个接口对应1个实现类,即生成一个wsdl文件,但现实中可能并不推荐这么做。。)
@WebService //注意:实现类要有该注解,才能被发布 public class MutiServiceImpl implements IService, IService2 { @Override public void getInfo(Person person) { System.out.println("该人员的信息:" + person); } @Override public void sayHello(String name) { System.out.println("Hello, my name is " + name); } @Override public int calculatr(int m, int n) { return m * n; } }
服务端接口服务的发布:
public class ServicePublish { public static void main(String[] args) { String address = "http://localhost:9001/Service/service"; //address由自己来指定 不过要符合规范 http://ip地址:端口/服务名/具体服务 //第二个参数必须是具体实现类 Endpoint.publish(address, new MutiServiceImpl()); System.out.println("webService之服务端服务发布成功!"); } }
运行main方法,可以看到打印信息,说明接口服务发布成功!(其实测试webService不是非得建立web project,普通的工程即可~~)
我们不妨在浏览器上输入刚刚发布的地址:http://localhost:9001/Service/service?wsdl(要加上?wsdl),即可看到一个自动生成的xml格式的描述文件:
This XML file does not appear to have any style information associated with it. The document tree is shown below. <!-- Published by JAX-WS RI (http://jax-ws.java.net). RI's version is JAX-WS RI 2.2.9-b130926.1035 svn-revision#5f6196f2b90e9460065a4c2f4e30e065b245e51e. --> <!-- Generated by JAX-WS RI (http://jax-ws.java.net). RI's version is JAX-WS RI 2.2.9-b130926.1035 svn-revision#5f6196f2b90e9460065a4c2f4e30e065b245e51e. --> <definitions xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:wsp="http://www.w3.org/ns/ws-policy" xmlns:wsp1_2="http://schemas.xmlsoap.org/ws/2004/09/policy" xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="http://the_service/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.xmlsoap.org/wsdl/" targetNamespace="http://the_service/" name="MutiServiceImplService"> <types> <xsd:schema> <xsd:import namespace="http://the_service/" schemaLocation="http://localhost:9001/Service/service1?xsd=1"/> </xsd:schema> </types> <message name="getInfo"> <part name="parameters" element="tns:getInfo"/> </message> <message name="getInfoResponse"> <part name="parameters" element="tns:getInfoResponse"/> </message> <message name="sayHello"> <part name="parameters" element="tns:sayHello"/> </message> <message name="sayHelloResponse"> <part name="parameters" element="tns:sayHelloResponse"/> </message> <message name="calculatr"> <part name="parameters" element="tns:calculatr"/> </message> <message name="calculatrResponse"> <part name="parameters" element="tns:calculatrResponse"/> </message> <portType name="MutiServiceImpl"> <operation name="getInfo"> <input wsam:Action="http://the_service/MutiServiceImpl/getInfoRequest" message="tns:getInfo"/> <output wsam:Action="http://the_service/MutiServiceImpl/getInfoResponse" message="tns:getInfoResponse"/> </operation> <operation name="sayHello"> <input wsam:Action="http://the_service/MutiServiceImpl/sayHelloRequest" message="tns:sayHello"/> <output wsam:Action="http://the_service/MutiServiceImpl/sayHelloResponse" message="tns:sayHelloResponse"/> </operation> <operation name="calculatr"> <input wsam:Action="http://the_service/MutiServiceImpl/calculatrRequest" message="tns:calculatr"/> <output wsam:Action="http://the_service/MutiServiceImpl/calculatrResponse" message="tns:calculatrResponse"/> </operation> </portType> <binding name="MutiServiceImplPortBinding" type="tns:MutiServiceImpl"> <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/> <operation name="getInfo"> <soap:operation soapAction=""/> <input> <soap:body use="literal"/> </input> <output> <soap:body use="literal"/> </output> </operation> <operation name="sayHello"> <soap:operation soapAction=""/> <input> <soap:body use="literal"/> </input> <output> <soap:body use="literal"/> </output> </operation> <operation name="calculatr"> <soap:operation soapAction=""/> <input> <soap:body use="literal"/> </input> <output> <soap:body use="literal"/> </output> </operation> </binding> <service name="MutiServiceImplService"> <port name="MutiServiceImplPort" binding="tns:MutiServiceImplPortBinding"> <soap:address location="http://localhost:9001/Service/service1"/> </port> </service> </definitions>
这里顺便简单讲一下这个wsdl文件的一些关键字段 。
1)definitions元素——wsdl文件的根元素
2)type元素——作为一容器,定义了自定义的特殊数据类型,在声明消息部分(有效负载)的时候,messages定义使用了types元素中定义的数据类型与元素。
3)Message元素描述了Web服务的有效负载。相当于函数调用中的参数和返回值。
4)PortType元素定义了Web服务的抽象接口,它可以由一个或者多个operation元素,每个operation元素定义了一个RPC样式或者文档样式的Web服务方法,相当于类接口的名称。
5)Operation元素要用一个或者多个messages消息来定义它的输入、输出以及错误,相当于接口中包含的函数。
6)Binding元素将一个抽象的portType映射到一组具体的协议(SOAP或者HTTP)、消息传递样式(RPC或者document)以及编码样式(literal或者SOAP encoding)。
7)Service元素包含一个或者多个Port元素,每个Port元素对应于一个web服务
三、客户端简单示例(开另一个工程,不一定是web工程)
生成了wsdl文件之后,我们就需要根据该wsdl文件【自动】生成客户端的调用代码了。
一般而言,使用Jdk1.6+自带的命令会比较简单。(前提是你已配置好jdk环境变量)
具体命令格式为:
wsimport -s "src目录" -p “生成类所在包名” -keep “wsdl发布地址”
在本例中,为 wsimport -s E:\xxx\the_client\src -p org.webservice.client -keep http://localhost:9001/Service/service?wsdl (因为服务端和客户端都在同一台机器,所以直接用localhost,如果不是同一台机器,则客户端需要准确输入服务端的地址)
成功执行完命令之后,刷新会发现多了如下类:
public class ClientSub { public static void main(String[] args) { try { MutiServiceImpl impl = new MutiServiceImplService().getMutiServiceImplPort(); int x = impl.calculatr(30, 2); System.out.println("计算结果:" + x); Person person = new Person(); person.setAge(23); person.setGender("男"); person.setName("Karl"); impl.getInfo(person); impl.sayHello("Connor"); } catch (Exception e) { e.printStackTrace(); } } }
运行该服务的订阅类,会发现分别在服务端和客户端的控制台打印如下:
服务端:
说明:利用webService来进行远程调用接口服务成功!