Apache XML-RPC入门：使用java搭建服务端和客户端

 1、简介

　　XML-RPC的全称是XML Remote Procedure Call，即XML远程方法调用。它是一套允许运行在不同操作系统、不同环境的程序实现基于Internet过程调用的规范和一系列的实现。这种远程过程调用使用http作为传输协议，XML作为传送信息的编码格式。Xml-Rpc的定义尽可能的保持了简单，但同时能够传送、处理、返回复杂的数据结构。

　　XML-RPC是工作在Internet上的远程过程调用协议。一个XML-RPC消息就是一个请求体为xml的http-post请求，被调用的方法在服务器端执行并将执行结果以xml格式编码后返回。

  

 

请求实例

下面是一个XML-RPC的请求实例

 

view plain

1. POST /RPC2 HTTP/1.0User-Agent: Frontier/5.1.2 (WinNT)Host: betty.userland.comContent-Type: text/xmlContent-length: 181   
2.   
3. 　　<?xml version="1.0"?>   
4.   
5. 　　<methodCall>   
6.   
7. 　　<methodName>examples.getStateName</methodName>   
8.   
9. 　　<params>   
10.   
11. 　　<param>   
12.   
13. 　　<value><i4>41</i4></value>   
14.   
15. 　　</param>   
16.   
17. 　　</params>   
18.   
19. 　　</methodCall>   

 

响应实例

下面是一个XML-RPC的响应实例

　　

view plain

1. HTTP/1.1 200 OKConnection: closeContent-Length: 158Content-Type: text/xmlDate: Fri, 17 Jul 1998 19:55:08 GMTServer: UserLand Frontier/5.1.2-WinNT   
2.   
3. 　　<?xml version="1.0"?>   
4.   
5. 　　<methodResponse>   
6.   
7. 　　<params>   
8.   
9. 　　<param>   
10.   
11. 　　<value><string>some string params</string></value>   
12.   
13. 　　</param>   
14.   
15. 　　</params>   
16.   
17. 　　</methodResponse>  

 

下面将简要介绍如何快速适用Apache搭建服务端和客户端

2、搭建服务端

      首先通过http://labs.renren.com/apache-mirror//ws/xmlrpc/apache-xmlrpc-current-bin.zip下载最新版本，当前最新版本是3.1.3，解压后将lib目录下得所有jar包都拷贝到项目WEB-INF/lib目录下。

      然后将下面这段XML加入到项目的web.xml文件中：

view plain

1. <servlet>  
2.         <servlet-name>XmlRpcServlet</servlet-name>  
3.         <servlet-class>org.apache.xmlrpc.webserver.XmlRpcServlet</servlet-class>  
4.         <init-param>  
5.           <param-name>enabledForExtensions</param-name>  
6.           <param-value>true</param-value>  
7.           <description>  
8.             Sets, whether the servlet supports vendor extensions for XML-RPC.  
9.           </description>  
10.         </init-param>  
11.     </servlet>  
12.     <servlet-mapping>  
13.         <servlet-name>XmlRpcServlet</servlet-name>  
14.         <url-pattern>/xmlrpc</url-pattern>  
15.     </servlet-mapping>  

      先建一个java类：

view plain

1. package org.apache.xmlrpc.demo;  
2.     public class Calculator {  
3.                 public int add(int i1, int i2) {  
4.                         return i1 + i2;  
5.                 }  
6.                 public int subtract(int i1, int i2) {  
7.                         return i1 - i2;  
8.                 }  
9.     }  

    在包org.apache.xmlrpc.webserver下面新建一个 XmlRpcServlet.properties文件，注意：包名和文件名都不能变。在里面添加上对刚才新建的Calculator类的声明，以便外部调用。

    Calculator=org.apache.xmlrpc.demo.Calculator

     =左侧是Calculator是外部调用时使用的名称，=右侧是类的全名（包括包名）

    至此，服务端就简单搭建完成了。

3、搭建客户端

     由于XML-RPC是支持跨平台调用的，各个平台有与之相对应的实现，这里介绍java平台下客户端的调用实现方式。

    新建一个java类，贴入下面代码

 

view plain

1. import java.net.URL;  
2.   
3. import org.apache.xmlrpc.client.XmlRpcClient;  
4. import org.apache.xmlrpc.client.XmlRpcClientConfigImpl;  
5.   
6. public class RPCTest {  
7.     public static void main(String[] args)throws Exception {  
8.         XmlRpcClientConfigImpl config = new XmlRpcClientConfigImpl();  
9.         config.setServerURL(new URL("http://127.0.0.1:8080/ProjectName/xmlrpc"));  
10.         XmlRpcClient client = new XmlRpcClient();  
11.         client.setConfig(config);  
12.         Object[] params = new Object[]{new Integer(31), new Integer(9)};  
13.         Integer result = (Integer) client.execute("Calculator.add", params);  
14.         System.out.println(result);  
15.     }  
16. }