用JAX-RPC开发Web服务: Servlet作�ؓWeb服务端点

Fri, 23 Jun 2006 03:01:00 GMT

关键�?/strong>�Q?JAX-RPC web服务
阅读本文前您需要以下的知识和工��P��
JavaTM Web Services Developer Pack 1.1�Q��ƈ且会使用初步使用�Q?
辽倩崾褂靡恢諩JB容器来开发、部�|�EJB�Q��ƈ且了解怎么在客��L��讉K��EJB�l��g�Q?
对Apache axis Web服务开发工��h��基本的了解；
基本的Java�~�程知识�?
如果使用JAX-RPC开发Web服务�Q�我们几�U�选择�Q?/p>
Servlet作�ؓWeb服务端点�Q?
无状态会话Bean作�ؓWeb服务端点�Q?
��Z��消息�Q�如JMS�Q�的应用�E�序作�ؓWeb服务端点�?
本文以Servlet作�ؓWeb服务端点的情冉|��介绍JAX-RPC Web服务开发，关于本篇文章中案例的介绍详见本系列文章第一��：《用JAXM开发Web服务�?/a>�?
本文的参考资料见参考资�?/a>
本文的全部代码在�q�里下蝲
JAX-RPC快速入�?/span>
JAX-RPC�Q�Java�?API for XMLbased RPC�Q�顾名思义�Q�它是一�U�远�E�方法调用（或者说�q�程�q�程调用�Q�，那么它和其它的远�E�方法调用（RPC�Q?COM�Q�CORBA�Q�RMI�Q�有什么区别呢�Q�我们看一般的�q�程�Ҏ��调用的结构，如图1所�C��?/p>

�l�合比较常用的远�E�方法调用技术，它们有以下的共性：
在客��L��和服务端有通用�~�程接口�Q?
在客��L��有Stub�Q�在服务端有Tie�Q�有的叫Skeleton�Q�；
客户端和服务端有专门的协议进行数据传输�?
对于通用接口的描�q�ͼ�比如CORBA有IDL of CORBA�Q�Java RMI有Java RMI interface in RMI�Q�对于XMLbased RPC来说�Q�IDL��是WSDL�Q�Web服务描述语言�Q�。那么XMLbased RPC来说�Q�什么是�q�个�l�构中的"传输协议"�Q�当然是SOAP�Q�SOAP消息通过以传输文本�ؓ基础的协议（HTTP、SMTP、FTP�Q��ؓ载体来��用的�Q�也��是��_��SOAP消息的传输徏立在HTTP、SMTP、FTP传输协议之上�?/p>
JAX-RPC的构架如下�?/p>

从上囑֏�以看出，客户端调用的是JAX-RPC服务端点(Service Endpoint)�Q�这个服务端�Ҏ��通过WSDL语言描述的。在�q�个体系�l�构中，对于客户端，可以是JS2E、J2ME或者J2EE�q�_��q�行环境�Q�对于服务端�Q�可以是J2EE1.3或者J2EE1.4容器�Q�Servlet容器或者EJB容器�Q�。Apache axis是一个很好的JAX-RPC�q�行环境实现�Q�同时也提供了优�U�的开发工��P��本文��用它�q�行开发�?/p>
使用Servlet作�ؓ服务端点�Q�本案例的基本构架如下图所�C��?/p>

客户端通过SOAP消息和JAX-RPC服务端交互，JAX-RPC服务端运行在Servlet容器中，它通过调用EJB容器中的EJB�l��g来处理具体的业务逻辑�?/p>
使用JAX-RPC开发Web服务�Q�可以按照以下的步骤�q�行�Q?/p>
服务端点定义�Q?
服务描述�Q?
服务端点实现�Q?
服务端点部��v�Q?
服务发布和发现�?
注意�Q�对于服务的发布和发玎ͼ��׃��机制比较复杂�Q�本文不讨论�Q�可能会在本�p�d��文章�q�行专题讨论�?/p>
开发快速入�?/span>
一个完整的JAX-RPC开发实例，��按照上面的5个步骤进行，但是我们也可以��用非常简单的方式来发布一个Web服务。在介绍我们的案例前�Q�让我们用一分钟快速开发一个Web服务�?/p>
首先安装好JWSDP�Q�你可以�?http://java.sun.com/webservices下蝲�?
把本案例源代码中的\src\bookservice.ear\web.war目录拯��?JWSDP_HOME%\webapps目录下，web.war文�g里已�l�包括了Apache axis�q�行环境�?/p>
�?JWSDP_HOME%\classes目录下新��Z��个HelloWorld.java文�g�Q�它的代码如下：
例程1 最��单的Web服务HelloWorld
package com.hellking.webservice; public class HelloWorld { public String sayHello(String name) { return "Hello! "+name; } }
�~�译�q�个�c�，然后�~�辑%JWSDP_HOME%\webapps\WEB-INF\server-config.wsdd文�g�Q�找到记�Q�在其后面加入以下内容：
在浏览器例输入：
http://localhost:8080/web/services/HelloWorld?wsdl
如果出现部��vWSDL描述文�g�Q�那么最��单的Web服务已经部��v成功�Q?/p>
下面我们使用最��单的方式来调用这个Web服务�Q�在��览器里输入�Q?/p>http://localhost:8080/web/services/HelloWorld?wsdl&method=sayHello&name=hellking
那么在浏览器��会昄��以下内容�Q?/p>
例程2 在浏览器里调用Web服务
Hello! hellking
如果�l�果是这��P��那么最��单的Web服务已经部��v成功�Q��ƈ且测试也通过了。注�?Hello�Q�hellking"是调用Web服务�q�回的结果，它是我们期望的。下面我们来看一个完整的Web服务开发的例子�?/p>
服务端点定义
服务端点定义的工作主要是��定"服务定义接口"�Q�Service Definition Interface�Q�，有时也叫Web服务端点接口�Q�Web services endpoint interface�Q�。服务端点定义有两中�Ҏ��获得�Q?/p>
使用某些工具从WSDL文�g获得�Q?
直接使用Java语言�~�写�?
Apache axis提供了从WSDL文�g中获得Web服务端点的工兗��您可以�q�样使用�Q?/p>
java org.apache.axis.wsdl.WSDL2Java (WSDL-file-URL)
使用�q�个命��o前先讄��好以下的环境变量�Q�后面的介绍中还会��用axis工具�Q�它们也要这栯��|�环境变量：
SET AXIS_HOME= set CLASSPATH=%CLASSPATH%; %AXIS_HOME%/axis-1_1/lib/axis.jar; %AXIS_HOME%/axis-1_1/lib/jaxrpc.jar; %AXIS_HOME%/axis-1_1/lib/saaj.jar; %AXIS_HOME%/axis-1_1/lib/commons-logging.jar; %AXIS_HOME%/axis-1_1/lib/commons-discovery.jar; %AXIS_HOME%/axis-1_1/lib/wsdl4j.jar;.
关于WSDL2Java的更详细的��用，请参考Apache axis的User Guides�Q?http://ws.apache.org/axis/�Q��?
我们�q�里直接使用Java�~�写服务端点接口的方法。在本案例中�Q�定义了三个业务�Ҏ��Q�它们分别是查找所有的图书、按书名查找图书、按�c�d��查找图书。那么安照这三个业务�Ҏ��Q�可以定义出以下的服务端�Ҏ��口：
例程3 服务端点定义�Q�BookServiceInterface.java�Q?/p>
package com.hellking.webservice.servlet; /** *@author hellking */ import java.util.Collection; import com.hellking.webservice.BookVO; public interface BookServiceInterface { /** * @return Vector */ public Collection getAllBooks();//查找所有的图书 /** * @param name * @return BookVO */ public BookVO getTheBookDetail(String name);//按照书名查找图书 /** * @return Collection */ public Collection getBookByCategory(String category);//按类别查�? }
上面代码中的BookVO是一个序列化的对象，它有以下属性，每个属性都提供了getter和setter�Ҏ��?/p>
例程4 BookVO的部分代�?/p>
public class BookVO implements java.io.Serializable { private String name; private String publisher; private float price; private String isbn; private String description; private String category; private Collection authors; public void setName(String name) { this.name=name; } public String getName() { return this.name; } �? }
�~�译好这两个�c�R�?/p>
服务端点描述
可以使用Java2WSDL从以上定义的服务端点接口中获得服务描�q�ͼ�WSDL文�g�Q�。��用Apache axis工具�Q�只要��用以下命令即可：
java org.apache.axis.wsdl.Java2WSDL -o temp.wsdl -l"http://localhost:8080/axis/services/BookServletService" -n "urn:BookServletService" -p"com.hellking.webservice" "urn:BookServletService" com.hellking.webservice.servlet.BookServiceInterface
以上命��o的解释：
-o�Q�生成的WSDL文�g�Q? -l�Q�Web服务的位�|�； -n�Q�这个WSDL文�g的名字空��_�� -p�Q�包到名字空间的映射�Q?
最后一个参数是Web服务端点接口�?/p>
使用以上命��o后，��生成一个名为temp.wsdl Web服务描述文�?/p>
服务端点实现
有了服务描述文�g�Q�就可以使用它来生成JAX-RPC 的框�Ӟ��q�个框架使得我们�~�程变得��单，当然您也可以直接�~�写实现代码�Q�然后部�|Ԍ��但是那样�~�程会变得困难�?/p>
使用以下的命令就可以生成�q�个框架�Q?/p>
java org.apache.axis.wsdl.WSDL2Java -o . -d Session -s -S true -Nurn:BookServletService com.hellking.webservice.servlet temp.wsdl
使用�q�个命��o后将生成以下文�g�Q?/p>
BookServiceInterface.java�Q�新的BookServiceInterface接口�Q�它扩展了java.rmi.Remote接口�Q?/p>
BookServiceInterfaceService.java�Q�客��L��服务接口�Q�用来获得BookServiceInterface对象的引用；
BookServiceInterfaceServiceLocator.java�Q�在客户端��用，主要用来服务定位�Q?/p>
BookServletServiceSoapBindingImpl.java�Q�服务端实现�c�，它实��C��BookServiceInterface接口�Q�服务端的业务方法实��C��码就在这里编写；
BookServletServiceSoapBindingSkeleton.java�Q�服务端Skeleton�Q?/p>
BookServletServiceSoapBindingStub.java�Q�客��L��Stub�Q?/p>
BookVO.java�Q�新的BookVO序列化对象；
deploy.wsdd�Q�部�|�这个Web服务的脚本；
undeploy.wsdd�Q�卸载这个Web服务的脚本�?/p>
服务端点实现�cȝ��基本框架已经生成出来了，我们的�Q务就是往里面增加具体的业务内宏V��下面我们来看具体的服务端点的实现。如例程3所�C��?/p>
例程5 服务端点实现�c?/p>
package com.hellking.webservice.servlet; import java.util.*; import javax.naming.*; import com.hellking.webservice.ejb.*; public class BookServletServiceSoapBindingImpl implements com.hellking.webservice.servlet.BookServiceInterface{ InitialContext init=null; BookServiceFacadeHome facadeHome; public BookServletServiceSoapBindingImpl() { try { init=new InitialContext(); } catch(Exception e) { } } //业务�Ҏ��Q�查找所有的图书 public java.lang.Object[] getAllBooks() throws java.rmi.RemoteException { System.out.println("getAllBooks"); try { Object objref = init.lookup("ejb/bookfacade"); facadeHome = (BookServiceFacadeHome)javax.rmi.PortableRemoteObject.narrow( objref, BookServiceFacadeHome.class); Collection result=facadeHome.create().getAllBook(); System.out.println(result.size()); Object[] ret=new Object[result.size()]; Iterator it=result.iterator(); int i=0; while(it.hasNext()) { ret[i++]=it.next(); } // System.out.println(((BookVO)ret[0]).getName()); return ret; } catch(Exception e) { e.printStackTrace(); return null; } } //业务�Ҏ��Q�按书名查找图书 public com.hellking.webservice.BookVO getTheBookDetail(java.lang.String in0) throws java.rmi.RemoteException { com.hellking.webservice.BookVO ret=null; try { Object objref = init.lookup("ejb/bookfacade"); facadeHome = (BookServiceFacadeHome)javax.rmi.PortableRemoteObject.narrow( objref, BookServiceFacadeHome.class); Collection result=facadeHome.create().getBookDetail(in0); Iterator it=result.iterator(); while(it.hasNext()) { ret=( com.hellking.webservice.BookVO)it.next(); } } catch(Exception e) { } return ret; } //业务�Ҏ��Q�按�c�d��查找图书 public java.lang.Object[] getBookByCategory(java.lang.String in0) throws java.rmi.RemoteException { try { Object objref = init.lookup("ejb/bookfacade"); facadeHome = (BookServiceFacadeHome)javax.rmi.PortableRemoteObject.narrow( objref, BookServiceFacadeHome.class); System.out.println(in0); Collection result=facadeHome.create().findByCategory(in0); Object[] ret=new Object[result.size()]; Iterator it=result.iterator(); int i=0; while(it.hasNext()) { ret[i++]=it.next(); System.out.println(i); } return ret; } catch(Exception e) { e.printStackTrace(); return null; } } }
可以看出�Q�服务端点的主要��d��是调用EJB�l��g来完成业务逻辑的�?/p>
需要向读者说明的是，��Z��和本�p�d��W�一��文章中的客��L��框架兼容�Q�客��L��使用的值对象是com.hellking.webservice.BookVO�Q�而这里由WSDL2Java生成的值对象是com.hellking.webservice.servlet.BookVO�Q�。我们需要做以下的改动：
把生成的�q�些代码中的com.hellking.webservice.servlet.BookVO全部改�ؓcom.hellking.webservice.BookVO�Q�然后在Apache axis服务配置文�g中申明这个BeanMapping�Q�具体的声明�Ҏ��在后面介�l��?/p>
接下来的工作是编译服务端相关的文�Ӟ��BookServletServiceSoapBindingImpl、BookServletServiceSoapBindingSkeleton、BookServiceInterfaceService、BookServiceInterface�?/p>
服务端点部��v
启动服务器，�q�个服务器可以是��M��能够�q�行Apache引擎Web服务器，当然最好是同时有EJB容器和EJB容器的服务器�Q�如Webphere 、Weblogic、JBOSS�Q�如果没有EJB容器�Q�还需要一个额外的EJB容器�Q��ƈ且需要更改BookServletServiceSoapBindingImpl中获得上下文�Q�InitialContext�Q�的�Ҏ��Q�如�Q?/p>
例程6 获得上下文环�?/p>
Properties p = new Properties(); p.put(Context.INITIAL_CONTEXT_FACTORY, "xxxxx"); p.put(Context.URL_PKG_PREFIXES, "xxxx"); p.put(Context.PROVIDER_URL, "xxxx"); init=new javax.naming.InitialContext(p);
在控制台中，转到deploy.wsdd目录下，执行以下的命令就可以完成部��v�Q?/p>
java org.apache.axis.client.AdminClient deploy.wsdd
�׃��我们使用的是自己的序列化Bean对象�Q�故要在%Web-Apps%/WEB-INF/ server-config.wsdd文�g中做以下更改�Q?
扑ֈ�
�?
在中间加入以下内容：
部��v后您必须��保�?Web-Apps%/WEB-INF/classes目录下有服务端相关的�c�（BookServletServiceSoapBindingImpl、BookServletServiceSoapBindingSkeleton�{�）�?/p>
在浏览器里输入（�q�个地址您需要根据具体情冉|��改）�Q?/p>
http://localhost:8080/axis/services/BookServletService?wsdl
来验证Web服务是否已经部��v成功�Q�如果部�|�不成功�Q�您可以先尝试重新启动服务器�?/p>
客户�?/span>
如果服务端已�l�成功部�|Ԍ��下一步的工作��是�~�写客户端程序了。由于��用WSDL2Java已经生成了客��L��的框�Ӟ��所以我们的��d��相对简单了�?/p>
客户端编�E��Q务主要有以下几个�Q?/p>
在BookServletServiceSoapBindingStub里注册BeanMapping�Q?
�~�写客户端业务代表，�q�里使用了JAXRPCDelegate�Q?
更改以前的BookGUI的部分程序�?
在BookServletServiceSoapBindingStub里注册BeanMapping
�׃��在SOAP消息中��用了序列化的BookVO对象�Q�故在BookServletServiceSoapBindingStub中要�q�行BeanMapping注册。具体方法：
扑ֈ�BookServletServiceSoapBindingStub中的getAllBooks�Q�getTheBookDetail�Q�getBookByCategory�Ҏ��Q�在每个�Ҏ��中的
java.lang.Object _resp = _call.invoke(new java.lang.Object[] {in0});
前加入以下代码：
例程7 在BookServletServiceSoapBindingStub注册BeanMapping
QName qn = new QName( "BookServletService", "BookServletService" ); _call.registerTypeMapping(com.hellking.webservice.BookVO.class, qn, new org.apache.axis.encoding.ser.BeanSerializerFactory(com.hellking.webservice.BookVO.class, qn), new org.apache.axis.encoding.ser.BeanDeserializerFactory(com.hellking.webservice.BookVO.class, qn));
注意�q�里的Qname要和server-config.wsdd中描�q�的名称�I�间一致。在中server-config.wsdd�Q�我们��用了以下的映��：
在编写业务代表程序前�Q�我们先来对Web服务做一个调用测试。在��试前您必须保证数据库里已经有图书信息。如果EJB和Web Application都部�|�好�Q�您可以通过以下��面来往数据库里增加数据�Q?/p>
http://localhost:8080/axis/insert_data.jsp
��试代码如下�Q?/p>
例程8 ��试Web服务
package com.hellking.webservice.servlet; import java.net.URL; import javax.xml.namespace.QName; import javax.xml.rpc.Service; import javax.xml.rpc.ServiceFactory; import com.hellking.webservice.ejb.*; public class Client { public static void main(String[] args) { try { BookServiceInterfaceServiceLocator locator=new BookServiceInterfaceServiceLocator(); BookServiceInterface myProxy=locator.getBookServletService(); Object[] c=myProxy.getAllBooks(); com.hellking.webservice.BookVO book=(com.hellking.webservice.BookVO)c[0]; System.out.println(book.getName()); } catch (Exception ex) { ex.printStackTrace(); } } }
如果在控制台里打印出某个图书的名字，那么��验证了客户端和服务端的部��v是正��的。在�q�行下面的工作前�Q�请��保�q�个��试是成功的�?/p>
�~�写客户端业务代�?/span>
对于客户端程序来��_��业务代表直接和Web服务打交道，获得Web服务�q�回的数据，�q�做对应的处理，然后把数据返回给GUI�E�序�Q�GUI�E�序只负责数据显�C�。业务代表的代码如下�Q?/p>
例程9 JAXRPCDelegate业务代表
package com.hellking.webservice.servlet; import java.net.URL; import javax.xml.namespace.QName; import javax.xml.rpc.Service; import javax.xml.rpc.ServiceFactory; import com.hellking.webservice.ejb.*; import java.util.*; public class JAXRPCDelegate implements com.hellking.webservice.BookBusiness { BookServiceInterfaceServiceLocator locator; com.hellking.webservice.servlet.BookServiceInterface bookService; public JAXRPCDelegate() { try { locator=new BookServiceInterfaceServiceLocator(); bookService=locator.getBookServletService(); } catch(Exception e) { } } public Collection getBookByCategory(String category) { System.out.println("by_category"); Collection ret=new ArrayList(); try { Object[] books=bookService.getBookByCategory(category); System.out.println(category); int i=0; while(true) { ret.add(books[i++]); System.out.println(i); } } catch(Exception e) { } return ret; } public Collection getAllBooks() { Collection ret=new ArrayList(); try { Object[] books=bookService.getAllBooks(); int i=0; while(true) { ret.add(books[i++]); } } catch(Exception e) { } return ret; } public com.hellking.webservice.BookVO getTheBookDetail(String name) { System.out.println("bookdetail"); com.hellking.webservice.BookVO ret=new com.hellking.webservice.BookVO(); try { ret=bookService.getTheBookDetail(name); } catch(Exception e) { } return ret; } }
和第一��文章介�l�的JAXMDelegate一��P��JAXRPCDelegate 同样实现了BookBusiness接口�Q�BookBusiness接口是以前设计的接口�Q�我们在�q�里�q�行重用�Q�这��L��好处是BookClientGUI�E�序几只要做很少的更改就可以�q�行�?/p>
更改以前的BookClientGUI的部分程�?/span>
在BookGUI构造方法里增加以下内容�Q?/p>
例程10 更改BookGUI�E�序
public BookClientGUI() { business=new JAXRPCDelegate(); �? }
好了�Q�经�q�以上的奋战�Q�让我们来看�q�行的结果吧�?/p>
java com.hellking.webservice.BookClientGUI
�q�行�l�果如图4所�C��?/p>

�ȝ��
通过以上的介�l�，�怿�读者对JAX-RPC Web服务开发已�l�有一个比较深�ȝ��认识。�ȝ��一下，使用JAX-RPC开发Web服务�Ӟ��主要有以下的工作�Q?/p>
服务端点定义�Q?
服务描述�Q?
服务端点实现�Q?
服务端点部��v�Q?
下一�?/span>
本文已经介绍了把Servlet作�ؓWeb服务端点开发Web服务的全�q�程�Q�下一��将是把EJB作�ؓWeb服务端点来开发�?/p>
参考资�?
Apache axis User's Guides�Q?http://ws.apache.org/axis/ Sun jwsdp-1_1-tutorial�Q?http://java.sun.com/webservices/downloads/webservicestutorial.html http://www.ibm.com/developerworks/cn/xml/index.htmlXML & Web services专区 JAX-RPC API http://java.sun.com/webservices Jwdp1.1 http://java.sun.com/webservices 下蝲样例代码
关于作�?/span>
陈亚强：北京华园天一�U�技有限公司高��软�g工程师，擅长J2EE技术，曑֏�与多个J2EE��目的设计和开发，对Web服务有很大的兴趣�q�且有一定的��目�l�验。热爱学习，喜欢新技术。即��由电子工业出版�C�և�版的《J2EE企业应用开发》正在最�l�定�E�K��D�，目前正从事J2EE斚w��的开发和J2EE Web服务斚w��的图书写作。您可以通过 cyqcims@mail.tsinghua.edu.cn和他联系�?/td>

汪松�?/a> 2006-06-23 11:01 发表评论

久久亚洲综合色一区二区三区,亚洲乱码国产乱码精品精,亚洲国产一级在线观看

用JAX-RPC开发Web服务: Servlet作�ؓWeb服务端点