几行代码实现RPC框架

前言

RPC是指远程过程调用，也就是说两台服务器A，B，一个应用部署在A服务器上，想要调用B服务器上应用提供的函数/方法，由于不在一个内存空间，不能直接调用，需要通过网络来表达调用的语义和传达调用的数据。如Thrift，阿里开源的Dubbo等。本文主要摘自阿里大神的博客：RPC框架几行代码就够了

代码实现

框架代码RpcFramework.java

package com.jcx.study.rpc.framework;

import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.net.ServerSocket;
import java.net.Socket;

public class RpcFramework {
	/**
	 * 暴露服务
	 * @param service 服务实现(实例)
	 * @param port 服务端口
	 * @throws Exception
	 */
	@SuppressWarnings("resource")
	public static void export(final Object service, int port) throws Exception {
		if (service == null)
			throw new IllegalArgumentException("service instance == null");
		if (port <= 0 || port > 65535)
			throw new IllegalArgumentException("Invalid port " + port);
		System.out.println("Export service " + service.getClass().getName() + " on port " + port);
		// 创建服务端Socket
		ServerSocket server = new ServerSocket(port);
		for (;;) {
			try {
				// 接收客户端Socket
				final Socket socket = server.accept();
				// 创建新线程,处理请求，并返回相应
				new Thread(new Runnable() {
					@Override
					public void run() {
						try {
							// 获取socket输入流,并转换为对象输入流
							ObjectInputStream input = new ObjectInputStream(socket.getInputStream());
							try {
								// 获取字符串 要执行的方法名
								String methodName = input.readUTF();
								// 获取要执行的方法的参数的类型
								Class<?>[] parameterTypes = (Class<?>[]) input.readObject();
								// 获取要执行的方法的参数
								Object[] arguments = (Object[]) input.readObject();
								// 获取Socket输出流，并包装为对象输出流
								ObjectOutputStream output = new ObjectOutputStream(socket.getOutputStream());
								try {
									// 利用Java反射获取到要执行的方法，并执行，返回结果
									Method method = service.getClass().getMethod(methodName, parameterTypes);
									Object result = method.invoke(service, arguments);
									// 将结果写入对象输出流
									output.writeObject(result);
								} catch (Throwable t) {
									// 将异常写入对象输出流
									output.writeObject(t);
								} finally {
									output.close();
								}
							} finally {
								input.close();
								socket.close();
							}

						} catch (Exception e) {
							e.printStackTrace();
						}
					}
				}).start();
			} catch (Exception e) {
				e.printStackTrace();
			}
		}
	}

	/**
	 * @param <T> 接口泛型
	 * @param interfaceClass 接口类型
	 * @param host 服务器主机名
	 * @param port 服务器端口
	 * @return 远程服务(服务的代理类)
	 */
	@SuppressWarnings("unchecked")
	public static <T> T refer(final Class<T> interfaceClass, final String host, final int port) {
		if (interfaceClass == null)
			throw new IllegalArgumentException("Interface class == null");
		if (!interfaceClass.isInterface())
			throw new IllegalArgumentException("The " + interfaceClass.getName() + " must be interface class!");
		if (host == null || host.length() == 0)
			throw new IllegalArgumentException("Host == null!");
		if (port <= 0 || port > 65535)
			throw new IllegalArgumentException("Invalid port " + port);
		System.out.println("Get remote service " + interfaceClass.getName() + " from server " + host + ":" + port);
		// 返回一个远程服务的代理类，使用了Java自带的动态代理，在InvocationHandler里面写处理逻辑
		return (T) Proxy.newProxyInstance(interfaceClass.getClassLoader(), new Class<?>[]{interfaceClass}, new InvocationHandler(){

			@Override
			public Object invoke(Object proxy, Method method, Object[] arguments) throws Throwable {
				// 创建客户端Socket
				Socket socket = new Socket(host, port);
				try{
					// 获得Socket输出流,并包装为对象输出流
					ObjectOutputStream output = new ObjectOutputStream(socket.getOutputStream());
					try{
						// 将要调用的方法名字符串写入对象输出流
						output.writeUTF(method.getName());
						// 将要调用的方法的参数的类型(数组)写入对象输出流
						output.writeObject(method.getParameterTypes());
						// 将要调用的方法的参数写入对象输出流
						output.writeObject(arguments);
						// 获得Socket输入流,并包装为对象输入流
						ObjectInputStream input = new ObjectInputStream(socket.getInputStream());
						try{
							// 从输入流中获得远端服务处理后返回的结果
							Object result = input.readObject();
							// 如果返回结果为异常或错误,则抛出
							if(result instanceof Throwable){
								throw (Throwable) result;
							}
							return result;
						} finally {
							input.close();
						}
					} finally{
						output.close();
					}
				} finally{
					socket.close();
				}
			}
			
		});
	}
}

使用Demo

1、定义服务接口

package com.jcx.study.rpc.test;

public interface HelloService {
	public String hello(String name);
}

2、实现服务

package com.jcx.study.rpc.test;

public class HelloServiceImpl implements HelloService {
	@Override
	public String hello(String name) {
		return "Hello " + name;
	}
}

3、服务器端暴露服务

package com.jcx.study.rpc.test;

import com.jcx.study.rpc.framework.RpcFramework;

public class RpcProvider {
	public static void main(String[] args) throws Exception {
		HelloService service = new HelloServiceImpl();
		RpcFramework.export(service, 1234);
	}
}

4、客户端引用服务

package com.jcx.study.rpc.test;

import com.jcx.study.rpc.framework.RpcFramework;

public class RpcConsumer {

	public static void main(String[] args) throws Exception {
		HelloService service = RpcFramework.refer(HelloService.class, "127.0.0.1", 1234);
		for(int i = 0; i < Integer.MAX_VALUE; i++){
			String hello = service.hello("World " + i);
			System.out.println(hello);
			Thread.sleep(1000);
		}
	}
}

体会

个人感觉RPC框架的精髓在于动态代理和网络这两块，因为在客户端是没有服务端的服务具体实现类的，所以只能在客户端实现一个代理类，通过代理类去调用服务中的方法。方法的调用是将相应的方法名、方法参数及其类型通过网络传输给服务端，在服务端通过反射机制调用方法，然后将结果再通过网络返回给调用端（客户端）。