Java RPC通讯机制之RMI

大卫注1：

写完CORBA系列后，本想接着写写其它几种典型的远程通信协议：RMI、XML-RPC、SOAP，但由于工作的原因，加之房子装修等麻烦事，一直没有心情动笔。今天接到装修公司老板电话说开工证要晚几天办下来，要停工4-5天，狂怒后突然有了静下心来完成原本想写的东西的想法，既来之，则安之（i.e.郁闷啊，郁闷啊，就习惯了...）

大卫注2：

这个系列基本上是一份笔记，没有加入太多我自己的东西，仅仅记录了自己在使用过程中遇到的问题，及其解决办法。



在传统的RPC编程接口逐渐淡出人们视线的同时，新的、更便于使用且附加了更多特性的RPC编程接口也不断涌现，CORBA作为分布式对象计算技术的典范，在很长一段时间内极大地吸引了大家的注意，但是由于CORBA规范试图覆盖过多的内容，使得CORBA显得过于复杂，也极大地限制了CORBA的应用范围，本系列将向大家介绍几种轻量级的，更适于在Java开发中使用的RPC编程接口：RMI、XML-RPC、SOAP。

RMI（Remote Method Invocation）
与本系列将介绍的其它两种RPC编程接口不同，RMI（Remote Method Invocation）显得有些老旧，它是在Java-IDL加入J2SE之前被引入的。RMI开发流程与CORBA如出一辙（从出现的时间上无法确定RMI是否是按照CORBA规范定制的），因此，其开发过程相对比较烦琐，但是由于RMI是EJB的基础，因此，它在Java开发中具有十分重要的地位。

以下是创建远程方法调用的5个步骤：

1.   定义一个扩展了Remote接口的接口，该接口中的每一个方法必须声明它将产生一个RemoteException异常；

2.   定义一个实现该接口的类；

3.   使用rmic程序生成远程实现所需的存根和框架；

4.   创建一个客户程序和服务器进行RMI调用；

5.   启动rmiregistry并运行自己的服务程序和客户程序。

下面举一个简单、而且被无数次引用的例子：Echo。

1、定义Echo接口
//Echo.java

//The Echo remote interface

package demo.rmi;



import java.rmi.*;



public interface Echo extends Remote {

      String echo(String msg) throws RemoteException;

}

2、实现Echo接口
//EchoServer.java

//The implementation of the Echo remote object

package demo.rmi;



import java.net.*;

import java.rmi.*;

import java.rmi.registry.*;

import java.rmi.server.*;



public class EchoServer

      extends UnicastRemoteObject

      implements Echo {

       //默认构件器，也要“掷”出RemoteException违例

      public EchoServer() throws RemoteException {

            super();

      }



      public String echo(String msg) throws RemoteException {

            return "Echo: " + msg;

      }



      public static void main(String [] args) {

            /*创建和安装一个安全管理器，令其支持RMI。作为Java开发包的一部分，适用于RMI唯一一个是RMISecurityManager.*/

            System.setSecurityManager(new RMISecurityManager());



            try {

                     /*创建远程对象的一个或多个实例，下面是EchoServer对象*/

                  EchoServer es = new EchoServer();

                  /*向RMI远程对象注册表注册至少一个远程对象。一个远程对象拥有的方法即可生成指向其他远程对象的句柄，这样，客户到注册表里访问一次，得到第一个远程对象即可.*/

                  Naming.rebind("EchoServer", es);

                  System.out.println("Ready to provide echo service...");

            } catch (Exception e) {

                  e.printStackTrace();

            }

      }

}

这个实现类使用了UnicastRemoteObject去连接RMI系统。在我们的例子中，我们是直接的从UnicastRemoteObject这个类上继承的，事实上并不一定要这样做，如果一个类不是从UnicastRmeoteObject上继承，那必须使用它的exportObject()方法去连接到RMI。（否则，运行时将被告知无法序列化。）

如果一个类继承自UnicastRemoteObject，那么它必须提供一个构造函数并且声明抛出一个RemoteException对象（否则，会遇到编译错误）。当这个构造函数调用了super()，它就激活UnicastRemoteObject中的代码完成RMI的连接和远程对象的初始化。

3、运行rmic编译实现类，产生_Stub类
在demo.rmi.EchoServer.java上级目录下运行如下命令：

rmic demo.rmi.EchoServer

4、编写客户程序
//EchoClient.java

//Uses remote object EchoServer

package demo.rmi;



import java.rmi.*;

import java.rmi.registry.*;



public class EchoClient {

      public static void main(String [] args) {

            System.setSecurityManager(new RMISecurityManager());



            try {

                  Echo t = (Echo)Naming.lookup("EchoServer");



                  for (int i = 0; i < 10; i++) {

                        System.out.println(t.echo(String.valueOf(i)));

                  }

            } catch (Exception e) {

                  e.printStackTrace();

            }

      }

}

5、运行
编码的工作就只有这些，现在可以依次启动rmiregistry（启动rmiregistry时可以附加一个端口，一般使用默认的端口1099即可，这是默认的Naming Service运行端口）、EchoServer、EchoClient了。但是，虽然有些RMI的资料没有提到，但你运行时不可避免会遇到如下两个错误：

1）java.security.AccessControlException: access denied (java.net.SocketPermission 127.0.0.1:1099 connect,resolve)

原因很简单，RMI Server/Client程序试图通过Socket连接访问本机的rmiregistry服务（即RMI的Naming Service，其运行的默认端口是1099）。要解决这个问题，可以在运行Server/Client时指定一个Policy文件（关于Policy的更多信息，见参考2），如下：

java -Djava.security.policy=demo/rmi/policyfile.txt demo.rmi.EchoServer

Policy文件的内容为：

grant{

      permission java.net.SocketPermission "localhost:1099", "connect, resolve";

};

即允许访问本机的1099端口。

或者干脆来个彻底开放：

grant {

      permission java.security.AllPermission "", "";

};

2）java.rmi.ServerException: RemoteException occurred in server thread; nested exception is:

        java.rmi.UnmarshalException: error unmarshalling arguments; nested exception is:

        java.lang.ClassNotFoundException: demo.rmi.EchoServer_Stub

        ...

如果你凑巧用启动rmiregistry的终端窗口启动了EchoServer，那么你很走运，你看不到上面的错误，但如果你不是在看完这篇文章后就再也用不到RMI，那么，这个错误在那里等着你，:)。

错误很明显，rmiregistry找不到与EchoServer放在同一目录下的EchoServer_Stub，因为package所在demo.rmi目录的上级目录不在rmiregistry的classpath中，这个问题有两种解决方案：

a）在启动rmiregistry前先调整一下CLASSPATH环境变量，以目录E:/为例，执行：

set CLASSPATH=%CLASSPATH%;E:/

b）修改code，在EchoServer中通过如下代码：

Registry r = LocateRegistry.createRegistry(8111);

r.rebind("EchoServer", es);

在程序内部创建一个LocateRegistry，并将自身注册到该LocateRegistry，其中的数值8111表示LocateRegistry运行的端口。

同样，对于客户程序，也需要作相应的调整：

Registry r = LocateRegistry.getRegistry("localhost", 8111);

Echo e = (Echo)r.lookup("EchoServer");

而不是像上面例子中一样访问Naming类的static方法来访问默认的rmiregistry服务。

参考：
1.      Java RMI Tutorial, http://www.ccs.neu.edu/home/kenb/com3337/rmi_tut.html

2.      Policy Tool - Policy File Creation and Management Tool. http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/policytool.html

3.     Java RMI入门实战，http://www.huihoo.com/java/rmi/index.html