由于项目需要,决定学习一下接口开发,找到一个比较简单的WebService方法实践一番,并将注意点列出来,本文主要借鉴自http://www.cnblogs.com/javawebsoa/archive/2013/05/19/3087234.html的文章,谢谢原博的分享!
开发工具:tomcat6.0,myeclipse
引用包:axis2-1.6.1-war.zip(下载地址:http://download.csdn.net/detail/wenzhiyinghen/4026674)
第一步:将axis2-1.6.1-war.zip下载下来,然后将压缩包里的axis2.war放入tomcat里的webapps文件夹下面发布,启动tomcat,在webapps目录下会自动生成axis2文件夹。访问http://localhost:8080/axis2可以查看axis2运行画面
第二步:新建web项目WebServiceDemo,新建包com.web.service,新建类TestDemo并构造两个方法,代码如下:
package com.web.service;
public class TestDemo {
/*
* 新建三个服务器方法,供接口远程访问
*/
public String sayHello(String name){
return "Hello,"+name+"";
}
public String getHello(){
return "Hello World!";
}
public void getDemo(){
System.out.print("Test");
}
}
第三步:修改WEB-INF目录下的web.xml文件,代码如下:
<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
<display-name></display-name>
<!--Axis2 配置开始-->
<servlet>
<servlet-name>AxisServlet</servlet-name>
<servlet-class>org.apache.axis2.transport.http.AxisServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>AxisServlet</servlet-name>
<url-pattern>/services/*</url-pattern>
</servlet-mapping>
<!--Axis2 配置结束 -->
<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
</welcome-file-list>
</web-app>
第四步:将tomcat/webapps/axis2/WEB-INF文件夹下面的modules、service和conf文件件拷至WebServiceDemo工程下的WebRoot/WEB-INF目录下,并把tomcat/webapps/axis2/WEB-INF/lib下面所有jar包拷贝到WebServiceDemo工程下的WebRoot/WEB-INF/lib目录下。然后在services下新建TestDemo/META-INF路径,META-INF下新建services.xml文件,并添加代码,代码如下:
<?xml version="1.0" encoding="UTF-8"?>
<service name="TestDemo">
<description>
WebServiceDemo Example
</description>
<parameter name="ServiceClass">
com.web.service.TestDemo
</parameter>
<operation name="sayHello">
<messageReceiver class="org.apache.axis2.rpc.receivers.RPCMessageReceiver"/>
</operation>
<operation name="getHello">
<!--有返回值时 --><messageReceiver class="org.apache.axis2.rpc.receivers.RPCMessageReceiver"/>
<!--无返回值时 <messageReceiver class="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver"/> -->
</operation>
<operation name="getDemo">
<messageReceiver class="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver"/>
</operation>
</service>
启动tomcat后访问http://127.0.0.1:8080/WebServiceDemo/services/TestDemo?wsdl能看到服务信息就表示WebService服务已成功发布 。
第五步:客户端调用接口方法,新建TestAxis.java,代码如下:
package com.web.client;
import javax.xml.namespace.QName;
import org.apache.axis2.addressing.EndpointReference;
import org.apache.axis2.client.Options;
import org.apache.axis2.rpc.client.RPCServiceClient;
public class TestAxis {
public static String sendService(String xmlStr,String url,String method){
String xml=null;
try {
RPCServiceClient serviceClient=new RPCServiceClient();
Options options=serviceClient.getOptions();
EndpointReference targetEPR=new EndpointReference(url);
options.setTo(targetEPR);
//在创建QName对象时,QName类的构造方法的第一个参数表示WSDL文件的命名空间名,也就是<wsdl:definitions>元素的targetNamespace属性值
QName opAddEntry=new QName("http://service.web.com",method);
//接口方法调用的参数,如果有多个,继续往后面增加即可,不用指定参数的名称
Object[] opAddEntryArgs=new Object[]{xmlStr};
//接口方法的返回值类型
Class[] classes=new Class[]{String.class};
// invokeBlocking方法有三个参数,其中第一个参数的类型是QName对象,表示要调用的方法名;
// 第二个参数表示要调用的WebService方法的参数值,参数类型为Object[];
// 第三个参数表示WebService方法的返回值类型的Class对象,参数类型为Class[]。
// 当方法没有参数时,invokeBlocking方法的第二个参数值不能是null,而要使用new Object[]{}
// 如果被调用的WebService方法没有返回值,应使用RPCServiceClient类的invokeRobust方法,
xml=(String)serviceClient.invokeBlocking(opAddEntry, opAddEntryArgs, classes)[0];
System.out.println(xml);
} catch (Exception e) {
e.printStackTrace();
long end=System.currentTimeMillis();
}
return xml;
}
public static void main(String[] args) {
String xmlStr="Wade";
String url="http://127.0.0.1:8080/WebServiceDemo/services/TestDemo";
String method="sayHello";
TestAxis.sendService(xmlStr,url,method);
}
}
结果输出Hello,Wade
整体实现都比较简单,主要注意三个地方:
1:services.xml里面的<service name="TestDemo">
name必须与你开放调用的类名一致,如果不一致,会报javax.servlet.ServletException: File "/axis2-web/listSingleService.jsp" not found错误。
2:services.xml配置中operation标签下当接口方法有返回值时用<messageReceiver class="org.apache.axis2.rpc.receivers.RPCMessageReceiver"/>
没有返回值时用<messageReceiver class="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver" />
3:接口方法调用时当接口方法没有返回值,我们要采用RPCServiceClient的invokeRobust(QName, new Object[]{..})方法,当有返回参数的时候需采用RPCServiceClient的invokeBlocking(QName, new Object[]{..},new Class[]{..})方法。