# facebook/facebook-android-sdk architecture

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

- Interactive diagram: https://gitdiagram.com/facebook/facebook-android-sdk
- Repository: https://github.com/facebook/facebook-android-sdk

## Overview

##### Project type and purpose
- This is a multi-module Android SDK (Facebook Android SDK).
- Its purpose is to expose reusable Facebook features (Login, Share, Messenger, App Links, Analytics/Marketing, Gaming Services) as independent Gradle modules that app developers can pick and choose.

##### File structure
- Top-level modules (each with its own build.gradle.kts):
- facebook-core (base SDK functionality, Graph API, initialization, networking)
- facebook-common (shared UI/dialog utilities, custom tabs, login flows)
- facebook-login, facebook-share, facebook-messenger, facebook-applinks, facebook-gamingservices, facebook-marketing (feature modules that depend on core/common)
- facebook-bolts (asynchronous Task library used by multiple modules)
- facebook-testutil (utilities and mocks for testing within SDK modules)
- buildSrc directory managing shared dependency versions.
- Root build scripts: settings.gradle.kts, gradle.properties, jacoco.gradle.kts, maven.gradle (publishing), GitHub workflows under .github/workflows.
- “samples” directory containing standalone Android applications that consume the SDK modules.

##### README for additional insights
Facebook-android-sdk (umbrella)
├─ facebook-login, facebook-share, facebook-messenger, facebook-applinks
├─ facebook-common
└─ facebook-core
- Advises users to include only the modules they need, and warns that SDK init must run in the main process.

##### Main components
- Core (facebook-core)
- Common (facebook-common)
- Feature modules: Login, Share, Messenger, AppLinks, Marketing, GamingServices
- Bolts (facebook-bolts)
- Test utilities (facebook-testutil)
- Sample apps (FBLoginSample, HelloFacebookSample, KotlinSampleApp)
- CI/CD (GitHub Actions workflows, Maven Central publishing)
- Bolts → Core → Common → Feature modules
- Feature modules → Core (Graph API calls, token management)
- Feature modules → Common (UI flows, dialogs)
- Samples → selected Feature modules (they declare dependencies on specific feature modules in their Gradle configs)
- CI/CD → publishing pipeline → Maven Central
c. Architectural patterns and principles:
- Layered modular architecture: base (Core) → shared utilities (Common) → feature-specific modules
- Separation of concerns: each feature is its own Gradle project
- Dependency management via buildSrc (centralized versions)
- Testability: each module has its own unit tests and uses facebook-testutil for mocks
d. Technologies and frameworks:
- Kotlin & Java source → Android library modules
- Gradle Kotlin DSL for builds & publishing (build.gradle.kts, maven.gradle)
- GitHub Actions for CI (needs-attention.yml, stale.yml)
- ProGuard rules per module (proguard-rules.pro)
- Maven Central for distribution

##### Detailed focus points
- BuildSrc as the single source of truth for all dependency versions.
- That each module has its own ProGuard rules and tests.
- Publishing step: root maven.gradle → Maven Central badge (as shown in README)
- GitHub Actions workflows in the CI/CD component.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Subgraph: SDK Modules
    subgraph "Android SDK Modules"
        direction TB
        Bolts["Bolts Library"]:::utilModule
        Core["Core (facebook-core)"]:::codeModule
        Common["Common (facebook-common)"]:::codeModule
        Login["Login Module"]:::codeModule
        Share["Share Module"]:::codeModule
        Messenger["Messenger Module"]:::codeModule
        AppLinks["AppLinks Module"]:::codeModule
        Marketing["Marketing Module"]:::codeModule
        Gaming["Gaming Services Module"]:::codeModule
        TestUtil["Test Utilities"]:::utilModule
    end

    %% Subgraph: Sample Apps
    subgraph "Sample Applications"
        direction TB
        FBLoginSample["FBLoginSample"]:::externalClient
        HelloFacebookSample["HelloFacebookSample"]:::externalClient
        KotlinSampleApp["KotlinSampleApp"]:::externalClient
    end

    %% Subgraph: Build & CI
    subgraph "Build & CI"
        direction TB
        BuildSrc["buildSrc (Dependency Versions)"]:::ci
        Settings["settings.gradle.kts"]:::ci
        Properties["gradle.properties"]:::ci
        Jacoco["jacoco.gradle.kts"]:::ci
        CIWorkflows["GitHub Actions Workflows"]:::ci
        MavenScript["maven.gradle (Publishing)"]:::publish
        MavenCentral["Maven Central"]:::externalClient
    end

    %% Dependencies within SDK
    Bolts -->|"Provides async tasks"| Core
    Core -->|"Initialization, Graph API"| Common
    Common -->|"Shared UI & dialogs"| Login
    Common -->|"Shared UI & dialogs"| Share
    Common -->|"Shared UI & dialogs"| Messenger
    Common -->|"Shared UI & dialogs"| AppLinks
    Common -->|"Shared UI & dialogs"| Marketing
    Common -->|"Shared UI & dialogs"| Gaming

    Login -->|"Uses Core Graph API"| Core
    Share -->|"Uses Core Graph API"| Core
    Messenger -->|"Uses Core Graph API"| Core
    AppLinks -->|"Uses Core Graph API"| Core
    Marketing -->|"Uses Core Graph API"| Core
    Gaming -->|"Uses Core Graph API"| Core

    %% Test utilities usage
    TestUtil -->|"Mocks & utilities"| Core
    TestUtil -->|"Mocks & utilities"| Common
    TestUtil -->|"Mocks & utilities"| Login
    TestUtil -->|"Mocks & utilities"| Share
    TestUtil -->|"Mocks & utilities"| Messenger
    TestUtil -->|"Mocks & utilities"| AppLinks
    TestUtil -->|"Mocks & utilities"| Marketing
    TestUtil -->|"Mocks & utilities"| Gaming

    %% Samples dependencies
    FBLoginSample -->|"Depends on Login, Core, Common"| Login
    HelloFacebookSample -->|"Depends on Share, Common"| Share
    KotlinSampleApp -->|"Depends on Login, Share, Common"| Login

    %% Build & CI flow
    Settings --> BuildSrc
    Properties --> BuildSrc
    Jacoco --> BuildSrc
    CIWorkflows --> BuildSrc
    BuildSrc --> MavenScript
    CIWorkflows --> MavenScript
    MavenScript -->|"Publishes artifacts"| MavenCentral

    %% Click events
    click Core "https://github.com/facebook/facebook-android-sdk/tree/main/facebook-core"
    click Common "https://github.com/facebook/facebook-android-sdk/tree/main/facebook-common"
    click Login "https://github.com/facebook/facebook-android-sdk/tree/main/facebook-login"
    click Share "https://github.com/facebook/facebook-android-sdk/tree/main/facebook-share"
    click Messenger "https://github.com/facebook/facebook-android-sdk/tree/main/facebook-messenger"
    click AppLinks "https://github.com/facebook/facebook-android-sdk/tree/main/facebook-applinks"
    click Marketing "https://github.com/facebook/facebook-android-sdk/tree/main/facebook-marketing"
    click Gaming "https://github.com/facebook/facebook-android-sdk/tree/main/facebook-gamingservices"
    click Bolts "https://github.com/facebook/facebook-android-sdk/tree/main/facebook-bolts"
    click TestUtil "https://github.com/facebook/facebook-android-sdk/tree/main/facebook-testutil"
    click BuildSrc "https://github.com/facebook/facebook-android-sdk/tree/main/buildSrc"
    click CIWorkflows "https://github.com/facebook/facebook-android-sdk/tree/main/.github/workflows"
    click MavenScript "https://github.com/facebook/facebook-android-sdk/blob/main/maven.gradle"
    click Settings "https://github.com/facebook/facebook-android-sdk/blob/main/settings.gradle.kts"
    click Properties "https://github.com/facebook/facebook-android-sdk/blob/main/gradle.properties"
    click Jacoco "https://github.com/facebook/facebook-android-sdk/blob/main/jacoco.gradle.kts"
    click FBLoginSample "https://github.com/facebook/facebook-android-sdk/tree/main/samples/FBLoginSample"
    click HelloFacebookSample "https://github.com/facebook/facebook-android-sdk/tree/main/samples/HelloFacebookSample"
    click KotlinSampleApp "https://github.com/facebook/facebook-android-sdk/tree/main/samples/KotlinSampleApp"

    %% Styles
    classDef codeModule fill:#AED6F1,stroke:#1B4F72,color:#1B2631;
    classDef utilModule fill:#F9E79F,stroke:#7D6608,color:#1B2631;
    classDef ci fill:#ABEBC6,stroke:#196F3D,color:#1B2631;
    classDef publish fill:#D7BDE2,stroke:#581845,color:#1B2631;
    classDef externalClient fill:#D5DBDB,stroke:#566573,color:#1B2631;
```
