這篇文章主要介紹了利用Ruby的SOAP4R編寫SOAP服務器的教程,並且詳細介紹了添加驅動和調用服務的方法,需要的朋友可以參考下
什麼是SOAP ?
簡單對象訪問協議(SOAP)是一個跨平台和語言無關的,基於XML的RPC協議,通常(但不一定)是HTTP。
它使用XML來編碼信息使遠程過程調用,HTTP在網絡上從客戶機到服務器來傳輸信息,反之亦然。
SOAP有幾個優勢超過其他技術,如COM,CORBA等為例,其相對廉價的部署和調試成本,它的可擴展性和易於使用,存在幾種不同的語言和平台實現。
請參閱出簡單的教程了解 SOAP
本教程將熟悉SOAP實現Ruby(SOAP4R)。這是一個基本的教程,所以如果需要深入細節,那麼需要參考其他資源。
安裝SOAP4R:
SOAP4R是由Hiroshi Nakamura編定,可以直接從網上下載Ruby的開發的SOAP實現:
注意:有可能已經安裝了這個組件。
Download SOAP
如果知道 gem 實用工具,那麼可以使用下面的命令安裝SOAP4R和相關包。
$ gem install soap4r --include-dependencies
如果是在Windows上工作,那麼需要下載一個壓縮文件,從上面的位置,需要安裝它使用標准的安裝方法運行Ruby的 install.rb.
編寫SOAP4R服務器:
SOAP4R支持兩種不同類型的服務器:
CGI/FastCGI based (SOAP::RPC::CGIStub)
Standalone (SOAP::RPC:StandaloneServer)
本教程將詳細編寫一個獨立的服務器。涉及編寫SOAP服務器有以下步驟:
第1步 - 繼承SOAP::RPC::StandaloneServer 類:
要實現自己的獨立服務器,需要編寫一個新類,這將SOAP::StandaloneServer 類的子類,如下:
復制代碼 代碼如下:
class MyServer < SOAP::RPC::StandaloneServer
...............
end
注意:如果想編寫一個基於FastCGI的服務器,那麼需要繼承SOAP::RPC::CGIStub 類, 其余步驟將保持相同。
第2步 - 定義處理程序方法:
第二步是編寫Web服務方法,希望向外界公開。
它們可以寫成簡單的Ruby方法。例如,讓我們寫了兩個兩個兩個數相加,兩個數相除的方法:
?
1 2 3 4 5 6 7 8 9 10 11 class MyServer < SOAP::RPC::StandaloneServer ............... # Handler methods def add(a, b) return a + b end def div(a, b) return a / b end end第3步 - 暴露處理程序方法:
下一步是我們定義的方法添加到我們的服務器。 initialize方法用於暴露服務的方法,用以下兩種方法之一:
?
1 2 3 4 5 class MyServer < SOAP::RPC::StandaloneServer def initialize(*args) add_method(receiver, methodName, *paramArg) end end下面的參數說明:
To understand the usage of inout or out parameters, consider the following service method that takes two parameters (inParam and inoutParam), returns one normal return value (retVal) and two further parameters: inoutParam and outParam:
?
1 2 3 4 5 6 def aMeth(inParam, inoutParam) retVal = inParam + inoutParam outParam = inParam . inoutParam inoutParam = inParam * inoutParam return retVal, inoutParam, outParam end現在,我們可以公開這個方法如下:
?
1 2 3 4 5 6 add_method(self, 'aMeth', [ %w(in inParam), %w(inout inoutParam), %w(out outParam), %w(retval return) ])第4步 - 啟動服務器:
最後一步是通過實例的派生類的一個實例,並調用start方法來啟動服務器。
?
1 2 3 4 myServer = MyServer.new('ServerName', 'urn:ruby:ServiceName', hostname, port) myServer.start這是必需的參數的描述:
例如:
現在使用上述步驟,讓我們寫一個獨立的服務器:
?
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 require "soap/rpc/standaloneserver" begin class MyServer < SOAP::RPC::StandaloneServer # Expose our services def initialize(*args) add_method(self, 'add', 'a', 'b') add_method(self, 'div', 'a', 'b') end # Handler methods def add(a, b) return a + b end def div(a, b) return a / b end end server = MyServer.new("MyServer", 'urn:ruby:calculation', 'localhost', 8080) trap('INT){ server.shutdown } server.start rescue => err puts err.message end執行時,服務器應用程序開始一個獨立的SOAP服務在localhost上偵聽8080端口的請求。它暴露了一個服務方法:add 和 div ,這需要兩個參數並返回結果。
現在可以運行這個服務器後台如下:
?
1 $ ruby MyServer.rb&編寫SOAP4R客戶端:
SOAP::RPC::Driver 類用於寫入SOAP客戶端應用程序提供支持。本教程將介紹這個類,顯示其使用的應用程序的基礎。
以下是最低要求的信息,需要調用SOAP服務:
SOAP服務(SOAP端點URL)
service方法(方法命名空間URI)
service方法的名稱及其參數
現在我們將編寫一個SOAP客戶端調用服務定義的方法在上面的例子名稱為add和div。
以下是主要的步驟來創建一個SOAP客戶端:
步驟1 - 創建一個SOAP驅動程序實例:
我們創建一個實例 SOAP::RPC::Driver 通過調用 new 方法如下:
?
1 SOAP::RPC::Driver.new(endPoint, nameSpace, soapAction)這是必需的參數的描述:
第2步 - 添加服務的方法:
要添加到SOAP SOAP服務方法到 SOAP::RPC::Driver 我們可以調用下面的方法使用 SOAP::RPC::Driver 實例:
driver.add_method(name, *paramArg)
下面的參數說明:
第3步 - 調用SOAP服務:
最後一步是調用SOAP服務使用 SOAP::RPC::Driver 實例如下:
?
1 result = driver.serviceMethod(paramArg...)這裡serviceMethod是實際的Web服務方法和paramArg...是列表參數需要通過在服務方法。
例如:
根據上述步驟,我們將編寫一個SOAP客戶端如下:
?
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 #!/usr/bin/ruby -w require 'soap/rpc/driver' NAMESPACE = 'urn:ruby:calculation' URL = 'http://localhost:8080/' begin driver = SOAP::RPC::Driver.new(URL, NAMESPACE) # Add remote sevice methods driver.add_method('add', 'a', 'b') # Call remote service methods puts driver.add(20, 30) rescue => err puts err.message