手把手教你简单实现RPC协议! - Java

1,522 阅读4分钟

本文已参与「新人创作礼」活动, 一起开启掘金创作之路。

 什么是RPC

RPC - Remote Procedure Call,远程过程调用。它是一个计算机通信协议,允许像调用本地服务一样调用远程服务。

        假设Computer1在调用sayHi()方法,对于Computer1而言调用sayHi()方法就像调用本地方法一样,调用 –>返回。但其实Computer1调用的是Computer2中的sayHi()方法,RPC屏蔽了底层的实现细节,让调用者无需关注网络通信,数据传输等细节。

分析

我们从以下几个方面考虑实现:

  • 通信模型:假设通信的为A机器与B机器,A与B之间有通信模型,在Java中一般基于BIO或NIO。
  • 过程(服务)定位:使用给定的通信方式,与确定IP与端口及方法名称确定具体的过程或方法。
  • 远程代理对象:本地调用的方法(服务)其实是远程方法的本地代理,因此可能需要一个远程代理对象,对于Java而言,远程代理对象可以使用Java的动态对象实现,封装了调用远程方法调用。
  • 序列化:将对象名称、方法名称、参数等对象信息进行网络传输需要转换成二进制传输,这里可能需要不同的序列化技术方案。如:protobuf,Arvo等。

实现

技术方案

对于以上几点,我们采用Socket通信、动态代理与反射与Java原生的序列化来实现。

框架架构

RPC架构分为三部分:

  1. 服务提供者,运行在服务器端,提供服务接口定义与服务实现类。
  2. 服务中心,运行在服务器端,负责将本地服务发布成远程服务,管理远程服务,提供给服务消费者使用。
  3. 服务消费者,运行在客户端,通过远程代理对象调用远程服务。

具体实现

        我们首先定义需要调用的接口及其实现类,此处为 ServerService 和 ServerServiceImpl

    public interface ServerService {
        void doSome(String name);
    }
    public class ServerServiceImpl implements ServerService {
        @Override
        public void doSome(String name) {
            System.out.println(name + " doSome");
        }
    }

        紧接着,我们需要明确通信的传输规则。 对于一个最基本的方法调用,我们需要得知 类名、方法名、形式参数种类,实际参数。基于以上分析与Java生成代理类的要求,我们可以写出以下客户端方法,当调用代理类时向服务端发送套接字调用对应方法获取返回的输出流。

    /**
     * @param serviceInterface 要调用的抽象类接口(用于服务端获取对应实现类
     * */
    public static <T> T getRemoteProxyObject(Class<?> serviceInterface, String host, int port) {
        return (T) Proxy.newProxyInstance(serviceInterface.getClassLoader(), new Class<?>[]{serviceInterface}, (proxy, method, args) -> {
            try (Socket socket = new Socket()) {
                socket.connect(new InetSocketAddress(host, port));
                try (
                    ObjectOutputStream output = new ObjectOutputStream(socket.getOutputStream());
                    ObjectInputStream input = new ObjectInputStream(socket.getInputStream());
                ) {
                    output.writeUTF(serviceInterface.getName());
                    output.writeUTF(method.getName());
                    output.writeObject(method.getParameterTypes());
                    output.writeObject(args);

                    return input.readObject();
                }
            }
        });
    }

请注意,服务端与客户端的连接我们使用Java原生套接字实现,这是一个既定的基础!

        在完成客户端向客户端的请求之后,我们需要在服务端接受并处理对应请求。为了便于找到对应抽象类的实现类,我们维护一个Map用于快速获取对应实例。 为了便于对客户端的请求进行处理,我们专门定义一个 Server 类用于管理和维护。

public class Server {
    private final ExecutorService executor = Executors.newFixedThreadPool(Runtime.getRuntime().availableProcessors());
    private final HashMap<String, Class<?>> serviceRegister = new HashMap<>(1 << 3);
    private boolean running = false;
    private final int port;

    public Server(int port) {
        this.port = port;
    }

    public <T> void register(Class<T> serviceInterface, Class<? extends T> impl) {
        serviceRegister.put(serviceInterface.getName(), impl);
    }

    public void start() throws IOException {
        ServerSocket server = new ServerSocket();
        server.bind(new InetSocketAddress(port));
        System.out.println("Start Server ...");
        try {
            while (true) {
                executor.execute(new ServiceTask(server.accept(), this));
//                如果调用方法较轻量,可选取该方法进行及时处理
//                Socket socket = server.accept();
//                if (socket != null) {
//                    executor.execute(new ServiceTask(socket, this));
//                }
            }
        } finally {
            server.close();
        }
    }

    public void stop() {
        if (running) {
            running = false;
            executor.shutdown();
        }
    }
}

ServerTask 是专门定义的一个内部线程实现类用于服务端对接收到套接字信息进行解析。

    private static class ServiceTask implements Runnable {
        private final Socket socket;
        private final Server server;

        public ServiceTask(Socket socket, Server server) {
            this.socket = socket;
            this.server = server;
        }

        @Override
        public void run() {
            try (
                ObjectInputStream input = new ObjectInputStream(socket.getInputStream());
                ObjectOutputStream output = new ObjectOutputStream(socket.getOutputStream());
            ) {
                String className = input.readUTF();
                String methodName = input.readUTF();
                Class<?>[] parameterTypes = (Class<?>[]) input.readObject();
                Object[] arguments = (Object[]) input.readObject();

                Class<?> serviceClass = this.server.serviceRegister.get(className);
                if (serviceClass == null)
                    throw new ClassNotFoundException(className);
                Method method = serviceClass.getMethod(methodName, parameterTypes);
                Object result = method.invoke(serviceClass.newInstance(), arguments);
                output.writeObject(result);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }

    }

测试

服务端主方法

    public static void main(String[] args) throws IOException {
        Server serverService = new Server(25565);
        serverService.register(ServerService.class, ServerServiceImpl.class);
        serverService.start();
    }

客户端主方法

    public static void main(String[] args) {
        for (int i = 0; i < 5 ; ++ i) {
            ServerService service = RPCClient.getRemoteProxyObject(ServerService.class, "localhost", 25565);
            service.doSome("IllTamer " + i);
        }
    }

输出

注意

        本文为简便实现直接在请求方法时创建实现类实例,故有较大开销。若实际开发中需要实现此协议,可自行实现单例调用及采用第三方成熟类库进行通信连接,数据传输加密等。本文仅作RPC思想说明。