RPC原理与代码实现远程过程调用

关键词：RPC框架，Socket通信、反射、动态代理、Java原生的序列化与反序列化

1、RPC简介

RPC（Remote Procedure Call），远程过程调用。它是一种通过网络从远程计算机程序上请求服务。RPC是一种技术解决方案，一种思想，与语言无关的。可用于：高并发程序，将程序各层分离以提高程序的负载；公共模块，为其他模块提供服务等。

2、RPC框架的实现

1. 技术简介

RPC的核心：就是能够让本地应用简单、高效地调用远程服务。一般从以下几方面考虑：

(1) 远程服务代理：本地调用的方法(服务)实质是远程方法的本地代理，因此会需要一个远程服务代理对象。在Java中，远程服务代理对象可以使用JDK动态代理实现。

(2) 通信模型：客户端与服务器之间的通信方式。Java中一般基于BIO或NIO。

(3) 服务定位：通过IP与端口确定服务器后，再通过接口名及方法名、参数等确定具体的服务。

(4) 参数序列化：将接口名、方法名、方法参数类型等要进行网络传输的数据，需要转换成二进制传输，这里可能需要不同的序列化技术方案。如:Protostuff，java原生序列化等。

2. Java技术

(1) JDK动态代理

(2) Socket通信（BIO方式）

(3) java反射

(4) Java序列化（所有需要序列化的对象类须实现Serializable接口）

3. RPC框架架构实现

(1) 服务提供者：由框架提供，运行在服务器，发布服务、接受客户端请求、响应请求

(2) 服务调用者：由框架提供，运行在客户端，生成代理对象、调用远程服务

(3) 服务具体实现：由使用框架者提供，运行在服务器，服务接口、接口实现类

4. 代码实现

1、业务服务类

public class ProducerServiceImpl implements ProducerService {

    public String produceCar(String modelName) {
        return "生产出汽车：" + modelName;
    }

}
interface ProducerService {

    String produceCar(String modelName);

}

2、服务中心提供类

package com.rpc;

import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.lang.reflect.Method;
import java.net.InetSocketAddress;
import java.net.ServerSocket;
import java.net.Socket;
import java.util.HashMap;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

/**
 * Created by Liuxd on 2018-09-14.
 */
public class RPCServerImpl implements RPCServer {
    private static ExecutorService executor = Executors.newFixedThreadPool(Runtime.getRuntime().availableProcessors());

    private static final HashMap<String, Class> serviceRegistry = new HashMap<>();

    private static boolean isRunning = false;

    private static int port;

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

    public void stopService() {
        isRunning = false;
        executor.shutdown();
    }

    public void startService() throws IOException {
        ServerSocket server = new ServerSocket();
        server.bind(new InetSocketAddress(port));
        System.out.println("启动服务...");
        try {
            while (true) {
                // 1.监听客户端的TCP连接，接到TCP连接后将其封装成task，由线程池执行
                executor.execute(new ServiceTask(server.accept()));
            }
        } finally {
            server.close();
        }
    }

    public void register(Class serviceInterface, Class impl) {
        serviceRegistry.put(serviceInterface.getName(), impl);
    }

    public boolean isRunning() {
        return isRunning;
    }

    public int getPort() {
        return port;
    }

    private static class ServiceTask implements Runnable {
        Socket clent = null;

        public ServiceTask(Socket client) {
            this.clent = client;
        }

        public void run() {
            ObjectInputStream input = null;
            ObjectOutputStream output = null;
            try {
                // 2.将客户端发送的码流反序列化成对象，反射调用服务实现者，获取执行结果
                input = new ObjectInputStream(clent.getInputStream());
                String serviceName = input.readUTF();
                String methodName = input.readUTF();
                Class<?>[] parameterTypes = (Class<?>[]) input.readObject();
                Object[] arguments = (Object[]) input.readObject();
                Class serviceClass = serviceRegistry.get(serviceName);
                if (serviceClass == null) {
                    throw new ClassNotFoundException(serviceName + " not found");
                }
                Method method = serviceClass.getMethod(methodName, parameterTypes);
                Object result = method.invoke(serviceClass.newInstance(), arguments);

                // 3.将执行结果反序列化，通过socket发送给客户端
                output = new ObjectOutputStream(clent.getOutputStream());
                output.writeObject(result);
            } catch (Exception e) {
                e.printStackTrace();
            } finally {
                if (output != null) {
                    try {
                        output.close();
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                }
                if (input != null) {
                    try {
                        input.close();
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                }
                if (clent != null) {
                    try {
                        clent.close();
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                }
            }

        }
    }
}


interface RPCServer {
    public void startService() throws IOException;

    public boolean isRunning();

    public int getPort();

    public void register(Class serviceInterface, Class impl);

    public void stopService();
}

3、代理类

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.InetSocketAddress;
import java.net.Socket;

/**
 * Created by Liuxd on 2018-09-14.
 */
public class RPCClient<T> {
    public static <T> T getRemoteProxyObj(final Class<?> serviceInterface, final InetSocketAddress addr) {
        // 1.将本地的接口调用转换成JDK的动态代理，在动态代理中实现接口的远程调用
        return (T) Proxy.newProxyInstance(serviceInterface.getClassLoader(), new Class<?>[]{serviceInterface},
                new InvocationHandler() {
                    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                        Socket socket = null;
                        ObjectOutputStream output = null;
                        ObjectInputStream input = null;
                        try {
                            // 2.创建Socket客户端，根据指定地址连接远程服务提供者
                            socket = new Socket();
                            socket.connect(addr);

                            // 3.将远程服务调用所需的接口类、方法名、参数列表等编码后发送给服务提供者
                            output = new ObjectOutputStream(socket.getOutputStream());
                            output.writeUTF(serviceInterface.getName());
                            output.writeUTF(method.getName());
                            output.writeObject(method.getParameterTypes());
                            output.writeObject(args);

                            // 4.同步阻塞等待服务器返回应答，获取应答后返回
                            input = new ObjectInputStream(socket.getInputStream());
                            return input.readObject();
                        } finally {
                            if (socket != null) socket.close();
                            if (output != null) output.close();
                            if (input != null) input.close();
                        }
                    }
                });
    }
}

4、调用类

package com.rpc;

import java.io.IOException;
import java.net.InetSocketAddress;

/**
 * Created by Liuxd on 2018-09-14.
 */
public class RPCController {

    public static int port = 8902;

    public static void main(String[] args) throws IOException {
//      接口服务端
        new Thread(new Runnable() {
            public void run() {
                try {

                    RPCServer serviceRPCServer = new RPCServerImpl(port);

                    serviceRPCServer.register(ProducerService.class, ProducerServiceImpl.class);

                    serviceRPCServer.startService();

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

//      消费者端调用
        ProducerService service = RPCClient.getRemoteProxyObj(ProducerService.class, new InetSocketAddress("localhost", port));
        System.out.println(service.produceCar("兰博基尼"));
    }
}