RMI的简单例子

Java的远程方法调用(Remote Method Invocation) 是为了分布式计算而提出来的，最近做一个项目需要用到，所以学习了一番，现在将一个简单的demo贴出来，以便想要学习RMI的同志可以快速上手。

 

RMI的调用是基于接口的，这个接口的定语需要客户知道，客户程序运行时需要一个实现该接口的类的存根(stub)。RMI的内部使用了TCP/IP连接方式，因此需要一个安全机制，且需要对客户机的权限进行一定的设置。

 

想要被远程调用的接口需要扩展Remote类，接口中定义的方法需要对RemoteException异常进行处理，当然，也可以只是抛出异常，将对异常的处理延迟到别的类。

 

RMI的安全处理机制使用的是RMISecurityManager，这个类提供必要的安全验证等处理，而权限控制是通过在客户端和服务端分别设置policy文件来做到的。

 

下面给出一个比较简单，但是能说明问题的例子，略去了不必要的代码，而且这个程序可以通过扩展达到你的某些特殊要求。

 

这个例子是这样，设计一个接口TaskContainer，这个接口对LinkedList进行了一个简单的封装，用途是作为Task的容器，其中可以加入多个Task，这些Task又分别可以独立运行(运行的逻辑可以自行扩展)。TaskContainer扩展了Remote类，因此是可以通过远程调用的。

 

package rmidemo;

import java.rmi.Remote;
import java.rmi.RemoteException;

public interface TaskContainer extends Remote{
	int getTaskCount() throws RemoteException;
	Task getTask() throws RemoteException;
	void addTask(Task t) throws RemoteException;
}

 下面是这个接口的实现

package rmidemo;

import java.rmi.RemoteException;
import java.rmi.server.UnicastRemoteObject;
import java.util.LinkedList;

public class TaskContainerImpl extends UnicastRemoteObject 
implements TaskContainer{

	private static final long 
			serialVersionUID = 4656230894967394376L;
	LinkedList<Task> taskList;
	
	public TaskContainerImpl() throws RemoteException{
		taskList = new LinkedList<Task>();
	}
	
	public Task getTask() throws RemoteException{
		return taskList.size() > 0 ? 
				taskList.removeFirst() : null;
	}

	public int getTaskCount() throws RemoteException{
		return taskList.size();
	}

	public void addTask(Task task) throws RemoteException{
		taskList.add(task);
	}
}

 代码非常简单，就不用多说了，需要注意的是这个类需要扩展UnicastRemoteObject类，而且每个方法都要对RemoteException异常进行处理，这里只是简单的抛出。

 

下面是引用到的Task接口和其实现

package rmidemo;

import java.rmi.Remote;
import java.rmi.RemoteException;

public interface Task extends Remote{
	void execute() throws RemoteException;
	int getTaskID() throws RemoteException;
}

 Task也很简单，一个执行方法，一个获得Task的ID的方法，实现：

package rmidemo;

import java.rmi.RemoteException;
import java.rmi.server.UnicastRemoteObject;

public class TaskImpl extends UnicastRemoteObject implements Task{
	private static final long serialVersionUID = -4520397655735981164L;
	private int taskID;
	
	protected TaskImpl(int i) throws RemoteException {
		taskID = i;
	}

	public void execute() throws RemoteException{
		System.out.println("execute task = "+taskID);//这里只是一个简单的打印，你可以任意扩展之
	}
	
	public int getTaskID() throws RemoteException{
		return taskID;
	}
}

 定义完这些具体的逻辑，就可以在server端进行RMI的配置了，下面是RMI的主入口TaskServer

package rmidemo;

import java.rmi.Naming;
import java.rmi.RMISecurityManager;
import java.rmi.registry.LocateRegistry;

public class TaskServer {
	private static final String host = "localhost";
	private static final int port = 9527;
	
	public static void main(String[] args){
		System.setProperty("java.security.policy", 
		"TaskServer.policy");//权限控制
		
		if(System.getSecurityManager() == null){
			System.setSecurityManager(new RMISecurityManager());
		}//安全管理器的安装
		
		try{
			System.out.println("Constructing server");
			LocateRegistry.createRegistry(port);//注册
			
			TaskContainer container = new TaskContainerImpl();
			
			container.addTask(new TaskImpl(1));//想容器中添加几个Task
			container.addTask(new TaskImpl(2));
			container.addTask(new TaskImpl(3));
			
			System.out.println("binding server impl to registry");

			Naming.rebind("//"+host+":"+port+"/TaskContainer", container);
			
		}catch(Exception e){
			e.printStackTrace();
		}
	}
}

 先安装一个权限配置文件，再安装一个安全管理器，然后注册监听端口，并创建需要被远程调用的对象container,并通过Naming.rebind(String url, Object remote)方法对其绑定，以便远程对其按照URL进行访问。

 

权限的配置需要放在一个单独的文件中，这个例子中，配置放在TaskServer.policy文件中，其内容如下：

grant
{
 permission java.net.SocketPermission
      "*:1000-9999","accept,connect,listen,resolve";
};

 以上为服务器端的全部配置，不过，现在还不能使用，不是因为没有客户端，而是RMI需要一个存根stub才能使远程的线程来调用。

 

JDK里带了一个工具rmic.exe，这个工具可以根据扩展了Remote的类的class文件生成一个存根类，如根据x.class，生成x_stub.class。如果你的类有包名的话，你需要提供给rmic一个完整的包路径。

 

通过下面的命令即可完成这个动作：

$ rmic rmidemo.TaskContainerImpl
$ rmic rmidemo.TaskImpl

 现在在类的完整的路径下生成两个文件TaskContainerImpl_stub.class，TaskImpl_stub.class，服务端的所有配置到此结束。下面我们来看看客户端的代码。

 

相比服务端，客户端的代码就相当简单了，只需要一个用于测试的类即可：

package rmidemo;

import java.rmi.Naming;
import java.rmi.RMISecurityManager;

public class TaskClient {
	private static final String host = "localhost";
	private static final int port = 9527;
	
	public static void main(String[] args){
		System.setProperty("java.security.policy", 
		"TaskClient.policy");//install the policy file
		
		//install RMI Security Manager
		System.setSecurityManager(new RMISecurityManager());
		String url = "rmi://"+host+":"+port+"/";
		
		try{
			TaskContainer container = 
				(TaskContainer)Naming.lookup(url+"TaskContainer");
			while(container.getTaskCount() > 0){
				container.getTask().execute();//invoke the remote method.
			}
		}catch(Exception e){
			e.printStackTrace();
		}
	}
}

 同样，客户端也需要一个权限配置文件，TaskClient.policy

grant
{
 permission java.net.SocketPermission
      "*:1000-9999","connect";
};

 好了，客户端的代码及配置到此结束。现在，我们可以运行这个典型的RMI了，为了清晰起见，我们在控制台上运行这两个程序(分别启两个cmd窗口，因为RMI的server端不会退出[CTRL+C]),先启动server端，再运行客户端，可以看到，server窗口的输出为：

Constructing server
binding server impl to registry
execute task = 1
execute task = 2
execute task = 3

 而客户端没有人户输出就结束了，这正好说明了RMI的意义和流程，client调用的是远程的方法(即server端的对象的方法)

 

好了，这个简单的例子就说到这里，程序很简单，我就不打包了。如果有任何问题，可以留言。

评论

4 楼 napolone1983 2011-08-16  

另外RMISecurityManager ，这个东西是做什么用的，不加不行么？

3 楼 napolone1983 2011-08-16  

能解释一下
permission java.net.SocketPermission  
     "*:1000-9999","connect"; 

授权什么意思么？只能连接1000-9999的端口服务么？

2 楼 abruzzi 2010-05-05  

crabboy 写道

实际项目中有什么具体应用？
很喜欢你写的东西，有深度。

实际项目中的用处还是很大的，但是如果应用比较小的话，体现不出来，事实上如果项目小的话几乎不会用到RMI。

RMI的好处在于将底层的TCP/IP通信封装起来了，其中内部使用的仍然是通过socket来传输序列化过的对象，然后在远程反序列化，执行。

我之前开发过一个BBMS，http://code.google.com/p/bbms/
你可以看看，这里就大概给你说下其中的流程，只是一个方面的例子，你应该就可以理解为什么RMI很重要了：

BBMS是一个基于总线机制的消息系统，所有的实体都可以挂载在总线上，但是实体的物理地址是不知道的。比如，实体A和实体B都挂载在BUS上，但是A不知道B的物理地址，当A想B发送消息(比如邮件，短消息等)的时候，它就向BUS提交一个请求，BUS上有所有实体的注册表，如果收到消息了，它会根据目标实体做回调，比如B是在远程，然后BUS会调用B的一个方法来通知B消息到达，这里就是远程方法调用了。

简而言之，RMI主要用在分布式的系统上，而一般的项目很少涉及到分布式。我曾经在的一家公司做的产品主要是一个Report Server，其中有很多模块都是要支持RMI的。

1 楼 crabboy 2010-05-05  

实际项目中有什么具体应用？
很喜欢你写的东西，有深度。