XML-RPC 和 XML-RPC 服务器类

CodeIgniter 的 XML-RPC 类允许你发送请求到另一个服务器, 或者建立一个你自己的XML-RPC服务器来接受请求.

什么是XML-RPC?

这是一个非常简单的两台计算机使用XML通过互联网进行通信的方法. 一台计算机 , 我们称之为 客户端 , 发送一个XML-RPC 请求 给另外一台计算机 , 我们称之为 服务器. 当服务器收到请求并加以处理,然后将 结果 返回给客户端.

例如,使用 MetaWeblog 的 API(应用程序接口) , 一个XML-RPC客户端(通常是桌面发布工具)会发送一个请求到运行在你网站的XML-RPC服务端. 这个请求有可能是要发布一篇新的网志,或者是要修改已存在的网志. 当XML-RPC服务器接收到请求,将检验请求并且决定调用何种类/方法来处理请求.一旦处理完毕,服务器将返回一个响应信息.

如果要查看更详细的规范,你可以浏览 XML-RPC 网站.

初始化类

像CodeIgniter的大多数类一样, XML-RPC 和 XML-RPCS 类 在你的控制器中调用 $this->load->library 方法来进行初始化:

使用以下代码载入XML-RPC类库:

$this->load->library('xmlrpc');

一旦XML-RPC类被载入, XML-RPC 库的对象就可以使用了: $this->xmlrpc

使用下面的方法载入 XML-RPC 服务器类：

$this->load->library('xmlrpc');
$this->load->library('xmlrpcs');

$this->load->library('xmlrpc');
$this->xmlrpc->server('http://rpc.pingomatic.com/', 80);
$this->xmlrpc->method('weblogUpdates.ping');
$request = array('My Photoblog', 'http://www.my-site.com/photoblog/');
$this->xmlrpc->request($request);
if ( ! $this->xmlrpc->send_request())
{
    echo $this->xmlrpc->display_error();
}

说明

以上代码初始化XML-RPC类，设置了服务器的URL和要调用的方法（weblogUpdates.ping). 请求（在此例中为你网站的标题和URL）被放在一个数组中使用 request() 函数传输、编译。最后，整个请求发出，如果send_request()方法返回 false，我们将显示XML-RPC 服务器发回的错误信息。 　

请求剖析

一个 XML-RPC 请求只是你发送到 XML-RPC 服务器的数据。请求中的每个数据片断也被称为请求参数。在上面的示例中，有两个参数：你网站的URL和标题。当 XML-RPC 服务器接到你的请求，服务器会寻找请求参数。

请求参数必须放在数组中传输，每个参数可以是七种数据类型中的任一种（字符串，数字，日期，等等）。如果你的参数是字符串外的其它类型，则必须在请求数组中包含数据类型。

下面是一个包含三个参数的简单数组示例:

$request = array('John', 'Doe', 'www.some-site.com');
$this->xmlrpc->request($request);

$request = array (
                   array('John', 'string'),
                   array('Doe', 'string'),
                   array(FALSE, 'boolean'),
                   array(12345, 'int')
                 );
$this->xmlrpc->request($request);

$this->load->library('xmlrpc');
$this->load->library('xmlrpcs');
$config['functions']['new_post'] = array('function' => 'My_blog.new_entry'),
$config['functions']['update_post'] = array('function' => 'My_blog.update_entry');
$config['object'] = $this;
$this->xmlrpcs->initialize($config);
$this->xmlrpcs->serve();

class My_blog extends CI_Controller {
    function new_entry($request)
    {
 
    }
}

class My_blog extends CI_Controller {
    function getUserInfo($request)
    {
        $username = 'smitty';
        $password = 'secretsmittypass';
        $this->load->library('xmlrpc');
    
        $parameters = $request->output_parameters();
    
        if ($parameters['1'] != $username AND $parameters['2'] != $password)
        {
            return $this->xmlrpc->send_error_message('100', 'Invalid Access');
        }
    
        $response = array(array('nickname'  => array('Smitty','string'),
                                'userid'    => array('99','string'),
                                'url'       => array('http://yoursite.com','string'),
                                'email'     => array('jsmith@yoursite.com','string'),
                                'lastname'  => array('Smith','string'),
                                'firstname' => array('John','string')
                                ),
                         'struct');
        return $this->xmlrpc->send_response($response);
    }
}

注意：

output_parameters() 函数会检索一个由相应客户端发送的索引过的请求参数数组。上面的例子中输出参数将会是用户名和密码。

如果客户端发送的用户名和密码无效的话，错误信息会通过 send_error_message() 函数返回。

如果操作成功，客户端会收到包含用户信息的反馈数组。

格式化反馈信息

就像 Requests, Responses 必须被格式化为数组。然而不同于请求信息，反馈信息是只包含一个项的数组。该项可以是一个包含很多其他数组的的数组，但是只有一个主数组索引，下面是一个反馈信息大概的样子：

$response = array('Response data',  'array');

$response = array (
                   array(
                         'first_name' => array('John', 'string'),
                         'last_name' => array('Doe', 'string'),
                         'member_id' => array(123435, 'int'),
                         'todo_list' => array(array('clean house', 'call mom', 'water plants'), 'array'),
                        ),
                 'struct'
                 );

return $this->xmlrpc->send_error_message('123', 'Requested data not available');

<?php
class Xmlrpc_client extends CI_Controller {
 function index()
 { 
  $this->load->helper('url');
  $server_url = site_url('xmlrpc_server');
  $this->load->library('xmlrpc');
  $this->xmlrpc->server($server_url, 80);
  $this->xmlrpc->method('Greetings');
  $request = array('How is it going?');
  $this->xmlrpc->request($request); 
  if ( ! $this->xmlrpc->send_request())
  {
   echo $this->xmlrpc->display_error();
  }
  else
  {
   echo '<pre>';
   print_r($this->xmlrpc->display_response());
   echo '</pre>';
  }
 }
}
?>

<?php
class Xmlrpc_server extends CI_Controller {
 function index()
 {
  $this->load->library('xmlrpc');
  $this->load->library('xmlrpcs');
  $config['functions']['Greetings'] = array('function' => 'Xmlrpc_server.process');
  $this->xmlrpcs->initialize($config);
  $this->xmlrpcs->serve();
 }
 function process($request)
 {
  $parameters = $request->output_parameters();
  $response = array(
       array(
         'you_said'  => $parameters['0'],
         'i_respond' => 'Not bad at all.'),
       'struct');
  return $this->xmlrpc->send_response($response);
 }
}
?>

试试吧！

现在像下面的链接这样访问你的站点：

example.com/index.php/xmlrpc_client/

$request = array(
                  array(
                        // Param 0
                        array(
                              'name'=>'John'
                              ),
                              'struct'
                        ),
                        array(
                              // Param 1
                              array(
                                    'size'=>'large',
                                    'shape'=>'round'
                                    ),
                              'struct'
                        )
                  );
 $this->xmlrpc->request($request);

$parameters = $request->output_parameters();
 $name = $parameters['0']['name'];
 $size = $parameters['1']['size'];
 $shape = $parameters['1']['shape']; 

XML-RPC 函数参考

$this->xmlrpc->server()

设置发送给服务器端的XML-RPC的url和端口参数:

$this->xmlrpc->server('http://www.sometimes.com/pings.php', 80);

$this->xmlrpc->timeout()

设置一个超时时间（以秒计算）:

$this->xmlrpc->timeout(6);

$this->xmlrpc->method()

设置XML-RPC服务器接受的请求方法:

$this->xmlrpc->method('method');

$request = array(array('My Photoblog', 'string'), 'http://www.yoursite.com/photoblog/');
$this->xmlrpc->request($request);

$this->xmlrpc->send_request()

请求发送函数. 函数使用之前设置的参数去发起请求XML-RPC服务，成功则返回布尔值TRUE，失败则返回布尔值.

$this->xmlrpc->set_debug(TRUE);

开始调试模式, 开启后，程序将输出错误、警告等信息，以帮助开发者更快的找到问题所在。

$this->xmlrpc->display_error()

当请求失败后，返回错误信息。

echo $this->xmlrpc->display_error();

$this->xmlrpc->display_response()

远程服务器接收请求后，返回的数据通常是一个关联数组。

$this->xmlrpc->display_response();

$this->xmlrpc->send_error_message()

此函数允许你从服务器发送一个错误消息到客户端.第一个参数是错误编号，第二个参数是错误信息。

return $this->xmlrpc->send_error_message('123', 'Requested data not available');

$this->xmlrpc->send_response()

从服务器发送返回数据到客户端，可以用下面的方法发送一个合法的数组。

$response = array(                 array(                        'flerror' => array(FALSE, 'boolean'),                        'message' => "Thanks for the ping!"                     )                 'struct');return $this->xmlrpc->send_response($response);

数据类型

参考 XML-RPC 规格说明 您可通过XML-RPC发送以下几种数据类型:

• int or i4
• boolean
• string
• double
• dateTime.iso8601
• base64
• struct (contains array of values)
• array (contains array of values)

翻译贡献者:Hex, huanxiangwu, huboo, ianyang, Jacklee, shishirui, sydcurie, wanglinqiang