作为CSDN JavaWebService的小斑竹,很久就想写一些关于JWS的基础文章,苦于公私繁忙,一直无心下笔,所以一拖再拖,今日看了我斑块下有网友问及关于Java调用WebService之问题,遂下决心写下此文以资共勉。
装备:
JDK1.4.1_02,关于这方面的问题,没必要说了吧。^_^
Java Web Services Developer Pack 1.2 (http://java.sun.com/webservices/downloads/webservicespack.html)
我的JWSDP安装路径为E:/miniTool/jwsdp-1.2/,文章中直接使用,就不重声。
平台:
Microsoft Windows 2000 [Version 5.00.2195]
全文以Google的WebService为例,它提供了一个开发包,http://www.google.com/apis/download.html,但是很多的WebService不会这样的,只是告诉你一个他们的WSDL(WebService Description Language)文件。但是这都没有本质的区别的,在Google的开发包中也包含这么一个文件GoogleSearch.wsdl。大多数的WebService客户端开发,知道了WSDL文件就已经可以了,但是Google呢还需要一个LicenseKey,因为只是测试用,所以这个限制了同一个账号一天只能够查询1000还是2000次,我忘记了,我申请了两个,在我这个C#的演示站点(http://63.210.240.215/rookieport/)就用到了这两个LicenseKey(随机使用),关于这个C#演示站点的介绍及源文件见http://www10.brinkster.com/rookieport/default.aspx。非常遗憾的是,这两个站点我都不能够更新了,世界上从来没有免费的午餐!!!
好了,这篇文章的主题是JavaWebService而不是C#WebService,做好准备工作之后,我们稍微分析下WSDL文件,这个文件主要是描述WebService具体使用到了哪些数据结构(types中描述),提供了哪些Web服务功能(operation中描述),以及该服务的访问地址(service中描述),关于WSDL这里不详述,找时间补上。在GoogleSearch.wsdl中,我们看到有一个doGoogleSearch的Operation,从名称上我们可以看出,这个方法应该是提供搜索服务的,前面有一段描述了doGoogleSearch调用的参数:
<message name="doGoogleSearch">
<part name="key" type="xsd:string"/>
<part name="q" type="xsd:string"/>
<part name="start" type="xsd:int"/>
<part name="maxResults" type="xsd:int"/>
<part name="filter" type="xsd:boolean"/>
<part name="restrict" type="xsd:string"/>
<part name="safeSearch" type="xsd:boolean"/>
<part name="lr" type="xsd:string"/>
<part name="ie" type="xsd:string"/>
<part name="oe" type="xsd:string"/>
</message>
第一个参数就是LicenseKey,第二个参数是要查询的内容,第三个参数是起始结果页,对于多页的结果集合起翻页作用,第四个参数是定义每页最大记录数,后面的参数不是很重要了,其中lr是定义查找的语言类型,假如查找简体中文可以为lang_zh-CN,ie/oe是输入和输出的编码类型,缺省都为UTF-8。
再往后面我们看到关于doGoogleSearch的返回类型的描述:
<message name="doGoogleSearchResponse">
<part name="return" type="typens:GoogleSearchResult"/>
</message>
type="typens:GoogleSearchResult"说明了数据类型的命名空间,我们查找GoogleSearchResult,可以看到他是个复合类型,
<xsd:complexType name="GoogleSearchResult">
<xsd:all>
<xsd:element name="documentFiltering" type="xsd:boolean"/>
<xsd:element name="searchComments" type="xsd:string"/>
<xsd:element name="estimatedTotalResultsCount" type="xsd:int"/>
<xsd:element name="estimateIsExact" type="xsd:boolean"/>
<xsd:element name="resultElements" type="typens:ResultElementArray"/>
<xsd:element name="searchQuery" type="xsd:string"/>
<xsd:element name="startIndex" type="xsd:int"/>
<xsd:element name="endIndex" type="xsd:int"/>
<xsd:element name="searchTips" type="xsd:string"/>
<xsd:element name="directoryCategories" type="typens:DirectoryCategoryArray"/>
<xsd:element name="searchTime" type="xsd:double"/>
</xsd:all>
</xsd:complexType>
这里面用xml语言描述了GoogleSearchResult的数据结构,type="xsd:XXX"的属性都是简单数据类型,还用到了两个复合类型ResultElementArray, DirectoryCategoryArray读者可以继续分析,这些数据类型,都会被JWS的解释转换工具生成相应的Java类。两个Array结尾的复合类型,在JWSDP1.1以前也是生成了一个相应的ArrayOfXXXXX的类,现在1.2做得比较好了,,直接映射到java的数组。
好了我们可以进入客户端开发的实际性操作的第一步了,首先我们需要编辑一个xml格式的config文件,形式如下:
<?xml version="1.0" encoding="UTF-8"?>
<configuration xmlns="http://java.sun.com/xml/ns/jax-rpc/ri/config">
<wsdl name="SearchService" location="GoogleSearch.wsdl" packageName="rook.searcher"/>
</configuration>
这里面指明了WebService描述文件的位置,可以是本地的也可以是远程的。后面packageName说明了生成WebService客户端文件的包名。把这个文件放到GoogleAPI的目录下。
第二步,启动控制台,进入GoogleAPI的目录
C:/googleapi>dir/w
Volume in drive C is WIN2K
Volume Serial Number is 0B73-18E3
Directory of C:/googleapi
[.] [..]
README.txt GoogleAPIDemo.java
GoogleSearch.wsdl APIs_Reference.html
LICENSE.txt googleapi.jar
[javadoc] [dotnet]
[soap-samples] [licenses]
google.config
JavaWebService客户端简明攻略.txt
建立一个client的目录C:/>mkdir client
执行WSCompile生成客户端文件C:/googleapi>E:/miniTool/jwsdp-1.2/jaxrpc/bin/wscompile -gen -d client -keep google.config
-gen参数告诉编译器生成WebService客户端文件,-d client将生成的文件保存的目录,-keep指示保留中间文件。执行之后,进入client/rook/searcher目录可以看到生成系列java和java类文件。
第三步,我们创建客户端调用文件。查找包含rookie的中文网页前十条记录,然后打印标题和Url。
import rook.searcher.*;
import java.rmi.*;
public class Searcher{
public static void main(String[] args){
try {
GoogleSearchPort sport = new GoogleSearchService_Impl().getGoogleSearchPort();
GoogleSearchResult result = sport.doGoogleSearch("OyGtVqM5YRRS7hFXHLWEodMSEbiZlmc9", "rookie", 0, 10, true, "lang_zh-CN", true, "lang_zh-CN", "UTF-8", "UTF-8");//第一个参数是LicenseKey
ResultElement[] results = result.getResultElements();
for ( int idx = 0; idx < results.length; idx ++) {
System.out.println(idx + ": " + results[idx].getTitle() + "/r/n" + results[idx].getURL());
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
第四步,编译。这里面用到了jaxrpc-impl包。
C:/googleapi/client>javac -classpath E:/miniTool/jwsdp-1.2/jaxrpc/lib/jaxrpc-impl.jar;. Searcher.java
第五步,执行。
C:/googleapi/client>java -cp E:/miniTool/jwsdp-1.2/jaxrpc/lib/jaxrpc-impl.jar;E:/miniTool/jwsdp-1.2/jaxrpc/lib/jaxrpc-api.jar;E:/miniTool/jwsdp-1.2/jwsdp-shared/lib/jax-qname.jar;E:/miniTool/jwsdp-1.2/jwsdp-shared/lib/activation.jar;E:/miniTool/jwsdp-1.2/jwsdp-shared/lib/mail.jar;E:/miniTool/jwsdp-1.2/jwsdp-shared/lib/xsdlib.jar;E:/miniTool/jwsdp-1.2/saaj/lib/saaj-api.jar;E:/miniTool/jwsdp-1.2/saaj/lib/saaj-impl.jar;E:/miniTool/jwsdp-1.2/jwsdp-shared/lib/commons-logging.jar;E:/miniTool/jwsdp-1.2/jaxp/lib/endorsed/xercesImpl.jar;E:/miniTool/jwsdp-1.2/jaxp/lib/endorsed/dom.jar;. Searcher
全文到此结束,讲了作JavaWebService客户端开发的基本步骤,希望能够抛砖引玉!文中不详之处,敬请指教:zlyperson@163.net