`
wbj0110
  • 浏览: 1604615 次
  • 性别: Icon_minigender_1
  • 来自: 上海
文章分类
社区版块
存档分类
最新评论

自定义的RPC的Java实现

阅读更多

在看hadoop的源代码的时候,看到hadoop实现了一个自定义的RPC,于是有了自己写代码实现RPC的想法。

RPC的全名Remote Process Call,即远程过程调用。使用RPC,可以像使用本地的程序一样使用远程服务器上的程序。下面是一个简单的RPC 调用实例,从中可以看到RPC如何使用以及好处:

 

Java代码 复制代码 收藏代码
  1. public class MainClient {  
  2.     public static void main(String[] args) {  
  3.         Echo echo = RPC.getProxy(Echo.class"127.0.0.1"20382);     
  4.         System.out.println(echo.echo("hello,hello"));  
  5.     }  
  6. }  
public class MainClient {
	public static void main(String[] args) {
		Echo echo = RPC.getProxy(Echo.class, "127.0.0.1", 20382);	
		System.out.println(echo.echo("hello,hello"));
	}
}
Java代码 复制代码 收藏代码
  1.   

 

 

Java代码 复制代码 收藏代码
  1. public interface Echo {  
  2.     public String echo(String string);  
  3. }  
public interface Echo {
	public String echo(String string);
}

 

 

 

 

使用RPC.getProxy生成接口Echo的代理实现类。然后就可以像使用本地的程序一样来调用Echo中的echo方法。

使用RPC的好处是简化了远程服务访问。提高了开发效率。在分发代码时,只需要将接口分发给客户端使用,在客户端看来只有接口,没有具体类实现。这样保证了代码的可扩展性和安全性。

 

在看了RPCClient如何使用,我们再来定义一个RPC服务器的接口,看看服务器都提供什么操作:

 

 

Java代码 复制代码 收藏代码
  1. public interface Server {  
  2.     public void stop();  
  3.     public void start();  
  4.     public void register(Class interfaceDefiner,Class impl);  
  5.     public void call(Invocation invo);  
  6.     public boolean isRunning();  
  7.     public int getPort();  
  8. }  
public interface Server {
	public void stop();
	public void start();
	public void register(Class interfaceDefiner,Class impl);
	public void call(Invocation invo);
	public boolean isRunning();
	public int getPort();
}

 

 服务器提供了start和stop方法。使用register注册一个接口和对应的实现类。call方法用于执行Invocation指定的接口的方法名。isRunning返回了服务器的状态,getPort()则返回了服务器使用的端口。

 

来看看Invocation的定义:

 

 

Java代码 复制代码 收藏代码
  1. public class Invocation implements Serializable{  
  2.     /** 
  3.      *  
  4.      */  
  5.     private static final long serialVersionUID = 1L;  
  6.       
  7.     private Class interfaces;  
  8.     private Method method;  
  9.     private Object[] params;  
  10.     private Object result;  
  11.       
  12.       
  13.     /** 
  14.      * @return the result 
  15.      */  
  16.     public Object getResult() {  
  17.         return result;  
  18.     }  
  19.     /** 
  20.      * @param result the result to set 
  21.      */  
  22.     public void setResult(Object result) {  
  23.         this.result = result;  
  24.     }  
  25.     /** 
  26.      * @return the interfaces 
  27.      */  
  28.     public Class getInterfaces() {  
  29.         return interfaces;  
  30.     }  
  31.     /** 
  32.      * @param interfaces the interfaces to set 
  33.      */  
  34.     public void setInterfaces(Class interfaces) {  
  35.         this.interfaces = interfaces;  
  36.     }  
  37.     /** 
  38.      * @return the method 
  39.      */  
  40.     public Method getMethod() {  
  41.         return method;  
  42.     }  
  43.     /** 
  44.      * @param method the method to set 
  45.      */  
  46.     public void setMethod(Method method) {  
  47.         this.method = method;  
  48.     }  
  49.     /** 
  50.      * @return the params 
  51.      */  
  52.     public Object[] getParams() {  
  53.         return params;  
  54.     }  
  55.     /** 
  56.      * @param params the params to set 
  57.      */  
  58.     public void setParams(Object[] params) {  
  59.         this.params = params;  
  60.     }  
  61.     @Override  
  62.     public String toString() {  
  63.         return interfaces.getName()+"."+method.getMethodName()+"("+Arrays.toString(params)+")";  
  64.     }  
  65.       
  66. }  
public class Invocation implements Serializable{
	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;
	
	private Class interfaces;
	private Method method;
	private Object[] params;
	private Object result;
	
	
	/**
	 * @return the result
	 */
	public Object getResult() {
		return result;
	}
	/**
	 * @param result the result to set
	 */
	public void setResult(Object result) {
		this.result = result;
	}
	/**
	 * @return the interfaces
	 */
	public Class getInterfaces() {
		return interfaces;
	}
	/**
	 * @param interfaces the interfaces to set
	 */
	public void setInterfaces(Class interfaces) {
		this.interfaces = interfaces;
	}
	/**
	 * @return the method
	 */
	public Method getMethod() {
		return method;
	}
	/**
	 * @param method the method to set
	 */
	public void setMethod(Method method) {
		this.method = method;
	}
	/**
	 * @return the params
	 */
	public Object[] getParams() {
		return params;
	}
	/**
	 * @param params the params to set
	 */
	public void setParams(Object[] params) {
		this.params = params;
	}
	@Override
	public String toString() {
		return interfaces.getName()+"."+method.getMethodName()+"("+Arrays.toString(params)+")";
	}
	
}

 

 

 

     具体服务器实现类中的call方法是这样使用Invocation的:

 

 

 

Java代码 复制代码 收藏代码
  1. @Override  
  2.         public void call(Invocation invo) {  
  3.             Object obj = serviceEngine.get(invo.getInterfaces().getName()); //根据接口名,找到对应的处理类  
  4.             if(obj!=null) {  
  5.                 try {  
  6.                     Method m = obj.getClass().getMethod(invo.getMethod().getMethodName(), invo.getMethod().getParams());  
  7.                     Object result = m.invoke(obj, invo.getParams());  
  8.                     invo.setResult(result);  
  9.                 } catch (Throwable th) {  
  10.                     th.printStackTrace();  
  11.                 }  
  12.             } else {  
  13.                 throw new IllegalArgumentException("has no these class");  
  14.             }  
  15.         }  
@Override
		public void call(Invocation invo) {
			Object obj = serviceEngine.get(invo.getInterfaces().getName()); //根据接口名,找到对应的处理类
			if(obj!=null) {
				try {
					Method m = obj.getClass().getMethod(invo.getMethod().getMethodName(), invo.getMethod().getParams());
					Object result = m.invoke(obj, invo.getParams());
					invo.setResult(result);
				} catch (Throwable th) {
					th.printStackTrace();
				}
			} else {
				throw new IllegalArgumentException("has no these class");
			}
		}

 

 

  下面来看服务器接收连接并处理连接请求的核心代码:

 

 

 

Java代码 复制代码 收藏代码
  1. public class Listener extends Thread {  
  2.     private ServerSocket socket;  
  3.     private Server server;  
  4.   
  5.     public Listener(Server server) {  
  6.         this.server = server;  
  7.     }  
  8.   
  9.     @Override  
  10.     public void run() {  
  11.   
  12.         System.out.println("启动服务器中,打开端口" + server.getPort());  
  13.         try {  
  14.             socket = new ServerSocket(server.getPort());  
  15.         } catch (IOException e1) {  
  16.             e1.printStackTrace();  
  17.             return;  
  18.         }  
  19.         while (server.isRunning()) {  
  20.             try {  
  21.                   
  22.                 Socket client = socket.accept();  
  23.                 ObjectInputStream ois = new ObjectInputStream(client.getInputStream());  
  24.                 Invocation invo = (Invocation) ois.readObject();  
  25.                 server.call(invo);  
  26.                 ObjectOutputStream oos = new ObjectOutputStream(client.getOutputStream());  
  27.                 oos.writeObject(invo);  
  28.                 oos.flush();  
  29.                 oos.close();  
  30.                 ois.close();  
  31.             } catch (Exception e) {  
  32.                 // TODO Auto-generated catch block  
  33.                 e.printStackTrace();  
  34.             }  
  35.   
  36.         }  
  37.   
  38.         try {  
  39.             if (socket != null && !socket.isClosed())  
  40.                 socket.close();  
  41.         } catch (IOException e) {  
  42.             // TODO Auto-generated catch block  
  43.             e.printStackTrace();  
  44.         }  
  45.     }  
  46. }  
public class Listener extends Thread {
	private ServerSocket socket;
	private Server server;

	public Listener(Server server) {
		this.server = server;
	}

	@Override
	public void run() {

		System.out.println("启动服务器中,打开端口" + server.getPort());
		try {
			socket = new ServerSocket(server.getPort());
		} catch (IOException e1) {
			e1.printStackTrace();
			return;
		}
		while (server.isRunning()) {
			try {
				
				Socket client = socket.accept();
				ObjectInputStream ois = new ObjectInputStream(client.getInputStream());
				Invocation invo = (Invocation) ois.readObject();
				server.call(invo);
				ObjectOutputStream oos = new ObjectOutputStream(client.getOutputStream());
				oos.writeObject(invo);
				oos.flush();
				oos.close();
				ois.close();
			} catch (Exception e) {
				// TODO Auto-generated catch block
				e.printStackTrace();
			}

		}

		try {
			if (socket != null && !socket.isClosed())
				socket.close();
		} catch (IOException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
	}
}

 

 

RPC具体的Server类是这样来使用Listener的:

 

Java代码 复制代码 收藏代码
  1. public static class RPCServer implements Server{  
  2.         private int port = 20382;  
  3.         private Listener listener;   
  4.         private boolean isRuning = true;  
  5.           
  6.         /** 
  7.          * @param isRuning the isRuning to set 
  8.          */  
  9.         public void setRuning(boolean isRuning) {  
  10.             this.isRuning = isRuning;  
  11.         }  
  12.   
  13.         /** 
  14.          * @return the port 
  15.          */  
  16.         public int getPort() {  
  17.             return port;  
  18.         }  
  19.   
  20.         /** 
  21.          * @param port the port to set 
  22.          */  
  23.         public void setPort(int port) {  
  24.             this.port = port;  
  25.         }  
  26.   
  27.         private Map<String ,Object> serviceEngine = new HashMap<String, Object>();  
  28.           
  29.           
  30.         @Override  
  31.         public void call(Invocation invo) {  
  32.             System.out.println(invo.getClass().getName());  
  33.             Object obj = serviceEngine.get(invo.getInterfaces().getName());  
  34.             if(obj!=null) {  
  35.                 try {  
  36.                     Method m = obj.getClass().getMethod(invo.getMethod().getMethodName(), invo.getMethod().getParams());  
  37.                     Object result = m.invoke(obj, invo.getParams());  
  38.                     invo.setResult(result);  
  39.                 } catch (Throwable th) {  
  40.                     th.printStackTrace();  
  41.                 }  
  42.             } else {  
  43.                 throw new IllegalArgumentException("has no these class");  
  44.             }  
  45.         }  
  46.   
  47.         @Override  
  48.         public void register(Class interfaceDefiner, Class impl) {  
  49.             try {  
  50.                 this.serviceEngine.put(interfaceDefiner.getName(), impl.newInstance());  
  51.                 System.out.println(serviceEngine);  
  52.             } catch (Throwable e) {  
  53.                 // TODO Auto-generated catch block  
  54.                 e.printStackTrace();  
  55.             }   
  56.         }  
  57.   
  58.         @Override  
  59.         public void start() {  
  60.             System.out.println("启动服务器");  
  61.             listener = new Listener(this);  
  62.             this.isRuning = true;  
  63.             listener.start();  
  64.         }  
  65.   
  66.         @Override  
  67.         public void stop() {  
  68.             this.setRuning(false);  
  69.         }  
  70.   
  71.         @Override  
  72.         public boolean isRunning() {  
  73.             return isRuning;  
  74.         }  
  75.           
  76.     }  
public static class RPCServer implements Server{
		private int port = 20382;
		private Listener listener; 
		private boolean isRuning = true;
		
		/**
		 * @param isRuning the isRuning to set
		 */
		public void setRuning(boolean isRuning) {
			this.isRuning = isRuning;
		}

		/**
		 * @return the port
		 */
		public int getPort() {
			return port;
		}

		/**
		 * @param port the port to set
		 */
		public void setPort(int port) {
			this.port = port;
		}

		private Map<String ,Object> serviceEngine = new HashMap<String, Object>();
		
		
		@Override
		public void call(Invocation invo) {
			System.out.println(invo.getClass().getName());
			Object obj = serviceEngine.get(invo.getInterfaces().getName());
			if(obj!=null) {
				try {
					Method m = obj.getClass().getMethod(invo.getMethod().getMethodName(), invo.getMethod().getParams());
					Object result = m.invoke(obj, invo.getParams());
					invo.setResult(result);
				} catch (Throwable th) {
					th.printStackTrace();
				}
			} else {
				throw new IllegalArgumentException("has no these class");
			}
		}

		@Override
		public void register(Class interfaceDefiner, Class impl) {
			try {
				this.serviceEngine.put(interfaceDefiner.getName(), impl.newInstance());
				System.out.println(serviceEngine);
			} catch (Throwable e) {
				// TODO Auto-generated catch block
				e.printStackTrace();
			} 
		}

		@Override
		public void start() {
			System.out.println("启动服务器");
			listener = new Listener(this);
			this.isRuning = true;
			listener.start();
		}

		@Override
		public void stop() {
			this.setRuning(false);
		}

		@Override
		public boolean isRunning() {
			return isRuning;
		}
		
	}

 

    服务器端代码搞定后,来看看客户端的代码,先看看我们刚开始使用RPC.getProxy方法:

 

Java代码 复制代码 收藏代码
  1. public static <T> T getProxy(final Class<T> clazz,String host,int port) {  
  2.           
  3.         final Client client = new Client(host,port);  
  4.         InvocationHandler handler = new InvocationHandler() {  
  5.               
  6.             @Override  
  7.             public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {  
  8.                 Invocation invo = new Invocation();  
  9.                 invo.setInterfaces(clazz);  
  10.                 invo.setMethod(new org.jy.rpc.protocal.Method(method.getName(),method.getParameterTypes()));  
  11.                 invo.setParams(args);  
  12.                 client.invoke(invo);  
  13.                 return invo.getResult();  
  14.             }  
  15.         };  
  16.         T t = (T) Proxy.newProxyInstance(RPC.class.getClassLoader(), new Class[] {clazz}, handler);  
  17.         return t;  
  18.     }  
public static <T> T getProxy(final Class<T> clazz,String host,int port) {
		
		final Client client = new Client(host,port);
		InvocationHandler handler = new InvocationHandler() {
			
			@Override
			public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
				Invocation invo = new Invocation();
				invo.setInterfaces(clazz);
				invo.setMethod(new org.jy.rpc.protocal.Method(method.getName(),method.getParameterTypes()));
				invo.setParams(args);
				client.invoke(invo);
				return invo.getResult();
			}
		};
		T t = (T) Proxy.newProxyInstance(RPC.class.getClassLoader(), new Class[] {clazz}, handler);
		return t;
	}

 

Client类的代码如下:

 

Java代码 复制代码 收藏代码
  1. public class Client {  
  2.     private String host;  
  3.     private int port;  
  4.     private Socket socket;  
  5.     private ObjectOutputStream oos;  
  6.     private ObjectInputStream ois;  
  7.   
  8.     public String getHost() {  
  9.         return host;  
  10.     }  
  11.   
  12.   
  13.     public void setHost(String host) {  
  14.         this.host = host;  
  15.     }  
  16.   
  17.     public int getPort() {  
  18.         return port;  
  19.     }  
  20.     public void setPort(int port) {  
  21.         this.port = port;  
  22.     }  
  23.   
  24.     public Client(String host, int port) {  
  25.         this.host = host;  
  26.         this.port = port;  
  27.     }  
  28.   
  29.     public void init() throws UnknownHostException, IOException {  
  30.         socket = new Socket(host, port);  
  31.         oos = new ObjectOutputStream(socket.getOutputStream());  
  32.     }  
  33.   
  34.     public void invoke(Invocation invo) throws UnknownHostException, IOException, ClassNotFoundException {  
  35.         init();  
  36.         System.out.println("写入数据");  
  37.         oos.writeObject(invo);  
  38.         oos.flush();  
  39.         ois = new ObjectInputStream(socket.getInputStream());  
  40.         Invocation result = (Invocation) ois.readObject();  
  41.         invo.setResult(result.getResult());  
  42.     }  
  43.   
  44. }  
public class Client {
	private String host;
	private int port;
	private Socket socket;
	private ObjectOutputStream oos;
	private ObjectInputStream ois;

	public String getHost() {
		return host;
	}


	public void setHost(String host) {
		this.host = host;
	}

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

	public Client(String host, int port) {
		this.host = host;
		this.port = port;
	}

	public void init() throws UnknownHostException, IOException {
		socket = new Socket(host, port);
		oos = new ObjectOutputStream(socket.getOutputStream());
	}

	public void invoke(Invocation invo) throws UnknownHostException, IOException, ClassNotFoundException {
		init();
		System.out.println("写入数据");
		oos.writeObject(invo);
		oos.flush();
		ois = new ObjectInputStream(socket.getInputStream());
		Invocation result = (Invocation) ois.readObject();
		invo.setResult(result.getResult());
	}

}

 

    至此,RPC的客户端和服务器端代码完成,启动服务器的代码如下:

 

Java代码 复制代码 收藏代码
  1. public class Main {  
  2.     public static void main(String[] args) {  
  3.         Server server = new RPC.RPCServer();  
  4.         server.register(Echo.class, RemoteEcho.class);  
  5.         server.start();  
  6.     }  
  7.   
  8. }  
public class Main {
	public static void main(String[] args) {
		Server server = new RPC.RPCServer();
		server.register(Echo.class, RemoteEcho.class);
		server.start();
	}

}

 

   现在先运行服务器端代码,再运行客户端代码,就可以成功运行。

   详细的代码,参考附件的源代码。

 

    在写这个RPC时,没有想太多。在数据串行化上,使用了java的标准io序列化机制,虽然不能跨平台,但是做DEMO还是不错的;另外在处理客户端请求上,使用了ServerSocket,而没有使用ServerSocketChannel这个java nio中的新特性;在动态生成接口的实现类上,使用了java.lang.reflet中的Proxy类。他可以动态创建接口的实现类。

 

 

 

 

分享到:
评论

相关推荐

    自定义RPC的Java实现

    ### 自定义RPC的Java实现详解 #### 一、引言 在现代软件开发中,分布式系统变得越来越普遍,其中远程过程调用(RPC)技术因其简单高效的特点而在跨网络节点间进行服务通信方面发挥着重要作用。本文将详细介绍如何...

    使用netty自定义rpc通信框架

    本项目是基于Netty 4.0实现的自定义RPC通信框架,旨在为Java开发者提供一种高效、灵活的远程服务调用解决方案。 首先,我们来深入理解Netty的基本概念。Netty的核心是其NIO(非阻塞I/O)模型,它使用了Reactor模式...

    基于Java Etcd Vert.x的自定义RPC框架.zip

    本项目是一个基于Java、Etcd和Vert.x框架实现的自定义RPC(远程过程调用)框架。开发者可以通过引入Spring Boot Starter,使用注解和配置文件快速使用该框架,实现像调用本地方法一样轻松调用远程服务。框架支持通过...

    netty实现自定义rpc.zip

    本项目"Netty实现自定义RPC"旨在教你如何利用Netty构建自己的RPC框架。 首先,我们需要理解RPC的基本原理。RPC的核心是将远程服务调用的过程透明化,使它看起来就像是本地方法调用一样。这涉及到序列化、网络通信和...

    自定义rpc框架

    本项目基于Java、Netty和Zookeeper实现了一个自定义的RPC框架,这三个组件各自在RPC框架中扮演着关键角色。 Java作为编程语言,提供了丰富的类库和API,使得开发高效稳定的服务器端应用成为可能。Netty则是一个高...

    JAVA实现简单RPC框架

    在这个“JAVA实现简单RPC框架”的项目中,我们将探讨如何利用Java的核心特性来构建这样的框架。以下是关键知识点的详细说明: 1. **JDK动态代理**: JDK动态代理是Java提供的一种机制,可以在运行时创建一个实现了...

    《netty实战》http协议、自定义协议、自定义RPC模块学习源码.zip

    在Netty中,实现自定义RPC模块通常包括以下步骤: 1. 定义服务接口:这是RPC调用的核心,包含客户端需要调用的方法。 2. 服务端实现:服务提供者实现这个接口,并暴露服务。 3. 编码与解码:为了通过网络传输,我们...

    guide-rpc-framework:由Netty + Kyro + Zookeeper实现的自定义RPC框架。(基于Netty + Kyro + Zookeeper实现的自定义RPC框架-附加详细实现过程和相关教程。)

    guide-rpc-framework ...通过这个简易的轮子,你可以学到RPC的替代原理和原理以及各种Java编码实践的运用。 你甚至可以把当做你的毕设/项目经验的选择,这是非常不错!对比其他求职者的项目经验都是各种系统,造轮子

    java实现rpc框架

    Java实现RPC(Remote Procedure Call)框架是一个复杂而深入的话题,涉及到多个关键的技术点。RPC框架允许程序通过网络调用远程机器上的方法,就像调用本地方法一样,极大地简化了分布式系统开发。以下将详细讲解在...

    netty实例与自定义实现RPC代码

    实现自定义RPC的关键步骤包括: 1. **序列化与反序列化**:选择合适的序列化工具,如JSON、Protobuf或Hessian,将Java对象转换为字节流在网络中传输。 2. **编解码器**:实现自定义的编码器和解码器,将网络消息转化...

    phprpc for java 服务器实例

    Phprpc是一个跨语言的远程过程调用(RPC)框架,它允许PHP和Java应用程序之间进行无缝通信。在本实例中,我们将深入探讨如何在Java环境中设置和使用Phprpc服务器,以便理解其核心概念和操作流程。 1. **Phprpc简介*...

    一款基于 Netty+Kyro+Zookeeper 实现的自定义 RPC 框架

    guide-rpc-framework 是一款基于 Netty+Kyro+Zookeeper 实现的 RPC 框架。代码注释详细,结构清晰,并且集成了 Check Style 规范代码结构,非常适合阅读和学习。

    最简单的JAVA RPC框架实现

    在Java中实现一个简单的RPC框架,我们需要理解以下几个关键概念和技术: 1. **网络通信**:RPC的核心是通过网络进行通信。在Java中,我们可以使用Socket API来实现客户端和服务器端之间的数据传输。Socket提供了低...

    JSON-RPC for Java.src 2.0

    2. "JSON-RPC.jar":这是编译后的Java库文件,包含了JSON-RPC for Java的核心组件,可以直接在Java项目中引用以实现JSON-RPC通信。 3. "JsonRpcClient.js":这可能是JavaScript版本的客户端库,用于在浏览器端或Node...

    gameserver分布式java游戏框架,基于SSM+netty+redis+自定义rpc+MyBatis + mysql

    Java语言游戏项目实战资源包 内容概览: 这次分享为你带来了丰富的Java语言游戏项目实战资源,让你在实践中深入掌握Java语言,并开启游戏开发之旅。资源包中包括: 游戏项目代码:精心挑选了多个经典的小游戏项目...

    一个自定义的RPC框架示例

    通过上述知识点,我们可以构建一个基本的自定义RPC框架。这个框架不仅能够实现服务间的远程调用,还具有一定的扩展性和稳定性,可以满足不同分布式系统的需要。当然,实际的RPC框架可能还需要考虑更多的细节,如...

    RPC简单实现-JAVA

    在JAVA中实现RPC,我们需要理解以下几个关键知识点: 1. **远程调用原理**:RPC的核心思想是让客户端可以像调用本地方法一样调用远程服务器上的方法,中间过程对用户透明。它通过网络协议将请求发送到远程服务,...

Global site tag (gtag.js) - Google Analytics