简易RPC框架-代理

代理

代理的意思就是请求者不直接与终端交互，而是通过一个中间者来做请求转发，举几个生活中的代理案例：

• 翻墙上网

国外有很多网站在国内不能访问，所以就需要利用一个代理中转发请求，达到瞒天过海的目的。

• 用户炒股

要想投资股票，你只能通过在证券商那开通账户然后，通过在证券商那提供的功能才能实现在上海证券交易所交易股票。

• 经济人

下面的看图就明白了，不需要多做解释。

RPC

RPC的意思是远程过程调用，使客户端调用远程方法像调用本地方法一样简单，而不需要去关心如何与远程服务器通信相关问题：

• 具体的通信协议选择

比如是TCP通信还是基于HTTP通信，像dubbo默认是基于TCP的，当当在此基础上扩展了劫持HTTP通信的扩展，spring cloud也是基于HTTP。

• 具体的编码方式

计算机之间通信时最需要按一定格式的数据进行传输，比如TCP通信时就需要将JAVA对象通过编码转换成字节流，比如这两对象：
MessageToByteEncoder与ByteToMessageDecoder

• 具体数据传输

比如TCP传输时，各类问题：半包，粘包，延迟，超时，重连等处理。

• ......

为了不在客户端调用服务端时处理上述逻辑，就需要有一个专门处理上述问题的框架来协助，这里可以利用JAVA提供的动态代理业完成。将请求委托给一个代理，这个代理去专门解决通信问题。

动态代理基础

InvocationHandler

要想写一个代理实现类，最简单的方法就是实现InvocationHandler接口，它只包含一个接口方法:

Object invoke(Object proxy, Method method, Object[] args)

包含三个参数：

• proxy

是指被代理的真实对象

• method

是指我们需要执行的真实对象的方法

• args

是指我们需要执行的真实对象的方法所需要的参数

此类需要配合下面的Proxy类来创建动态代理，自身只是一个代理类的实现。

Proxy

这个类是用来创建真实对象代理类的，我这里应用Proxy.newProxyInstance构建Rpc客户端代理,它也有三个参数:

• ClassLoader loader

是指由哪一个类加载器来加载生成的代理对象，一般我们就用真实对象所用的加载器即可。

• Class<?>[] interfaces

是指真实对象都实现了哪些接口，接口确认之后才能调用其中的方法。

• InvocationHandler h

是指产生的代理类在执行方法时所关联的一个代理对象，即我们第一步提到的实现了InvocationHandler接口的实例，代理对象在执行方法时委托给这个关联的handle去处理。

RPC客户端代理实现

RpcProxy

编写一个代理类RpcProxy，它用来处理TCP通信相关的问题，主要流程如下：

• 组装参数

从method以及args参数中获取相应的值，填充到私有协议栈所需要的数据对象中（RpcRequest）。

• 找一个可用的连接进行数据通信

从连接管理器(RpcClientInvokerManager)中获取可用连接，构建处理请求链最后调用执行方法。

• 返回结果

根据客户端请求的方式，如果是需要返回值则返回一个Future对象供异步回调，如果不关心返回值则直接返回空。

@Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {

        RpcRequest request = new RpcRequest();
        request.setRequestId(UUID.randomUUID().toString());
        request.setClassName(method.getDeclaringClass().getName());
        request.setMethodName(method.getName());
        request.setParameterTypes(method.getParameterTypes());
        request.setParameters(args);

        if (this.reference != null) {
            request.setMaxExecutesCount(this.reference.maxExecutesCount());
        }

        request.setContextParameters(RpcContext.getContext().getContextParameters());

        RpcClientInvoker invoker = RpcClientInvokerManager.getInstance(this.referenceConfig).getInvoker();
        invoker.setRpcRequest(request);

        RpcInvoker rpcInvoker=invoker.buildInvokerChain(invoker);
        ResponseFuture response=(ResponseFuture) rpcInvoker.invoke(invoker.buildRpcInvocation(request));

        if(isSync){
            return response.get();
        }
        else {
            RpcContext.getContext().setResponseFuture(response);
            return null;
        }
    }

RPC客户端初始化远程接口

• 在RpcClient类中封装一个创建代理的方法：

public <T> T createProxy(Class<T> interfaceClass,RpcReference reference) {
    return (T) Proxy.newProxyInstance(
            interfaceClass.getClassLoader(),
            new Class<?>[]{interfaceClass},
            new RpcProxy<T>(interfaceClass,this.referenceConfig,reference)
    );
}

通过上面代码产后的代理，是在JVM运行时产生的，它即不是我们上面所提到的代理对象RpcProxy也不是我们的真实对象，它的主要作用就是在调用接口时，将invoke方法的执行委托给我们的代理对象RpcProxy，起到一个转发的效果。

• 通过注解自动生成代理

要想实现调用远程接口与调用本地接口一样简单，思路就是在系统初始化时，扫描特殊注解的变量从而为变量创建代理对象。这里可以借助于BeanPostProcessor对象，它有一个初始化的方法：

public Object postProcessBeforeInitialization(Object bean, String beanName)

我们可以在这个函数中为特殊的变量调用RpcClient.createProxy生成代理，比如下面的代码会遍历所有的字段，如果字段上标记了RpcReference注解，说明这是一个远程接口，所以调用RpcClient调用createProxy生成代理对象。

public Object initRpcReferenceBean(Object bean, String beanName){
    Class<?> clazz = bean.getClass();
    if(isProxyBean(bean)){
        clazz = AopUtils.getTargetClass(bean);
    }

    Field[] fields = clazz.getDeclaredFields();
    for (Field field : fields) {
        try {
            if (! field.isAccessible()) {
                field.setAccessible(true);
            }
            RpcReference reference = field.getAnnotation(RpcReference.class);
            if (reference != null) {
                Object value=this.rpcClient.createProxy(field.getType(),reference);
                if (value != null) {
                    field.set(bean, value);
                }
            }
        } catch (Exception e) {
            throw new BeanInitializationException("Failed to init remote service reference at filed " + field.getName() + " in class " + bean.getClass().getName(), e);
        }
    }
    return bean;
}

RPC客户端引用远程接口

以下代码是一个服务中依赖的变量，增加上@rpcreference之后说明接口是一个远程接口。

@RpcReference(isSync = false)
private ProductService productServiceAsync;

方法中调用远程接口：

public Product getById(Long productId){
   return this.productService.getById(productId);
}

业务代码中，直接调用productServiceAsync中包含的方法即可，不需要去写任何写通信相关的代码，实现了典型的远程过程调用。

本文源码

https://github.com/jiangmin168168/jim-framework

文中代码是依赖上述项目的，如果有不明白的可下载源码