简介: 本文将讨论怎么在J2EE组件中引用Web服务、并且通过JNDI来查找Web服务。
原文地址:http://www.ibm.com/developerworks/cn/webservices/ws-jndi/index.html
本文是J2EE Web服务开发系列文章的第十一篇,本文将讨论怎么在J2EE组件中引用Web服务、并且通过JNDI来查找Web服务。在内容组织上,首先把一个EJB2.1无状态会话Bean发布成Web服务,然后开发基于JSP的Web服务客户端,最后着重介绍怎么在JSP的部署时引用Web服务,并且讨论怎么通过JNDI来查找和调用Web服务。
阅读本文前您需要以下的知识和工具:
- J2EE1.4 SDK,并且会初步使用;
- 掌握基本的JAX-RPC Web服务开发技能;
- 了解JNDI的基本知识,能够使用它进行简单编程;
- 一般的Java编程知识。
本文的参考资料见 参考资料。
本文的全部代码在这里 下载。
我们知道,JAX-RPC Web服务客户端有以下几个类型:
- 基于Stub;
- 基于动态代理;
- 基于动态调用接口(DII)。
实际上,厦嫒挚突Ф硕际鞘褂肧ervice接口来作为它们的创建工厂,Service接口中定义了诸如以下的方法:
例程1 Service接口中的某些方法
Call createCall() ; Call createCall(QName portName, String operationName) ; Remote getPort(QName portName, Class serviceEndpointInterface) ; Remote getPort(Class serviceEndpointInterface) ; |
可以看出,通过Service接口,能够创建Call对象和Remote对象,而Call或者Remote对象正是调用Web服务所需要的。
通过使用Service接口,我们可以在Web服务客户端通过以下的方式来实现调用:
例程2 在客户端调用Web服务
//创建一个ServiceFactory对象。 ServiceFactory serviceFactory = ServiceFactory.newInstance(); //通过ServiceFactory对象创建一个调用Web服务的Service对象。 Service service = serviceFactory.createService(taxWsdlUrl, new QName(nameSpaceUri, serviceName)); //获得服务端点实例。 TaxService myProxy = ( TaxService) service.getPort(new QName(nameSpaceUri, portName), TaxService.class); //调用Web服务。 double result=myProxy.calculateTax(5000); |
可以看出,在创建Service实例时,需要使用指定的WSDL文件位置、由服务名和名称空间URI组成的有效名称空间,这样使得创建这个实例时变得复杂。JAX-RPC规范推荐使用JNDI来查找服务接口。通过JNDI,使得调用Web服务时就像调用EJB一样简单。只要通过两步就可以获得Web服务接口:
- 初始化一个名称空间上下文;
- 在这个上下文中查找Web服务。
比如可以按照以下的方式来进行:
例程3 通过JNDI调用Web服务 1
InitialContext ic = new InitialContext (); Service abf = (Service)ic.lookup( "java:comp/env/service/AddressBookService"); |
Web服务引用的名字(AddressBookService)在部署时指定,java:comp/env是JNDI的上下文,service是Web服务的sub context。所以Web服务的JNDI名字一般由以下几个部分组成:
Web服务JNDI=客户端环境上下文+service(sub context)+服务引用名字
我们看到,例程3中查找到的是Service接口,其实在开发中,我们可以采用另一种服务引用形式:直接查找Web服务接口,如例程4所示。
例程4通过JNDI调用Web服务2
Context ic= new InitialContext(); HelloServiceInterface service = (HelloServiceInterface) ic.lookup("java:comp/env/service/HelloService"); |
在后面的例子可以看到,使用这个方式在调用时又简化了一步。
下面我们通过一个实例来演示怎么在J2EE Web服务的客户端引用Web服务,然后通过JNDI来查找Web服务。
我们开发一个提供个人所得税计算的Web服务,采用EJB作为服务端点。首先定义一个接口,如例程5所示。
例程5 定义服务接口
package com.hellking.study.webservice.tax; import java.rmi.Remote; import java.rmi.RemoteException; /** *个人所得税Web服务。 */ public interface TaxService extends Remote { public double calculateTax(double salary)throws java.rmi.RemoteException; } |
它提供的服务方法是计算个人所得税。
下面是EJB部分代码。
(由于EJB的实现代码是特意借朋友的会计书查到的,它是真正意义的业务逻辑代码,适合于现在的个人所得税计算,来之不易,所以贴出来共享之, ^_^)
例程6 EJB部分代码
double base=1200;//个人所得税基数,2003年10起北京为1200元。 //业务逻辑代码,实现服务端点接口中定义的方法。 public double calculateTax(double salary) { return getTax(salary-base); } //下面是具体的计算方法。公式适合于现在的个人所得税制度。 private double getTax(double tax_salary) { double tax=0.0d; if(0>tax_salary) tax=0; else if(0<tax_salary&&tax_salary <=500) tax=tax_salary*0.05-0; else if(500<tax_salary&&tax_salary<=2000) tax=tax_salary*0.10-25; else if(2000<tax_salary&&tax_salary<=5000) tax=tax_salary*0.15-125; else if(5000<tax_salary&&tax_salary<=20000) tax=tax_salary*0.20-375; else if(20000<tax_salary&&tax_salary<=40000) tax=tax_salary*0.25-1375; else if(40000<tax_salary&&tax_salary<=60000) tax=tax_salary*0.30-3375; else if(60000<tax_salary&&tax_salary<=80000) tax=tax_salary*0.35-6375; else if(80000<tax_salary&&tax_salary<=100000) tax=tax_salary*0.40-10375; else if(100000<tax_salary) tax=tax_salary*0.45-15375; return tax; } |
下面编写一个配置文件,通过配置文件来生成WSDL到JAX-RPC之间的映射描述符。配置文件如下:
例程7 config.xml
<?xml version="1.0" encoding="UTF-8"?> <configuration xmlns="http://java.sun.com/xml/ns/jax-rpc/ri/config"> <service name="MyTaxService" targetNamespace="urn:Tax" typeNamespace="urn:Tax" packageName="com.hellking.study.webservice.tax"> <interface name="com.hellking.study.webservice.tax.TaxService"/> </service> </configuration> |
注意这里Web服务的名字是MyTaxService,名称空间是"urn:Tax",服务接口是"com.hellking.study.webservice.tax.TaxService",这些参数将在后面的编程中使用。通过以下命令来生成一个mapping.xml映射文件:
wscompile -define -d . -nd . -classpath . -mapping mapping.xml config.xml |
接下来就可以部署这个Web服务。Web服务部署的细节请参考本系列文章《使用EJB2.1无状态会话Bean作为Web服务端点》一文。如果你不想手工部署,您也可以通过J2EESDK提供的GUI部署工具来部署它。
这个例子提供了两种不同引用Web服务的方法,如例程8所示。
例程8 在客户端通过JNDI查找Web服务
package com.hellking.study.webservice.tax; import javax.naming.*; import javax.xml.rpc.Service; import javax.xml.namespace.QName; /** *Web服务客户演示:通过JNDI来查找Web服务。 */ public class TaxBean { /** *第一种查找服务的方法,直接获得MyTaxService接口。 */ public double getTax1(double sal) { double ret=0; try { Context ctx=new InitialContext(); MyTaxService taxService=(MyTaxService)ctx.lookup("java:comp/env/service/tax"); //通过MyTaxService获得TaxService服务端点接口。 TaxService tax=taxService.getTaxServicePort(); ret=tax.calculateTax(sal); } catch(Exception e) { System.out.println(e); } return ret; } /** *另一种查找服务的方法,获得的是Service接口,然后再通过这个接口来获得具体的服务。 */ public double getTax2(double sal) { double ret=0; try { Context ctx=new InitialContext(); Service service=(Service)ctx.lookup("java:comp/env/service/tax2"); QName portQName= new QName("urn:Tax","TaxService"); //使用这种方式获得服务端点接口时,需要指定名称空间。 TaxService tax=(TaxService)service.getPort(portQName, com.hellking.study.webservice.tax.TaxService.class); ret=tax.calculateTax(sal); } catch(Exception e) { e.printStackTrace(); System.out.println(e); } return ret; } } |
可以看出,第一种方法查找的就是MyTaxService接口,而第二种方法查找的是Service接口。具体使用那种方式,是和部署描述相关的,在后面将介绍部署的差别。
最后开发一个JSP来作为测试客户端,这个JSP通过JavaBean调用Web服务,如例程9所示。
例程9 测试的JSP
<%@ page contentType="text/htmlcharset=ISO-8859-1"%> <%@ page import="com.hellking.study.webservice.tax.*,javax.naming.*"%> <jsp:useBean id="tax" class="com.hellking.study.webservice.tax.TaxBean"/> <% double salary=0; try{ salary=Double.parseDouble((String)request.getParameter("salary")); } catch(Exception e){} %> <html> <head> <title>通过JNDI调用Web服务。</title> </head> <body> <div align="center"> <h1>Web服务----适合北京地区,2003年</h1> <% out.println("个人所得税是:<br>"); out.println(tax.getTax1(salary)); out.println("<br>另一种方法调用Web服务,个人所得税是:<br>"); out.println(tax.getTax2(salary)); %> <hr> <form action="/tax/tax"> <table border=1> <tr bgcolor=654321> <td >输入工资</td> <td><input type=text name=salary></td> </tr> <tr><td colspan=2><input type=submit value=查看></td> </tr> </table> </form> </div> <hr> </body> </html> |
最后来看具体的部署描述符。
打开J2EESDK部署工具(执行%J2EESDK_HOME%\\AppServer\\bin\\deploytool.bat或者$J2EESDK/AppServer/bin/deploytool.sh),新建一个Web应用,把上面的测试JSP添加进来。在部署时,Web应用将包含如图1所示的文件。
点击这个Web应用,在右边再点击【Web services Refs】选项卡,再点击【Add】按钮。现在可以增加Web服务引用了。增加一个名称为service/tax的Web服务引用,如图2所示。
注意上面的Service接口是com.hellking.study.webservice.tax.MyTaxService。然后点击【Container Managed Ports】,如图3所示。
到此,一种引用Web服务的方式就完成了。
下面看服务接口直接是Service的情况,再增加一个Web服务引用,如图4所示。
注意上面Service Interface是javax.xml.rpc.Service,并且指定了名称空间(urn:Tax)和Local Part(MyTaxService)。同样,按照图3所示方法增加一个容器管理端点,端点接口名称和端口组件名称和图3一致。
经过了上面的部署,实际上在web.xml中生成了以下的部署描述符。
例程 10 生成的部署描述符
<service-ref> <service-ref-name>service/tax</service-ref-name> <service-interface>com.hellking.study.webservice.tax.MyTaxService</service-interface> <wsdl-file>WEB-INF/wsdl/MyTaxService.wsdl</wsdl-file> <jaxrpc-mapping-file>mapping.xml</jaxrpc-mapping-file> <port-component-ref> <service-endpoint-interface>com.hellking.study.webservice.tax.TaxService </service-endpoint-interface> <port-component-link>TaxServicePort</port-component-link> </port-component-ref> </service-ref> <service-ref> <service-ref-name>service/tax2</service-ref-name> <service-interface>javax.xml.rpc.Service</service-interface> <wsdl-file>WEB-INF/wsdl/MyTaxService.wsdl</wsdl-file> <jaxrpc-mapping-file>mapping.xml</jaxrpc-mapping-file> <service-qname xmlns:service-qname_ns__="urn:Tax">service-qname_ns__:MyTaxService </service-qname> <port-component-ref> <service-endpoint-interface>com.hellking.study.webservice.tax.TaxService </service-endpoint-interface> <port-component-link>TaxServicePort</port-component-link> </port-component-ref> </service-ref> |
下面解释一下这个描述付。对Web服务的引用通过<service-ref>元素来指定;<service-ref-name>就是在客户端编程中要使用的引用名字;<service-interface>就是服务接口,有两种,分别是javax.xml.rpc.Service和com.hellking.study.webservice.tax.MyTaxService;<service-qname>是服务的有效名称空间,如果直接使用com.hellking.study.webservice.tax.MyTaxService作为服务接口,就不需要指定<service-qname>元素;<port-component-ref>就是对服务端点的引用,它引用的是webservices.xml中定义<port-component>元素。<port-component-link>用来链接到webservices.xml中指定的<port-component-name>,并且两者的名字是一致的。
部署完成后,在浏览器里输入:
将出现如图5所示的界面。
通过上面的介绍,相信读者对Web服务的引用已经有了全面的认识。我们可以看到,通过使用JNDI,在J2EE组件中调用Web服务就像面向对象编程一样,甚至可以不理解WSDL、XML之类的概念就能调用Web服务。
本文的全部代码在这里 下载。
下载J2EESDK1.4 http://java.sun.com/downloads/。
J2EE Home Page, http://java.sun.com/j2ee。
J2EE 1.4 (JSR 151), http://www.jcp.org/jsr/detail/151.jsp。
Web Services for J2EE (JSR 109), http://www.jcp.org/jsr/detail/109.jsp。
Jwdp1.3 http://java.sun.com/webservices。
JAX-RPC规范, http://java.sun.com/xml/downloads/jaxrpc.html。
JNDI教学, http://java.sun.com/。
陈亚强:北京华园天一科技有限公司高级软件工程师,擅长J2EE技术,曾参与多个J2EE项目的设计和开发,对Web服务有很大的兴趣并且有一定的项目经验。热爱学习,喜欢新技术,曾参与多本图书的写作。好交朋友,您可以通过cyqcims@mail.tsinghua.edu.cn和他联系。