XML-RPC Web服务(XML-RPC Web Services)

XML-RPC 是一个著名的Web服务. Web 服务是一个工具，它可以再现有的网络基础设施上面设置分布式的应用程序。这些应用程序使用一种传输层的网络但是并不提供直接通过浏览器的人机界面。可扩展标记语言(XML)提供了描述远程过程调用(RPC)的词汇表，RPC是使用超文本传输协议（HTTP） 在计算机之间传输。实际上，RPC让各开发者自行定义网络调用中的接口。这些接口可以是很简单的一个函数调用也可以像大型API那样复杂.

XML-RPC 允许在两台或者更多运行不同操作系统和不同语言程序的计算机之间协同处理。比如，一个JAVA应用可以和一个Perl应用会谈，一个Perl应用可以同一个同ASP会谈的PYTHON应用会谈，等等。系统集成商往往在不同系统之间建立自己的连接，创建它们自己定义的格式的协议来进行通信，但是这造成了大量的不常使用的协议。RPC方法的程序员无需了解底层的协议、网络以及各种实施细则.

XML-RPC 可以同 Python, Java, Perl, PHP, C, C++, Ruby, Microsoft’s .NET 以及许多其他的编程语言来一起使用。它的实现被广泛用于 Unix, Linux, Windows 和 Macintosh 的平台.

一个 XML-RPC 调用实在双方之间进行的，客户端(调用程序)和服务器(被调用过程)。服务时提供在一个特定的URL上的，比如 (such as http://example.org:8080/rpcserv/).

上面我们只是接触了 XML-RPC 的表面. 我推荐 O’Reilly’s “Programming Web Service with XML-RPC” 进行进一步的学习。还可以阅读以下几个环节:

接口（InterFaces）

XML-RPC

XML-RPC 架构

OpenERP 基于C/S体系结构。服务器和客户端之间的通信使用XML-RPC协议。XML-RPC是一个非常简单的协议，它允许客户端进行远程过程调用。被调用的函数，它的参数，调用结果通过XML编码并且使用HTTP进行传输。欲了解更多的关于XML-RPC的详尽信息，请参阅: http://www.xml-rpc.com.

架构(Architecture)

下面的图标综合了OpenERP的客户端和服务器结构。OpenERP的服务器和客户端通信使用 XML-RPC.

/doc_static/5.0/_images/tech_arch.png

客户端

OpenERP 的逻辑实在服务器一段配置的。客户端是很简单的，它是仅用于POST的数据(forms, lists, trees)并且把结果发回服务器。新功能的更新和加入并不需要客户端的升级，这使得OpenERP更容易维护.

客户端并不明白POST的内容。即使像点击打印图标的行动时发送到服务器并且询问如何作出反应.

客户端的操作时很简单的，当客户发出一个动作（保存一个表格、打开一个目录、打印…）它发送动作到服务器。然后服务器执行客户端的请求并将结果发送回来.

下面是三种行为;

  • Open a window (form or tree)

  • Print a document

  • Execute a wizard

Python

通过 xml-rpc 获取数据

代码示例
  • Create a partner and his address
  1. import xmlrpclib
  3. username = 'admin' #the user
  4. pwd = 'admin'      #the password of the user
  5. dbname = 'terp'    #the database
  7. # Get the uid
  8. sock_common = xmlrpclib.ServerProxy ('http://localhost:8069/xmlrpc/common')
  9. uid = sock_common.login(dbname, username, pwd)
  11. #replace localhost with the address of the server
  12. sock = xmlrpclib.ServerProxy('http://localhost:8069/xmlrpc/object')
  14. partner = {
  15.    'name': 'Fabien Pinckaers',
  16.    'lang': 'fr_FR',
  17. }
  19. partner_id = sock.execute(dbname, uid, pwd, 'res.partner', 'create', partner)
  21. address = {
  22.    'partner_id': partner_id,
  23.    'type' : 'default',
  24.    'street': 'Chaussée de Namur 40',
  25.    'zip': '1367',
  26.    'city': 'Grand-Rosière',
  27.    'phone': '+3281813700',
  28.    'fax': '+3281733501',
  29. }
  31. address_id = sock.execute(dbname, uid, pwd, 'res.partner.address', 'create', address)

  • 查询业务伙伴

    1. args = [('vat', '=', 'ZZZZZZ')] #query clause
    2. ids = sock.execute(dbname, uid, pwd, 'res.partner', 'search', args)

  • 读取业务伙伴数据

    1. fields = ['name', 'active', 'vat', 'ref'] #fields to read
    2. data = sock.execute(dbname, uid, pwd, 'res.partner', 'read', ids, fields) #ids is a list of id

  • 更新业务伙伴数据

    1. values = {'vat': 'ZZ1ZZZ'} #data to update
    2. result = sock.execute(dbname, uid, pwd, 'res.partner', 'write', ids, values)

  • 删除业务伙伴

    1. # ids : list of id
    2. result = sock.execute(dbname, uid, pwd, 'res.partner', 'unlink', ids)

PHP

JAVA

Download the XML-RPC framework for PHP

下载 XML-RPC PHP Library

windows / linux: download the xml-rpc framework for php from http://phpxmlrpc.sourceforge.net/ The latest stable release is version 2.2 released on February 25, 2007

extract file xmlrpc-2.2.tar.gz and take the file xmlrpc.inc from lib directory place the xmlrpc.inc in the php library folder restart the apcahe/iis server

Download the xml-rpc framework for java from http://ws.apache.org/xmlrpc/ The latest stable release is version 3.1 released on August 12, 2007. All OpenERP errors throw exceptions because the framework allows only an int as the error code where OpenERP returns a string.

  • 获取OpenERP帐套列表
  1. function connect() {
  2.    var $user = 'admin';
  3.    var $password = 'admin';
  4.    var $dbname = 'db_name';
  5.    var $server_url = 'http://localhost:8069/xmlrpc/';
  8.    if(isset($_COOKIE["user_id"]) == true)  {
  9.        if($_COOKIE["user_id"]>0) {
  10.        return $_COOKIE["user_id"];
  11.        }
  12.    }
  14.    $sock = new xmlrpc_client($server_url.'common');
  15.    $msg = new xmlrpcmsg('login');
  16.    $msg->addParam(new xmlrpcval($dbname, "string"));
  17.    $msg->addParam(new xmlrpcval($user, "string"));
  18.    $msg->addParam(new xmlrpcval($password, "string"));
  19.    $resp =  $sock->send($msg);
  20.    $val = $resp->value();
  21.    $id = $val->scalarval();
  22.    setcookie("user_id",$id,time()+3600);
  23.    if($id > 0) {
  24.        return $id;
  25.    }else{
  26.        return -1;
  27.    }
  28.  }
  • 登陆OpenERP
  1. /**
  2.  * $client = xml-rpc handler
  3.  * $relation = name of the relation ex: res.partner
  4.  * $attribute = name of the attribute ex:code
  5.  * $operator = search term operator ex: ilike, =, !=
  6.  * $key=search for
  7.  */
  9. function search($client,$relation,$attribute,$operator,$keys) {
  10.      var $user = 'admin';
  11.      var $password = 'admin';
  12.      var $userId = -1;
  13.      var $dbname = 'db_name';
  14.      var $server_url = 'http://localhost:8069/xmlrpc/';
  16.      $key = array(new xmlrpcval(array(new xmlrpcval($attribute , "string"),
  17.               new xmlrpcval($operator,"string"),
  18.               new xmlrpcval($keys,"string")),"array"),
  19.         );
  21.      if($userId<=0) {
  22.      connect();
  23.      }
  25.      $msg = new xmlrpcmsg('execute');
  26.      $msg->addParam(new xmlrpcval($dbname, "string"));
  27.      $msg->addParam(new xmlrpcval($userId, "int"));
  28.      $msg->addParam(new xmlrpcval($password, "string"));
  29.      $msg->addParam(new xmlrpcval($relation, "string"));
  30.      $msg->addParam(new xmlrpcval("search", "string"));
  31.      $msg->addParam(new xmlrpcval($key, "array"));
  33.      $resp = $client->send($msg);
  34.      $val = $resp->value();
  35.      $ids = $val->scalarval();
  37.      return $ids;
  38. }
  • 查询业务伙伴
  1. <?
  3. include('xmlrpc.inc');
  5. $arrayVal = array(
  6. 'name'=>new xmlrpcval('Fabien Pinckaers', "string") ,
  7. 'vat'=>new xmlrpcval('BE477472701' , "string")
  8. );
  10. $client = new xmlrpc_client("http://localhost:8069/xmlrpc/object");
  12. $msg = new xmlrpcmsg('execute');
  13. $msg->addParam(new xmlrpcval("dbname", "string"));
  14. $msg->addParam(new xmlrpcval("3", "int"));
  15. $msg->addParam(new xmlrpcval("demo", "string"));
  16. $msg->addParam(new xmlrpcval("res.partner", "string"));
  17. $msg->addParam(new xmlrpcval("create", "string"));
  18. $msg->addParam(new xmlrpcval($arrayVal, "struct"));
  20. $resp = $client->send($msg);
  22. if ($resp->faultCode())
  24.     echo 'Error: '.$resp->faultString();
  26. else
  28.     echo 'Partner '.$resp->value()->scalarval().' created !';
  30. ?>
  • 创建业务伙伴
  1. /**
  2.  * $client = xml-rpc handler
  3.  * $relation = name of the relation ex: res.partner
  4.  * $attribute = name of the attribute ex:code
  5.  * $operator = search term operator ex: ilike, =, !=
  6.  * $id = id of the record to be updated
  7.  * $data = data to be updated
  8.  */
  10. function write($client,$relation,$attribute,$operator,$data,$id) {
  11.      var $user = 'admin';
  12.      var $password = 'admin';
  13.      var $userId = -1;
  14.      var $dbname = 'db_name';
  15.      var $server_url = 'http://localhost:8069/xmlrpc/';
  17.      $id_val = array();
  18.      $id_val[0] = new xmlrpcval($id, "int");
  20.      if($userId<=0) {
  21.      connect();
  22.      }
  24.      $msg = new xmlrpcmsg('execute');
  25.      $msg->addParam(new xmlrpcval($dbname, "string"));
  26.      $msg->addParam(new xmlrpcval($userId, "int"));
  27.      $msg->addParam(new xmlrpcval($password, "string"));
  28.      $msg->addParam(new xmlrpcval($relation, "string"));
  29.      $msg->addParam(new xmlrpcval("write", "string"));
  30.      $msg->addParam(new xmlrpcval($id, "array"));
  31.      $msg->addParam(new xmlrpcval($data, "struct"));
  33.      $resp = $client->send($msg);
  34.      $val = $resp->value();
  35.      $record = $val->scalarval();
  37.      return $record;
  39. }

更新业务伙伴数据

JAVA

Download the apache XML-RPC framework for JAVA

下载 JAVA XML-RPC Library

Download the xml-rpc framework for java from http://ws.apache.org/xmlrpc/ The latest stable release is version 3.1 released on August 12, 2007. All OpenERP errors throw exceptions because the framework allows only an int as the error code where OpenERP returns a string.

  • 代码示例
  1. import java.net.URL;
  2. import java.util.Vector;
  4. import org.apache.commons.lang.StringUtils;
  5. import org.apache.xmlrpc.XmlRpcException;
  6. import org.apache.xmlrpc.client.XmlRpcClient;
  7. import org.apache.xmlrpc.client.XmlRpcClientConfigImpl;
  9. public Vector<String> getDatabaseList(String host, int port)
  10. {
  11.   XmlRpcClient xmlrpcDb = new XmlRpcClient();
  13.   XmlRpcClientConfigImpl xmlrpcConfigDb = new XmlRpcClientConfigImpl();
  14.   xmlrpcConfigDb.setEnabledForExtensions(true);
  15.   xmlrpcConfigDb.setServerURL(new URL("http",host,port,"/xmlrpc/db"));
  17.   xmlrpcDb.setConfig(xmlrpcConfigDb);
  19.   try {
  20.     //Retrieve databases
  21.     Vector<Object> params = new Vector<Object>();
  22.     Object result = xmlrpcDb.execute("list", params);
  23.     Object[] a = (Object[]) result;
  25.     Vector<String> res = new Vector<String>();
  26.     for (int i = 0; i < a.length; i++) {
  27.     if (a[i] instanceof String)
  28.     {
  29.       res.addElement((String)a[i]);
  30.     }
  31.   }
  32.   catch (XmlRpcException e) {
  33.     logger.warn("XmlException Error while retrieving OpenERP Databases: ",e);
  34.     return -2;
  35.   }
  36.   catch (Exception e)
  37.   {
  38.     logger.warn("Error while retrieving OpenERP Databases: ",e);
  39.     return -3;
  40.   }
  41. }
  • 获取OpenERP帐套列表
  1. import java.net.URL;
  3. import org.apache.commons.lang.StringUtils;
  4. import org.apache.xmlrpc.XmlRpcException;
  5. import org.apache.xmlrpc.client.XmlRpcClient;
  6. import org.apache.xmlrpc.client.XmlRpcClientConfigImpl;
  8. public int Connect(String host, int port, String tinydb, String login, String password)
  9. {
  10.   XmlRpcClient xmlrpcLogin = new XmlRpcClient();
  12.   XmlRpcClientConfigImpl xmlrpcConfigLogin = new XmlRpcClientConfigImpl();
  13.   xmlrpcConfigLogin.setEnabledForExtensions(true);
  14.   xmlrpcConfigLogin.setServerURL(new URL("http",host,port,"/xmlrpc/common"));
  16.   xmlrpcLogin.setConfig(xmlrpcConfigLogin);
  18.   try {
  19.     //Connect
  20.     params = new Object[] {tinydb,login,password};
  21.     Object id = xmlrpcLogin.execute("login", params);
  22.     if (id instanceof Integer)
  23.       return (Integer)id;
  24.     return -1;
  25.   }
  26.   catch (XmlRpcException e) {
  27.     logger.warn("XmlException Error while logging to OpenERP: ",e);
  28.     return -2;
  29.   }
  30.   catch (Exception e)
  31.   {
  32.     logger.warn("Error while logging to OpenERP: ",e);
  33.     return -3;
  34.   }
  35. }

  • 登陆

    1. TODO

  • 查询业务伙伴

    1. TODO

  • 创建业务伙伴

    1. TODO

更新业务伙伴

Example of creation of a partner and his address.

  1. import xmlrpclib
  3. sock = xmlrpclib.ServerProxy('http://localhost:8069/xmlrpc/object')
  4. uid = 1
  5. pwd = 'demo'
  7. partner = {
  8.     'title': 'Monsieur',
  9.     'name': 'Fabien Pinckaers',
  10.     'lang': 'fr',
  11.     'active': True,
  12. }
  14. partner_id = sock.execute(dbname, uid, pwd, 'res.partner', 'create', partner)
  16. address = {
  17.     'partner_id': partner_id,
  18.     'type': 'default',
  19.     'street': 'Rue du vieux chateau, 21',
  20.     'zip': '1457',
  21.     'city': 'Walhain',
  22.     'phone': '(+32)10.68.94.39',
  23.     'fax': '(+32)10.68.94.39',
  24. }
  26. sock.execute(dbname, uid, pwd, 'res.partner.address', 'create', address)

Example of creation of a partner and their address.

  1. sock = xmlrpclib.ServerProxy('http://localhost:8069/xmlrpc/common')
  2.  UID = sock.login('terp3', 'admin', 'admin')

To get the UID of a user, you can use the following script:

  1. """
  2. :The login function is under
  3. ::    http://localhost:8069/xmlrpc/common
  4. :For object retrieval use:
  5. ::    http://localhost:8069/xmlrpc/object
  6. """
  7. import xmlrpclib
  9. user = 'admin'
  10. pwd = 'admin'
  11. dbname = 'terp3'
  12. model = 'res.partner'
  14. sock = xmlrpclib.ServerProxy('http://localhost:8069/xmlrpc/common')
  15. uid = sock.login(dbname ,user ,pwd)
  17. sock = xmlrpclib.ServerProxy('http://localhost:8069/xmlrpc/object')
  19. # CREATE A PARTNER
  20. partner_data = {'name'.. code-block:: php:'Tiny', 'active':True, 'vat':'ZZZZZ'}
  21. partner_id = sock.execute(dbname, uid, pwd, model, 'create', partner_data)
  23. # The relation between res.partner and res.partner.category is of type many2many
  24. # To add  categories to a partner use the following format:
  25. partner_data = {'name':'Provider2', 'category_id': [(6,0,[3, 2, 1])]}
  26. # Where [3, 2, 1] are id fields of lines in res.partner.category
  28. # SEARCH PARTNERS
  29. args = [('vat', '=', 'ZZZZZ'),]
  30. ids = sock.execute(dbname, uid, pwd, model, 'search', args)
  32. # READ PARTNER DATA
  33. fields = ['name', 'active', 'vat', 'ref']
  34. results = sock.execute(dbname, uid, pwd, model, 'read', ids, fields)
  35. print results
  37. # EDIT PARTNER DATA
  38. values = {'vat':'ZZ1ZZ'}
  39. results = sock.execute(dbname, uid, pwd, model, 'write', ids, values)
  41. # DELETE PARTNER DATA
  42. results = sock.execute(dbname, uid, pwd, model, 'unlink', ids)

CRUD(创建/读取/更新/删除)代码示例:

  1. PRINT(打印) 示例代码:

  2. PRINT INVOICE

  3. IDS is the invoice ID, as returned by:

  1. import time
  2. import base64
  3. printsock = xmlrpclib.ServerProxy('http://server:8069/xmlrpc/report')
  4. model = 'account.invoice'
  5. id_report = printsock.report(dbname, uid, pwd, model, ids, {'model': model, 'id': ids[0], 'report_type':'pdf'})
  6. time.sleep(5)
  7. state = False
  8. attempt = 0
  9. while not state:
  10.     report = printsock.report_get(dbname, uid, pwd, id_report)
  11.     state = report['state']
  12.     if not state:
  13.     time.sleep(1)
  14.     attempt += 1
  15.     if attempt>200:
  16.     print 'Printing aborted, too long delay !'
  18.     string_pdf = base64.decodestring(report['result'])
  19.     file_pdf = open('/tmp/file.pdf','w')
  20.     file_pdf.write(string_pdf)
  21.     file_pdf.close()

PHP Example

PHP 代码示例

  1. <?
  3.     include('xmlrpc.inc');
  5.     $arrayVal = array(
  6.     'name'=>new xmlrpcval('Fabien Pinckaers', "string") ,
  7.     'vat'=>new xmlrpcval('BE477472701' , "string")
  8.     );
  10.     $client = new xmlrpc_client("http://localhost:8069/xmlrpc/object");
  12.     $msg = new xmlrpcmsg('execute');
  13.     $msg->addParam(new xmlrpcval("dbname", "string"));
  14.     $msg->addParam(new xmlrpcval("3", "int"));
  15.     $msg->addParam(new xmlrpcval("demo", "string"));
  16.     $msg->addParam(new xmlrpcval("res.partner", "string"));
  17.     $msg->addParam(new xmlrpcval("create", "string"));
  18.     $msg->addParam(new xmlrpcval($arrayVal, "struct"));
  20.     $resp = $client->send($msg);
  22.     if ($resp->faultCode())
  24.         echo 'Error: '.$resp->faultString();
  26.     else
  28.         echo 'Partner '.$resp->value()->scalarval().' created !';
  30.     ?>

Here is an example on how to insert a new partner using PHP. This example makes use the phpxmlrpc library, available on sourceforge.

Here is an example in Perl for creating,searching and deleting a partner.

  1. #!c:/perl/bin/perl
  2. # 17-02-2010
  3. # OpenERP XML RPC communication example
  4. # Todor Todorov <todorov@hp.com> <tttodorov@yahoo.com>
  6. use strict;
  7. use Frontier::Client;
  8. use Data::Dumper;
  10. my($user) = 'admin';
  11. my($pw) = 'admin';
  12. my($db) = 'put_your_dbname_here';
  13. my($model) = 'res.partner';
  15. #login
  16. my $server_url = 'http://localhost:8069/xmlrpc/common';
  17. my $server = Frontier::Client->new('url' => $server_url);
  18. my $uid = $server->call('login',$db,$user,$pw);
  20. print Dumper($uid);
  22. my $server_url = 'http://localhost:8069/xmlrpc/object';
  23. my $server = Frontier::Client->new('url' => $server_url);
  25. print Dumper($server);
  27. #
  28. # CREATE A PARTNER
  29. #
  30. my $partner_data = {'name'=>'MyNewPartnerName',
  31.                   'active'=> 'True',
  32.           'vat'=>'ZZZZZ'};
  33. my $partner_id = $server->call('execute',$db, $uid, $pw, $model, 'create', $partner_data);
  35. print Dumper($partner_id);
  37. #
  38. # SEARCH PARTNERS
  39. #
  40. my $query = [['vat', '=', 'ZZZZZ']];
  42. print Dumper($query);
  44. my $ids = $server->call('execute',$db, $uid, $pw, $model, 'search', $query);
  46. print Dumper($ids);
  49. #Here waiting for user input
  50. #OpenERP interface my be checked if partner is shown there
  52. print $/."Check OpenERP if partner is inserted. Press ENTER".$/;
  53. <STDIN>;
  55. #
  56. # DELETE PARTNER DATA
  57. #
  58. my $results = $server->call('execute',$db, $uid, $pw, $model, 'unlink', $ids);
  60. print Dumper($results);

Here is an example in Perl for creating, searching and deleting a partner.