JAVA SOAP技術(shù)(轉(zhuǎn)http://www.cnblogs.com/mingzi/archive/2009/03/23/1419385.html)
Posted on 2012-10-16 16:41 小白19870626 閱讀(499) 評(píng)論(0) 編輯 收藏 所屬分類: Soap從技術(shù)的角度來說,有必要提一下我們的調(diào)試環(huán)境。我們使用的是Windows XP操作系統(tǒng) ,安裝有JAVA 2 SDK 1.4.1,Apache SOAP 2.3.1,JAF 1.0.2,JavaMail 1.3.1和Xerces 2.6.0。上面所提及的都能在Tcomcat 4.1.29 JSP /Servlet 容器中正常運(yùn)行。所有的軟件都是免費(fèi)自由軟件,因此你能夠很容易的下載 它們并自己在任何你喜歡的平臺(tái)如Windows或UNIX上安裝它們。Java SDK,JAF和JAVAMAIL位于SUN的官方網(wǎng)站( http://java.sun.com ),其他的軟件在Jakarta項(xiàng)目組的官方網(wǎng)站( http://jakarta.apache.org )上有down的。可能你在看到我們需要這么多不同的包(package)時(shí)已經(jīng)有點(diǎn)擔(dān)心和不安了,但是實(shí)際上你不應(yīng)該擔(dān)心這些的。一旦你懂了基礎(chǔ),那么對(duì)你將相當(dāng)容易。安裝不是一件很難的事情,你只需要在設(shè)置環(huán)境變量的時(shí)候仔細(xì)些,比如CATALINA_HOME , CLASSPATH , JAVA_HOME 等等,所有這些步驟都是手工的。由于我僅僅是想將你的注意力再次集中到它們身上,所以你能很快的就完成以上配置過程。我只是添加下面的一些字符串到Tomcat的bin/setclasspath.bat 文件中:
...
set CATALINA_HOME=C:\Tomcat4.1.29
set CLASSPATH=%JAVA_HOME%\lib\tools.jar
set CLASSPATH=%JAVA_HOME%\soap-2.3.1\lib\soap.jar
set CLASSPATH=%CLASSPATH%;%JAVA_HOME%\javamail-1.3.1\mail.jar
set CLASSPATH=%CLASSPATH%;%JAVA_HOME%\jaf-1.0.2\activation.jar
set CLASSPATH=%CLASSPATH%;%JAVA_HOME%\xerces-2_6_0\xercesImpl.jar
set CLASSPATH=%CLASSPATH%;%JAVA_HOME%\xerces-2_6_0\xercesSamples.jar
set CLASSPATH=%CLASSPATH%;%JAVA_HOME%\xerces-2_6_0\xml-apis.jar
set CLASSPATH=%CLASSPATH%;%JAVA_HOME%\xerces-2_6_0\xmlParserAPIs.jar
set CLASSPATH=%CLASSPATH%;%CATALINA_HOME%\common\lib\servlet.jar
set CLASSPATH=%CLASSPATH%;%CATALINA_HOME%\common\lib\tools.jar
...
如果你的安裝路徑(installation paths)和上面使用的不同,你需要更正它們,然后關(guān)閉和重啟Tomcat以使它們生效。這樣,你就有為運(yùn)行SOAP作好了準(zhǔn)備。但是現(xiàn)在,我要忘記有關(guān)的技術(shù)部分,來學(xué)一點(diǎn)理論知識(shí)。
SOAP意思是簡單對(duì)象訪問協(xié)議(S imple O bject A ccess P rotocol)。的確如它的名字一樣,SOAP是很簡單的。它是一個(gè)基于XML的協(xié)議,允許程序組件和應(yīng)用程序彼此使用一種標(biāo)準(zhǔn)的Internet協(xié)議 --HTTP來通訊。SOAP是一種獨(dú)立的平臺(tái),它不依賴程序語言,它是簡單的,彈性的,很容易擴(kuò)展的。目前,應(yīng)用程序能夠彼此使用一種基于DCOM和 CORBA技術(shù)的遠(yuǎn)程過程調(diào)用(RPC)來進(jìn)行相互通訊,但HTTP不被設(shè)計(jì)為這個(gè)目的。RPC在Internet上應(yīng)用是非常困難的,它們會(huì)出現(xiàn)許多兼容性和安全性的問題,因?yàn)?a target="_blank">防火墻 和代理服務(wù)器 通常都會(huì)阻斷(block)這些類型的流量。應(yīng)用程序之間最好的通訊方式是通過HTTP協(xié)議,因?yàn)镠TTP是支持所有Internet瀏覽器和服務(wù)器的。基于這個(gè)目的,SOAP協(xié)議被創(chuàng)建出來。
那么,它們是如何運(yùn)作的呢?比如,一個(gè)應(yīng)用程序(A)需要和另一個(gè)應(yīng)用程序(B)在SOAP的幫助下進(jìn)行彼此通訊。它們將使用下面的框架圖來完成這個(gè)過程:
這個(gè)SOAP信封(SOAP envelope)是一個(gè)包含以下內(nèi)容的XML文檔:
正如你看到的,它是非常簡單的。它看起來確實(shí)就象一個(gè)普通的信封或者你的 email。你想看看它們是如何動(dòng)作的嗎?下面跟我們一起來吧。其實(shí)我們有很多方法是不用SOAP來在創(chuàng)建和運(yùn)行我們自己的“Hello World”應(yīng)用程序的,但是因?yàn)槲覀円3炙暮唵涡裕視?huì)給你一個(gè)它運(yùn)作方式的框架圖(scheme)。
我們的“Hello World”范例會(huì)包含一個(gè)SOAP Service。我們的SOAP Client將發(fā)送它們的名字到該SOAP Service,并試圖得到一些答復(fù)或響應(yīng)。這個(gè)SOAP Service需要部署到一個(gè)SOAP Admin的工具,以至重定位所有請(qǐng)求的SOAP(Proxy) RPC Router能夠知道它們應(yīng)該使用哪種服務(wù)來運(yùn)作。總而言之,這個(gè)是以下面的方式來運(yùn)作的:
現(xiàn)在,我們來一步步的看看到底發(fā)生了什么。在Step 1里,HelloWorldClient將連接一個(gè)SOAP RPC Router,請(qǐng)求我們的SOAP Service并將包含我們名字的一個(gè)字符串傳遞給它。該SOAP RPC Router會(huì)檢查是否它已經(jīng)部署了這個(gè)SOAP Service。如果它被發(fā)現(xiàn)是被部署的,那么它將傳遞數(shù)據(jù)到這個(gè)SOAP Service并調(diào)用特定的方法,這個(gè)是Step 2。然后SOAP Service方法會(huì)被執(zhí)行,將返回某個(gè)字符串值(該值就是SOAP Client的答復(fù)或者響應(yīng))(Step 3)。在Step4中,SOAP RPC Router將僅僅只是重定向這個(gè)數(shù)據(jù)到SOAP Client。所有在Step1和Step4里傳輸?shù)臄?shù)據(jù)是通過SOAP Envelope來完成的。正如你所看到的,算法是相當(dāng)簡單的,因此我們只準(zhǔn)備關(guān)心實(shí)際的代碼。
首先,我們要?jiǎng)?chuàng)建一個(gè)SOAP Service。下面是它的代碼,請(qǐng)不要忘記將它放入HelloWorld/ 目錄中(必須被包含在你的CLASSPATH中):
1: // SOAPService.java
2: package HelloWorld;
3: public class SOAPService {
4: public String sayHi(String x) {
5: return("Hello my friend, " + x + "! Glad to see you!");
6: }
7: }
添加任何注釋也是很容易的。要編譯它,只需要用下列命令:
javac SOAPService.java
第二步,一旦我們準(zhǔn)備好了SOAP Service,我們需要用SOAP Service Manager來部署它。這個(gè)可以通過很多方式來實(shí)現(xiàn),但是為了能讓初學(xué)SOAP的讀者更容易理解SOAP,我提供了一個(gè)最容易的方式。我們假設(shè)你的Web Server(Tomcat或其他)已經(jīng)正常運(yùn)行,并且你已經(jīng)正確安裝了SOAP。那么當(dāng)瀏覽器訪問 http://localhost:8080/soap/ ,你會(huì)看見Apache SOAP的歡迎頁面。點(diǎn)擊Run the admin client ,然后 Deploy 。你會(huì)得到一個(gè)屏幕顯示,在那里你需要填入ID,Scope,Method,Provider Type和JAVA Provider的信息到表單域中。你能忽略其他所有的表單域,除非你真的需要它們的信息。我們的“HelloWorld”例子不需要它們,所以,我們填的下面的值:
ID: | urn:HelloWorld_SOAPService |
Scope: | Application |
Methods: | sayHi |
Provider Type: | java |
Java Provider - Provider Class: | HelloWorld.SOAPService |
Java Provider - Static? | No |
一些注釋:ID是我們要從SOAP Client標(biāo)識(shí)我們的SOAP Service的唯一名字。Method包含SOAP Service提供的一系列方法。JAVA Provider-Provider Class是SOAP Service Java類的名字。
現(xiàn)在,點(diǎn)擊Deploy 按鈕,那么你的服務(wù)會(huì)被部署。再次強(qiáng)調(diào),請(qǐng)注意正確設(shè)置CLASSPATH環(huán)境變量。然后,你的HelloWorld.SOAPService類能夠被找到,并且所有必需的jar包也能被找到。這是個(gè)幾乎每個(gè)人都會(huì)犯的普通錯(cuò)誤。現(xiàn)在,你能夠點(diǎn)擊 List ,將會(huì)看見你的服務(wù)已經(jīng)被部署進(jìn)來。恭喜!
最后,讓我們來創(chuàng)建一個(gè)SOAP Client。代碼看起來有點(diǎn)復(fù)雜,但是在現(xiàn)實(shí)中不會(huì)只有這么點(diǎn)長。
1: // HelloWorldClient.java
2: import java.io.*;
3: import java.net
.*;
4: import java.util.*;
5: import org.apache.soap.*;
6: import org.apache.soap.rpc.*;
7: public class HelloWorldClient {
8: public static void main(String[] arg) throws Exception {
9: Call c = null;
10: URL url = null;
11: Vector params = null;
12: Response rep = null;
13: String ourName = "Superman";
14: String ourUrn = "urn:HelloWorld_SOAPService";
15: String ourMethod = "sayHi";
16: url = new URL("http://localhost:8080/soap/Servlet
/
rpcrouter");
17: System.out.println("Passing to our deployed "+ourUrn+"
our name ("+ourName+"): ");
18: c = new Call();
19: c.setTargetObjectURI(ourUrn);
20: c.setMethodName(ourMethod);
21: c.setEncodingStyleURI(Constants.NS_URI_SOAP_ENC);
22: params = new Vector();
23: params.addElement(new Parameter("ourName", String.class,
ourName, null));
24: c.setParams(params);
25: System.out.print("and its answer is: ");
26: rep = c.invoke(url, "");
27: if (rep.generatedFault()) {
28: Fault fault = rep.getFault();
29: System.out.println("\nCall failed!");
30: System.out.println("Code = " + fault.getFaultCode());
31: System.out.println("String = " + fault.getFaultString());
32: } else {
33: Parameter result = rep.getReturnValue();
34: System.out.print(result.getValue());
35: System.out.println();
36: }
37: }
38:}
下面我要做一些解釋。在第13行,我們?cè)O(shè)置了我們的名字,這個(gè)名字將會(huì)傳遞給 SOAP Service。在第14行,我們?cè)O(shè)置了我們將要調(diào)用的服務(wù)的ID(service ID),和第15行里設(shè)置的服務(wù)方法(service method)。有了這個(gè)ID,服務(wù)能夠被部署到SOAP服務(wù)管理器(SOAP Service Manager)中。我們沒有設(shè)置任何其他值,僅僅只用剛才那些基礎(chǔ)值就可以正常運(yùn)作了。你能從SOAP的官方文檔上得到相關(guān)信息,該文檔來自SOAP包中,它們的解釋超出了本文的范圍。
用以下方式編譯這個(gè)SOAP Client:
javac HelloWorldClient.java
為了圓滿完成它,讓我們檢查一下針對(duì)我們的測(cè)試,是否所有事情都準(zhǔn)備就緒。Tomcat正在運(yùn)行,所有的環(huán)境變量都正確,SOAP Service被編譯和部署,SOAP Client被成功編譯。OK,讓我們運(yùn)行它,你將看到這個(gè)屏幕:
正如你所看到的,我們的SOAP Client使用SOAP協(xié)議成功發(fā)送它的名字和接收了一個(gè)答復(fù)。正如前面所說的,SOAP Service發(fā)送和接收的是SOAP envelope。這個(gè)是SOAP envelope的源代碼。
被發(fā)送 到SOAP Service的SOAP Envelope
<?XML
version='1.0' encoding='UTF-8'?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/
soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SOAP-ENV:Body>
<ns1:sayHi xmlns:ns1="urn:HelloWorld_SOAPService"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/
soap/encoding/">
<ourName xsi:type="xsd:string">Superman</ourName>
</ns1:sayHi>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>:
從SOAP Service接收 的SOAP Envelope
<?xml version='1.0' encoding='UTF-8'?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/
soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SOAP-ENV:Body>
<ns1:sayHiResponse xmlns:ns1="urn:HelloWorld_SOAPService"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.
org/soap/encoding/">
<return xsi:type="xsd:string">Hello my friend, Superman!
Glad to see you!</return>
</ns1:sayHiResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
要理解SOAP Envelope中的所有標(biāo)簽的含義,我建議你花一點(diǎn)時(shí)間閱讀 http://www.w3.org/2001/06/soap-envelope 命名空間規(guī)范。
我希望本文能夠在你理解SOAP技術(shù)上有一定幫助。這個(gè)技術(shù)是簡單的,有趣的,強(qiáng)大的,彈性的。它被用在許多Web應(yīng)用中,這些應(yīng)用的數(shù)量也在不斷增加。學(xué)習(xí)SOAP是值得的,至少你要知道它是什么和它是怎么運(yùn)作的
小白