当前位置：首页 > 资讯 > 技术文档

利用Ruby的SOAP4R编写SOAP服务器的教程

时间：2022-09-22 02:16 编辑：来源：阅读：
扫一扫，手机访问

摘要：利用Ruby的SOAP4R编写SOAP服务器的教程

[b] 什么是SOAP ?[/b] 简单对象访问协议（SOAP）是一个跨平台和语言无关的，基于XML的RPC协议，通常（但不一定）是HTTP。它使用XML来编码信息使远程过程调用，HTTP在网络上从客户机到服务器来传输信息，反之亦然。 SOAP有几个优势超过其他技术，如COM，CORBA等为例，其相对廉价的部署和调试成本，它的可扩展性和易于使用,存在几种不同的语言和平台实现。请参阅出简单的教程了解 SOAP 本教程将熟悉SOAP实现Ruby（SOAP4R）。这是一个基本的教程，所以如果需要深入细节，那么需要参考其他资源。安装SOAP4R: SOAP4R是由Hiroshi Nakamura编定，可以直接从网上下载Ruby的开发的SOAP实现：注意：有可能已经安装了这个组件。 [url=http://raa.ruby-lang.org/project/soap4r/]Download SOAP[/url] 如果知道 gem 实用工具，那么可以使用下面的命令安装SOAP4R和相关包。 $ gem install soap4r --include-dependencies 如果是在Windows上工作，那么需要下载一个压缩文件，从上面的位置，需要安装它使用标准的安装方法运行Ruby的 install.rb. [b]编写SOAP4R服务器：[/b] SOAP4R支持两种不同类型的服务器： [list=1] [*] CGI/FastCGI based (SOAP::RPC::CGIStub)[/*] [*] Standalone (SOAP::RPC:StandaloneServer)[/*] [/list] 本教程将详细编写一个独立的服务器。涉及编写SOAP服务器有以下步骤： [b]第1步 - 继承SOAP::RPC::StandaloneServer 类:[/b] 要实现自己的独立服务器，需要编写一个新类，这将SOAP::StandaloneServer 类的子类，如下：

[u]复制代码[/u] 代码如下:

class MyServer < SOAP::RPC::StandaloneServer

  ...............

end

注意：如果想编写一个基于FastCGI的服务器，那么需要继承SOAP::RPC::CGIStub 类, 其余步骤将保持相同。 [b]第2步 - 定义处理程序方法：[/b] 第二步是编写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

[b]第3步 - 暴露处理程序方法：[/b] 下一步是我们定义的方法添加到我们的服务器。 initialize方法用于暴露服务的方法，用以下两种方法之一：

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

下面的参数说明： [img]http://files.jb51.net/file_images/article/201505/2015513104627431.jpg?2015413104638[/img] 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)
])

[b]第4步 - 启动服务器：[/b] 最后一步是通过实例的派生类的一个实例，并调用start方法来启动服务器。

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

myServer.start

这是必需的参数的描述： [img]http://files.jb51.net/file_images/article/201505/2015513105220947.jpg?2015413105231[/img] 例如：现在使用上述步骤，让我们写一个独立的服务器：

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&

[b]编写SOAP4R客户端：[/b] SOAP::RPC::Driver 类用于写入SOAP客户端应用程序提供支持。本教程将介绍这个类，显示其使用的应用程序的基础。以下是最低要求的信息，需要调用SOAP服务： [list] [*] SOAP服务（SOAP端点URL）[/*] [*] service方法（方法命名空间URI）[/*] [*] service方法的名称及其参数[/*] [/list] 现在我们将编写一个SOAP客户端调用服务定义的方法在上面的例子名称为add和div。以下是主要的步骤来创建一个SOAP客户端： [b]步骤1 - 创建一个SOAP驱动程序实例：[/b] 我们创建一个实例 SOAP::RPC::Driver 通过调用 new 方法如下：

SOAP::RPC::Driver.new(endPoint, nameSpace, soapAction)

这是必需的参数的描述： [img]http://files.jb51.net/file_images/article/201505/2015513105327148.jpg?2015413105336[/img] [b] 第2步 - 添加服务的方法：[/b] 要添加到SOAP SOAP服务方法到 SOAP::RPC::Driver 我们可以调用下面的方法使用 SOAP::RPC::Driver 实例: driver.add_method(name, *paramArg) 下面的参数说明： [img]http://files.jb51.net/file_images/article/201505/2015513105419866.jpg?2015413105434[/img] [b]第3步 - 调用SOAP服务：[/b] 最后一步是调用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

全部评论(0)

上一篇：Ruby程序中发送基于HTTP协议的请求的简单示例
下一篇：Ruby的面向对象方式编程学习杂记

资讯排行榜
更多>>