SOAP凈化有線協議（四）：簡化客戶程序

2024-07-21 02:21:50

字體：大中小

來源：轉載

供稿：網友

　　java 2平臺1.3版本為java映像api（reflection api）增加了一個極其實用的擴展：動態代理類。一個動態代理類就是一個實現了一系列運行時指定的接口的類。這個代理可以象它真正實現了這些接口一樣使用。換句話說，可以直接在代理對象上調用任意接口的任意方法——當然，必須先進行必要的類型定型（casting）。由此，我們可以用動態代理類為一組接口創建一個類型安全的代理對象，且不必象使用編譯時工具一樣預先生成代理（有關動態代理類更詳細的說明，請參見本文最后的參考資源）。

接下來我將介紹一個以動態代理類為基礎的框架，這個框架使得soap（簡單對象訪問協議）客戶程序的創建更加簡單和直觀。soap是一種用xml編碼數據的有線協議。在本系列文章的第二篇、第三篇構造soap服務的過程中，我們發現客戶程序的開發者必須多做許多原來不必做的工作。為幫助回憶，你可以看一下第二篇文章中的soap服務代碼，看看和客戶程序代碼相比較時，服務程序的soap代碼是多么微不足道。本系列文章前幾篇所創建的簡單soap服務顯示出，基于soap的服務只包含無論用不用soap都必須提供的代碼。服務程序的開發者要編寫的額外代碼很少，而客戶程序開發者卻有許多額外工作要做。本文介紹的類將把這些額外工作減到最少。

一、介紹soap代理類
首先，我要給出如果客戶程序使用了本文創建的框架，它將變成什么樣子：

package hello;
import soapproxy.*;
public class client
{
public static void main(string[] args)
{
try
{
class[] interfaces = new class[] {hello.hello.class};
hello hello = (hello)(proxy.newinstance("urn:hello",interfaces));
// 調用sayhelloto方法
// 這個sayhelloto方法需要一個字符串參數
system.out.println(hello.sayhelloto("john"));
// 調用sayhelloto方法
// 這個sayhelloto方法需要一個name javabean參數
name thename = new name();
thename.setname("mala");
system.out.println(hello.sayhelloto(thename));
}
catch(exception e)
{
e.printstacktrace();
}
}
}
也許是出于我的個人愛好，我認為上面的客戶代碼比第二篇和第三篇文章中的客戶代碼更好。如果你現在不能理解上面的代碼，這很正常，但我想待到本文結束時你會理解的。

要理解客戶程序的代碼，你必須深入了解soap proxy類，它在soapproxy包內，可以在proxy.java內找到（參見本文最后的參考資源）。proxy類有一個私有的構造函數，它意味著proxy實例不能從proxy之外創建；新建proxy實例的唯一方法是通過靜態的newinstance()方法。newinstance()方法有兩個參數：soap服務的對象id，以及一個數組，數組中包含一組該代理要實現的接口的名字。對象id很簡單，但這些接口名字是什么？從哪里去得到這些接口的名字？soap服務的開發者直接把服務上所有可被客戶程序調用的方法堆在一起得到一個接口。相當簡單，不是嗎？

現在我們為helloworld服務定義一個接口。第二篇文章中，這個服務的最終版本有sayhelloto()方法的兩個重載版本：一個版本的參數是一個字符串，另一個版本的參數是一個name javabean。這兩個方法就可以構成一個接口，稱為hello，如下所示：

package hello;
public interface hello
{
public string sayhelloto(string name);
public string sayhelloto(name name);
}
服務開發者決定要創建多少接口，以及為這些接口取什么樣的名字。例如，你可以為helloworld服務創建兩個接口，每一個接口包含一個方法。一般地，你應該避免創建方法數量大于七個的接口。另外，注意只把那些看來有必要放在一起的方法用一個接口組織起來。例如，如果helloworld服務還有一個返回定制的good-bye消息給調用者的saybyeto()方法，設計兩個獨立的接口也許比較明智：一個接口用于sayhelloto()方法，一個接口用于saybyeto()方法。

現在我們有了定義helloworld服務和客戶程序之間契約的接口，下面返回來看newinstance()方法。如前所述，newinstance()方法創建proxy類的一個新實例。newinstance()方法可以創建新實例是因為它屬于proxy類，能夠訪問私有的構造函數。newinstance()方法為新創建的實例調用initialize()方法。initialize()值得關注，因為動態代理就是在這里創建和返回。initialize()的代碼如下所示：

private object initialize(class[] interfaces)
{
return(java.lang.reflect.proxy.newproxyinstance(getclass().getclassloader()
,interfaces,this));
}
注意newproxyinstance()方法的應用。創建動態代理類實例的唯一辦法是調用該類（即java.lang.reflect.proxy類）靜態的newproxyinstance()方法。java.lang.reflect.proxy類為創建動態代理類提供了靜態方法，而且它還是所有由這些方法創建的動態代理類的超類。換句話說，它不僅是一個創建動態代理類的工廠，而且它本身也是一個動態代理類！因此，在我們的例子中，soap代理不是動態代理；相反，這個動態代理實際上是newproxyinstance靜態方法返回的java.lang.reflect.proxy類的一個實例。從本文后面可以看到，這個動態代理實際上通過soap代理實現的invoke()方法完成它的所有工作。那么，這個動態代理如何建立和soap代理的聯系呢？因為有一個對soap代理的引用傳遞給了newproxyinstance()方法。也許現在這聽起來有點費解，但只要你分析一下invoke()方法，這一切就很明白了。

java.lang.reflect.proxy類構造函數的第一個參數是一個類裝載器實例，第二個參數是需要動態實現的接口的數組（它就是客戶程序傳遞給newinstance()的數組），第三個參數是一個實現了java.lang.reflect.invocationhandler接口的類的實例。因為soap proxy類實現了invocationhandler接口，所以第三個參數是代理實例本身（即this）。invocationhandler接口有一個方法invoke()。當動態代理的動態實現的接口被調用時，java運行時環境調用invoke()方法。因此，舉例來說，當客戶程序調用動態代理的hello接口的sayhelloto()方法時，java運行時環境將調用soap代理的invoke()方法。

你可能已經發現，soap代理的newinstance()方法不返回soap代理的實例；相反，它返回newinsance()剛剛創建的動態代理，而動態代理動態地實現客戶程序傳入的接口數組。客戶程序可以將這個返回的動態代理定型為傳入newinstance()的任意接口類型，在動態代理上調用接口所定義的各個方法，就象動態代理真地實現了那些接口一樣。

.
.
try
{
class[] interfaces = new class[] {hello.hello.class};
hello hello = (hello)(proxy.newinstance("urn:hello",interfaces));
// 調用參數為字符串的sayhelloto方法
system.out.println(hello.sayhelloto("john"));
// 調用參數為name javabean的sayhelloto方法
name thename = new name();
thename.setname("mala");
system.out.println(hello.sayhelloto(thename));
}
.
.
在上面的代碼中，invoke()方法將被調用兩次，每次調用sayhelloto()方法時執行一次?，F在我們來看看invoke()方法。簡而言之，invoke()方法的工作正是第二篇文章中每一個客戶程序必須手工完成的工作，其中包括：用合適的調用參數設置一個call對象，定制的調用參數所需要的類型映射。由于soap代理中的invoke()方法擔負了所有這些任務，客戶程序釋放了這份負擔。

在invoke()方法接收到的三個參數中，我們只對后面兩個感興趣。第二個參數，即method對象，給出了被調用方法的名字。記住，被調用方法的名字對應著一個soap服務導出的已知方法。服務的對象id作為參數傳遞給newinstance()方法，所以invoke()方法已經擁有該對象id。invoke()方法利用這些信息，按照如下方式設置call對象：

call call = new call();
call.settargetobjecturi(urn);
call.setmethodname(m.getname());
call.setencodingstyleuri(constants.ns_uri_soap_enc);
現在要做的是為遠程服務調用設置參數。為此，我們要用到invoke()方法的第三個參數：傳入動態代理上被調用方法的一個參數數組。數組中索引為0的參數是方法調用中最左邊的參數，索引為1的參數是方法的第二個參數，依此類推。舉例來說，如果客戶程序調用了sayhelloto(string name)方法，那么參數數組就是包含一個字符串的數組。invoke()方法處理該數組的每一個元素，創建一個由parameter對象構成的向量（vector）（正如第二篇文章中客戶程序所做的那樣）：

java.util.vector params = new java.util.vector();
for( int i=0; i<args.length; i++ )
{
if( issimple(args[i]) || issimplearray(args[i]) )
{
params.add(new parameter(_paramname+(i+1),
args[i].getclass(),args[i],null));
}
else if( isvector(args[i]) )
{
addmapping((java.util.vector)args[i]);
params.add(new
parameter(_paramname+(i+1),args[i].getclass(),args[i],null));
}
// 如果這個數組的元素不屬于java基本數據類型
// 則假定這是一個javabean的數組
else if( isarray(args[i]) )
{
if( smr == null )
smr = new soapmappingregistry();
if( beanser == null )
beanser = new beanserializer();
arrayserializer arrayser = new arrayserializer();
smr.maptypes(constants.ns_uri_soap_enc,
null, null, beanser, beanser);
smr.maptypes(constants.ns_uri_soap_enc,
null,args[i].getclass(), arrayser, arrayser);
params.add(new parameter(_paramname+(i+1),
args[i].getclass(),args[i],null));
}
// 假定這是一個bean
else
{
if( smr == null )
smr = new soapmappingregistry();
if( beanser == null )
beanser = new beanserializer();
string qnamepart = args[i].getclass().getname();
smr.maptypes(constants.ns_uri_soap_enc,
new qname(urn, qnamepart),args[i].getclass(), beanser,
beanser);
params.add(new parameter(_paramname+(i+1),args[i].getclass(),args[i],null));
}
}
invoke()方法用到了許多私有的輔助方法，比如用issimple()來確定參數的類型。如果參數是一個javabean或者一個數組，那么，程序必須設置一個定制的soap映射注冊項，并通過setsoapmappingregistry()方法對call對象作相應的設置（參見第二篇文章）。soap代理假定，當出現javabean時，soap服務用到的所有javabean按照如下方式映射：namespace uri設置成對象id，local part設置成javabean完整的類名。我們部署helloworld服務時正是按照這個要求進行，所以一切都不存在問題。

invoke()方法的剩余部分相當簡單：設置call對象參數，設置定制soap映射注冊項（如果有必要的話），發出調用，接收方法調用的返回值。如下所示：

if( params.size() != 0 )
call.setparams(params);
if( smr != null )
call.setsoapmappingregistry(smr);
// 發出調用
response resp = call.invoke(serverurl, "");
if( !resp.generatedfault() )
{
parameter ret = resp.getreturnvalue();
return(ret.getvalue());
}
else
{
fault fault = resp.getfault();
throw new
soapexception(fault.getfaultcode(),fault.getfaultstring());
}
二、helloworld服務
下面是helloworld服務的完整代碼。有似曾相識的感覺嗎？

package hello;
public class helloserver
{
public string sayhelloto(string name)
{
system.out.println("sayhelloto(string name)");
return "hello " + name + ", how are you doing?";
}
public string sayhelloto(name thename)
{
system.out.println("sayhelloto(name thename)");
return "hello " + thename.getname() + ", how are you doing?";
}
}
回憶一下，name是一個簡單的javabean，代碼如下：

package hello;
public class name
{
private string name;
public string getname()
{
return name;
}
public void setname(string name)
{
this.name = name;
}
}
事實上，這里服務的代碼與第二篇文章中的服務程序代碼完全一樣。對于服務開發者來說，唯一增加的工作是創建java接口。部署服務的方法也和第二篇文章中討論的完全一樣，所以這里我不再介紹。相同的地方還不止如此，編譯和運行客戶程序的方法也和第二篇文章介紹的一樣。為什么有這么多相同之處呢？因為我們創建的代理是一個非插入式的框架，它不會修改和干涉任何apache soap部件的內部工作——無論是客戶端還是服務端。

三、其他說明
本文討論的soap代理（可以從文章后面下載）支持以下參數類型：

⑴ 下面的java基本數據類型及其對應的對象形式。

boolean, boolean,
double, double,
float, float,
long, long,
int, integer,
short, short,
byte, byte
注：服務器端總是接收基本數據類型。

⑵ 任何javabean

注：

該javabean不能包含其他javabean。

如果數組或向量包含除字符串或1列出數據類型之外的類型，則javabean不能包含這類數組或向量。

⑶ 下面的類：string, vector

注：

vector可以包含1、2列出的所有類型和字符串。

服務器端把vector作為一個對象的數組接收。

⑷ 數組。數組元素可以是在1、2中列出的所有類型和字符串（上面已注明的除外）。

■ 結束語
在這個四篇文章構成的系列中，我不僅介紹了soap的基礎知識，而且介紹了soap 1.1標準的一個優秀的實現：apache soap。在本文中，我提供了一個以動態代理類為基礎的框架，這個框架極大地簡化了使用apache soap的客戶程序開發者的工作。

我深切地感到soap有著美好的前景，至少有兩個理由使我這么認為：首先，soap以一些開放的標準為基礎，比如xml。這使得無論是microsoft，還是反microsoft的企業，都廣泛地接受了soap。對于開發者來說，這無疑是一個天大的好消息。第二，soap正在成為其他許多標準的基礎，比如uddi（universal description，discovery，and integration）。許多人認為，web服務代表著下一代的web應用開發，而soap和uddi都是web服務的關鍵組成部分。

■ 參考資源

下載本文的完整代碼：javaandsoap4_code.zip

w3c的soap 1.1規范：

http://www.w3.org/tr/soap/

有關動態代理類的更多信息：

http://java.sun.com/j2se/1.3/docs/guide/reflection/proxy.html

關于ibm soap工程的更多信息：

http://www.alphaworks.ibm.com/tech/soap4j

下載apache soap：

http://xml.apache.org/dist/soap/

，歡迎訪問網頁設計愛好者web開發。

上一篇：SOAP凈化有線協議（三）：用腳本語言編寫服務

下一篇：交互界面，Web服務定義的核心