Java--详解WebService技术

一、什么是 webservice

WebService是一种跨编程语言和跨操作系统平台的远程调用技术。

所谓跨编程语言和跨操作平台，就是说服务端程序采用java编写，客户端程序则可以采用其他编程语言编写，反之亦然！跨操作系统平台则是指服务端程序和客户端程序可以在不同的操作系统上运行。

谓远程调用，就是一台计算机a上的一个程序可以调用到另外一台计算机b上的一个对象的方法，譬如，银联提供给商场的pos刷卡系统，商场的POS机转账调用的转账方法的代码其实是跑在银行服务器上。再比如，amazon，天气预报系统，淘宝网，校内网，百度等把自己的系统服务以webservice服务的形式暴露出来，让第三方网站和程序可以调用这些服务功能，这样扩展了自己系统的市场占有率，往大的概念上吹，就是所谓的SOA应用。

从表面上看，WebService就是一个应用程序向外界暴露出一个能通过Web进行调用的API，也就是说能用编程的方法通过Web来调用这个应用程序。我们把调用这个WebService的应用程序叫做客户端，而把提供这个WebService的应用程序叫做服务端。从深层次看，WebService是建立可互操作的分布式应用程序的新平台，是一个平台，是一套标准。它定义了应用程序如何在Web上实现互操作性，你可以用任何你喜欢的语言，在任何你喜欢的平台上写Web service ，只要我们可以通过Web service标准对这些服务进行查询和访问。

WebService平台需要一套协议来实现分布式应用程序的创建。任何平台都有它的数据表示方法和类型系统。要实现互操作性，WebService平台必须提供一套标准的类型系统，用于沟通不同平台、编程语言和组件模型中的不同类型系统。Web service平台必须提供一种标准来描述Web service，让客户可以得到足够的信息来调用这个Web service。最后，我们还必须有一种方法来对这个Web service进行远程调用,这种方法实际是一种远程过程调用协议(RPC)。为了达到互操作性，这种RPC协议还必须与平台和编程语言无关。

二、webservice采用什么技术

WebService平台由XML+XSD,SOAP和WSDL三大技术构成。

1、XML+XSD（封装数据）：

WebService采用HTTP协议传输数据，采用XML格式封装数据（即XML中说明调用远程服务对象的哪个方法，传递的参数是什么，以及服务对象的返回结果是什么）。XML是WebService平台中表示数据的格式。除了易于建立和易于分析外，XML主要的优点在于它既是平台无关的，又是厂商无关的。无关性是比技术优越性更重要的：软件厂商是不会选择一个由竞争对手所发明的技术的。

XML解决了数据表示的问题，但它没有定义一套标准的数据类型，更没有说怎么去扩展这套数据类型。例如，整形数到底代表什么？16位，32位，64位？这些细节对实现互操作性很重要。XML Schema(XSD)就是专门解决这个问题的一套标准。它定义了一套标准的数据类型，并给出了一种语言来扩展这套数据类型。WebService平台就是用XSD来作为其数据类型系统的。当你用某种语言(如VB.NET或C#)来构造一个Web service时，为了符合WebService标准，所有你使用的数据类型都必须被转换为XSD类型。你用的工具可能已经自动帮你完成了这个转换，但你很可能会根据你的需要修改一下转换过程。

2、SOAP（传输协议）：

WebService通过HTTP协议发送请求和接收结果时，发送的请求内容和结果内容都采用XML格式封装，并增加了一些特定的HTTP消息头，以说明HTTP消息的内容格式，这些特定的HTTP消息头和XML内容格式就是SOAP协议。SOAP提供了标准的RPC方法来调用Web Service。

SOAP协议 = HTTP协议 + XML数据格式

SOAP协议定义了SOAP消息的格式，SOAP协议是基于HTTP协议的，SOAP也是基于XML和XSD的，XML是SOAP的数据编码方式。打个比喻：HTTP就是普通公路，XML就是中间的绿色隔离带和两边的防护栏，SOAP就是普通公路经过加隔离带和防护栏改造过的高速公路。

3、WSDL（描述Web Service的文档格式）：

好比我们去商店买东西，首先要知道商店里有什么东西可买，然后再来购买，商家的做法就是张贴广告海报。 WebService也一样，WebService客户端要调用一个WebService服务，首先要有知道这个服务的地址在哪，以及这个服务里有什么方法可以调用，所以，WebService务器端首先要通过一个WSDL文件来说明自己家里有啥服务可以对外调用，服务是什么（服务中有哪些方法，方法接受的参数是什么，返回值是什么），服务的网络地址用哪个url地址表示，服务通过什么方式来调用。

WSDL(Web Services Description Language)就是这样一个基于XML的语言，用于描述Web Service及其函数、参数和返回值。它是WebService客户端和服务器端都能理解的标准格式。因为是基于XML的，所以WSDL既是机器可阅读的，又是人可阅读的，这将是一个很大的好处。一些最新的开发工具既能根据你的Web service生成WSDL文档，又能导入WSDL文档，生成调用相应WebService的代理类代码。

WSDL文件保存在Web服务器上，通过一个url地址就可以访问到它。客户端要调用一个WebService服务之前，要知道该服务的WSDL文件的地址。WebService服务提供商可以通过两种方式来暴露它的WSDL文件地址：1.注册到UDDI服务器，以便被人查找；2.直接告诉给客户端调用者。

三、webservice开发的两种形式

WebService开发可以分为服务器端开发和客户端开发两个方面：

服务端开发：把公司内部系统的业务方法发布成WebService服务，供远程合作单位和个人调用。(借助一些WebService框架可以很轻松地把自己的业务对象发布成WebService服务，Java方面的典型WebService框架包括：axis，xfire，cxf等，java ee服务器通常也支持发布WebService服务，例如JBoss。)
客户端开发：调用别人发布的WebService服务，大多数人从事的开发都属于这个方面，例如，调用天气预报WebService服务。（使用厂商的WSDL2Java之类的工具生成静态调用的代理类代码；使用厂商提供的客户端编程API类；使用SUN公司早期标准的jax-rpc开发包；使用SUN公司最新标准的jax-ws开发包。当然SUN已被ORACLE收购)

WebService的工作调用原理：对客户端而言，我们给这各类WebService客户端API传递wsdl文件的url地址，这些API就会创建出底层的代理类，我调用这些代理，就可以访问到webservice服务。代理类把客户端的方法调用变成soap格式的请求数据再通过HTTP协议发出去，并把接收到的soap数据变成返回值返回。对服务端而言，各类WebService框架的本质就是一个大大的Servlet，当远程调用客户端给它通过http协议发送过来soap格式的请求数据时，它分析这个数据，就知道要调用哪个java类的哪个方法，于是去查找或创建这个对象，并调用其方法，再把方法返回的结果包装成soap格式的数据，通过http响应消息回给客户端。

四、webservice开发步骤

客户端接口开发步骤：

1、xml转java的jar包生成：
本接口采用xmlbeans-2.5.0转换接口中的xml为java对象。(xmlbeans-2.5.0在项目tool文件夹下),解压然后在xmlbeans-2.5.0文件夹下新增
sxzy\gys\src三个文件夹
根据接口内容xml编写xsd文件。参考gys.xsd的编写(xsd编写时候去掉xml的Item标签)。放在sxzy\gys下。
>cd xmlbeans-2.5.0/bin
>scomp -src ..\sxzy\gys\src -out ..\sxzy\gys\gysinterface.jar ..\sxzy\gys\gys.xsd ..\sxzy\gys\gys.xsdconfig -compiler "C:\jdk142_04\bin\javac.exe"

gys.xsdconfig是对生成jar的类文件包的定义。里面内容如下：

<xb:config xmlns:xb=http://xml.apache.org/xmlbeans/2004/02/xbean/config>
<xb:namespace uri=http://www.gys.com/> (http://www.gys.com/)此处根据xsd头定义的targetNamespace。
<xb:package>com.nb.adv.webservice.gys</xb:package>
</xb:namespace>
</xb:config>

2、将生成的jar包和xsd放在项目的interface下并将jar报添加到编译路径。
下面介绍具体供应商接口的开发。
与写Action类似。只需要编写控制层即可。
在nb.adv.result包下新增供应商接口的控制层类：GysControl.java (需要继承抽象类 PIAbstractService)。
具体代码参考GysControl。（其中的回调接口代码基本上不用变）

3、根据接口文档规范。供应商对应的我们这边的项目业务定义为W8000MDM001，将其对应关系维护进pi.properties即可完成开发。

服务器端接口开发步骤：

1、数据准备：需要对方的wsdl文件或者WSDL地址（创建webservice，得到接口类），xml接收格式，表数据结构（为了将数据用xmlbeans封装成xml文件）；

2、xml转java的jar包生成：
本接口采用xmlbeans-2.5.0转换接口中的xml为java对象。(xmlbeans-2.5.0在项目tool文件夹下),解压然后在xmlbeans-2.5.0文件夹下新增
sxzy\gys\src三个文件夹
根据接口内容xml编写xsd文件（注意大小写与xml一致）。参考gys.xsd的编写(xsd编写时候去掉xml的Item标签)。放在sxzy\gys下。
>cd xmlbeans-2.5.0/bin
>scomp -src E:\opt\wl\src -out E:\opt\wl\interface\boxinventoryinterface.jar E:\opt\wl\interface\boxinventory.xsd E:\opt\wl\interface\boxinventory.xsdconfig -compiler "D:\Java\jdk1.6.0_21\bin\javac.exe"

gys.xsdconfig是对生成jar的类文件包的定义。里面内容如下：

<xb:config xmlns:xb=http://xml.apache.org/xmlbeans/2004/02/xbean/config>

<xb:namespace uri=http://www.gys.com/> (http://www.gys.com/)此处根据xsd头定义的targetNamespace。

<xb:package>com.nb.adv.webservice.gys</xb:package>

</xb:namespace>

</xb:config>

可以不必生成xsdconfig文件；

3、将生成的jar包和xsd放在项目的interface下并将jar报添加到编译路径。

在Java中对数据进行封装成xml文件，实例如下：

CallHelper helper = initializeCallHelper("l_boxInventoryInterfaceList", form, request, false);

helper.setParam("date1", request.getParameter("year"));

helper.setParam("date2", request.getParameter("month"));

helper.setParam("boxid", request.getParameter("boxid"));

helper.setParam("personid", getPersonId(request));

helper.execute();

List<BasicDynaBean> list = helper.getResult("results");

//封装成xml文件

com.nb.adv.webservice.boxinventory.InputDocument input = com.nb.adv.webservice.boxinventory.InputDocument.Factory.newInstance();

TAPSSmokeboxType delivery = input.addNewInput().addNewTAPSSmokebox();

for (BasicDynaBean bean : list) {

com.nb.adv.webservice.boxinventory.ItemType item = delivery.addNewItem();

item.setFPlant(bean.get("from_id").toString());

item.setFPlantName(bean.get("from_name").toString());

item.setFMaterialNum(bean.get("brand").toString());

item.setFMaterialNumName(bean.get("matkx").toString());

item.setFYear(bean.get("year").toString());

item.setFMonth(bean.get("month").toString());

item.setFFactoryStock(bean.get("startinvent_num").toString());

item.setFMaterialFactoryStock(bean.get("startinvent_num1").toString());

item.setFReserved1("");

item.setFReserved2("");

item.setFReserved3("");

}

Map<String,String> map = new HashMap<String,String>();

map.put("","http://www.boxinventory.com/");

XmlOptions options = new XmlOptions();

options.setUseDefaultNamespace();

options.setSaveImplicitNamespaces(map);

options.setSavePrettyPrint();

4、将xml文件发送出去，通过wsdl生成Java类；
第一种方法：使用MyEclipse自动生成webservice客户端（步骤参考word文件）；

第二种方法：对于接口有复杂自定义类型返回的，最好根据wsdl生成java类
1. 建立一个web工程wsdl，将axis的包拷贝到lib下(共8个)
2. 点击run新建一个java applation，选择WSDL2JAVA.
3. 选择第二个选项”Arguments”,在Program arguments:中输入wsdl地址；
4. 点击apply----Run即生成相应类；

实例代码如下所示：

SIDNInfoOutbAsynService service = new SIDNInfoOutbAsynService();

SIDNInfoOutbAsyn out = service.getHTTPSPort();

DTDNInfo msg = new DTDNInfo();

msg.setBIZTYPE("TMS002");//此处固定不变

msg.setSOURCE("W-8000-TMS");//此处固定不变

msg.setMSGID(OptionUtil.getNo(5));//此处固定不变

msg.setTIME(OptionUtil.getSystemDateFormate("HHmmss"));//此处固定不变

msg.setDATE(OptionUtil.getSystemDateFormate("yyyyMMdd"));//此处固定不变

msg.setMSGCODE("A1-201");//此处固定不变

msg.setRETRYCOUNT("0");//此处固定不变

msg.setBACKUP1("");

msg.setBACKUP2("");

msg.setBACKUP3("");

msg.setDestination("N8000TMS006");///此处为 目标系统编码+业务编码

msg.setSXmlString(input.xmlText(options));//此处固定不变

out.siDNInfoOutbAsyn(msg);

下面介绍具体供应商接口的开发。
与写Action类似。只需要编写控制层即可。
在nb.adv.result包下新增供应商接口的控制层类：GysControl.java (需要继承抽象类 PIAbstractService)。
具体代码参考GysControl。（其中的回调接口代码基本上不用变）

4、根据接口文档规范。供应商对应的我们这边的项目业务定义为W8000MDM001，将其对应关系维护进pi.properties即可完成开发。