axis2创建webservice操作手册

搭建WebService操作手册 2020-07-15 修订记录 日期 版本 描述 2020年07月15日 创建 结合网上资料和开发经验，阐述webservice工作原理和使用axis2框架创建搭建webservice环境。 1.引言4 1.1 目的4 1.2 为什么要使用WebService4 1.3 什么是WebService4 1.4 WebService WSDL SOAP关系5 1.5 Web Service服务器工作流程5 1.6 Web Service客户端工作流程6 2.系统所需环境6 3.构建WebService服务器6 3.1 使用AXIS2构建WebService服务器6 3.1.1 POJO方式6 3.1.2 使用框架构建webservice11 3.1.3 使用独立安装模式20 4. 构建WebService客户端21 4.1.1 使用插件创建WebService客户端21 1.引言 1.1 目的 本操作手册具体介绍了WebService的工作原理并详细描述了使用axis2构建WebService的流程，主要面向刚刚接触WebService的开发人员。 1.2 为什么要使用WebService WebService是一个新的概念，它并不是微软首先提出的，但是微软的dotnet战略让它最广泛的发挥它的潜能。也许它流行的根本原因并不是微软，也许是因为带宽与存储量的飞速发展，但是dotnet战略确实起到了很大的作用，令它能够在更加广泛的开发平台上施展。dotnet战略领导着微软前进，微软为了dotnet计划也花费了近300亿美元。为什么？因为微软要它的理念、方式不但在单机软件，甚至在Internet上也被最广泛的认同。WebService最早被应用在Sun等对网络先知先觉的平台上，并且在苦苦的期待发展。而J2EE是最早的成功开发WebService的平台，它的理念就是在网上最广泛的传播、使用，成为一种真正的服务。当微软的dotnet计划即将实施的时候，微软也开始发掘WebService的潜力。今天的 Web 站点仅能为浏览器提供用户界面，而下一代可编程 Web 站点直接将企业、应用程序、服务和设备彼此链接。这些可编程 Web 站点将不只是被动访问的站点，而将成为可重用的智能 Web 服务。因此我们要使用WebService才能适应将来的发展趋势。一句话：为了顺应时代的发展。 1.3 什么是WebService W3C组织对其的定义如下，它是一个软件系统，为了支持跨网络的机器间相互操作交互而设计。Web Service服务通常被定义为一组模块化的API，它们可以通过网络进行调用，来执行远程系统的请求服务。 这里我们从一个程序员的视角来观察web service。在传统的程序编码中，存在这各种的函数方法调用。通常，我们知道一个程序模块M中的方法A，向其发出调用请求，并传入A方法需要的参数P，方法A执行完毕后，返回处理结果R。这种函数或方法调用通常发生在同一台机器上的同一程序语言环境下。现在的我们需要一种能够在不同计算机间的不同语言编写的应用程序系统中，通过网络通讯实现函数和方法调用的能力，而Web service正是应这种需求而诞生的。 简单理解：Web Service 就是一个网络组件（一个可以通过网络访问的程序）。 它有一个或多个端口（Port），这些端口用于接收客户端的请求，并返回响应 请求和响应的 都是一种基于XML的消息。不过这种消息遵循特定的格式（SOAP ）。 1.4 WebService WSDL SOAP关系 Web Service = SOAP + HTTP + WSDL。其中，SOAP Simple Object Access Protocol）协议是web service的主体，它通过HTTP或者SMTP等应用层协议进行通讯，自身使用XML文件来描述程序的函数方法和参数信息，从而完成不同主机的异构系统间的计算服务处理。这里的WSDL（Web Services Description Language）web 服务描述语言也是一个XML文档，它通过HTTP向公众发布，公告客户端程序关于某个具体的 Web service服务的URL信息、方法的命名，参数，返回值等。 SOAP格式数据： 张三 1.5 Web Service服务器工作流程 ? 监听网络端口（监听服务端口） ? 接收客户端请求（接收SOAP请求） ? 解析客户端请求（解析SOAP消息，将SOAP消息转换为数据对象） ? 调用业务逻辑 （调用Web Service实现类的特定操作，参数是由SOAP消息 转换而来的数据对象） ? 生成响应 （将返回值转换为SOAP消息） ? 返回响应 （返回SOAP响应） 1.6 Web Service客户端工作流程 ? 构造SOAP请求消息（将本地数据对象转换为SOAP消息） ? 发送SOAP消息到Web Service服务器的指定端口 ? 接收SOAP响应消息 ? 将SOAP响应消息转换为本地数据对象 2.系统所需环境 ? JDK1.4以上版本 ? 设置JAVA_HOME环境变量 ? ANT必须是1.6.5以上版本 ? 设置AXIS2_HOME环境变量，指向安装跟目录 ? 在path路径下添加：%AXIS2_HOME%\bin\ 3.构建WebService服务器 3.1 使用AXIS2构建WebService服务器 ? POJO ? Eclipse插件 3.1.1 POJO方式 1、 下载所需的包：axis2 的2进制的包和axis2.war 下载地址：http://ws.apache.org/axis2/download/1_5_2/download.cgi 2、 将下载的axis2.war,放置到tomcat的webapps目录下，启动tomcat，此时webapps目录会自动解压出axis2目录，如下图所示 此时，在浏览器中输入：http://localhost:8080/axis2/，如果一切正常将会看到如下界面 3、 编写服务器端代码 启动Eclipse，选择File---->New--->Project，打开新建项目向导，如下图所示： 4、 选择Java Project,点击Next，打开新建项目窗口，为新建项目命名，这里命名为：4thWebService，如下图所示： 5、 点击Finish完成项目创建。 6、 编写服务器端代码 选择File--->New---->Class,为新建的不含任何报名的类，命名为：myWebService,如下图所示： 7、 点击Finish,编写代码，代码如下 public class MyWebService { public String helloWebService(String name) { return name + “ ,this is WebService ^-^“; } } 8、将编译后的MyWebService .class放置到tomcat的webapps\axis2\WEB-INF\pojo（没有pojo文件夹的需要手动创建该文件夹）目录下 9、在地址栏中输入： http://localhost:8080/axis2/services/MyWebService?wsdl，如果创建成功，将会看到如下界面： 使用POJO方式搭建Web Service优缺点 优点：简单 缺点：服务器端java类不能含有包名 3.1.2 使用框架构建webservice 1、 下载所需的包（方法参考3.1.1 POJO方式中的1 2） 2、下载Axis2_Codegen_Wizard_1.3.0，Axis2_Service_Archiver_1.3.0并解压插件到eclipse的plugins目录下，启动eclipse(下载地址略) 3、编写服务器端代码 选择File--->New---->Class,为新建的类，包名命名为：gongqiang,类名命名为：myWebService,如下图所示： 4、点击Finish,编写代码，代码如下 package gongqiang; public class MyWebService { public String helloWebService(String name) { return name + “ ,this is WebService ^-^“; } } 5、新建项目，FILE---->NEW---->OTHER,选择Axis2 Service Archiver ,如下图 6、点击Next进入下一个设置页面 7、在该页面中设置你的JAVA类编译后存放的CLASS目录，记住这里的目录不需要包括JAVA包，点击next进入下一个设置页面 8、选择第一个SkipWSDL，点击Next进入下一页，该页我们不设置，再点击Next，进入如下页面 9、 点击Next,出现如下页面 10、面中填入ServiceName，ClassName（你将要作为webservice暴露的JAVA类的全路径），点击load 选择Search declared methods only只显示你定义的方法，然后在列表中选择你需要暴露的方法，点击next,出现如下图 11、点击finish，出现如下图表示生成服务器端成功。 12、 将生成的loginService放置到tomcat的ebapps\axis2\WEB-INF\services目录下，如下图 13、在地址栏中输入： http://localhost:8080/axis2/services/myService2?wsdl，如果创建成功，将会看到如下界面： 3.1.3 使用独立安装模式 1、 修改配置文件：axis2二进制文件下面的axis2-1.5.2\conf\axis2.xml 8060 端口号修改为：8060（防止与tomcat冲突） 2、 运行axis2server.bat（位于axis2二进制文件下面的axis2-1.5.2\bin目录下） 3、 浏览器中输入：http://localhost:8060/axis2/services/Version?wsdl，可以看到如下界面 4. 构建WebService客户端 4.1.1 使用插件创建WebService客户端 1、 下载geronimo-stax-api_1.0_spec-1.0.1.jar，backport-util-concurrent-3.1.jar，将下载后的文件放置到eclipse安装目录的Axis2_Codegen_Wizard_1.3.0文件下（该文件夹是3.1.2 第2步中解压之后的文件夹） 2、 修改Axis2_Codegen_Wizard_1.3.0\plugin.xml文件，在该文件中添加如下代码： 3、 将文件夹Axis2_Codegen_Wizard_1.3.0重命名为Axis2_Codegen_Wizard_1.4.0 4、 启动Eclipse ，点击File---->New--->Other,弹出如下界面： 5、 选择Axis2 Code Genetator,点击Next,进入下一个设置页面，如下图： 6、 选择Generate Java source from a WSDL file,点击Next,进入下一个设置界面，如下图 7、 在上图文本框中输入wsdl地址，点击Next,进入下一设置页面，如下图： 8、 点击Next,进入下一个设置页面，如下图： 9、 点击上图的Browse，选择生成客户端代码存放位置（这里放置到桌面），点及Finish,将会看到如下操作，说明客户端创建成功 10、 将生成的两个类（这里为MyService2CallbackHandler.java、MyService2Stub.java）源文件拷贝到eclipse工作空间中，如下图： 11、 引入相关jar 包 A)点击Window---->Preferences,进入Preferences窗口，如下图 B)依此选择Java-->Build Path--->User Liberaries,点击New ,新建User Liberaries（这里命名为axis2）选中新建好的axis2库，点击import,引入jar包(axis2二进制包中lib目录下所有jar包) C)右键项目名称，选择build path---->Add Liberary弹出Add Liberary窗口，如下图 D)点击Next,选择刚刚创建的axis2 库。 12、 编写客户端实现类，代码如下 package gongqiang; public class MyClient { public static void main(String[] args) { try { MyService2Stub stub = new MyService2Stub(); // 初始化SimpleMethod方法。 MyService2Stub.HelloWebService request = new MyService2Stub.HelloWebService(); // 调用simpleMethod的setName方法。 request.setName(“gq“); System.out.println(stub.helloWebService(request).get_return()); } catch (Exception e) { e.printStackTrace(); } } } 13、 执行MyClient.class,控制台输出如下信息，说明调用服务成功 gq ,this is WebService ^-^