利用Ruby的SOAP4R編寫SOAP伺服器的教程_ruby專題

 什麼是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支援兩種不同類型的伺服器：

1.     CGI/FastCGI based (SOAP::RPC::CGIStub)
2.     Standalone (SOAP::RPC:StandaloneServer)

本教程將詳細編寫一個獨立的伺服器。涉及編寫SOAP伺服器有以下步驟：
第1步 - 繼承SOAP::RPC::StandaloneServer 類:

要實現自己的獨立伺服器，需要編寫一個新類，這將SOAP::StandaloneServer 類的子類，如下：

複製代碼 代碼如下:

class MyServer < SOAP::RPC::StandaloneServer
  ...............
end

注意：如果想編寫一個基於FastCGI的伺服器，那麼需要繼承SOAP::RPC::CGIStub 類, 其餘步驟將保持相同。
第2步 - 定義處理常式方法：

第二步是編寫Web服務方法，希望向外界公開。

它們可以寫成簡單的Ruby方法。例如，讓我們寫了兩個兩個兩個數相加，兩個數相除的方法：

class MyServer < SOAP::RPC::StandaloneServer  ...............  # Handler methods  def add(a, b)   return a + b  end  def div(a, b)    return a / b   endend

第3步 - 暴露處理常式方法：

下一步是我們定義的方法添加到我們的伺服器。 initialize方法用於暴露服務的方法，用以下兩種方法之一：

class MyServer < SOAP::RPC::StandaloneServer  def initialize(*args)   add_method(receiver, methodName, *paramArg)  endend

下面的參數說明：

 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:

def aMeth(inParam, inoutParam)  retVal = inParam + inoutParam  outParam = inParam . inoutParam  inoutParam = inParam * inoutParam  return retVal, inoutParam, outParamend

現在，我們可以公開這個方法如下：

add_method(self, 'aMeth', [  %w(in inParam),  %w(inout inoutParam),  %w(out outParam),  %w(retval return)])

第4步 - 啟動伺服器：

最後一步是通過執行個體的衍生類別的一個執行個體，並調用start方法來啟動伺服器。

myServer = MyServer.new('ServerName',            'urn:ruby:ServiceName', hostname, port)myServer.start

這是必要參數的描述：

  例如：

現在使用上述步驟，讓我們寫一個獨立的伺服器：

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.startrescue => err puts err.messageend

執行時，伺服器應用程式開始一個獨立的SOAP服務在localhost上偵聽8080連接埠的請求。它暴露了一個服務方法：add 和 div ，這需要兩個參數並返回結果。

現在可以運行這個伺服器後台如下：

$ 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 方法如下：

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 執行個體如下:

result = driver.serviceMethod(paramArg...)

這裡serviceMethod是實際的Web服務方法和paramArg...是列表參數需要通過在服務方法。
例如：

根據上述步驟，我們將編寫一個SOAP用戶端如下：

#!/usr/bin/ruby -wrequire '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.messageend