幾行程式碼實現RPC框架

尋箏發表於2018-05-22

前言

昨天看了一篇關於用幾行程式碼實現RPC框架的部落格javatar.iteye.com/blog/112391…,收穫很大,於是我想在這篇部落格的基礎上理一理思路,儘可能的多加一點註釋,進一步降低學習RPC框架原理的門檻。

原理圖

先上一個原理圖,讀者可根據此圖來幫助理解後續的程式碼。

幾行程式碼實現RPC框架

程式碼

RpcFramework核心類

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 {

        System.out.println("Export service " + service.getClass().getName() + " on port " + port);

        ServerSocket server = new ServerSocket(port);
        //一直輪詢,相比while(true),這種方式效能更佳
        for(;;) {
            try {
                //此處阻塞一直等到有consumer請求過來
                final Socket socket = server.accept();
                //每來一個消費請求就開啟一個新的執行緒
                new Thread(() -> {
                    try {
                        try {
                            ObjectInputStream input = new ObjectInputStream(socket.getInputStream());
                            try {
                                //consumer會分三次傳送所需要的方法資訊,這裡的readUTF(),readObject()都會發生阻塞
                                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);
                                    //將執行結果返回給consumer
                                    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 {

        System.out.println("Get remote service " + interfaceClass.getName() + " from server " + host + ":" + port);
        //通過JDK動態代理的方式直接返回給呼叫refer方法的呼叫者一個被動態代理處理過的 物件
        return (T) Proxy.newProxyInstance(interfaceClass.getClassLoader(), new Class<?>[] {interfaceClass}, new InvocationHandler() {
            @Override
            //呼叫該物件的每個方法都會先去呼叫下面的邏輯
            public Object invoke(Object proxy, Method method, Object[] arguments) throws Throwable {
                //當方法真實被呼叫的時候才會發起RPC遠端請求provider執行服務
                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();
                }
            }
        });
    }

}

複製程式碼

服務介面

public interface HelloService {

    String hello(String name);

}

複製程式碼

服務介面實現

public class HelloServiceImpl implements HelloService {

    @Override
    public String hello(String name) {
        System.out.println("被呼叫了");
        return "Hello" + name;
    }

}

複製程式碼

provider引導類

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

複製程式碼

consumer引導類

public class RpcConsumer {
        public static void main(String[] args) throws Exception {
            //此時獲取到的service是被JDK動態代理包裝後的service,在呼叫方法的時候會進行遠端呼叫
            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);
            }
        }
}

複製程式碼

下圖是provider專案的類結構圖

幾行程式碼實現RPC框架
下圖是consumer專案的類結構圖

幾行程式碼實現RPC框架

總結

簡單總結了一下簡易RPC框架,博主最近正在學習dubbo原理,故並沒有延展講太多分散式內容,希望隨著學習的深入以後能寫一篇關於分散式的文章,共勉!

相關文章