Java分布式之RMI实例教程

Java分布式之RMI实例教程

Peter Wei
2010-8-22

前言
   最近的联通项目，下一阶段可能会涉及到和各省间的RMI接口，所以总结一下08年中国移动自动拨测系统用到的RMI技术，以备不时之需。同时也给广大初哥提供一些学习资料，哈哈。前几年，一直忙于项目，没怎么做系统总结。以后计划写一些以前项目用过的Java分布式技术实例教程，如：RMI、Socket、Mina、SNMP、SOAP、Web Service、Hessian、JMS等。希望和大家一起交流，分享经验，一起提高。

RMI简介
RMI，远程方法调用（Remote Method Invocation）是Enterprise JavaBeans的支柱，是建立分布式Java应用程序的方便途径。RMI是非常容易使用的，但是它非常的强大。
RMI的基础是接口，RMI构架基于一个重要的原理：定义接口和定义接口的具体实现是分开的。看看jboss-remoting:


基本原理
   要实现网络机器间的通讯，首先得来看看计算机系统网络通信的基本原理，在底层层面去看，网络通信需要做的就是将流从一台计算机传输到另外一台计算机，基于传输协议和网络IO来实现，其中传输协议比较出名的有http、tcp、udp等等，http、tcp、udp都是在基于Socket概念上为某类应用场景而扩展出的传输协议，网络IO，主要有bio、nio、aio三种方式，所有的分布式应用通讯都基于这个原理而实现，只是为了应用的易用，各种语言通常都会提供一些更为贴近应用易用的应用层协议。

主要步骤
  分为以下几个步骤:
1. 创建远程接口及声明远程方法（RmiMonitorService.java）
2. 实现远程接口及远程方法（继承UnicastRemoteObject）(RmiMonitorServiceImpl.java)
3. 启动RMI注册服务，并注册远程对象（RmiServer.java）
4. 客户端查找远程对象，并调用远程方法（MonitorClient.java）
5. 运行实例

业务场景
在移动拨测系统管理端中要融合实时显示。简单点说就是设备出现告警时，要采用不同方式实时展示。如Web界面(Ajax)、GIS等。

   主要业务流程设计：
1. 设备告警
2. 调用RMI Client
3. 调用RMI Server
4. 调用业务处理接口
5. 告警信息入库
6. 实时显示(Ajax,Gis等技术)


技术设计
接口函数函数名称： int interactive( int funindex, string param )
参数说明：
funindex 功能号，整型。1为设备告警
param 交互参数，字符串型。
返回：
成功=1，失败=0。
说明：
param交互参数用键值对组成，每个键值对以“&”分割，如：Tsid=01&devid=002&warnid=102&warntype=01&warnlevel=1 。
测试点ID(tsid)
设备ID(devid)
告警ID(warnid)
告警类型(warntype)
告警级别(warnlevel)

代码实现
废话少说，上代码，为了演示方便，经过整理，省去了很多get，set之类的东东还有业务的东西以及Spring相关的东西。

RmiMonitorService.java
package nbpt.ts.manager.message.service;

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

/**
 * Description: 实时显示RMI服务接口.
 * 
 * RMI接口必须扩展接口java.rmi.Remote
 * 
 * @author Peter Wei
 * @version 1.0 Feb 25, 2009
 */
public interface RmiMonitorService extends Remote {
	/**
	 * 实时显示对外接口
	 * 
	 * @param funindex
	 *            功能号
	 * @param param
	 *            键名列表，也就是实际传输的内容
	 * @return
	 * @throws RemoteException
	 *             远程接口方法必须抛出java.rmi.RemoteException
	 */
	public int interactive(int funindex, String param) throws RemoteException;
}
RmiMonitorServiceImpl.java
package nbpt.ts.manager.message.service.impl;

import java.rmi.RemoteException;
import java.rmi.server.UnicastRemoteObject;
// import nbpt.ts.manager.base.util.AppContext;
import nbpt.ts.manager.message.service.RmiMonitorService;
import nbpt.ts.manager.message.service.WarnService;
/**
 * Description: 实时显示RMI接口实现.
 * 
 * 实现RMI接口及远程方法（继承UnicastRemoteObject）
 * 
 * @author Peter Wei
 * @version 1.0 Feb 25, 2009
 */
public class RmiMonitorServiceImpl extends UnicastRemoteObject implements
		RmiMonitorService {

	private static final long serialVersionUID = -3771656108378649574L;

	public static final int SUCCSS = 1;

	public static final int FAIL = 0;

	public WarnService warnService;

	/**
	 * 必须定义构造方法，因为要抛出RemoteException异常
	 * 
	 * @throws RemoteException
	 */
	public RmiMonitorServiceImpl() throws RemoteException {
		super();
	}

	public int interactive(int funindex, String param) throws RemoteException {

		int result = FAIL;
		switch (funindex) {
		// 告警
		case (1): {

			// warnService = (WarnService) AppContext.getAppContext().getBean(
			// "warn.warnService");
			// 实际应用是从Spring应用中获取告警Service,如上代码
			warnService = new WarnServiceImpl();
			// 网络告警的业务操作
			warnService.dealWarn(param);
			result = SUCCSS;
		}
			break;
		case (2):
			// do other biz
			break;
		}
		// ......

		return result;
	}

	public WarnService getWarnService() {
		return warnService;
	}

	public void setWarnService(WarnService warnService) {
		this.warnService = warnService;
	}

}

RmiServer.java
package nbpt.ts.manager.message.service;

import java.net.MalformedURLException;
import java.rmi.AlreadyBoundException;
import java.rmi.Naming;
import java.rmi.RemoteException;
import java.rmi.registry.LocateRegistry;
import nbpt.ts.manager.message.service.impl.RmiMonitorServiceImpl;
/**
 * Description: RMI服务端.
 * 
 * @author Peter Wei
 * @version 1.0 Feb 25, 2009
 */
public class RmiServer {

	public String ip = "localhost";

	public int port = 8889;

	/**
	 * 启动RMI注册服务，并注册远程对象.实际应用中是在Spring初始化并启动
	 */
	public void init() {
		try {
			LocateRegistry.createRegistry(port);
			// 创建一个远程对象
			RmiMonitorService comm = new RmiMonitorServiceImpl();
			Naming.bind("//" + ip + ":" + port + "/comm", comm);
		} catch (RemoteException e) {
			System.out.println("创建远程对象发生异常！" + e.toString());
			e.printStackTrace();
		} catch (AlreadyBoundException e) {
			System.out.println("发生重复绑定对象异常！" + e.toString());
			e.printStackTrace();
		} catch (MalformedURLException e) {
			System.out.println("发生URL畸形异常！" + e.toString());
			e.printStackTrace();
		}
	}

	public String getIp() {
		return ip;
	}

	public void setIp(String ip) {
		this.ip = ip;
	}

	public int getPort() {
		return port;
	}

	public void setPort(int port) {
		this.port = port;
	}

	public static void main(String[] args) {
		// 实际应用中是在Spring初始化并启动
		RmiServer rmiServer = new RmiServer();
		System.out.println("RMI服务初始化:");
		rmiServer.init();

	}
}
MonitorClient.java
package nbpt.ts.manager.message.service;

import java.net.MalformedURLException;
import java.rmi.Naming;
import java.rmi.NotBoundException;
import java.rmi.RemoteException;
/**
 * Description: RMI客户端.
 * 
 * @author Peter Wei
 * @version 1.0 Feb 25, 2009
 */
public class MonitorClient {

	public RmiMonitorService monitorService;

	public String ip = "localhost";

	public int port = 8889;

	public int interactive(int funindex, String param) {
		int result = 0;
		try {
			getMonitorService().interactive(funindex, param);
			result = 1;
		} catch (RemoteException e) {
			e.printStackTrace();
		}
		return result;
	}

	public RmiMonitorService getMonitorService() {
		try {
			// 在RMI服务注册表中查找名称为RmiMonitorService的对象，并调用其上的方法
			monitorService = (RmiMonitorService) Naming.lookup("rmi://" + ip
					+ ":" + port + "/comm");

		} catch (NotBoundException e) {
			e.printStackTrace();
		} catch (MalformedURLException e) {
			e.printStackTrace();
		} catch (RemoteException e) {
			e.printStackTrace();
		}
		return monitorService;
	}

	public static void main(String args[]) throws RemoteException {
		MonitorClient client = new MonitorClient();
		System.out.println("发送告警信息:");
		String msg = "tsid=1022&devid=10001027&warnid=102&warntype=01&warnlevel=1&warnmsg=设备出错,请检查.";
		System.out.println(client.getValue(msg, "warnmsg"));
		client.interactive(1, msg);

	}

	public String getValue(String content, String key) {
		String value = "";

		int begin = 0, end = 0;
		begin = content.indexOf(key + "=");
		end = content.indexOf("&", begin);

		if (end == -1)
			end = content.length();
		value = content.substring(begin + key.length() + 1, end);
		return value;

	}
}

WarnService.java
package nbpt.ts.manager.message.service;

/**
 * Description: 告警服务
 * 
 * @author Peter Wei
 * @version 1.0 2010-8-22
 */
public interface WarnService {

	/**
	 * 处理告警:告警来时的业务操作,实际操作是解析消息存库，然后界面Ajax定时刷新数据，获取实时告警展示
	 * 
	 * @param message
	 * @return
	 */
	public int dealWarn(String message);
}
WarnServiceImpl.java
package nbpt.ts.manager.message.service.impl;

import nbpt.ts.manager.message.service.WarnService;

/**
 * Description: 告警服务
 * 
 * @author Peter Wei
 * @version 1.0 2010-8-22
 */
public class WarnServiceImpl implements WarnService {

	public int dealWarn(String message) {
		// 告警处理方法
		System.out.println("已接收网络告警");
// …
		return 1;
	}

}

小结
花了4个多小时才完成本实例教程，已经半夜2点多了。大家鼓励一下吧，哈哈。

附：

引用

我也是在core java2上跑不通，yidao620c说按LZ的跑通了，请问是如何跑通的？另外，core java2没有明确的使用rmic在客户端存根，而有些帖子上讲到了这一点。
想问LZ两个问题：
1.如何运行此例。
2.rmic存根是否必要，或者说采用了其它方式代替了。
期待LZ的回复！

在Jdk5.0中，java通过动态代理和反射自动生成stub存根。我们程序中不再需要再做这一步。

评论

22 楼 akunamotata 2011-03-06  

star022 写道

kimmking 写道

peterwei 写道

自已以前只是做过，并没有太深入的研究，够用就好。实际的工程，更多的是业务的东西，还有其它技术的实现。写这个一方面是对以前技术的一些总结，另一方面是给初哥的入门教程。

入门教程 请发到入门讨论

JavaEye的人气就这样被打落了~~~~~~~

我差点又犯规了...发了个表情...

正好最近想看呢，谢谢LZ辛苦贡献

21 楼 peterwei 2011-02-28  

空谷悠悠 写道

我也是在core java2上跑不通，yidao620c说按LZ的跑通了，请问是如何跑通的？另外，core java2没有明确的使用rmic在客户端存根，而有些帖子上讲到了这一点。
想问LZ两个问题：
1.如何运行此例。
2.rmic存根是否必要，或者说采用了其它方式代替了。
期待LZ的回复！

最近在整理代理模式知识时，再看了一下rmi代理。在Jdk5.0中，java通过动态代理和反射自动生成stub存根。我们程序中不再需要再做这一步。

20 楼 flyshark 2011-02-01  

最小的行动比最大的想法伟大, 不管入不入门级, 至少精神可嘉, 比光说不做充大爷的强多了.
---------支持java,支持开源

19 楼 peterwei 2011-01-12  

空谷悠悠 写道

public String ip = "localhost";  将RMI服务器注册到IP指定到主机上，这里是本地的，假如注册到它机上呢，你试过吗？难道也能运行？没有在客户端存根注册RMI服务器恐怕不行吧。

换个ip,试运行一下就行了呀。
说得清楚些吧。你server bind什么ip,你client就连什么ip就行了。
server:

            LocateRegistry.createRegistry(port);   
            // 创建一个远程对象   
            RmiMonitorService comm = new RmiMonitorServiceImpl();   
            Naming.bind("//" + 192.xx + ":" + port + "/comm", comm); 

 

那么你client:

            // 在RMI服务注册表中查找名称为RmiMonitorService的对象，并调用其上的方法   
            monitorService = (RmiMonitorService) Naming.lookup("rmi://" + 192.xx   
                    + ":" + port + "/comm"); 

18 楼 空谷悠悠 2011-01-12  

public String ip = "localhost";  将RMI服务器注册到IP指定到主机上，这里是本地的，假如注册到它机上呢，你试过吗？难道也能运行？没有在客户端存根注册RMI服务器恐怕不行吧。

17 楼 peterwei 2011-01-12  

空谷悠悠 写道

这里服务程序和客户端程序貌似都运行在本机了吧，那RMI岂不是没有意义了，假如如客户端运行在其它机器上呢？LZ尝试或将localhost改为其它机器的IP吗？

实际的运行环境当然是外面的系统。这里是个例子。

16 楼 空谷悠悠 2011-01-12  

这里服务程序和客户端程序貌似都运行在本机了吧，那RMI岂不是没有意义了，假如如客户端运行在其它机器上呢？LZ尝试或将localhost改为其它机器的IP吗？

15 楼 peterwei 2011-01-12  

1.在eclipse里直接run运行就行了，没什么特别的东西。
2.我没看过core java2，所以不知道你们说的rmic在客户端存根是指什么。从rmi原理上来说stub和skelete肯定是要有的。这里用的是jdk.5.0,rmic是不用运行的了，java通过动态代理和反射自动完成了。
这里是UnicastRemoteObject类jdk里的一些说明，供你参考：

public class UnicastRemoteObject extends RemoteServer用于导出带 JRMP 的远程对象和获得与该远程对象通信的 stub。 

对于下面的构造方法和静态 exportObject 方法，正在导出的远程对象的 stub 按以下方式获得： 


如果使用 UnicastRemoteObject.exportObject(Remote) 方法导出该远程对象，则加载 stub 类（通常使用 rmic 工具从远程对象的类预生成）并按以下方式构造 stub 类的实例。 
“根类”按以下情形确定：如果远程对象的类直接实现扩展 Remote 的接口，则远程对象的类为根类；否则，根类为直接实现扩展 Remote 接口的远程对象类的最具派生能力的超类。 
要加载的 stub 类的名称通过连接带有后缀 "_Stub" 的根类的二进制名称确定。 
按使用根类的类加载器的名称加载 stub 类。该 stub 类必须扩展 RemoteStub 并且必须有公共构造方法，该构造方法有一个属于类型 RemoteRef 的参数。 
最后，用 RemoteRef 构造 stub 类的实例。 
如果无法找到适当的 stub 类，或无法加载 stub 类，或创建 stub 实例时出现问题，则抛出 StubNotFoundException。 

对于所有其他导出方式： 

如果无法加载远程对象的 stub 类（如上所述）或将系统属性 java.rmi.server.ignoreStubClasses 设置为 "true"（不分大小写），则用以下属性构造 Proxy 实例： 
代理的实例由远程对象类的类加载器定义。 
该代理实现由远程对象类实现的所有远程接口。 
代理的调用处理程序是用 RemoteRef 构造的 RemoteObjectInvocationHandler 实例。 
如果无法创建代理，则抛出 StubNotFoundException。 

否则，将远程对象的 stub 类（如上所述）的实例用作 stub

14 楼 空谷悠悠 2011-01-12  

我也是在core java2上跑不通，yidao620c说按LZ的跑通了，请问是如何跑通的？另外，core java2没有明确的使用rmic在客户端存根，而有些帖子上讲到了这一点。
想问LZ两个问题：
1.如何运行此例。
2.rmic存根是否必要，或者说采用了其它方式代替了。
期待LZ的回复！

13 楼 nature1 2010-09-20  

楼主辛苦了，非常不错：）

12 楼 heereey 2010-08-31  

入门比较不错

11 楼 kimmking 2010-08-23  

star022 写道

kimmking 写道

peterwei 写道

自已以前只是做过，并没有太深入的研究，够用就好。实际的工程，更多的是业务的东西，还有其它技术的实现。写这个一方面是对以前技术的一些总结，另一方面是给初哥的入门教程。

入门教程 请发到入门讨论

JavaEye的人气就这样被打落了~~~~~~~

je走的就不是大杂烩的路线

10 楼 yidao620c 2010-08-23  

谢谢lz的分享。
我按照《Core Java2》上面的跑不通，然后跑你的例子通了。

9 楼 maoone2003 2010-08-23  

楼主辛苦了，非常不错：）

8 楼 yonlist 2010-08-23  

同意楼上，hessian的性能和效率优于Java内置的序列化/反序列化

7 楼 spell 2010-08-23  

rmi与其他技术相比，要暴露一个端口号，这个在正式的生产环境中，要求开放这个端口，防火墙方面需要做下设置，这个是稍微有点麻烦的地方，我们基本上是用hessian做为分布式接口技术的首选，因为是基于HTTP协议的二进制流技术，所以很容易穿透防火墙，而且hessian的对象序列化效率相当的高，还是轻量级的。

6 楼 冰冷缠绵 2010-08-23  

希望继续分享.

5 楼 pk3589 2010-08-23  

期待后续大作

4 楼 star022 2010-08-22  

kimmking 写道

peterwei 写道

自已以前只是做过，并没有太深入的研究，够用就好。实际的工程，更多的是业务的东西，还有其它技术的实现。写这个一方面是对以前技术的一些总结，另一方面是给初哥的入门教程。

入门教程 请发到入门讨论

JavaEye的人气就这样被打落了~~~~~~~

3 楼 kimmking 2010-08-22  

peterwei 写道

自已以前只是做过，并没有太深入的研究，够用就好。实际的工程，更多的是业务的东西，还有其它技术的实现。写这个一方面是对以前技术的一些总结，另一方面是给初哥的入门教程。

入门教程 请发到入门讨论