java-rpc介绍

来源：互联网发布：sublime 知乎编辑：程序博客网时间：2024/05/01 04:31

RPC应用的java实现

一、RPC介绍

　　什么是RPC？Remote Procedure Call，远程过程调用。也就是说，调用过程代码并不是在调用者本地运行，而是要实现调用者与被调用者二地之间的连接与通信。比较严格的定义是：Remote procedure call (RPC) is a protocol that allows a computer program running on one computer to cause a subroutine on another computer to be executed without the programmer explicitly coding the details for this interaction. When the software in question is written using object-oriented principles, RPC may be referred to asremote invocation or remote method invocation.　这样一讲，容易联想到C/S模式的程序设计，我想是对的。RPC的基本通信模型是基于Client/Server进程间相互通信模型的一种同步通信形式；它对Client提供了远程服务的过程抽象，其底层消息传递操作对Client是透明的。在RPC中，Client即是请求服务的调用者(Caller)，而Server则是执行Client的请求而被调用的程序 (Callee)。

下图是RPC调用协议图：

　　首先是建立RPC服务，约定底层的RPC传输通道(UDP或是TCP)。客户端的调用参数根据传输前所提供的目的地址及RPC 上层应用程序号，通过底层的RPC传输通道转至相应的服务器，即RPC Application Porgramme Server。客户端随即处于等待状态，以服务器等待应答或Time Out超时信号。当服务器端获得了请求消息，会根据注册RPC时告诉RPC系统的程序入口地址执行相应的操作，并将结果返回至客户端。当一次RPC调用结束后，相应线程发送相应的信号，客户端程序便继续运行。

二、基于xml-rpc的应用简单实现

下载xml-rpc jar包http://ws.apache.org/xmlrpc/download.html当前版本：3.1.3

1、业务处理接口

package com.flyoung.xmlrpc;

public interface ServicesHandler {
public String execute(String str);
}

2、业务接口实现

package com.flyoung.xmlrpc;

public class HelloHandlerimplements ServicesHandler {

    public String execute(String str) {

        return "hello "+str+"!";
    }

}

3、客户端

package com.flyoung.xmlrpc;

import java.net.MalformedURLException;
import java.net.URL;
import java.util.Vector;

import org.apache.xmlrpc.XmlRpcException;
import org.apache.xmlrpc.client.XmlRpcClient;
import org.apache.xmlrpc.client.XmlRpcClientConfigImpl;

public class TestClient {

    /**
     * @param args
     */
    public staticvoid main(String[] args) {
        try {
            //配置客户端
            XmlRpcClientConfigImpl config = new XmlRpcClientConfigImpl();
            //设置服务器端地址
            config.setServerURL(new URL("http://localhost:8080/Rpc/HelloHandler"));
            //创建XmlRpc客户端
            XmlRpcClient client = new XmlRpcClient();
            //绑定以上设置
            client.setConfig(config);
            //创建参数列表
            Vector<String> params = new Vector<String>();
            params.addElement("flyoung");
            //执行XML-RPC请求
            String result =(String) client.execute("HelloHandler.execute", params);
            System.out.println("result:"+result);
           } catch (MalformedURLException e) {
            e.printStackTrace();
            } catch (XmlRpcException e) {
            e.printStackTrace();
        }
    }

}

4、服务器端

package com.flyoung.xmlrpc;

import java.io.IOException;

import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.xmlrpc.XmlRpcException;
import org.apache.xmlrpc.server.PropertyHandlerMapping;
import org.apache.xmlrpc.server.XmlRpcServerConfigImpl;
import org.apache.xmlrpc.webserver.XmlRpcServletServer;
import com.flyoung.xmlrpc.HelloHandler;
public class XmlRpcServicesServletextends HttpServlet {
    private XmlRpcServletServer server;
    @Override
    public void init(ServletConfig config)throws ServletException {
        super.init(config);
        try {
            //创建XmlRpcServletServer对象
            server = new XmlRpcServletServer();

            //set up handler mapping of XmlRpcServletServer object
            PropertyHandlerMapping pmp = new PropertyHandlerMapping();
           pmp.addHandler("HelloHandler", HelloHandler.class);
            server.setHandlerMapping(pmp);

            //more config of XmlRpcServletServer object
            XmlRpcServerConfigImpl serverConfig = (XmlRpcServerConfigImpl)server.getConfig();
            serverConfig.setEnabledForExtensions(true);
            serverConfig.setContentLengthOptional(false);
        } catch (XmlRpcException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }


    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp)
            throws ServletException, IOException {

        server.execute(req, resp);
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp)
            throws ServletException, IOException {

        server.execute(req, resp);
    }



}

5、xml配置

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5"
    xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
    http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
<display-name></display-name>
<welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
</welcome-file-list>
<servlet>
      <servlet-name>XmlRpcServer</servlet-name>
      <servlet-class>com.flyoung.xmlrpc.XmlRpcServicesServlet</servlet-class>
</servlet>
<servlet-mapping>
     <servlet-name>XmlRpcServer</servlet-name>
      <url-pattern>/HelloHandler</url-pattern>
</servlet-mapping>
</web-app>

6、测试结果

result:hello flyoung!

　　在RPC中，当一个请求到达RPC服务器时，这个请求就包含了一个参数集和一个文本值，通常形成“classname.methodname”的形式。这就向RPC服务器表明，被请求的方法在为“classname”的类中，名叫“methodname”。然后RPC服务器就去搜索与之相匹配的类和方法，并把它作为那种方法参数类型的输入。这里的参数类型是与RPC请求中的类型是匹配的。一旦匹配成功，这个方法就被调用了，其结果被编码后返回客户方。

　　缺点：

　　1)XML-RPC的消息系统过于简单,没有完整意义上的消息模型
　　2)XML-RPC调用服务的方式要求直接指定对象和方法,称不上完整的面向服务的体系
　　3)XML-RPC服务器端提供的服务实际上是特定对象的某个方法,限制了服务器端的开发

Java RPC通信机制之XML-RPC：Apache XML-RPC 3.0开发简介

摘要：

XML-RPC是一种简单的，轻量级的通过HTTP协议进行RPC通信的规范。本文以Apache XML-RPC 3.0为基础，对XML-RPC的基本原理及Apache XML-RPC 3.0的主要特性进行了讨论和分析。

正文：

一、概述

XML-RPC是一种简单的，轻量级的通过HTTP协议进行RPC通信的规范。一个XML-RPC消息就是一个请求体为XML的HTTP-POST请求，被调用的方法在服务器端执行并将执行结果以XML格式编码后返回。

以下是通过ethereal抓到的一个典型的XML-RPC调用包（为便于阅读，进行了格式化）：

POST /xmlrpc HTTP/1.1

Content-Type: text/xml

User-Agent: Apache XML RPC 3.0 (Jakarta Commons httpclient Transport)

Host: 135.252.156.147:8080

Content-Length: 260

<?xmlversion="1.0"encoding="UTF-8"?>

<methodCallxmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions">

<methodName>Calculator.add</methodName>

<param>

<value>

</value>

</param>

<param>

<value>

</value>

</param>

</params>

</methodCall>

而对应的返回数据包为：

HTTP/1.1 200 OK

Server: Apache XML-RPC 1.0

Connection: close

Content-Type: text/xml

Content-Length: 189

<?xmlversion="1.0"encoding="UTF-8"?>

<methodResponsexmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions">

<param>

<value>

</value>

</param>

</params>

</methodResponse>

其格式很简单，几乎是不言自明的，分别用methodCall和methodResponse标签标识发送给Server的调用请求和Server的返回结果，请求方法的名称用methodName标识，参数用params和param标识，而参数的类型标签则如下表所示：

Tag

Java Type

说明

Integer/int

4字节带符号整数值

Boolean

0 (false) or 1 (true)

String

字符串

Double

双精度带符号浮点值

<dateTime.iso8601>

java.util.Date

日期/时间

byte[]

base64编码的二进制数据

java.util.Map

键值对，键为String类型，而值为任意有效类型

<array>

Object[]

java.util.List

对象数组

二、举例

同上

三、其它特性

除了上面的基本功能，XML-RPC3还支持动态代理/工厂和异步通信等特性。

通过运用动态代理特性，我们可以在Server端及Client端共享接口信息，从而在编译期间进行必要的类型检查，在XML-RPC内部，所有的调用仍然是被动态转发给XmlRpcClient对象来完成的。但要使用XML-RPC3的动态代理功能，相应的服务器端的处理器类名称必须是Client端接口类的全名（含包名，该名称一般应该与Server端接口类全名一致），否则将会导致调用失败。以上面的HelloHandler接口为例，其对应的处理器类名称应该为：demo.xmlrpc.HelloHandler。

Note: 动态代理（JDK1.3引入）是Proxy模式、依赖注入（Dependency Injection）及动态代码生成等技术相结合的一种应用，在各新型Web应用框架及容器中被广泛采用。

而要使用XML-RPC的异步通信功能，只需实现org.apache.xmlrpc.client.AsyncCallback接口，该接口包括两个方法：

publicvoid handleResult(XmlRpcRequest pRequest, Object pResult);

publicvoid handleError(XmlRpcRequest pRequest, Throwable pError);

此外，为了便于在普通应用中使用XML-RPC，XML-RPC还提供了一个WebServer类，以便在应用中内嵌一个HTTP服务器，为Client程序提供HTTP服务。

下面的范例演示了上面提到的几种特性，以下是Server端代码：

// Server3.java

package demo.xmlrpc;

import org.apache.xmlrpc.server.PropertyHandlerMapping;

import org.apache.xmlrpc.server.XmlRpcServer;

import org.apache.xmlrpc.server.XmlRpcServerConfigImpl;

import org.apache.xmlrpc.webserver.WebServer;

publicclass Server3 {

privatestatic finalint port = 8080;

publicstaticvoid main(String [] args) throws Exception {

WebServer webServer = new WebServer(port);

XmlRpcServer xmlRpcServer = webServer.getXmlRpcServer();

PropertyHandlerMapping phm =new PropertyHandlerMapping();

phm.addHandler("demo.xmlrpc.HelloHandler", HelloHandlerImpl.class);

xmlRpcServer.setHandlerMapping(phm);

XmlRpcServerConfigImpl serverConfig = (XmlRpcServerConfigImpl)xmlRpcServer.getConfig();

serverConfig.setEnabledForExtensions(true);

serverConfig.setContentLengthOptional(false);

webServer.start();

}

下面是Client端代码：

// Client3.java

package demo.xmlrpc;

import java.net.URL;

import java.util.List;

import java.util.Vector;

import org.apache.xmlrpc.XmlRpcRequest;

import org.apache.xmlrpc.XmlRpcException;

import org.apache.xmlrpc.client.XmlRpcClient;

import org.apache.xmlrpc.client.XmlRpcClientConfigImpl;

import org.apache.xmlrpc.client.AsyncCallback;

import org.apache.xmlrpc.client.util.ClientFactory;

class EchoCallback implements AsyncCallback {

publicvoid handleResult(XmlRpcRequest pRequest, Object pResult) {

System.out.println("Server returns: " + (String)pResult);

}

publicvoid handleError(XmlRpcRequest pRequest, Throwable pError) {

System.out.println("Error occurs: " + pError.getMessage());

}

publicclass Client3 {

publicstaticvoid main(String [] args) throws Exception {

// create configuration

XmlRpcClientConfigImpl config =new XmlRpcClientConfigImpl();

config.setServerURL(new URL("http://localhost:8080/xmlrpc"));

config.setEnabledForExtensions(true);

config.setConnectionTimeout(60 * 1000);

config.setReplyTimeout(60 * 1000);

XmlRpcClient client = new XmlRpcClient();

// set configuration

client.setConfig(config);

// make a call using dynamic proxy

ClientFactory factory =new ClientFactory(client);

HelloHandler handler = (HelloHandler)factory.newInstance(HelloHandler.class);

String str = handler.sayHello("Bill David");

System.out.println(str);

// make an asynchronous call

List<String> params = new Vector<String>(); // for JDK before 1.5, use 'List params = new Vector();'

params.add("Tom");

client.executeAsync("demo.xmlrpc.HelloHandler.sayHello", params,new EchoCallback());

}