# awasisto/android-clean-architecture-samples architecture

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

- Interactive diagram: https://gitdiagram.com/awasisto/android-clean-architecture-samples
- Repository: https://github.com/awasisto/android-clean-architecture-samples

## Overview

##### Project Type and Purpose
- This is a multi-module Android sample project demonstrating Clean Architecture.
- It provides four variants (MVP in Java/Kotlin and MVVM in Java/Kotlin), each structured into four Gradle modules:
- common – shared utilities (e.g., Logger)
- data – Android-specific data layer (Retrofit, SQLite)
- domain – business rules, use cases, models, interfaces
- ui – presentation layer (Activities, Presenters/ViewModels, Views)
- The sample app lets users search GitHub users and view search history.

##### File Structure Analysis
- Top-level modules: mvp-java, mvp-kotlin, mvvm-java, mvvm-kotlin.
- Within each sample module:
- common – contains cross-cutting code (Logger).
- data – implements domain interfaces:
– github remote (GithubService + RetrofitGithubDataSource)
– local history (SQLite via SearchHistoryDbHelper + SqliteSearchHistoryDataSource)
– AndroidLogger
- domain – pure Java/Kotlin with interfaces (GithubDataSource, SearchHistoryDataSource), entities (User, SearchUsersResult, SearchHistoryItem), and use cases (SearchUsersUseCase, GetUserUseCase, GetSearchHistoryUseCase).
- ui – Android project:
– ServiceLocator/DefaultServiceLocator to wire dependencies
– Presentation (Activity + Presenter or Activity + ViewModel)
– Adapters for RecyclerView, Views, layouts

##### README Insights
- Emphasis on separation of concerns: UI layer knows only about domain use cases; domain layer is independent of frameworks; data layer bridges domain interfaces to Android/Retrofit/SQLite.

##### Essential Architectural Elements to Capture
- Dependency flow: UI → Domain Interfaces ← Data Implementations
- Two data sources: remote (GitHub API) and local (SQLite)
- Use cases as the entry point to business logic
- Service Locator / Composition root in UI module
- Shared utilities in common module

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI Layer
    subgraph "UI Layer"
        direction TB
        SL["ServiceLocator"]:::ui
        DSL["DefaultServiceLocator"]:::ui
        MTE["MainThreadExecutor"]:::ui
        SA["SearchActivity"]:::ui
        SP["SearchPresenter"]:::ui
        SV["SearchView"]:::ui
        SRA["SearchResultAdapter"]:::ui
        SHA["SearchHistoryAdapter"]:::ui
        UDA["UserDetailsActivity"]:::ui
        UDP["UserDetailsPresenter"]:::ui
        UDV["UserDetailsView"]:::ui
    end

    %% Domain Layer
    subgraph "Domain Layer"
        direction TB
        SUC["SearchUsersUseCase"]:::domain
        GUC["GetUserUseCase"]:::domain
        GSH["GetSearchHistoryUseCase"]:::domain
        GDS["GithubDataSource"]:::domain
        SHDS["SearchHistoryDataSource"]:::domain
        U["User"]:::domain
        SUR["SearchUsersResult"]:::domain
        SHI["SearchHistoryItem"]:::domain
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        RGD["RetrofitGithubDataSource"]:::data
        GS["GithubService"]:::data
        SSD["SqliteSearchHistoryDataSource"]:::data
        SHDH["SearchHistoryDbHelper"]:::data
        SHC["SearchHistoryContract"]:::data
        AL["AndroidLogger"]:::data
    end

    %% Common Module
    CM["Logger"]:::common

    %% External Systems
    API["GitHub REST API"]:::external
    DB["SQLite Database"]:::external

    %% Relationships
    SA -->|"creates"| SP
    SP -->|"updates"| SV
    SP -->|"uses"| SUC
    UDA -->|"creates"| UDP
    UDP -->|"updates"| UDV
    UDP -->|"uses"| GUC
    SV -->|"displays"| SUR
    SHA -->|"binds"| SHI
    SRA -->|"binds"| U

    SUC -->|"depends on"| GDS
    SUC -->|"depends on"| SHDS
    GUC -->|"depends on"| GDS
    GSH -->|"depends on"| SHDS

    RGD -->|"implements"| GDS
    SSD -->|"implements"| SHDS

    RGD -->|"calls"| API
    SSD -->|"reads/writes"| DB

    SL -->|"provides"| RGD
    SL -->|"provides"| SSD
    SL -->|"provides"| AL
    SL -->|"provides"| SUC
    SL -->|"provides"| GUC
    SL -->|"provides"| GSH

    AL -->|"logs to"| CM
    RGD -->|"logs to"| CM
    SSD -->|"logs to"| CM
    SUC -->|"logs to"| CM
    SP -->|"logs to"| CM

    %% Click Events
    click CM "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/common/src/main/java/com/wasisto/githubuserfinder/common/Logger.java"
    click GS "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/data/src/main/java/com/wasisto/githubuserfinder/android/data/github/GithubService.java"
    click RGD "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/data/src/main/java/com/wasisto/githubuserfinder/android/data/github/RetrofitGithubDataSource.java"
    click SHC "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/data/src/main/java/com/wasisto/githubuserfinder/android/data/searchhistory/SearchHistoryContract.java"
    click SHDH "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/data/src/main/java/com/wasisto/githubuserfinder/android/data/searchhistory/SearchHistoryDbHelper.java"
    click SSD "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/data/src/main/java/com/wasisto/githubuserfinder/android/data/searchhistory/SqliteSearchHistoryDataSource.java"
    click AL "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/data/src/main/java/com/wasisto/githubuserfinder/android/data/logger/AndroidLogger.java"
    click GDS "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/domain/src/main/java/com/wasisto/githubuserfinder/domain/interfaces/GithubDataSource.java"
    click SHDS "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/domain/src/main/java/com/wasisto/githubuserfinder/domain/interfaces/SearchHistoryDataSource.java"
    click U "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/domain/src/main/java/com/wasisto/githubuserfinder/domain/models/User.java"
    click SUR "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/domain/src/main/java/com/wasisto/githubuserfinder/domain/models/SearchUsersResult.java"
    click SHI "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/domain/src/main/java/com/wasisto/githubuserfinder/domain/models/SearchHistoryItem.java"
    click SUC "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/domain/src/main/java/com/wasisto/githubuserfinder/domain/usecases/SearchUsersUseCase.java"
    click GUC "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/domain/src/main/java/com/wasisto/githubuserfinder/domain/usecases/GetUserUseCase.java"
    click GSH "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/domain/src/main/java/com/wasisto/githubuserfinder/domain/usecases/GetSearchHistoryUseCase.java"
    click SL "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/ui/src/main/java/com/wasisto/githubuserfinder/android/ServiceLocator.java"
    click DSL "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/ui/src/main/java/com/wasisto/githubuserfinder/android/DefaultServiceLocator.java"
    click MTE "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/ui/src/main/java/com/wasisto/githubuserfinder/android/MainThreadExecutorService.java"
    click SA "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/ui/src/main/java/com/wasisto/githubuserfinder/android/ui/search/SearchActivity.java"
    click SP "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/ui/src/main/java/com/wasisto/githubuserfinder/android/ui/search/SearchPresenter.java"
    click SV "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/ui/src/main/java/com/wasisto/githubuserfinder/android/ui/search/SearchView.java"
    click SRA "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/ui/src/main/java/com/wasisto/githubuserfinder/android/ui/search/SearchResultAdapter.java"
    click SHA "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/ui/src/main/java/com/wasisto/githubuserfinder/android/ui/search/SearchHistoryAdapter.java"
    click UDA "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/ui/src/main/java/com/wasisto/githubuserfinder/android/ui/userdetails/UserDetailsActivity.java"
    click UDP "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/ui/src/main/java/com/wasisto/githubuserfinder/android/ui/userdetails/UserDetailsPresenter.java"
    click UDV "https://github.com/awasisto/android-clean-architecture-samples/blob/master/mvp-java/ui/src/main/java/com/wasisto/githubuserfinder/android/ui/userdetails/UserDetailsView.java"

    %% Styles
    classDef ui fill:#D0E6FF,stroke:#333,stroke-width:1px
    classDef domain fill:#DFFFD0,stroke:#333,stroke-width:1px
    classDef data fill:#FFE0B2,stroke:#333,stroke-width:1px
    classDef common fill:#E0E0E0,stroke:#333,stroke-width:1px
    classDef external fill:#F0F0F0,stroke:#333,stroke-width:1px
```
