rpc服務實現原理的簡單示例

平時開發中我們在做分佈式項目時經常會用到rpc框架,實現微服務架構。現在公司用到比較多的類似dubbo等框架,這些開源框架是集成了很多功能較複雜的框架。此篇文章實現一個最簡單的rpc服務示例,來簡單說明rpc實現的最基本思想。

源碼已放到github: https://github.com/readreamer23/RpcFrameDemo

一、 核心框架類
封裝暴露服務和引用服務方法,供服務提供者和消費者調用
類名: RpcFrame.java


package com.rpc;
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;

/**
 * rpc簡單框架實現
 * 定義provider暴露服務方法和consumer引用服務方法
 *
 */
public class RpcFrame {

    /**
     * 暴露服務--服務提供者用
     *
     * @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("無效端口:" + port);
        System.out.println("provider服務暴露service= " + service.getClass().getName() + ", 端口 " + 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() + " 必須是接口類!");
        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();
                }
            }
        });
    }


}

二、 定義服務接口
定義一層接口,對外暴露服務用接口,而不是直接暴露實現類
類名: TestApiService.java

package com.rpc.service;

/**
 * 測試業務服務接口.
 */
public interface TestApiService {

    /**
     * 測試方法
     * @param name
     * @return
     */
    String getName(String name);
}

三、 實現服務--接口實現類
類名: TestApiServiceImpl.java

package com.rpc.service.impl;

import com.rpc.service.TestApiService;

/**
 * 測試業務服務接口實現
 */
public class TestApiServiceImpl implements TestApiService {

    public String getName(String name) {

        return "name-" + name;
    }

}

四、 暴露服務---服務提供者類
類名: Provider.java

package com.rpc;

import com.rpc.service.TestApiService;
import com.rpc.service.impl.TestApiServiceImpl;

/**
 * 服務提供者--暴露服務
 */
public class Provider {


    public static void main(String[] args) throws Exception {
        System.out.println("......服務提供者provider:");
        TestApiService service = new TestApiServiceImpl();
        RpcFrame.export(service, ConfigUtil.PORT);
        System.out.println("provider服務已經啓動! ");
    }

}

五、 引用服務---消費者類
類名: Consumer.java

package com.rpc;
import com.rpc.service.TestApiService;
/**
 * 消費者--引用服務
 */
public class Consumer {
    public static void main(String[] args) throws Exception {
        System.out.println("......消費者" );
        TestApiService service = RpcFrame.refer(TestApiService.class,ConfigUtil.HOST,ConfigUtil.PORT);
        System.out.println("consumer開始消費!" );
        for (int i = 0; i < 10; i ++) {
            String hello = service.getName("第" + i+"個");
            System.out.println(hello);
        }
    }
}

六、 運行測試
1.先運行服務提供者 Provider.java
運行結果打印日誌截圖如下

2.再運行消費者 Consumer.java
運行結果打印日誌截圖如下:

源碼鏈接: https://github.com/readreamer23/RpcFrameDemo

這個例子是使用阻塞的socket IO流來進行server和client的通信,也就是rpc應用中服務提供方和服務消費方。並且是端對端的,用端口號來直接進行通信。方法的遠程調用使用的是jdk的動態代理,參數的序列化也是使用的最簡單的objectStream。真實的rpc框架會對上面的實現方式進行替換,採用更快更穩定,更高可用易擴展,更適宜分佈式場景的中間件,技術來替換,而且會用zookeeper等組件做服務註冊與發現。還得有相應的監控系統等輔助平臺應用於企業中。

 

 

參考本人博客:   http://www.iotjike.com/article/43

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章