最近兩月計劃學習研究下RPC框架。本學習會以Dubbo和Motan為參考，先從RPC原理和一個簡單的例子入手。
一、 RPC原理
1. 服務消費方本地調用服務提供方的例子
package com.medici.lorenzo.rpc.stub;
/**
* @author Weimin Sun
*
*/
public interface HelloService {
String hello(String name);
}
package com.medici.lorenzo.rpc.stub;
/**
* @author Weimin Sun
*
*/
public class HelloServiceImpl implements HelloService {
/* (non-Javadoc)
* @see com.medici.lorenzo.easy.HelloService#hello(java.lang.String)
*/
public String hello(String name) {
return "Hello " + name;
}
}
package com.medici.lorenzo.rpc.stub;
import com.medici.lorenzo.rpc.easy.HelloService;
import com.medici.lorenzo.rpc.easy.HelloServiceImpl;
/**
* @author Weimin Sun
*
*/
public class LocalInvoke {
/**
* @param args
*/
public static void main(String[] args) {
HelloService helloService = new HelloServiceImpl();
helloService.hello("Hello World!");
}
}
2. 調用遠程服務
如果服務部署在不同機器，服務間的調用就要網絡通信過程，服務消費方每調用一個服務都要寫網絡通信相關代碼，不僅復雜而且極易出錯。那么有沒有一種方式能像調用本地服務一樣調用遠程服務，而讓調用者對網絡通信這些細節透明，比如服務消費方在執行helloService.hello(“Hello World!”)時，實質上調用的是遠端的服務。
答案就是RPC，看一下其調用流程：
image.png
- 服務消費方（client）調用以本地調用方式調用服務；
- client stub接收到調用后負責將方法、參數等組裝成能夠進行網絡傳輸的消息體；
- client stub找到服務地址，并將消息發送到服務端；
- server stub收到消息后進行解碼；
- server stub根據解碼結果調用本地的服務；
- 本地服務執行并將結果返回給server stub；
- server stub將返回結果打包成消息并發送至消費方；
- client stub接收到消息，并進行解碼；
- 服務消費方得到結果。
下面把上面的本地調用改造一下，可以用來遠程調用：
package com.medici.lorenzo.rpc.stub;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.net.Socket;
/**
* @author Weimin Sun
*
*/
public class RpcProxyClient implements java.lang.reflect.InvocationHandler{
public RpcProxyClient(){
}
/**
* 得到被代理對象;
*/
@SuppressWarnings("unchecked")
public static <T> T getProxy(final Class<T> interfaceClass){
return (T) Proxy.newProxyInstance(interfaceClass.getClassLoader(),
new Class<?>[] {interfaceClass}, new RpcProxyClient());
}
/**
* 調用此方法執行
*/
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
int port = 3456;
Socket socket = new Socket("127.0.0.1", port);
try {
ObjectOutputStream output = new ObjectOutputStream(socket.getOutputStream());
try {
output.writeUTF(method.getName());
output.writeObject(method.getParameterTypes());
output.writeObject(args);
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();
}
}
}
/**
*
*/
package com.medici.lorenzo.rpc.stub;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.lang.reflect.Method;
import java.net.ServerSocket;
import java.net.Socket;
import com.medici.lorenzo.rpc.easy.HelloService;
import com.medici.lorenzo.rpc.easy.HelloServiceImpl;
/**
* @author Weimin Sun
*
*/
public class RemoteServiceStub {
/**
* @param args
*/
public static void main(String[] args) {
int port = 3456;
ServerSocket server;
try {
server = new ServerSocket(port);
for(;;) {
try {
final Socket socket = server.accept();
new Thread(new Runnable() {
@Override
public void run() {
try {
try {
ObjectInputStream input = new ObjectInputStream(socket.getInputStream());
try {
String methodName = input.readUTF();
Class<?>[] parameterTypes = (Class<?>[])input.readObject();
Object[] arguments = (Object[])input.readObject();
ObjectOutputStream output = new ObjectOutputStream(socket.getOutputStream());
try {
HelloService service = new HelloServiceImpl();
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();
}
} finally {
socket.close();
}
} catch (Exception e) {
e.printStackTrace();
}
}
}).start();
Thread.sleep(2000);
} catch (Exception e) {
e.printStackTrace();
}
}
} catch (IOException e1) {
// TODO Auto-generated catch block
e1.printStackTrace();
}
}
}
/**
*
*/
package com.medici.lorenzo.rpc.stub;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.lang.reflect.Method;
import java.net.ServerSocket;
import java.net.Socket;
import com.medici.lorenzo.rpc.easy.HelloService;
/**
* @author Weimin Sun
*
*/
public class RemoteInvoke {
/**
* @param args
* @throws InterruptedException
*/
public static void main(String[] args) throws InterruptedException {
HelloService helloService = (HelloService)RpcProxyClient.getProxy(HelloService.class);
for (int i = 0; i < Integer.MAX_VALUE; i ++) {
String hello = helloService.hello("Hello World" + i);
System.out.println(hello);
Thread.sleep(1000);
}
}
}
這些代碼已實現了簡單的遠程調用服務的功能，下面再把編碼和解碼，通訊代碼放在一起，就是下面的實現。
二、 簡單RPC
1 核心框架
package com.medici.lorenzo.rpc.easy;
/**
* @author Weimin Sun
*
*/
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
*/
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);
ServerSocket server = new ServerSocket(port);
for(;;) {
try {
final Socket socket = server.accept();
new Thread(new Runnable() {
@Override
public void run() {
try {
try {
ObjectInputStream input = new ObjectInputStream(socket.getInputStream());
try {
String methodName = input.readUTF();
Class<?>[] parameterTypes = (Class<?>[])input.readObject();
Object[] arguments = (Object[])input.readObject();
ObjectOutputStream output = new ObjectOutputStream(socket.getOutputStream());
try {
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();
}
} finally {
socket.close();
}
} catch (Exception e) {
e.printStackTrace();
}
}
}).start();
} catch (Exception e) {
e.printStackTrace();
}
}
}
/**
* 引用服務
*
* @param <T> 接口泛型
* @param interfaceClass 接口類型
* @param host 服務器主機名
* @param port 服務器端口
* @return 遠程服務
* @throws Exception
*/
@SuppressWarnings("unchecked")
public static <T> T refer(final Class<T> interfaceClass, final String host, final int port) throws Exception {
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);
return (T) Proxy.newProxyInstance(interfaceClass.getClassLoader(), new Class<?>[] {interfaceClass}, new InvocationHandler() {
public Object invoke(Object proxy, Method method, Object[] arguments) throws Throwable {
Socket socket = new Socket(host, port);
try {
ObjectOutputStream output = new ObjectOutputStream(socket.getOutputStream());
try {
output.writeUTF(method.getName());
output.writeObject(method.getParameterTypes());
output.writeObject(arguments);
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();
}
}
});
}
}
2 定義服務接口
package com.medici.lorenzo.rpc.easy;
/**
* @author Weimin Sun
*
*/
public interface HelloService {
String hello(String name);
}
3 實現服務
package com.medici.lorenzo.rpc.easy;
/**
* @author Weimin Sun
*
*/
public class HelloServiceImpl implements HelloService {
/* (non-Javadoc)
* @see com.medici.lorenzo.easy.HelloService#hello(java.lang.String)
*/
public String hello(String name) {
return "Hello " + name;
}
}
4 暴露服務
package com.medici.lorenzo.rpc.easy;
/**
* @author Weimin Sun
*
*/
public class RpcProvider {
/**
* @param args
*/
public static void main(String[] args) throws Exception {
HelloService service = new HelloServiceImpl();
RpcFramework.export(service, 1234);
}
}
5 引用服務
package com.medici.lorenzo.rpc.easy;
/**
* @author Weimin Sun
*
*/
public class RpcConsumer {
/**
* @param args
*/
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);
}
}
}
本例的思路：
- 使用阻塞的socket IO流來進行server（rpc應用中服務提供方）和client（服務消費方）的通信。
- 并且是端對端的，用端口號來直接進行通信。
- 方法的遠程調用使用的是jdk的動態代理
- 參數的序列化也是使用的最簡單的objectStream。
如果是rpc框架會對上面的實現方式進行替換升級，采用可用易擴展，更適宜分布式場景的中間件技術來替換。
- 用netty的nio特性達到非阻塞的通信，
- 使用zookeeper或其它產品統一管理服務注冊與發現，解決了端對端不靈活的劣勢。
- 代理方式有cglib字節碼技術。
- 序列化方式有hession2，fastjson等。
- rpc框架要解決的不僅僅是技術層面的問題，還要考慮重試機制，超時配置，性能統計等…
代碼：最簡RPC例子
