Dubbo源码学习--Rmi协议（八）

深碍√TFBOYSˉ_ 2022-05-27 08:15 249阅读 0赞

RMI 协议采用 JDK 标准的 `java.rmi.*` 实现，采用阻塞式短连接和 JDK 标准序列化方式。

注意：如果正在使用 RMI 提供服务给外部访问 [1][]，同时应用里依赖了老的 common-collections 包 [2][] 的情况下，存在反序列化安全风险 [3][]。

## 特性 ##

*  连接个数：多连接
 *  连接方式：短连接
 *  传输协议：TCP
 *  传输方式：同步传输
 *  序列化：Java 标准二进制序列化
 *  适用范围：传入传出参数数据包大小混合，消费者与提供者个数差不多，可传文件。
 *  适用场景：常规远程服务方法调用，与原生RMI服务互操作

## 约束 ##

*  参数及返回值需实现 `Serializable` 接口
 *  dubbo 配置中的超时时间对 RMI 无效，需使用 java 启动参数设置：`-Dsun.rmi.transport.tcp.responseTimeout=3000`，参见下面的 RMI 配置

## dubbo.properties 配置 ##

dubbo.service.protocol=rmi

## RMI配置 ##

java -Dsun.rmi.transport.tcp.responseTimeout=3000

更多 RMI 优化参数请查看 [JDK 文档][JDK]

## 接口 ##

如果服务接口继承了 `java.rmi.Remote` 接口，可以和原生 RMI 互操作，即：

*  提供者用 Dubbo 的 RMI 协议暴露服务，消费者直接用标准 RMI 接口调用，
 *  或者提供方用标准 RMI 暴露服务，消费方用 Dubbo 的 RMI 协议调用。

如果服务接口没有继承 `java.rmi.Remote` 接口：

*  缺省 Dubbo 将自动生成一个 `com.xxx.XxxService$Remote` 的接口，并继承 `java.rmi.Remote` 接口，并以此接口暴露服务，
 *  但如果设置了 `<dubbo:protocol name="rmi" codec="spring" />`，将不生成 `$Remote` 接口，而使用 Spring 的 `RmiInvocationHandler` 接口暴露服务，和 Spring 兼容。

## 配置 ##

定义 RMI 协议：

<dubbo:protocol name="rmi" port="1099" />

设置默认协议：

<dubbo:provider protocol="rmi" />

设置服务协议：

<dubbo:service protocol="rmi" />

多端口：

<dubbo:protocol id="rmi1" name="rmi" port="1099" />
    <dubbo:protocol id="rmi2" name="rmi" port="2099" />
    
    <dubbo:service protocol="rmi1" />

Spring 兼容性：

<dubbo:protocol name="rmi" codec="spring" />

> 1. 公司内网环境应该不会有攻击风险 [ ↩][Link 1]

> 2. dubbo 不会依赖这个包，请排查自己的应用有没有使用 [ ↩][Link 2]

> 3. 请检查应用：将 commons-collections3 请升级到  [3.2.2][]；将 commons-collections4 请升级到  [4.1][]。新版本的 commons-collections 解决了该问题 [ ↩][Link 3]

Rmi协议完全使用了spring框架中提供的相关实现，同样提供了doExport和doRefer两个方法。

（1）doExport：通过rmi协议对外暴露服务

protected <T> Runnable doExport(final T impl, Class<T> type, URL url) throws RpcException {
            final RmiServiceExporter rmiServiceExporter = new RmiServiceExporter();
    		//暴露服务的端口
            rmiServiceExporter.setRegistryPort(url.getPort());
    		//服务名称
            rmiServiceExporter.setServiceName(url.getPath());
    		//服务接口
            rmiServiceExporter.setServiceInterface(type);
    		//服务实现类
            rmiServiceExporter.setService(impl);
            try {
                rmiServiceExporter.afterPropertiesSet();
            } catch (RemoteException e) {
                throw new RpcException(e.getMessage(), e);
            }
    		//返回线程，用于销毁服务使用
            return new Runnable() {
                public void run() {
                    try {
                        rmiServiceExporter.destroy();
                    } catch (Throwable e) {
                        logger.warn(e.getMessage(), e);
                    }
                }
            };
        }

（2）doRefer：引用服务，根据rmi协议调用服务

//创建rmi服务代理类
        @SuppressWarnings("unchecked")
        protected <T> T doRefer(final Class<T> serviceType, final URL url) throws RpcException {
            final RmiProxyFactoryBean rmiProxyFactoryBean = new RmiProxyFactoryBean();
            // RMI needs extra parameter since it uses customized remote invocation object
            if (url.getParameter(Constants.DUBBO_VERSION_KEY, Version.getVersion()).equals(Version.getVersion())) {
                // Check dubbo version on provider, this feature only support
                rmiProxyFactoryBean.setRemoteInvocationFactory(new RemoteInvocationFactory() {
                    public RemoteInvocation createRemoteInvocation(MethodInvocation methodInvocation) {
                        return new RmiRemoteInvocation(methodInvocation);
                    }
                });
            }
    		//设置服务地址
            rmiProxyFactoryBean.setServiceUrl(url.toIdentityString());
    		//接口信息
            rmiProxyFactoryBean.setServiceInterface(serviceType);
            rmiProxyFactoryBean.setCacheStub(true);
            rmiProxyFactoryBean.setLookupStubOnStartup(true);
            rmiProxyFactoryBean.setRefreshStubOnConnectFailure(true);
            rmiProxyFactoryBean.afterPropertiesSet();
            return (T) rmiProxyFactoryBean.getObject();

[1]: http://dubbo.apache.org/books/dubbo-user-book/references/protocol/rmi.html#fn_1
[2]: http://dubbo.apache.org/books/dubbo-user-book/references/protocol/rmi.html#fn_2
[3]: http://dubbo.apache.org/books/dubbo-user-book/references/protocol/rmi.html#fn_3
[JDK]: http://download.oracle.com/docs/cd/E17409_01/javase/6/docs/technotes/guides/rmi/sunrmiproperties.html
[Link 1]: http://dubbo.apache.org/books/dubbo-user-book/references/protocol/rmi.html#reffn_1
[Link 2]: http://dubbo.apache.org/books/dubbo-user-book/references/protocol/rmi.html#reffn_2
[3.2.2]: https://commons.apache.org/proper/commons-collections/release_3_2_2.html
[4.1]: https://commons.apache.org/proper/commons-collections/release_4_1.html
[Link 3]: http://dubbo.apache.org/books/dubbo-user-book/references/protocol/rmi.html#reffn_3