axis+webservice教程.doc

利用AXIS开发Webservice(一) 如何发布自己的webservice 先介绍下本人开发环境吧。 JDK 1.4.2 + Myeclipse 6.0（实在经不起诱惑，尝尝鲜） + Tomcat 5.0.28 + AXIS 1.4。 AXIS 1.4包可以在/axis/找到。 假设所有的环境你已经搭好，并且AXIS包也已经下好了。OK， Here we go 解压axis-bin-1_4.zip这个包可以看到webapps目录，双击进入把里面的AXIS文件夹拷到 %TOMCAT_HOME%webapps目录下，之后拷贝activation.jar、mail.jar、tools.jar到%TOMCAT_HOME%webappsaxisWEB-INFlib目录下。启动tomcat，访问http:/localhost:8080/axis/happyaxis.jsp 如果访问成功，恭喜你！基本的配置你已经做完了。 PS：此处的%TOMCAT_HOME%指的是Tomcat的安装目录，至于那另外的三个jar包，J2EE 1.4库里就能找的到。 现在来说一下最关键的Webservice的发布。AXIS提供了两种发布方式，一种是即时发布（Instant Deployment），另外一种是定制发布（Custom Deployment）。即时发布提供了一种非常简单的webservice的发布方式，但是其中限制太多，因此在实际的开发中定制发布才是首选。这里也将会以定制发布为重点来介绍。 1.即时发布 JWS (Java Web Service) Files - Instant Deployment 即时发布提供了一种非常简单发布方式，发布者只要有Java源代码（也就是.java文件），然后把其后缀名改成jws（也就是 java web service的缩写）拷贝到%TOMCAT_HOME%webappsaxis目录下即完成了所有的发布工作。AXIS的编译引擎会处理接下来的所有事情。下面是一段示例代码：java 代码public class HelloAXIS public String Hello(String name) return AXIS say hello to + name; 把 HelloAXIS.java 文件改成 HelloAXIS.jws 然后拷贝到%TOMCAT_HOME%webappsaxis目录下，启动Tomcat之后访问 http:/localhost:8080/axis/HelloAXIS.jws 如果能看到 Click to see the WSDL这个超链接就说明已经发布成功了，点击进去就可以看到这个Webservice的WSDL描述文件。server端的发布已经完成了，接下来就是编写Client端测试代码了。java 代码package com.chnic.test; import .URL; import space.QName; import org.apache.axis.client.Call; import org.apache.axis.client.Service; public class Test public static void main(String args) throws Exception String targetEendPoint = http:/localhost:8080/axis/HelloAXIS.jws; Service service = new Service(); Call call = (Call) service.createCall(); call.setOperationName(new QName(targetEendPoint, Hello); call.setTargetEndpointAddress(new URL(targetEendPoint); String result = (String) call.invoke(new ObjectRobert); System.out.println(result); 测试代码很简单，如果熟悉java反射机制的朋友不用两分钟就能看明白。运行后客户端控制台出现 AXIS say hello Robert。测试成功。果然很简单吧。不过在这简单背后却是以牺牲灵活性为代价的。假如你现在手里只有.class 或者一个jar包，jws就不再能满足你的需求了，最要命的就是即时发布不支持带包的类，这点AXIS的用户手册上写的也很明白。 Important: JWS web services are intended for simple web services. You cannot use packages in the pages, and as the code is compiled at run time you can not find out about errors until after deployment. Production quality web services should use Java classes with custom deployment. 2.定制发布 Custom Deployment - Introducing WSDD 比起即时发布定制发布更加烦琐也更复杂，但是换来的却是更大的灵活性，因此在实际项目中定制发布还是不二的选择。定制发布需要你自己编写一个WSDD（Web Service Deployment Descriptor）文件，这个东东类似与XML稍后会做出介绍。废话不多说，我们来看代码： java 代码package com.chnic.webservice; public class HelloWorld public HelloWorld() public String hello(String str) return Hello + str; public int add(int a, int b) return a + b; 一个带包的很简单的类，在eclipse下编译后按照包名拷到 %TOMCAT_HOME%webappsaxisWEB-INFclasses 目录下。以这个类为例，拷贝完之后这个HelloWorld.class的路径就是 %TOMCAT_HOME%webappsaxisWEB-INFclassescomchnicwebservice。PS： 如果嫌这样太麻烦，可以另外建一个Java Web工程用myeclipse的发布工具发布到Tomcat之后，整体一次性拷贝到websericve的工程中。 接下来就需要编写发布文件deploy.wsdd。到%TOMCAT_HOME%webappsaxisWEB-INF 目录下建立这个文件并在其中添加如下内容：xml 代码 简单的介绍下各个节点的含义，HelloWorld当然是这个webservice的名字，后面紧跟的java：RPC指的是服务类型。这里一共有有4种类型，分别是：RPC, Document, Wrapped 和 Message。有兴趣可以看下 viders这个包和子包下面的类的API文档。之后的parameter节点第一个当然是指出具体的类，第二个从字面上也很好理解：允许调用的方法。这里的配置告诉引擎可以调用所有的public方法，当然你也可以自己指定。 编写完配置发布文件之后，cmd打开windows的控制台，进入%TOMCAT_HOME%webappsaxisWEB-INF目录下键入如下命令 java -Djava.ext.dirs=lib org.apache.axis.client.AdminClient deploy.wsdd 之后控制台返回Processing file deploy.wsdd 和 Done processing 这两段话即说明发布成功。（此时会在同级目录生成一个server-config.wsdd文件）在这里的AdminClient是AXIS提供的一个客户端管理工具。至于java.ext.dirs的含义可以去了解一下classloader和JVM类装载机制方面的知识，在这里就不多解释。 还有一点要注意的是在发布的时候Tomcat服务必须处于启动状态，否则就会抛出一堆无法连接的异常信息。发布成功之后你可以通过访问 http:/localhost:8080/axis/servlet/AxisServlet 来查看你所有的定制发布的服务。客户端测试代码String targetEendPoint = http:/localhost:8080/axis/services/HelloWorld; Service service = new Service(); Call call = (Call) service.createCall(); call.setTargetEndpointAddress(new URL(targetEendPoint); call.setOperationName(new QName(targetEendPoint, hello); String result = (String) call.invoke(new ObjectRobert); System.out.println(result); call.setOperationName(new QName(targetEendPoint, add); Integer res = (Integer) call.invoke(new Objectnew Integer(1), new Integer(2); System.out.println(The result is: + res); 运行测试代码，控制台显示 Hello Robert 和 The result is: 3 这两句话，说明发布成功。仔细观察下发现其实除了那个targetEndpoint 之外，即时发布和定制发布的客户端调用代码基本上都是一样的。定制发布的URL可以在WSDL文件里找到。 其实定制发布还有一些高级特性，这个就留到下一篇再说吧。利用AXIS开发Webservice(二) WSDD的一些高级特性1、取消发布一个webservice开篇之前先把上篇的一个遗漏补充上，上篇只讲了怎么发布一个webservice，但是如何取消没有却没有提。其实取消一个已经发布的webservce也是非常简单的，我们就拿上篇的HelloWorld来做例子吧。 发布webservice的时候我们有一个deploy.wsdd文件，当然在取消发布的时候就会有一个undeploy.wsdd文件。这个文件的内容也很简单，xml的代码如下。Xml代码 编写完这个xml文件之后，把它同样copy到%TOMCAT_HOMwebappsaxisWEB-INF目录下，然后CMD打开控制台，在控制台输入一个我们很熟悉的命令 java -Djava.ext.dirs=lib org.apache.axis.client.AdminClient undeploy.wsdd 运行之后得到如下结果说明取消发布成功 Processing file undeploy.wsdd Done processing 2、WSDD的高级特性说完取消发布之后就来说一下AXIS的一些高级特性，AXIS在编写deploy.wsdd这个文件时，每个节点下面会有这样一个子节点。Xml代码 这个节点配置着你的service object也就是你webservice服务的那个object，在后面的value里可以有三个选项request, session, or application。熟悉Jsp、Servlet、或者EJB里的SessionBean的朋友应该能很快能明白这个三个配置选项的含义。 requst：这个选项会让AXIS为每一个SOAP的请求产生一个服务对象，可以想像如果这个webservice的对象足够复杂，而且SOAP的请求过多，这个选项是非常耗费服务器性能的。session：如果选择了session，程序就会给每个调用这个webservice的客户端创造一个服务对象。application：这个选项最彪悍，程序只会在内存里new出来一个服务对象，然后为所有webservice客户端服务。很显然这个选项不能储存客户端的一些个性化数据。所以在功能性上很多时候不能满足要求。3、高级特性Handler接下来说一下Axis的Handler和Chain机制，Handler和Chain是Axis引擎提供的一个很强大的工具。假如现在客户有这样一个需求，需要记录某一个webservice被调用的次数，这个时候如果在service object里去实现这个功能不仅麻烦，而且侵入了原有的程序也会对增加原有程序的不稳定性。有了Handler我们就能见easy的解决这个问题。我们先来编写handler的代码。Java代码 package com.chnic.handler; import org.apache.axis.AxisFault; import org.apache.axis.MessageContext; import org.apache.axis.handlers.BasicHandler; public class HelloWorldHandler extends BasicHandler private static final long serialVersionUID = 1L; public void invoke(MessageContext context) throws AxisFault String status = (String) this.getOption(status); System.out.println(HelloWorldHandlers status is: + status); package com.chnic.handler;import org.apache.axis.AxisFault;import org.apache.axis.MessageContext;import org.apache.axis.handlers.BasicHandler;public class HelloWorldHandler extends BasicHandlerprivate static final long serialVersionUID = 1L;public void invoke(MessageContext context) throws AxisFault String status = (String) this.getOption(status);System.out.println(HelloWorldHandlers status is: + status); BasicHandler是一个抽象类，Axis提供了很多Handler的具体实现，BasicHandler只是其中最简单的一个。要实现一个自己的handler首先要从继承BasicHandler这个类开始并实现其中的invoke(MessageContext arg)这个方法。MessageContext可以看成是一个Axis的上下文，里面存储的是一些Axis和webservice的基本信息。想了解的朋友可以看一下Axis的API。编写完Handler代码之后我们连编写发布文件。Xml代码 发布代码中有这样的一句，细心的朋友一定会发现。Xml代码 看完这句代码再对比一下Handler的实现代码中的一句，相信大多数人都能明白了。Java代码 String status = (String) this.getOption(status); String status = (String) this.getOption(status);Handler通过getOption(String)这个方法拿到了配置文件中我配置的属性值。而我们上述所做的所有工作对于原来的Webserivce来说都是透明的，不会对侵入原有的程序当中。 一个Handler可以被多个service所使用，通过这个标签来引用到某一个service中，这里还要多提一句既然是一个requestFlow，这个当然可以加不只一个的Handler。接下来编写测试代码运行。在本地应用服务器上会打出如下语句：HelloWorldHandlers status is: session说明测试成功，而且handler是配置在requestflow标签中所以这段代码会在service代码之前先执行。4、高级特性Chain介绍完了Handler再来介绍Chain。从Chain的字面意思就能猜到他实现的一连串Handler的功能。假如某个service需要不止一个Handler，或者要根据Client的情况来选择需要那些Handler。特别是后一个需求，我们无法用一个或者几个Handler来解决，这个时候我们就需要来实现了。我们先再编写一个Handler，加上之前的那个Handler我们来组成一条锁链。Java代码 package com.chnic.handler; import org.apache.axis.AxisFault; import org.apache.axis.MessageContext; import org.apache.axis.handlers.BasicHandler; public class MyHandler extends BasicHandler private static final long serialVersionUID = 1L; public void invoke(MessageContext context) throws AxisFault System.out.println(This is MyHandler.); 之后我们编写Chain的代码Java代码 package com.chnic.chain; import org.apache.axis.SimpleChain; import com.chnic.handler.HelloWorldHandler; import com.chnic.handler.MyHandler; public class HelloWorldChain extends SimpleChain private static final long serialVersionUID = 1L; public HelloWorldChain() HelloWorldHandler hwh = new HelloWorldHandler(); MyHandler mh = new MyHandler(); this.addHandler(hwh); this.addHandler(mh); 在Chain的构造函数中，把我要的两个Handler用addHandler()方法加载进去。之后我们来编写发布文件。和元素有些许不同在这里有必要多句嘴。元素中的子元素只允许是或者。后者也就是允许在“锁链”里再嵌套“锁链”，在这里就拿嵌套来举例，他同样有两种方式来实现。第一种是直接包含: Xml代码 第二种是引用别的Xml代码 因为我们这里的Handler并没有由BasicHandler来实现，而是由继承SimpleChain这个类来实现，严格意义上讲，SimpleChain也可以算是一个Handler，因为SimpleChain也是从BasicHandler继承而来，他同样实现了invoke()这个方法。下面回归正题，来看我们的发布代码。Xml代码 从新发布webservice之后，运行我们的测试代码。会发现在应用服务器的本地控制台上打出两句Handler要输出的语句，说明测试成功。而且控制台打出语句的顺序是和我们加载handler的顺序一样的。 除了之外，Axis还提供了与之相应的，用法和是requestflow一样的，所不同的是一个在service执行之前一个是之后。可以加下面代码到发布文件中的元素下就可以实现responseflow的功能Xml代码 最后简单提一下远程管理，也就是Remote Administration。要实现远程管理在发布文件的标签下加入下面一段语句就可以了。Xml代码 不过远程管理会有安全方面的问题，所以不建议使用。 一些高级部分就先说到这里，还有一些比如RPC docuement Wrapped Message的区别和使，如何传递一个Javabean，还有一些配置方面的的问题就留到下节说吧。利用AXIS开发Webservice(三) 如何传递javabean和你的对象在第一篇介绍Axis的文章里，我们做了一个简单的webservice，我们client side传递了String和int类型的数据给service object。Service处理之后返回处理结果给Client。对于大多数需求，那个demo显然已经足够应付了。但是如果client端需要传输一个对象给server，那么那个demo就显得力不从心了。Axis中提供了远程传输对象的方法，通过那些方法我们同样可以随心的传递自己的对象。 我们先从传递一个JavaBean开始，首先编写一个JavaBean。Java代码 package com.chnic.bean; public class OrderBean private String name; private int age; private String items; private int price; private boolean checked; public OrderBean() public int getAge() return age; public void setAge(int age) this.age = age; public boolean isChecked() return checked; public void setChecked(boolean checked) this.checked = checked; public String getItems() return items; public void setItems(String items) this.items = items; public String getName() return name; public void setName(String name) = name; public int getPrice() return price; public void setPrice(int price) this.price = price; 这个JavaBean的前4个属性都很清楚，要解释一下最后一个。因为这个JavaBean被传递到Service端处理之后要接着被传回，用来示例webservce传进和传出。这个变量用来区别传进和传出的差别。解释完我们来看下serviceJava代码 package com.chnic.webservice; import com.chnic.bean.OrderBean; public class AnalyzeOrder public AnalyzeOrder() public OrderBean process(OrderBean order) order.setChecked(true); System.out.println(name: + order.getName() + age: + order.getAge(); for(int i=0; iorder.getItems().length; i+) System.out.println(Item + (i+1) + order.getItems()i + and price is + order.getPrice()i); return order; Service Object的代码很简单，就不解释了。惯例，我们来编写发布文件。Xml代码 唯一不同的就是多了这个节点。qname 表示 XML 规范中定义的限定名称，他由名称空间 URI、本地部分和前缀组成。除了本地部分其他都不是必须的,另外QName是不可变的。xmlns后面的myNS是必须的。具体根据前面所指定的qname来决定。之后可以随意命名一个namespace。最后的languageSpecificType指定的是你传递的对象类型。第一个属性的本地部分和第二个节点你自定义的命名空间会组成一个新的QName，并将你要传输的对象mapping是上去。 发布这个webservice，编写测试代码Java代码 String targetEendPoint = http:/localhost:8080/axis/services/CheckOrder; OrderBean order = new OrderBean(); order.setName(Beckham); order.setAge(32); String items = new String Ipod, ThinkPad ; int price = new int 999, 5000 ; order.setItems(items); order.setPrice(price); order.setChecked(false); System.out.println(order.isChecked(); Service service = new Service(); Call call = (Call) service.createCall(); QName qn = new QName(urn:AnalyzeOrder, Order ); call.registerTypeMapping(OrderBean.class, qn, new org.apache.axis.encoding.ser.BeanSerializerFactory(OrderBean.class, qn), new org.apache.axis.encoding.ser.BeanDeserializerFactory(OrderBean.class, qn); call.setTargetEndpointAddress( new .URL(targetEendPoint) ); call.setOperationName( new QName(CheckOrder, process) ); call.addParameter( arg1, qn, ParameterMode.IN ); call.setReturnClass(OrderBean.class); OrderBean result = (OrderBean) call.invoke( new Object order ); System.out.println(Success.); System.out.println(result.isChecked() 从控制台输出一些信息以便测试，里面大多代码都应该见过。new QName和之后的registerTypeMapping方法也是在实现我上面那段黑体字的内容。之后注册完参数和返回值类型运行。会发现在tomcat控制台和本地控制台都会输出测试结果，值得注意的是checked这个属性在传入之前是false属性，传入之后我们改变了他的属性变为true。返回之后在本地控制台打印出来也为true。 事实上Axis除了可以传输JavaBean之外还可以传输一些自定义的类型。比如List、Map和时间日期类型。Axis也为他们提供了专门的SerializerFactory和DeserializerFactory。这些工厂类会产生串行化工具去序列化相应的对象。更多的Factory Object可以在org.apache.axis.encoding.ser下面找到。 对于自定义序列化，Axis也提供了相对性的配置节点。具体配置如下：Xml代码 typeMapping的前三个属性和上面讲的beanMapping都一样。不一样的是后三个。serializer指定的是串行化类，dserializer指定的是反串行化类。最后一个指定的编码方式。其实对于typeMapping来说beanMapping只不过是他的一个简化版而已。因为beanMapping的串行化和反串行化工厂类都是固定的，而编码方式也是固定的。 因为typemapping和beanMapping很相似，在这里就不再写demo了。 有些人也许会问，既然能串行化对象那能不能“串行化”文件呢？利用AXIS开发Webservice(四) 如何抛出自定义异常上一篇介绍了如果在Server和Client端传递一个自己的对象。有些人也许会问传递异常行不行？答案是可以。只不过传递异常的配置要稍微复杂一些。空口无凭，我还是用点代码来说明。今天的例子稍微复杂点，用一下数据库(MySQL)。首先创建表和输入测试数据。Sql代码 create table users(id integer primary key, name varchar(20) not null); insert into users values(1, Lincoln),(2, Michael),