# alibaba/asyncload architecture

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

- Interactive diagram: https://gitdiagram.com/alibaba/asyncload
- Repository: https://github.com/alibaba/asyncload

## Overview

##### Project type and purpose
- This is an open-source Java library (“asyncload”) that provides a business-layer asynchronous, parallel loading mechanism.
- It uses bytecode enhancement at runtime to generate proxies, returns lightweight mock objects immediately, and performs the real method calls in a managed thread pool.

##### File structure
- Top level:
- pom.xml – Maven coordinates and dependencies
- src/main/java/com/alibaba/asyncload – core Java packages
- src/main/resources – sample Spring XML config
- src/test – unit and integration tests under matching package structure
- Core packages under com.alibaba.asyncload:
- config & executor & method match & proxy classes
- impl.*: proxy implementation, service, result, status enums
- impl/annotation: annotation parser, advice classes, thread‐local, handler factory
- impl/pool: thread‐pool, callable, future, named thread factory
- impl/spring: FactoryBean, Interceptor, AutoProxyCreator
- impl/util & helper: reflection helpers, proxy repository, barrier, utils
- Key patterns:
- Bytecode enhancement / dynamic proxy
- Thread-pool executor with Future objects
- Annotation-driven configuration (custom annotations + parser)
- Optional Spring integration layer

##### README for additional insights
- Describes the problem (I/O blocking), solution approach (async + parallel), and high-level workflow:
1. Generate proxy and mock object via bytecode enhancement
2. Submit real method call into a thread pool
3. Return mock to caller; when real data is accessed later, block until result is ready

##### Main components
a. Caller (business code)
b. Proxy Generator / Bytecode Enhancer (e.g., Javassist or ASM)
c. AsyncLoadProxy / AsyncLoadEnhanceProxy
d. AsyncLoadExecutor
e. Thread-Pool Module (AsyncLoadThreadPool, NamedThreadFactory)
f. AsyncLoadFuture / AsyncLoadResult / AsyncLoadObject (mock vs. real result wrapper)
g. Annotation Processor (AsyncLoadAnnotationParserFactory, advice classes)
h. Spring Integration (AsyncLoadFactoryBean, AsyncLoadInterceptor, CompositeAutoProxyCreator)
i. Configuration (AsyncLoadConfig, AsyncThreadPoolConfig)
j. Helper modules (ReflectionHelper, ProxyRepository, Utilities)

##### Relationships and interactions
- Business code invokes a target method → intercepted by Proxy/Interceptor
- Proxy builds a mock AsyncLoadObject and schedules actual call via AsyncLoadExecutor → places AsyncLoadCallable into AsyncLoadThreadPool
- Thread pool worker executes the real method, wraps results in AsyncLoadResult, signals completion (possibly via AsyncLoadBarrier)
- When business code accesses the mock’s data, AsyncLoadFuture.get() blocks until AsyncLoadResult is available
- Annotation Processor scans classes/methods at startup to identify which to proxy
- Spring layer registers FactoryBean and AutoProxyCreator to weave proxies into the application context

##### Architectural patterns and principles
- Proxy Pattern (dynamic proxy + bytecode enhancement)
- Future / Promise (AsyncLoadFuture)
- Thread Pool Executor (configurable rejection policies, named threads)
- AOP / Advice (annotation-driven method interception)
- Inversion of Control (Spring integration with FactoryBean + CompositeAutoProxyCreator)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Layers and Components
    subgraph "Client Layer"
        direction TB
        Caller["Business Code"]:::external
    end

    subgraph "Proxy & Enhancement Layer"
        direction TB
        ProxyGen["Proxy Generator / Bytecode Enhancer"]:::core
        AsyncLoadProxy["AsyncLoadProxy"]:::core
        AsyncLoadEnhanceProxy["AsyncLoadEnhanceProxy"]:::core
    end

    subgraph "Executor Layer"
        direction TB
        AsyncLoadExecutor["AsyncLoadExecutor"]:::core
    end

    subgraph "Thread-Pool Layer"
        direction TB
        AsyncLoadThreadPool["AsyncLoadThreadPool"]:::pool
        NamedThreadFactory["NamedThreadFactory"]:::pool
        AsyncLoadCallable["AsyncLoadCallable"]:::pool
    end

    subgraph "Future & Result Layer"
        direction TB
        AsyncLoadFuture["AsyncLoadFuture"]:::pool
        AsyncLoadResult["AsyncLoadResult"]:::core
        AsyncLoadObject["AsyncLoadObject"]:::core
        AsyncLoadStatus["AsyncLoadStatus"]:::core
    end

    subgraph "Annotation & AOP Layer"
        direction TB
        AsyncAnnotationParserFactory["AsyncAnnotationParserFactory"]:::annotation
        AsyncLoadAnnotationThreadLocal["AsyncLoadAnnotationThreadLocal"]:::annotation
        AsyncLoadEnableAdvice["AsyncLoadEnableAdvice"]:::annotation
        AsyncLoadHandlerAdvice["AsyncLoadHandlerAdvice"]:::annotation
        AsyncLoadHandleFactory["AsyncLoadHandleFactory"]:::annotation
        EnableAsyncClass["EnableAsyncClass"]:::annotation
        EnableAsyncMethod["EnableAsyncMethod"]:::annotation
        AsyncThreadPoolConfigAnno["AsyncThreadPoolConfig"]:::annotation
    end

    subgraph "Spring Integration Layer"
        direction TB
        AsyncLoadFactoryBean["AsyncLoadFactoryBean"]:::spring
        AsyncLoadInterceptor["AsyncLoadInterceptor"]:::spring
        CompositeAutoProxyCreator["CompositeAutoProxyCreator"]:::spring
    end

    subgraph "Configuration Objects"
        direction TB
        AsyncLoadConfig["AsyncLoadConfig"]:::config
        AsyncLoadMethodMatch["AsyncLoadMethodMatch"]:::config
        AsyncThreadPoolConfig["AsyncThreadPoolConfig"]:::config
    end

    subgraph "Helper & Utility Modules"
        direction TB
        ReflectionHelper["AsyncLoadReflectionHelper"]:::helper
        ProxyRepository["AsyncLoadProxyRepository"]:::helper
        AsyncLoadBarrier["AsyncLoadBarrier"]:::helper
        AsyncLoadUtils["AsyncLoadUtils"]:::helper
        MethodFilterUtil["MethodFilterUtil"]:::helper
    end

    %% Relationships
    Caller -->|"invoke method"| AsyncLoadProxy
    AsyncLoadProxy -->|"use enhancer"| ProxyGen
    AsyncLoadProxy -->|"create proxy"| AsyncLoadEnhanceProxy
    AsyncLoadEnhanceProxy -->|"generate mock"| AsyncLoadObject
    AsyncLoadProxy -->|"schedule call"| AsyncLoadExecutor
    AsyncLoadExecutor -->|"submit task"| AsyncLoadThreadPool
    AsyncLoadThreadPool -->|"new thread"| NamedThreadFactory
    AsyncLoadThreadPool -->|"execute"| AsyncLoadCallable
    AsyncLoadCallable -->|"real method"| Caller
    AsyncLoadCallable -->|"wrap result"| AsyncLoadResult
    AsyncLoadResult -->|"signal"| AsyncLoadFuture
    AsyncLoadFuture -->|"block on get"| AsyncLoadObject
    AsyncLoadObject -->|"return mock"| Caller

    AsyncAnnotationParserFactory --> AsyncLoadEnableAdvice
    AsyncAnnotationParserFactory --> AsyncLoadHandlerAdvice
    AsyncLoadEnableAdvice --> AsyncLoadProxy
    AsyncLoadHandlerAdvice --> AsyncLoadExecutor
    AsyncLoadAnnotationThreadLocal --> AsyncAnnotationParserFactory

    AsyncLoadFactoryBean --> CompositeAutoProxyCreator
    CompositeAutoProxyCreator --> AsyncLoadInterceptor
    AsyncLoadInterceptor --> AsyncLoadProxy

    AsyncLoadConfig --> AsyncLoadExecutor
    AsyncLoadMethodMatch --> AsyncLoadProxy
    AsyncThreadPoolConfig --> AsyncLoadThreadPool

    ReflectionHelper --> ProxyGen
    ProxyRepository --> AsyncLoadEnhanceProxy
    AsyncLoadBarrier -.-> AsyncLoadFuture
    AsyncLoadUtils --> AsyncLoadExecutor
    MethodFilterUtil --> AsyncAnnotationParserFactory

    %% Click Events
    click ProxyGen "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/AsyncLoadEnhanceProxy.java"
    click AsyncLoadProxy "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/AsyncLoadProxy.java"
    click AsyncLoadExecutor "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/AsyncLoadExecutor.java"
    click AsyncLoadThreadPool "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/pool/AsyncLoadThreadPool.java"
    click NamedThreadFactory "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/pool/NamedThreadFactory.java"
    click AsyncLoadCallable "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/pool/AsyncLoadCallable.java"
    click AsyncLoadFuture "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/pool/AsyncLoadFuture.java"
    click AsyncLoadResult "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/AsyncLoadResult.java"
    click AsyncLoadObject "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/AsyncLoadObject.java"
    click AsyncLoadStatus "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/AsyncLoadStatus.java"
    click AsyncAnnotationParserFactory "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/annotation/AsyncAnnotationParserFactory.java"
    click AsyncLoadAnnotationThreadLocal "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/annotation/AsyncLoadAnnotationThreadLocal.java"
    click AsyncLoadEnableAdvice "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/annotation/AsyncLoadEnableAdvice.java"
    click AsyncLoadHandlerAdvice "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/annotation/AsyncLoadHandlerAdvice.java"
    click AsyncLoadHandleFactory "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/annotation/AsyncLoadHandleFactory.java"
    click EnableAsyncClass "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/annotation/EnableAsyncClass.java"
    click EnableAsyncMethod "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/annotation/EnableAsyncMethod.java"
    click AsyncThreadPoolConfigAnno "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/annotation/AsyncThreadPoolConfig.java"
    click AsyncLoadFactoryBean "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/spring/AsyncLoadFactoryBean.java"
    click AsyncLoadInterceptor "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/spring/AsyncLoadInterceptor.java"
    click CompositeAutoProxyCreator "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/spring/CompositeAutoProxyCreator.java"
    click AsyncLoadConfig "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/AsyncLoadConfig.java"
    click AsyncLoadMethodMatch "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/AsyncLoadMethodMatch.java"
    click AsyncThreadPoolConfig "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/annotation/AsyncThreadPoolConfig.java"
    click ReflectionHelper "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/helper/AsyncLoadReflectionHelper.java"
    click ProxyRepository "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/helper/AsyncLoadProxyRepository.java"
    click AsyncLoadBarrier "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/util/AsyncLoadBarrier.java"
    click AsyncLoadUtils "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/util/AsyncLoadUtils.java"
    click MethodFilterUtil "https://github.com/alibaba/asyncload/blob/master/src/main/java/com/alibaba/asyncload/impl/util/MethodFilterUtil.java"

    %% Styles
    classDef core fill:#D0E8FF,stroke:#0366d6
    classDef pool fill:#E6FFCC,stroke:#2E8B57
    classDef annotation fill:#FFEFD5,stroke:#FF8C00
    classDef spring fill:#F0F0F0,stroke:#808080
    classDef config fill:#FFF5BA,stroke:#DAA520
    classDef helper fill:#F5F5F5,stroke:#A9A9A9
    classDef external fill:#FFFFFF,stroke:#000000,stroke-width:1px,stroke-dasharray: 2 2
```
