android-clean-architecture (Android Clean Architecture)

Android Clean Architecture

Clean Architecture-Muster für Android- und KMP-Projekte. Behandelt Modulgrenzen, Abhängigkeitsinversion, UseCase-/Repository-Muster und Datenebenen-Design mit Room, SQLDelight und Ktor.

Wann aktivieren

• Strukturierung von Android- oder KMP-Projektmodulen
• Implementierung von UseCases, Repositories oder DataSources
• Entwurf von Datenflüssen zwischen Schichten (domain, data, presentation)
• Einrichtung von Abhängigkeitsinjektion mit Koin oder Hilt
• Arbeiten mit Room, SQLDelight oder Ktor in einer geschichteten Architektur

Modulstruktur

Empfohlenes Layout

project/
├── app/                  # Android-Einstiegspunkt, DI-Verkabelung, Application-Klasse
├── core/                 # Gemeinsame Hilfsmittel, Basisklassen, Fehlertypen
├── domain/               # UseCases, Domänenmodelle, Repository-Schnittstellen (reines Kotlin)
├── data/                 # Repository-Implementierungen, DataSources, DB, Netzwerk
├── presentation/         # Bildschirme, ViewModels, UI-Modelle, Navigation
├── design-system/        # Wiederverwendbare Compose-Komponenten, Theme, Typografie
└── feature/              # Feature-Module (optional, für größere Projekte)
    ├── auth/
    ├── settings/
    └── profile/

Abhängigkeitsregeln

app → presentation, domain, data, core
presentation → domain, design-system, core
data → domain, core
domain → core (oder keine Abhängigkeiten)
core → (nichts)

Wichtig: domain darf NIEMALS von data, presentation oder einem Framework abhängen. Es enthält nur reines Kotlin.

Domänenschicht

UseCase-Muster

Jeder UseCase repräsentiert eine Geschäftsoperation. Verwenden Sie operator fun invoke für saubere Aufrufe:

class GetItemsByCategoryUseCase(
    private val repository: ItemRepository
) {
    suspend operator fun invoke(category: String): Result<List<Item>> {
        return repository.getItemsByCategory(category)
    }
}

// Flow-basierter UseCase für reaktive Streams
class ObserveUserProgressUseCase(
    private val repository: UserRepository
) {
    operator fun invoke(userId: String): Flow<UserProgress> {
        return repository.observeProgress(userId)
    }
}

Domänenmodelle

Domänenmodelle sind einfache Kotlin-Data-Klassen ohne Framework-Annotationen:

data class Item(
    val id: String,
    val title: String,
    val description: String,
    val tags: List<String>,
    val status: Status,
    val category: String
)

enum class Status { DRAFT, ACTIVE, ARCHIVED }

Repository-Schnittstellen

Definiert in der Domäne, implementiert in der Datenebene:

interface ItemRepository {
    suspend fun getItemsByCategory(category: String): Result<List<Item>>
    suspend fun saveItem(item: Item): Result<Unit>
    fun observeItems(): Flow<List<Item>>
}

Datenebene

Repository-Implementierung

Koordiniert zwischen lokalen und entfernten Datenquellen:

class ItemRepositoryImpl(
    private val localDataSource: ItemLocalDataSource,
    private val remoteDataSource: ItemRemoteDataSource
) : ItemRepository {

    override suspend fun getItemsByCategory(category: String): Result<List<Item>> {
        return runCatching {
            val remote = remoteDataSource.fetchItems(category)
            localDataSource.insertItems(remote.map { it.toEntity() })
            localDataSource.getItemsByCategory(category).map { it.toDomain() }
        }
    }

    override suspend fun saveItem(item: Item): Result<Unit> {
        return runCatching {
            localDataSource.insertItems(listOf(item.toEntity()))
        }
    }

    override fun observeItems(): Flow<List<Item>> {
        return localDataSource.observeAll().map { entities ->
            entities.map { it.toDomain() }
        }
    }
}

Mapper-Muster

Halten Sie Mapper als Erweiterungsfunktionen nahe den Datenmodellen:

// In der Datenebene
fun ItemEntity.toDomain() = Item(
    id = id,
    title = title,
    description = description,
    tags = tags.split("|"),
    status = Status.valueOf(status),
    category = category
)

fun ItemDto.toEntity() = ItemEntity(
    id = id,
    title = title,
    description = description,
    tags = tags.joinToString("|"),
    status = status,
    category = category
)

Room-Datenbank (Android)

@Entity(tableName = "items")
data class ItemEntity(
    @PrimaryKey val id: String,
    val title: String,
    val description: String,
    val tags: String,
    val status: String,
    val category: String
)

@Dao
interface ItemDao {
    @Query("SELECT * FROM items WHERE category = :category")
    suspend fun getByCategory(category: String): List<ItemEntity>

    @Upsert
    suspend fun upsert(items: List<ItemEntity>)

    @Query("SELECT * FROM items")
    fun observeAll(): Flow<List<ItemEntity>>
}

SQLDelight (KMP)

-- Item.sq
CREATE TABLE ItemEntity (
    id TEXT NOT NULL PRIMARY KEY,
    title TEXT NOT NULL,
    description TEXT NOT NULL,
    tags TEXT NOT NULL,
    status TEXT NOT NULL,
    category TEXT NOT NULL
);

getByCategory:
SELECT * FROM ItemEntity WHERE category = ?;

upsert:
INSERT OR REPLACE INTO ItemEntity (id, title, description, tags, status, category)
VALUES (?, ?, ?, ?, ?, ?);

observeAll:
SELECT * FROM ItemEntity;

Ktor-Netzwerkclient (KMP)

class ItemRemoteDataSource(private val client: HttpClient) {

    suspend fun fetchItems(category: String): List<ItemDto> {
        return client.get("api/items") {
            parameter("category", category)
        }.body()
    }
}

// HttpClient-Einrichtung mit Content Negotiation
val httpClient = HttpClient {
    install(ContentNegotiation) { json(Json { ignoreUnknownKeys = true }) }
    install(Logging) { level = LogLevel.HEADERS }
    defaultRequest { url("https://api.example.com/") }
}

Abhängigkeitsinjektion

Koin (KMP-kompatibel)

// Domänenmodul
val domainModule = module {
    factory { GetItemsByCategoryUseCase(get()) }
    factory { ObserveUserProgressUseCase(get()) }
}

// Datenmodul
val dataModule = module {
    single<ItemRepository> { ItemRepositoryImpl(get(), get()) }
    single { ItemLocalDataSource(get()) }
    single { ItemRemoteDataSource(get()) }
}

// Präsentationsmodul
val presentationModule = module {
    viewModelOf(::ItemListViewModel)
    viewModelOf(::DashboardViewModel)
}

Hilt (nur Android)

@Module
@InstallIn(SingletonComponent::class)
abstract class RepositoryModule {
    @Binds
    abstract fun bindItemRepository(impl: ItemRepositoryImpl): ItemRepository
}

@HiltViewModel
class ItemListViewModel @Inject constructor(
    private val getItems: GetItemsByCategoryUseCase
) : ViewModel()

Fehlerbehandlung

Result/Try-Muster

Verwenden Sie Result<T> oder einen benutzerdefinierten versiegelten Typ für die Fehlerweitergabe:

sealed interface Try<out T> {
    data class Success<T>(val value: T) : Try<T>
    data class Failure(val error: AppError) : Try<Nothing>
}

sealed interface AppError {
    data class Network(val message: String) : AppError
    data class Database(val message: String) : AppError
    data object Unauthorized : AppError
}

// In ViewModel – in den UI-Status abbilden
viewModelScope.launch {
    when (val result = getItems(category)) {
        is Try.Success -> _state.update { it.copy(items = result.value, isLoading = false) }
        is Try.Failure -> _state.update { it.copy(error = result.error.toMessage(), isLoading = false) }
    }
}

Konventions-Plugins (Gradle)

Verwenden Sie für KMP-Projekte Konventions-Plugins, um Build-Datei-Duplizierung zu reduzieren:

// build-logic/src/main/kotlin/kmp-library.gradle.kts
plugins {
    id("org.jetbrains.kotlin.multiplatform")
}

kotlin {
    androidTarget()
    iosX64(); iosArm64(); iosSimulatorArm64()
    sourceSets {
        commonMain.dependencies { /* gemeinsame Abhängigkeiten */ }
        commonTest.dependencies { implementation(kotlin("test")) }
    }
}

In Modulen anwenden:

// domain/build.gradle.kts
plugins { id("kmp-library") }

Anti-Patterns, die vermieden werden sollten

• Importieren von Android-Framework-Klassen in domain – halten Sie es rein in Kotlin
• Datenbankentitäten oder DTOs für die UI-Schicht freigeben – immer auf Domänenmodelle abbilden
• Geschäftslogik in ViewModels unterbringen – in UseCases auslagern
• Verwendung von GlobalScope oder unstrukturierten Coroutinen – viewModelScope oder strukturierte Nebenläufigkeit verwenden
• Dicke Repository-Implementierungen – in fokussierte DataSources aufteilen
• Zirkuläre Modulabhängigkeiten – wenn A von B abhängt, darf B nicht von A abhängen

Referenzen

Siehe Skill: compose-multiplatform-patterns für UI-Muster. Siehe Skill: kotlin-coroutines-flows für asynchrone Muster.