webservice五种发布方式及客户端调用.doc

WebService 四种发布方式总结 Author:yczhang1. CXF方式CXF与spring搭建webservice是目前最流行的方式，但是传闻cxf与jdk1.5有些不兼容，我没有遇到过，我遇到的问题是cxf与was6.1.1不兼容，表现在cxf必须的jar包“wsdl4j-1.6.2.jar”报错，报的错为： java.lang.IncompatibleClassChangeError，明显的jar包不兼容问题，很是头痛，后来查找资料找到解决办法是，将上述jar包新建一个was共享库，可以解决，但是客户周经理不想用此种方式，因为需要修改was，于是改用了axis2方式，下文会介绍。该问题在此处做个记录，以后使用cxf与was的时候需要注意！使用cxf+spring搭建WebService：第一步，添加jar包。此处需要注意，不同环境（tomcat、was）jar也不一定相同，例如我本地cxf+spring只需要如下jar包：而泰康的was环境则需要如下jar包：明显的多了很多，原因应该是服务器jar包池的不同。根据错误提示缺什么补什么就可以了，注意jar包勿重复。第二步，配置web.xml文件，如下（重要的地方已标记）：contextConfigLocationclasspath:/applicationContext.xml org.springframework.web.context.ContextLoaderListener encodingFilterorg.springframework.web.filter.CharacterEncodingFilterencodingUTF-8encodingFilter/* CXFServlet org.apache.cxf.transport.servlet.CXFServlet 1 CXFServlet /webservice/* 上述标记的地方，第一处是spring配置文件路径；第二出是wsdl地址内容；第三步，编写接口类与实现类，注意注解接口类WebServicepublic interface SendService public boolean sendOA(WebParam(name=param)String param);public boolean sendOrg(OrgEntity org);实现类WebService(endpointInterface=com.service.SendService,serviceName=sendService)public class SendServiceImpl implements SendServicepublic boolean sendOA(String param) System.out.println(-sendOA-param:+param);if(param.equals(zhoujian)return true;return false;public boolean sendOrg(OrgEntity org) System.out.println(-sendOrg-begin-);return true;第四步，Spring配置文件 !- -“jaxws:client”该标签可以不必写，访问时可以手动拼接该url第五步，发布，直接部署到服务器，访问：1:9080/Wb/webservice/sendServie?wsdl2. Xfire方式据说xfire方式已经很老了，但个人感觉，xfire方式很简单且容易配置，不知为啥过时了，也没感觉cxf、axis2哪里先进，我当时卡在cxf与was搞不定时想尝试xfire方式被周经理给拒绝了。Xfire方式发布webservice：第一步，添加jar包，如下：第二步，修改web.xml文件 XFireServlet org.codehaus.xfire.transport.http.XFireConfigurableServlet 0 XFireServlet /services/* 第三步，编写接口类接口类：public abstract interface IBankingService public abstract String transferFunds(String paramString1);实现类：public class BankingService implements IBankingService public String transferFunds(String fromAccount) return fromAccount+:ok; 第四步，编写services.xml配置文件在WEB-INF目录下新建目录META-INF，在该目录下新建文件夹xfire，该目录下新建文件services.xmlBankingmybankcom.mybank.xfire.example.IBankingServicecom.mybank.xfire.impl.BankingService第五步，发布，部署到服务器，访问url:http:/localhost:9080/Xfire/services/Banking?wsdl3. AXIS2方式Axis2发布WebService有两种方式，其一是利用axis2插件打成aar包放到axis_war里面部署到服务器发布；其二是不打包发布（本例）；我不清楚打包发布有什么好处，感觉很麻烦项目外还得部署一个war，现在介绍第二种不打包的方式，类似xfire，同时由于cxf与was不兼容导致wsdl.jar报错，但是xfire与axis2也用到wsdl.jar却不报错，我个人也是很费解，泰康项目目前使用的就是axis2方式。Axis2发布WebService：第一步，添加jar包，如下：很多是吧，不过都是从axis.war里面WEB-INF下的lib目录复制来的。第二步，修改web.xml文件 AxisServlet org.apache.axis2.transport.http.AxisServlet 1 AxisServlet /services/* 第三步，编写实现类public class ServiceImpl public String sayHello(String name)System.out.println(=);return hello:+name;第四步，增加WEN-INF内容将axis.war解压下的WEN-INF文件夹内的conf、modules复制到项目WEB-INF下第五步，在WEB-INF下创建文件夹services（名字不可改），在该目录下创建文件夹（名称随意），在该目录下创建文件夹META-INF（名称不可改），在该目录下创建文件services.xml（名称不可改），该文件内容为： Web Service例子 com.ServiceImpl 第六步，部署到服务器，发布URL为：http:/localhost:9080/Axis2Test/services/axisDemo?wsdl4. AXIS1方式同上，不知道AXIS1哪里不好，配置也很简单，如下：第一步，添加jar包第二步，修改web.xml AxisServlet org.apache.axis.transport.http.AxisServlet AxisServlet /services/* 第三步，实现类与实体类实现类：package com;public class Axis public String sayHello(String name)System.out.println(=:+name);return hi:+name;public String sayHelloToUser(User u)System.out.println(=:+u.getId();System.out.println(=:+u.getPath();System.out.println(=:+u.getAdd();return hi:+u.getName();实体类：package com;public class User private String id;private String name;private String add;private String path; getter setter 方法第四步，创建配置文件：在WEB-INF下新建文件“server-config.wsdd” !- globalConfiguration 标签内容为系统默认 无需更改 !service 标签是需要配置的 -!name 是url中需要的参数 - !allowedMethods 的value值是方法名 可以写*- !className的value值是类路径- !wsdlTargetNamespace的wsdl文件中TargetNamespace的值- !此处很重要，若方法需要传实体类，则配置此处- !默认- 第五步，部署，同上。5. HTTPCLIENT方式Httpcilent属于一种比较简单的实现方式我们将Web Service发布在Tomcat或者其他应用服务器上后，有很多方法可以调用该Web Service，常用的有两种：1、通过浏览器HTTP调用，返回规范的XML文件内容 2、通过客户端程序调用，返回结果可自定义格式 接下来，我利用Eclipse作为开发工具，演示一个Httpclient调用WebService的简单示例步骤如下：准备工作：用到的jar包有： 下载链接（/detail/lanxuezaipiao/5354480）第一步：新建Java Project，项目名称为HttpCallWebService第二步：将所需jar包导入到库中第三步：编写调用class，这里有两种方式调用，即GET方式和POST方式，由于POST方式较安全，故这里采用POST方式调用；请求数据的构造也有两种方式：静态和动态构造，下面分别介绍这两种方式：注：这里以E邮宝开放的webservice接口为例调用其中一个API函数，而E邮宝的webservice基于SOAP，故请求数据为SOAP格式，大家可根据自己情况进行修改。静态构造请求数据：package com.http;import java.io.ByteArrayInputStream;import java.io.IOException;import java.io.InputStream;import mons.httpclient.HttpClient;import mons.httpclient.HttpException;import mons.httpclient.methods.InputStreamRequestEntity;import mons.httpclient.methods.PostMethod;import mons.httpclient.methods.RequestEntity;public class StaticHttpclientCall /* * param args * throws IOException * throws HttpException */ public static void main(String args) throws HttpException, IOException / TODO Auto-generated method stub String soapRequestData = + + + + + 123 + 123 + 123 + 123 + 123 + 123 + + + + ; System.out.println(soapRequestData); PostMethod postMethod = new PostMethod( /v3/orderservice.asmx?wsdl); / 然后把Soap请求数据添加到PostMethod中 byte b = soapRequestData.getBytes(utf-8); InputStream is = new ByteArrayInputStream(b, 0, b.length); RequestEntity re = new InputStreamRequestEntity(is, b.length, application/soap+xml; charset=utf-8); postMethod.setRequestEntity(re); / 最后生成一个HttpClient对象，并发出postMethod请求 HttpClient httpClient = new HttpClient(); int statusCode = httpClient.executeMethod(postMethod); if(statusCode = 200) System.out.println(调用成功！); String soapResponseData = postMethod.getResponseBodyAsString(); System.out.println(soapResponseData); else System.out.println(调用失败！错误码： + statusCode); 动态构造数据：package com.http;import java.io.ByteArrayInputStream;import java.io.InputStream;import java.util.HashMap;import java.util.Map;import java.util.Set;import mons.httpclient.HttpClient;import mons.httpclient.methods.InputStreamRequestEntity;import mons.httpclient.methods.PostMethod;import mons.httpclient.methods.RequestEntity;/ 动态构造调用串，灵活性更大public class DynamicHttpclientCall private String namespace; private String methodName; private String wsdlLocation; private String soapResponseData; public DynamicHttpclientCall(String namespace, String methodName, String wsdlLocation) space = namespace; this.methodName = methodName; this.wsdlLocation = wsdlLocation; private int invoke(Map patameterMap) throws Exception PostMethod postMethod = new PostMethod(wsdlLocation); String soapRequestData = buildRequestData(patameterMap); byte bytes = soapRequestData.getBytes(utf-8); InputStream inputStream = new ByteArrayInputStream(bytes, 0, bytes.length); RequestEntity requestEntity = new InputStreamRequestEntity(inputStream, bytes.length, application/soap+xml; charset=utf-8); postMethod.setRequestEntity(requestEntity); HttpClient httpClient = new HttpClient(); int statusCode = httpClient.executeMethod(postMethod); soapResponseData = postMethod.getResponseBodyAsString(); return statusCode; private String buildRequestData(Map patameterMap) StringBuffer soapRequestData = new StringBuffer(); soapRequestData.append(); soapRequestData .append(); soapRequestData.append(); soapRequestData.append(); soapRequestData.append(); Set nameSet = patameterMap.keySet(); for (String name : nameSet) soapRequestData.append( + patameterMap.get(name) + ); soapRequestData.append(); soapRequestData.append(); soapRequestData.append(); soapRequestData.append(); return soapRequestData.toString(); /* * param args * throws Exception */ public static void main(String args) throws Exception / TODO Auto-generated method stub DynamicHttpclientCall dynamicHttpclientCall = new DynamicHttpclientCall( /, GetAPACShippingPackage, /v3/orderservice.asmx?wsdl); Map patameterMap = new HashMap(); patameterMap.put(TrackCode, 123); patameterMap.put(Version, 123); patameterMap.put(APIDevUserID, 123); patameterMap.put(APIPassword, 123); patameterMap.put(APISellerUserID, 123); patameterMap.put(MessageID, 123); patameterMap.put(TrackCode, 123); String soapRequestData = dynamicHttpclientCall.buildRequestData(patameterMap); System.out.println(soapRequestData); int statusCode = dynamicHttpclientCall.invoke(patameterMap); if(statusCode = 200) System.out.println(调用成功！); System.out.println(dynamicHttpclientCall.soapResponseData); else System.out.println(调用失败！错误码： + statusCode); 最终运行结果：可见最终返回的也是xml格式的数据，这里数据未进行格式化显示和处理6. AXIS1客户端调用此处调用方式为axis1的调用，需要传递的参数可以是字符串或实体类，字符串方式：Service service = new Service();Call call = (Call) service.createCall();/wsdl地址call.setTargetEndpointAddress(new URL(wsdlUrl);/设定调用3分钟不返回则超时call.setTimeout(new Integer(180000);/命名空间(wsdl文件中的targetNameSpace属性值) 以及方法名call.setOperationName(new QName(http:/com, sayHello);/参数类型call.addParameter(name, XMLType.XSD_STRING, ParameterMode.IN);/返回值类型call.setReturnType(XMLType.XSD_STRING);/参数值String retXML2 = (String) call.invoke( new Object yczhang );System.out.println( retXML2);实体类方式（调用axis2的接口有点问题）：UserEntity userEntry = new UserEntity();userEntry.setId(yczhang);userEntry.setName(yczhang);Service service = new Service();Call call = (Call) service.createCall();/wsdl地址call.setTargetEndpointAddress(new URL(wsdlUrl);/设定调用3分钟不返回则超时call.setTimeout(new Integer(180000);/命名空间(wsdl文件中的targetNameSpace属性值) 以及方法名call.setOperationName(new QName(http:/com, sayHelloToUser);/注册SimpleObject的序列化类型QName qn = new QName(urn:BeanService, UserEntity);call.registerTypeMapping(UserEntity.class, qn, new BeanSerializerFactory(UserEntity.class, qn), new BeanDeserializerFactory(UserEntity.class, qn);/参数类型（可省略）call.addParameter(requestParam, org.apache.axis.encoding.XMLType.XSD_ANYTYPE, ParameterMode.IN);/返回值类型call.setReturnType(XMLType.XSD_BOOLEAN);Boolean retXML1 = (Boolean) call.invoke( new Object userEntry );System.out.println( retXML1);注意，实体类方式，当调用的是由axis2方式所发布的接口时，容易出现问题，表现在所传递的实体类的属性内容为null，但在该实体类内新建一属性传如该值时，却有值。应该是axis1对axis2的不兼容问题。并且调用axis2的接口时，需要在客户端写出namespace，即：/call.setOperationName(new QName(http:/localhost:9080/WS_Axis/serv