# chaoqinliu/composewechat architecture

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

- Interactive diagram: https://gitdiagram.com/chaoqinliu/composewechat
- Repository: https://github.com/chaoqinliu/composewechat

## Overview

##### Main Components (Nodes)
- UI / Presentation Layer:
- Activities: MainActivity, ChatActivity, LoginActivity, ImagePreviewActivity, MomentActivity, UserActivity.
- Compose Screens: Located under ui/screen (e.g., LoginScreen, ChatScreen, HomeScreen, MomentScreen, etc.), as well as dialogs and loading screens.
- UI Widgets and Views: custom components such as ActionBook, ActionTitle, CQDivider.

- ViewModel / Business Logic Layer:
- Individual ViewModels for each screen (ChatSessionViewModel, ChatViewModel, HomeViewModel, MomentViewModel, UserViewModel) and additional paged data sources.
- This layer bridges the UI and the underlying data operations.

- Data Access / Persistence Layer:
- Local Database: COMChatDataBase indicates usage of a Room or SQLite database.
- DAO: ChatSmsDao for handling database CRUD operations.
- Entities: chat and user entities found in entitys (e.g., ChatSmsEntity.kt).
- Data Models: Data classes for various UI or domain models (ChatSession, User, MomentData, AddrBookData, etc.).

- Network / API Communication Layer:
- API Service: UserService.kt provides an API interface possibly for user-related HTTP operations.
- Network Client: HttpClient.kt helps manage networking tasks.

- Utilities and Extensions:
- Common utility classes (e.g., ToastUtils, TimeUtils, DensityUtils).
- Extensions and modifiers aiding UI and other common operations.

- Additional Modules:
- Routing and Navigation: ui/route (Routes.kt) coordinate navigation within the app.

##### Relationships and Interactions
- The UI layer (activities, composable screens, custom views) interacts with the ViewModel layer through observers, ensuring that any changes in data are reflected in the UI.
- ViewModels coordinate with the data layer by calling methods on DAOs, accessing the local database, or querying remote APIs via the HttpClient and service interfaces.
- The data layer (DAO, entities, models) feeds information into the viewmodels, which in turn update the composables.
- Utilities and extensions support various cross-cutting concerns, such as displaying Toast messages, handling density conversions, and applying UI modifiers.

##### Architectural Patterns / Design Principles
- MVVM: Clear separation of presentation (activities, screens), business logic (viewmodels), and data handling (DAO, entities, API services).
- Modular organization: Each feature (chat, login, moments, user profile) is managed in its own sub-package, promoting separation of concerns.
- Composable UI: The use of Jetpack Compose elements is evident in the “ui” package, where each screen is designed as a composable function.

##### Technologies & Frameworks
- Android (Kotlin): Standard Android app with Kotlin code.
- Jetpack Compose: For building modern UI components/screen.
- Gradle: For building and dependency management (with associated gradle files).
- (Possibly) Room or SQLite: For the local database via COMChatDataBase and DAO patterns.
- Custom HTTP client: For network interactions (could be leveraging underlying libraries if expanded upon).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI / Presentation Layer
    subgraph "UI / Presentation Layer"
        UI_Activities["UI Activities"]:::ui
        Login_Screens["Login Screens"]:::ui
        Chat_Screens["Chat Screens"]:::ui
        Home_Screens["Home Screens"]:::ui
        Moment_Screens["Moment Screens"]:::ui
        Image_Preview["Image Preview Screen"]:::ui
        Additional_Screens["Additional Screens"]:::ui
        UI_Widgets["UI Widgets"]:::ui
        Theming_Elements["Theming Elements"]:::ui
    end

    %% Business Logic - ViewModel Layer
    subgraph "Business Logic - ViewModel Layer"
        Screen_ViewModels["Screen ViewModels"]:::viewmodel
        Paged_Data["Paged Data Sources"]:::viewmodel
    end

    %% Data Access / Persistence Layer
    subgraph "Data Access / Persistence Layer"
        Local_DB["Local Database"]:::data
        DAO["DAO"]:::data
        Entities["Entities"]:::data
        Data_Classes["Data Classes"]:::data
        Domain_Models["Domain Models"]:::data
    end

    %% Network / API Communication Layer
    subgraph "Network / API Communication Layer"
        API_Service["API Service"]:::network
        Network_Client["Network Client"]:::network
    end

    %% Utilities and Extensions
    subgraph "Utilities and Extensions"
        Utility_Classes["Utility Classes"]:::utils
        UI_Extensions["UI Extensions"]:::utils
    end

    %% Routing and Navigation
    subgraph "Routing and Navigation"
        Nav_Routes["Navigation Routes"]:::routing
    end

    %% UI Layer interactions to ViewModel
    UI_Activities -->|"UserActions/DataBindings"| Screen_ViewModels
    Login_Screens  -->|"UserActions/DataBindings"| Screen_ViewModels
    Chat_Screens   -->|"UserActions/DataBindings"| Screen_ViewModels
    Home_Screens   -->|"UserActions/DataBindings"| Screen_ViewModels
    Moment_Screens -->|"UserActions/DataBindings"| Screen_ViewModels
    Image_Preview  -->|"UserActions/DataBindings"| Screen_ViewModels
    Additional_Screens -->|"UserActions/DataBindings"| Screen_ViewModels

    %% UI Layer interactions with Routing
    UI_Activities -->|"Navigation"| Nav_Routes
    Login_Screens  -->|"Navigation"| Nav_Routes
    Chat_Screens   -->|"Navigation"| Nav_Routes
    Home_Screens   -->|"Navigation"| Nav_Routes
    Moment_Screens -->|"Navigation"| Nav_Routes
    Image_Preview  -->|"Navigation"| Nav_Routes
    Additional_Screens -->|"Navigation"| Nav_Routes

    %% ViewModel to Data Layer interactions
    Screen_ViewModels -->|"DatabaseCRUD"| DAO
    DAO -->|"CRUD"| Local_DB
    Screen_ViewModels -->|"DataModels"| Entities
    Screen_ViewModels -->|"DataClasses"| Data_Classes
    Screen_ViewModels -->|"DomainModels"| Domain_Models

    %% ViewModel to Network Layer interactions
    Screen_ViewModels -->|"API_Calls"| API_Service
    API_Service -->|"Uses"| Network_Client

    %% Utilities supporting layers
    UI_Extensions -->|"Enhance"| UI_Activities
    Utility_Classes -->|"Support"| Screen_ViewModels

    %% Click Events for UI / Presentation Layer
    click UI_Activities "https://github.com/chaoqinliu/composewechat/tree/main/app/src/main/java/com/lcq/composewechat/activity"
    click Login_Screens "https://github.com/chaoqinliu/composewechat/tree/main/app/src/main/java/com/lcq/composewechat/ui/screen/login"
    click Chat_Screens "https://github.com/chaoqinliu/composewechat/tree/main/app/src/main/java/com/lcq/composewechat/ui/screen/chat"
    click Home_Screens "https://github.com/chaoqinliu/composewechat/tree/main/app/src/main/java/com/lcq/composewechat/ui/screen/home"
    click Moment_Screens "https://github.com/chaoqinliu/composewechat/tree/main/app/src/main/java/com/lcq/composewechat/ui/screen/montent"
    click Image_Preview "https://github.com/chaoqinliu/composewechat/tree/main/app/src/main/java/com/lcq/composewechat/ui/screen/image"
    click Additional_Screens "https://github.com/chaoqinliu/composewechat/tree/main/app/src/main/java/com/lcq/composewechat/ui/screen"
    click UI_Widgets "https://github.com/chaoqinliu/composewechat/tree/main/app/src/main/java/com/lcq/composewechat/view"
    click Theming_Elements "https://github.com/chaoqinliu/composewechat/tree/main/app/src/main/java/com/lcq/composewechat/ui/theme"

    %% Click Events for ViewModel / Business Logic Layer
    click Screen_ViewModels "https://github.com/chaoqinliu/composewechat/tree/main/app/src/main/java/com/lcq/composewechat/viewmodel"
    click Paged_Data "https://github.com/chaoqinliu/composewechat/tree/main/app/src/main/java/com/lcq/composewechat/viewmodel/paged"

    %% Click Events for Data Access / Persistence Layer
    click Local_DB "https://github.com/chaoqinliu/composewechat/blob/main/app/src/main/java/com/lcq/composewechat/db/COMChatDataBase.kt"
    click DAO "https://github.com/chaoqinliu/composewechat/blob/main/app/src/main/java/com/lcq/composewechat/dao/ChatSmsDao.kt"
    click Entities "https://github.com/chaoqinliu/composewechat/tree/main/app/src/main/java/com/lcq/composewechat/entitys"
    click Data_Classes "https://github.com/chaoqinliu/composewechat/tree/main/app/src/main/java/com/lcq/composewechat/data"
    click Domain_Models "https://github.com/chaoqinliu/composewechat/tree/main/app/src/main/java/com/lcq/composewechat/models"

    %% Click Events for Network / API Communication Layer
    click API_Service "https://github.com/chaoqinliu/composewechat/blob/main/app/src/main/java/com/lcq/composewechat/api/UserService.kt"
    click Network_Client "https://github.com/chaoqinliu/composewechat/blob/main/app/src/main/java/com/lcq/composewechat/http/HttpClient.kt"

    %% Click Events for Utilities and Extensions
    click Utility_Classes "https://github.com/chaoqinliu/composewechat/tree/main/app/src/main/java/com/lcq/composewechat/utils"
    click UI_Extensions "https://github.com/chaoqinliu/composewechat/tree/main/app/src/main/java/com/lcq/composewechat/extensions"

    %% Click Event for Routing and Navigation
    click Nav_Routes "https://github.com/chaoqinliu/composewechat/blob/main/app/src/main/java/com/lcq/composewechat/ui/route/Routes.kt"

    %% Styles
    classDef ui fill:#ADD8E6,stroke:#333,stroke-width:2px;
    classDef viewmodel fill:#98FB98,stroke:#333,stroke-width:2px;
    classDef data fill:#FFFFE0,stroke:#333,stroke-width:2px;
    classDef network fill:#F08080,stroke:#333,stroke-width:2px;
    classDef utils fill:#FFDAB9,stroke:#333,stroke-width:2px;
    classDef routing fill:#D3D3D3,stroke:#333,stroke-width:2px;
```
