# captainlegoo/drpc architecture

> Architecture diagram of the GitHub repository captainlegoo/drpc, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-23). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/captainlegoo/drpc
- Repository: https://github.com/captainlegoo/drpc

## Overview

##### Project type and purpose
- This is a modular, open‑source RPC framework built in Java and Maven. It provides:
- An interface module defining RPC contracts
- A core engine for bootstrapping, proxying, Netty networking, serialization, compression, load balancing, heartbeats
- Pluggable registry center adapters (Zookeeper, Redis)
- Pluggable serialization engines (JDK, Protostuff) and compressors (Deflate, Gzip)
- Example/test consumers and providers (plain Java and Spring‐boot)

##### File structure
- Top‑level modules:
rpc-common        (shared constants, exceptions, utilities)
rpc-interface     (service, registry, compress, serialize interfaces)
rpc-core          (bootstrapper, Netty starters & handlers, proxy, cache, config, factory, strategy, tasks)
rpc-registrycenter
- redis adapter
- zookeeper adapter
rpc-serialization
- JDK adapter
- Protostuff adapter
rpc-compress
- Deflate adapter
- Gzip adapter
rpc-test          (api, plain consumer/provider, Spring consumer/provider)
- Patterns:
- Strategy (SerializeStrategy, CompressStrategy, LoadbalancerStrategy)
- Factory (RegistryFactory, ProxyConfig, Serializer/Compressor factories)
- Builder/Fluent API (DRpcBootstrap)
- Observer/Watcher (registry listeners)
- Runtime components: DRpcBootstrap, ConsumerNettyStarter, ProviderNettyStarter, various handlers

##### Key insights from the README
- DRpcBootstrap configuration for consumer and provider (with optional Spring integration via BeanPostProcessor)
- Zookeeper node layout under `/rpc‑metadata` for providers, consumers, config
- How proxies are injected for `@RpcReference` fields and how `@RpcService` is used to mark server implementations

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Application Layer"
        direction TB
        PJConsumer["Plain-Java Consumer"]:::app
        SBConsumer["Spring-Boot Consumer"]:::app
        PJProvider["Plain-Java Provider"]:::app
        SBProvider["Spring-Boot Provider"]:::app
    end

    subgraph "RPC API Layer"
        direction TB
        ServiceInterfaces["Service Interfaces"]:::api
    end

    subgraph "RPC Core Engine"
        direction TB
        DRpcBootstrap["DRpcBootstrap"]:::core
        ProxyConfig["ProxyConfig"]:::core
        ConsumerInvocationHandler["ConsumerInvocationHandler"]:::core
        RegistryFactory["RegistryFactory"]:::core
        subgraph "Netty Starters & Pipeline"
            direction TB
            ConsumerNettyStarter["ConsumerNettyStarter"]:::core
            ProviderNettyStarter["ProviderNettyStarter"]:::core
            subgraph "Netty Handlers"
                direction TB
                MsgToByteHandler["MsgToByteHandler"]:::core
                ConsumerInboundHandler["ConsumerInboundHandler"]:::core
                ProviderInboundHandler["ProviderInboundHandler"]:::core
                ProviderOutboundHandler["ProviderOutboundHandler"]:::core
                MethodCallHandler["MethodCallHandler"]:::core
            end
        end
        subgraph "Caches"
            direction TB
            ConsumerCache["ConsumerCache"]:::core
            ProviderCache["ProviderCache"]:::core
            NettyCache["NettyCache"]:::core
            ProxyCache["ProxyCache"]:::core
        end
        subgraph "Tasks & Heartbeat"
            direction TB
            Tasks["Scheduled Tasks & Heartbeat"]:::core
        end
    end

    subgraph "Plugin Strategies"
        direction TB
        subgraph "Serialization"
            direction TB
            JDKSerialize["JdkSerialize"]:::plugin
            ProtostuffSerialize["ProtostuffSerialize"]:::plugin
        end
        subgraph "Compression"
            direction TB
            DeflateCompressor["DeflateCompressor"]:::plugin
            GzipCompressor["GzipCompressor"]:::plugin
        end
        RoundRobinLoadbalancer["RoundRobinLoadbalancer"]:::plugin
    end

    subgraph "Registry Center Adapters"
        direction TB
        ZookeeperRegistry["ZookeeperRegistry"]:::registry
        RedisRegistry["RedisRegistry"]:::registry
    end

    %% Relations
    PJConsumer -->|uses| ProxyConfig
    SBConsumer -->|uses| ProxyConfig
    ProxyConfig -->|configures| DRpcBootstrap
    ServiceInterfaces -->|defines| ProxyConfig
    DRpcBootstrap -->|discovers| RegistryFactory
    RegistryFactory -->|connects to| ZookeeperRegistry
    RegistryFactory -->|connects to| RedisRegistry
    DRpcBootstrap -->|starts| ConsumerNettyStarter
    DRpcBootstrap -->|starts| ProviderNettyStarter
    ConsumerNettyStarter -->|pipeline| MsgToByteHandler
    MsgToByteHandler --> ConsumerInboundHandler
    ConsumerInboundHandler -->|TCP| ProviderInboundHandler
    ProviderInboundHandler --> MethodCallHandler
    MethodCallHandler -->|invoke impl| PJProvider
    PJProvider -->|response| ProviderOutboundHandler
    ProviderOutboundHandler -->|TCP| ConsumerInboundHandler
    ConsumerInboundHandler -->|deserialize| ConsumerInvocationHandler
    ConsumerInvocationHandler -->|returns| PJConsumer
    Tasks <--> RegistryFactory

    %% Click Events
    click ServiceInterfaces "https://github.com/captainlegoo/drpc/tree/master/rpc-interface/src/main/java/com/dcy/rpc"
    click DRpcBootstrap "https://github.com/captainlegoo/drpc/blob/master/rpc-core/src/main/java/com/dcy/rpc/bootstrap/DRpcBootstrap.java"
    click ProxyConfig "https://github.com/captainlegoo/drpc/blob/master/rpc-core/src/main/java/com/dcy/rpc/proxy/ProxyConfig.java"
    click ConsumerInvocationHandler "https://github.com/captainlegoo/drpc/blob/master/rpc-core/src/main/java/com/dcy/rpc/proxy/ConsumerInvocationHandler.java"
    click RegistryFactory "https://github.com/captainlegoo/drpc/blob/master/rpc-core/src/main/java/com/dcy/rpc/factory/RegistryFactory.java"
    click JDKSerialize "https://github.com/captainlegoo/drpc/blob/master/rpc-serialization/rpc-serialization-jdk/src/main/java/com/dcy/rpc/serialize/jdk/JdkSerialize.java"
    click ProtostuffSerialize "https://github.com/captainlegoo/drpc/blob/master/rpc-serialization/rpc-serialization-protostuff/src/main/java/com/dcy/rpc/serialize/protostuff/ProtostuffSerialize.java"
    click DeflateCompressor "https://github.com/captainlegoo/drpc/blob/master/rpc-compress/rpc-compress-deflate/src/main/java/com/dcy/rpc/compress/DeflateCompressor.java"
    click GzipCompressor "https://github.com/captainlegoo/drpc/blob/master/rpc-compress/rpc-compress-gzip/src/main/java/com/dcy/rpc/compress/GzipCompressor.java"
    click RoundRobinLoadbalancer "https://github.com/captainlegoo/drpc/blob/master/rpc-core/src/main/java/com/dcy/rpc/loadbalancer/impl/RoundRobinLoadbalancer.java"
    click ConsumerNettyStarter "https://github.com/captainlegoo/drpc/blob/master/rpc-core/src/main/java/com/dcy/rpc/netty/ConsumerNettyStarter.java"
    click ProviderNettyStarter "https://github.com/captainlegoo/drpc/blob/master/rpc-core/src/main/java/com/dcy/rpc/netty/ProviderNettyStarter.java"
    click MsgToByteHandler "https://github.com/captainlegoo/drpc/blob/master/rpc-core/src/main/java/com/dcy/rpc/netty/ConsumerHandler/MsgToByteHandler.java"
    click ConsumerInboundHandler "https://github.com/captainlegoo/drpc/blob/master/rpc-core/src/main/java/com/dcy/rpc/netty/ConsumerHandler/ConsumerInBoundHandler.java"
    click ProviderInboundHandler "https://github.com/captainlegoo/drpc/blob/master/rpc-core/src/main/java/com/dcy/rpc/netty/ProviderHandler/ProviderInboundHandler.java"
    click ProviderOutboundHandler "https://github.com/captainlegoo/drpc/blob/master/rpc-core/src/main/java/com/dcy/rpc/netty/ProviderHandler/ProviderOutboundHandler.java"
    click MethodCallHandler "https://github.com/captainlegoo/drpc/blob/master/rpc-core/src/main/java/com/dcy/rpc/netty/ProviderHandler/MethodCallHandler.java"
    click ConsumerCache "https://github.com/captainlegoo/drpc/blob/master/rpc-core/src/main/java/com/dcy/rpc/cache/ConsumerCache.java"
    click ProviderCache "https://github.com/captainlegoo/drpc/blob/master/rpc-core/src/main/java/com/dcy/rpc/cache/ProviderCache.java"
    click NettyCache "https://github.com/captainlegoo/drpc/blob/master/rpc-core/src/main/java/com/dcy/rpc/cache/NettyCache.java"
    click ProxyCache "https://github.com/captainlegoo/drpc/blob/master/rpc-core/src/main/java/com/dcy/rpc/cache/ProxyCache.java"
    click Tasks "https://github.com/captainlegoo/drpc/tree/master/rpc-core/src/main/java/com/dcy/rpc/task"
    click ZookeeperRegistry "https://github.com/captainlegoo/drpc/blob/master/rpc-registrycenter/rpc-registrycenter-zookeeper/src/main/java/com/dcy/rpc/registry/ZookeeperRegistry.java"
    click RedisRegistry "https://github.com/captainlegoo/drpc/blob/master/rpc-registrycenter/rpc-registrycenter-redis/src/main/java/com/dcy/registry/RedisRegistry.java"
    click PJConsumer "https://github.com/captainlegoo/drpc/tree/master/rpc-test/rpc-test-consumer"
    click SBConsumer "https://github.com/captainlegoo/drpc/tree/master/rpc-test/rpc-test-spring-consumer"
    click PJProvider "https://github.com/captainlegoo/drpc/tree/master/rpc-test/rpc-test-provider"
    click SBProvider "https://github.com/captainlegoo/drpc/tree/master/rpc-test/rpc-test-spring-provider"

    %% Styles
    classDef app fill:#ADD8E6,stroke:#000,color:#000
    classDef api fill:#ADD8E6,stroke:#000,color:#000
    classDef core fill:#90EE90,stroke:#000,color:#000
    classDef plugin fill:#FFD700,stroke:#000,color:#000
    classDef registry fill:#FFB347,stroke:#000,color:#000
```
