SOFABolt 源码分析3 - RpcClient 客户端启动的设计

 RpcClient client = new RpcClient();
 client.init();

一、代码执行流程梯形图

new RpcClient()
-->new ConcurrentHashMap> userProcessors
-->new RpcConnectionFactory
  -->static EventLoopGroup workerGroup
  -->new RpcCodec
  -->new HeartbeatHandler()
  -->new RpcHandler(userProcessors)
-->new RpcConnectionEventHandler(switches())
-->new ConnectionEventListener()
-->connectionSelectStrategy = new RandomSelectStrategy(switches())
-->connectionManager = new DefaultConnectionManager(connectionSelectStrategy, 
                                                    connectionFactory,
                                                    connectionEventHandler,
                                                    connectionEventListener,
                                                    switches())
-->taskScanner = new RpcTaskScanner()


RpcClient.init()

-->DefaultConnectionManager.init()
  -->this.connectionEventHandler.setConnectionManager(this); // 关联连接管理器和连接事件处理器
  -->this.connectionEventHandler.setConnectionEventListener(connectionEventListener) // 关联连接监听器和连接事件处理器
    -->new ConnectionEventExecutor() // 创建连接事件执行器（后续 ConnectionEventListener 中的 ConnectionEventProcessor 的执行都由该线程池来完成）
  -->RpcConnectionFactory.init(final ConnectionEventHandler connectionEventHandler)
    -->new Bootstrap()并做一系列配置

-->this.rpcRemoting = new RpcClientRemoting(new RpcCommandFactory(), this.addressParser, this.connectionManager);
  
  -->RpcProtocolManager.initProtocols()
    -->new RpcProtocol()
      -->this.encoder = new RpcCommandEncoder();
      -->this.decoder = new RpcCommandDecoder();
      -->this.commandFactory = new RpcCommandFactory();
      -->this.heartbeatTrigger = new RpcHeartbeatTrigger(this.commandFactory);
      -->this.commandHandler = new RpcCommandHandler(this.commandFactory);
        -->this.processorManager = new ProcessorManager()
          -->Map> cmd2processors
          -->ExecutorService defaultExecutor
        -->this.processorManager.registerProcessor(RpcCommandCode.RPC_REQUEST, new RpcRequestProcessor(this.commandFactory))
        -->this.processorManager.registerProcessor(RpcCommandCode.RPC_RESPONSE, new RpcResponseProcessor())
        -->this.processorManager.registerProcessor(CommonCommandCode.HEARTBEAT, new RpcHeartBeatProcessor());
        -->this.processorManager.registerDefaultProcessor(直接 logger.error)
    -->RpcProtocolManager.registerProtocol(Protocol protocol, byte... protocolCodeBytes)
    -->new RpcProtocol2()
      -->this.encoder = new RpcCommandEncoderV2();
      -->this.decoder = new RpcCommandDecoderV2();
      -->this.commandFactory = new RpcCommandFactory();
      -->this.heartbeatTrigger = new RpcHeartbeatTrigger(this.commandFactory);
      -->this.commandHandler = new RpcCommandHandler(this.commandFactory);
    -->RpcProtocolManager.registerProtocol(Protocol protocol, byte... protocolCodeBytes)
  
  -->new RpcCommandFactory()
  
  -->new RpcClientRemoting(CommandFactory commandFactory, RemotingAddressParser addressParser,
                             DefaultConnectionManager connectionManager)

总结：

关于连接 Connection 相关的，放在《Connection 连接设计》章节分析，此处跳过；
关于心跳 HeartBeat 相关的，放在《HeartBeat 心跳设计》章节分析，此处跳过。

1. 创建 RpcClient 实例

• 创建用户处理器 UserProcessor 实现类容器 Map> userProcessors
• 创建 RpcConnectionFactory 工厂

创建 workerGroup（static类变量，实现多个 RpcClient 实例共享 workerGroup）
创建 Codec 的实现类 RpcCodec 实例，用于创建 netty 的编解码器，实质上是一个工厂类
创建 HeartbeatHandler 心跳处理器
创建 RpcHandler 实例作为 netty 的业务逻辑处理器（后续处理链与 SOFABolt 源码分析2 - 服务端启动设计 完全一样）

• 创建 ConnectionSelectStrategy 连接选择器
• 创建 DefaultConnectionManager 连接管理器（是整个 Connection 设计的核心）

2. 初始化 RpcClient

• 创建 Bootstrap 实例并设置一系列 netty 客户端配置
• 创建两种协议 RpcProtocol 和 RpcProtocolV2 实例，添加到 RpcProtocolManager 的 Map protocols 协议容器中（与 SOFABolt 源码分析2 - 服务端启动设计 完全一样）
• 创建 Remote 层请求和响应封装实体的创建工厂 RpcCommandFactory 实例
• 创建 RpcClientRemoting (发起底层调用实现类) 实例

注意：此时 netty 客户端并没有与 netty 服务端进行连接，连接操作是延迟到第一次调用发起进行的

二、从 netty 的角度看执行链

        bootstrap.handler(new ChannelInitializer() {
            @Override
            protected void initChannel(SocketChannel channel) {
                ChannelPipeline pipeline = channel.pipeline();
                pipeline.addLast("decoder", codec.newDecoder());
                pipeline.addLast("encoder", codec.newEncoder());

                boolean idleSwitch = ConfigManager.tcp_idle_switch();
                if (idleSwitch) {
                    pipeline.addLast("idleStateHandler",
                        new IdleStateHandler(ConfigManager.tcp_idle(), ConfigManager.tcp_idle(), 0,
                            TimeUnit.MILLISECONDS));
                    pipeline.addLast("heartbeatHandler", heartbeatHandler);
                }

                pipeline.addLast("connectionEventHandler", connectionEventHandler);
                pipeline.addLast("handler", handler);
            }
        });

跳过心跳 HeartBeat 逻辑、跳过连接 Connection 逻辑，我们只看编解码器和业务处理器逻辑。
与 SOFABolt 源码分析2 - 服务端启动设计 完全一样。

三、RpcClient 类结构图

image.png

其中，AbstractConfigurableInstance 是可配置实例抽象类（RpcServer 与 RpcClient 都是其实现类），包含配置容器和全局开关（在《Config 配置设计》中进行分析）；

RpcClient 中 RpcRemoting 是向 RpcServer 发起调用的工具类；userProcessors 是 用户自定义的业务逻辑处理器容器（RpcServer 可以主动向 RpcClient 发起请求，所以RpcClient 也需要创建 UserProcessor 来处理这些请求）；后九个与 Connection 相关。