利用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支持两种不同类型的服务器：

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 
  end
end

第3步 - 暴露处理程序方法：

下一步是我们定义的方法添加到我们的服务器。 initialize方法用于暴露服务的方法，用以下两种方法之一：

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:

def ameth(inparam, inoutparam)
  retval = inparam + inoutparam
  outparam = inparam . inoutparam
  inoutparam = inparam * inoutparam
  return retval, inoutparam, outparam
end

现在，我们可以公开这个方法如下：

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.start
rescue => err
 puts err.message
end

执行时，服务器应用程序开始一个独立的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 -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
end