# tbiyiktas/android-clean-network-layer architecture

> Architecture diagram of the GitHub repository tbiyiktas/android-clean-network-layer, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/tbiyiktas/android-clean-network-layer
- Repository: https://github.com/tbiyiktas/android-clean-network-layer

## Overview

##### Project Type & Purpose
- This is an Android application demonstrating a “Clean Network Layer” library.
- The app module (`app/src/...`) contains a minimal UI (`MainActivity`, `Lookup`, `MyApplication`), domain models (`Post`), and integrates the `lib` network layer.
- The `lib` package is a standalone, pure-`HttpURLConnection` library providing a modular, testable network layer (producer–consumer queue, retry/backoff, cancellation, gzip, typed responses).

##### File Structure & Key Modules
Top-level “app” module:
- app/src/main/java/com/example/...
– MyApplication (initializes NetworkManager)
– MainActivity / Lookup (UI entry points invoking network calls)
– Domain model (Post)
- app/src/main/java/lib/...
– api: `TodoApi` (defines endpoints)
– model: `Todo`
– net: core network classes
· NetworkManager (public façade, request queue, executor service)
· ABaseApi (abstract base for typed APIs)
· MyHttpClient / AHttpClient (optional lower-level client)
· NetworkCallback / NetResult<T> (typed response wrapper)
– net/command: HTTP-method command classes (GetCommand, PostCommand, etc.) – Command Pattern
– net/connection: factory and adapters for HttpUrlConnection / HttpsConnection – Factory Pattern
– net/parser: `IResponseParser` + `GsonResponseParser` – Strategy Pattern
– net/util: `NetworkConfig`, `UrlBuilder`, `ResponseHandler`, `RequestCancelledException`

##### Extract Architecture Insights from README
- Emphasizes a bounded `BlockingQueue<RequestTask>` + `ExecutorService` (producer–consumer).

##### Main Components & Their Interactions

a. UI Layer (Android Main Thread)
– `MainActivity` / `Lookup` call → `NetworkManager.get()/post()/put()/...`
– Receives back a `RequestHandle` and a `NetworkCallback<T>`

b. Network Layer
– **NetworkManager**
- has a bounded request queue + thread-pool executor
- holds a `IHttpConnectionFactory` for creating connections
- posts responses back via `ResponseHandler` (Android `Handler` on main thread)
– **RequestTask** (internal)
- wraps a specific `ACommand` (e.g., `GetCommand`) and enqueues
– **ACommand** + Subclasses (`GetCommand`, `PostCommand`, …)
- build URL via `UrlBuilder` + `NetworkConfig` settings
- obtain `IHttpConnection` from factory → open connection → write body/headers → read response stream
– **IHttpConnectionFactory** / **HttpUrlConnectionFactory** → `HttpConnectionAdapter` / `HttpsConnectionAdapter`
– **IResponseParser** / `GsonResponseParser` parse raw JSON → model objects (e.g., `Todo`)
– **Retry & Backoff** logic lives in `ACommand` / `NetworkManager` using `NetworkConfig` settings
– On completion, wrap result in `NetResult.Success<T>` or `NetResult.Error<T>` and dispatch via `NetworkCallback<T>`

c. External Service

##### Architectural Patterns & Design Principles
- Command Pattern: one class per HTTP method
- Factory Pattern: decouple connection creation (HTTP vs. HTTPS)
- Producer–Consumer: bounded queue + thread pool to protect against OOM
- Strategy: pluggable `IResponseParser` (e.g., GSON)
- Singleton: `NetworkManager` optionally as Application singleton
- Separation of Concerns: UI vs. Networking vs. Parsing vs. Configuration

1. UI Layer at top; show `MainActivity` → calls `NetworkManager`.
4. Off to the side, show `IHttpConnectionFactory` → `HttpUrlConnectionFactory` → adapters.
5. Beneath that, show `IResponseParser` → `GsonResponseParser`.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI Layer
    subgraph "UI Layer"
        direction TB
        MainActivity["«Activity» MainActivity"]:::ui
        Lookup["«Activity» Lookup"]:::ui
        MyApp["«Singleton» MyApplication"]:::ui
    end

    %% Domain/API Layer
    subgraph "Domain/API Layer"
        direction TB
        Post["«Model» Post"]:::domain
        TodoApi["«API» TodoApi"]:::api
        ABaseApi["«Base API» ABaseApi"]:::api
        Todo["«Model» Todo"]:::domain
    end

    %% Networking Layer
    subgraph "Networking Layer"
        direction TB
        NetworkManager["«Facade» NetworkManager"]:::network
        RequestHandle["«Handle» RequestHandle"]:::network
        NetworkCallback["«Callback» NetworkCallback"]:::network
        NetResult["«Result» NetResult"]:::network
        RequestQueue["BlockingQueue<RequestTask>"]:::network
        Executor["ExecutorService"]:::network
        RequestTask["RequestTask"]:::network
        ACommand["«Abstract» ACommand"]:::network
        GetCommand["GetCommand"]:::network
        PostCommand["PostCommand"]:::network
        PutCommand["PutCommand"]:::network
        DeleteCommand["DeleteCommand"]:::network
        PatchCommand["PatchCommand"]:::network
        MultipartCommand["MultipartCommand"]:::network
        AHttpClient["«Client» AHttpClient"]:::network
        MyHttpClient["«Client» MyHttpClient"]:::network
    end

    %% Connection Factory Layer
    subgraph "Connection Factory Layer"
        direction TB
        IHttpConnectionFactory["«Factory» IHttpConnectionFactory"]:::infra
        HttpUrlConnectionFactory["HttpUrlConnectionFactory"]:::infra
        IHttpConnection["«Adapter» IHttpConnection"]:::infra
        HttpConnectionAdapter["HttpConnectionAdapter"]:::infra
        HttpsConnectionAdapter["HttpsConnectionAdapter"]:::infra
    end

    %% Parser Layer
    subgraph "Parser Layer"
        direction TB
        IResponseParser["«Strategy» IResponseParser"]:::infra
        GsonResponseParser["GsonResponseParser"]:::infra
    end

    %% Utilities
    subgraph "Utilities"
        direction TB
        NetworkConfig["NetworkConfig"]:::infra
        UrlBuilder["UrlBuilder"]:::infra
        ResponseHandler["ResponseHandler"]:::infra
        RequestCancelledException["RequestCancelledException"]:::infra
    end

    %% External Service
    ExternalAPI["JSONPlaceholder API"]:::external

    %% Relationships
    MainActivity -->|"calls get/post"| NetworkManager
    Lookup -->|"calls get/post"| NetworkManager
    MyApp -->|"initializes"| NetworkManager

    NetworkManager --> RequestQueue
    NetworkManager --> Executor
    NetworkManager -->|"returns"| RequestHandle

    RequestQueue -->|"feeds"| RequestTask
    Executor -->|"executes"| RequestTask
    RequestTask -->|"wraps command"| ACommand

    ACommand --> GetCommand
    ACommand --> PostCommand
    ACommand --> PutCommand
    ACommand --> DeleteCommand
    ACommand --> PatchCommand
    ACommand --> MultipartCommand

    GetCommand -.-> UrlBuilder
    GetCommand -.-> NetworkConfig

    ACommand -->|"uses factory"| IHttpConnectionFactory
    IHttpConnectionFactory -->|"creates"| IHttpConnection
    HttpUrlConnectionFactory --> IHttpConnectionFactory
    IHttpConnection --> HttpConnectionAdapter
    IHttpConnection --> HttpsConnectionAdapter
    HttpConnectionAdapter --> ExternalAPI
    HttpsConnectionAdapter --> ExternalAPI

    ACommand -->|"parses response"| IResponseParser
    IResponseParser --> GsonResponseParser

    IResponseParser --> ResponseHandler
    ResponseHandler --> NetResult
    NetResult --> NetworkCallback
    NetworkCallback --> MainActivity
    NetworkCallback --> Lookup

    NetworkManager --> AHttpClient
    AHttpClient --> MyHttpClient

    %% Click Events
    click MainActivity "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/com/example/android_clean_network_layer/MainActivity.java"
    click Lookup "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/com/example/android_clean_network_layer/Lookup.java"
    click MyApp "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/com/example/android_clean_network_layer/MyApplication.java"
    click Post "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/com/example/android_clean_network_layer/Post.java"
    click TodoApi "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/api/TodoApi.java"
    click ABaseApi "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/ABaseApi.java"
    click Todo "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/model/Todo.java"
    click NetworkManager "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/NetworkManager.java"
    click AHttpClient "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/AHttpClient.java"
    click MyHttpClient "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/MyHttpClient.java"
    click RequestHandle "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/RequestHandle.java"
    click NetworkCallback "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/NetworkCallback.java"
    click NetResult "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/NetResult.java"
    click ACommand "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/command/ACommand.java"
    click GetCommand "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/command/GetCommand.java"
    click PostCommand "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/command/PostCommand.java"
    click PutCommand "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/command/PutCommand.java"
    click DeleteCommand "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/command/DeleteCommand.java"
    click PatchCommand "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/command/PatchCommand.java"
    click MultipartCommand "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/command/MultipartCommand.java"
    click IHttpConnectionFactory "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/connection/IHttpConnectionFactory.java"
    click HttpUrlConnectionFactory "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/connection/HttpUrlConnectionFactory.java"
    click IHttpConnection "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/connection/IHttpConnection.java"
    click HttpConnectionAdapter "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/connection/HttpConnectionAdapter.java"
    click HttpsConnectionAdapter "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/connection/HttpsConnectionAdapter.java"
    click IResponseParser "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/parser/IResponseParser.java"
    click GsonResponseParser "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/parser/GsonResponseParser.java"
    click NetworkConfig "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/util/NetworkConfig.java"
    click UrlBuilder "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/util/UrlBuilder.java"
    click ResponseHandler "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/util/ResponseHandler.java"
    click RequestCancelledException "https://github.com/tbiyiktas/android-clean-network-layer/blob/main/app/src/main/java/lib/net/util/RequestCancelledException.java"

    %% Styles
    classDef ui fill:#bbdefb,stroke:#0d47a1,color:#0d47a1;
    classDef api fill:#80deea,stroke:#006064,color:#006064;
    classDef domain fill:#b2dfdb,stroke:#004d40,color:#004d40;
    classDef network fill:#c8e6c9,stroke:#2e7d32,color:#2e7d32;
    classDef infra fill:#ffe0b2,stroke:#ef6c00,color:#ef6c00;
    classDef external fill:#e0e0e0,stroke:#424242,color:#424242;
```
