Android Clean Architecture は何をしますか?
Android および KMP プロジェクト向けの Clean Architecture パターン。モジュール境界、依存関係逆転、UseCase/Repository パターン、Room、SQLDelight、Ktor を用いたデータ層設計をカバーします。
アクティブにするタイミング
- Android または KMP プロジェクトのモジュールを構築するとき
- UseCase、Repository、DataSource を実装するとき
- レイヤー間(domain、data、presentation)のデータフローを設計するとき
- Koin または Hilt で依存性注入を設定するとき
- レイヤードアーキテクチャで Room、SQLDelight、または Ktor を使用するとき
モジュール構造
推奨レイアウト
project/
├── app/ # Android エントリポイント、DI 配線、Application クラス
├── core/ # 共有ユーティリティ、基底クラス、エラー型
├── domain/ # UseCase、ドメインモデル、リポジトリインターフェース(純粋 Kotlin)
├── data/ # リポジトリ実装、DataSource、DB、ネットワーク
├── presentation/ # Screen、ViewModel、UI モデル、ナビゲーション
├── design-system/ # 再利用可能な Compose コンポーネント、テーマ、タイポグラフィ
└── feature/ # 機能モジュール(大規模プロジェクトでは任意)
├── auth/
├── settings/
└── profile/
依存関係ルール
app → presentation, domain, data, core
presentation → domain, design-system, core
data → domain, core
domain → core(または依存なし)
core →(依存なし)
重要: domain は data、presentation、またはいかなるフレームワークにも依存してはなりません。純粋な Kotlin のみで構成します。
ドメイン層
UseCase パターン
各 UseCase は 1 つのビジネス操作を表します。operator fun invoke を使用してクリーンな呼び出しサイトを実現します:
class GetItemsByCategoryUseCase(
private val repository: ItemRepository
) {
suspend operator fun invoke(category: String): Result<List<Item>> {
return repository.getItemsByCategory(category)
}
}
// Flow ベースの UseCase(リアクティブストリーム用)
class ObserveUserProgressUseCase(
private val repository: UserRepository
) {
operator fun invoke(userId: String): Flow<UserProgress> {
return repository.observeProgress(userId)
}
}
ドメインモデル
ドメインモデルはプレーンな Kotlin データクラスです(フレームワークのアノテーションは付けません):
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 }
リポジトリインターフェース
domain で定義し、data で実装します:
interface ItemRepository {
suspend fun getItemsByCategory(category: String): Result<List<Item>>
suspend fun saveItem(item: Item): Result<Unit>
fun observeItems(): Flow<List<Item>>
}
データ層
リポジトリ実装
ローカルデータソースとリモートデータソースを調整します:
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() }
}
}
}
マッパーパターン
マッパーはデータモデル近くの拡張関数として保持します:
// data レイヤー内
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 データベース(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 ネットワーククライアント(KMP)
class ItemRemoteDataSource(private val client: HttpClient) {
suspend fun fetchItems(category: String): List<ItemDto> {
return client.get("api/items") {
parameter("category", category)
}.body()
}
}
// HttpClient のセットアップ(コンテンツネゴシエーション付き)
val httpClient = HttpClient {
install(ContentNegotiation) { json(Json { ignoreUnknownKeys = true }) }
install(Logging) { level = LogLevel.HEADERS }
defaultRequest { url("https://api.example.com/") }
}
依存性注入
Koin(KMP フレンドリー)
// Domain モジュール
val domainModule = module {
factory { GetItemsByCategoryUseCase(get()) }
factory { ObserveUserProgressUseCase(get()) }
}
// Data モジュール
val dataModule = module {
single<ItemRepository> { ItemRepositoryImpl(get(), get()) }
single { ItemLocalDataSource(get()) }
single { ItemRemoteDataSource(get()) }
}
// Presentation モジュール
val presentationModule = module {
viewModelOf(::ItemListViewModel)
viewModelOf(::DashboardViewModel)
}
Hilt(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()
エラーハンドリング
Result/Try パターン
エラー伝播には Result<T> またはカスタム sealed 型を使用します:
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
}
// ViewModel 内 — UI 状態にマッピング
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) }
}
}
Convention Plugin(Gradle)
KMP プロジェクトでは Convention Plugin を使用してビルドファイルの重複を削減します:
// build-logic/src/main/kotlin/kmp-library.gradle.kts
plugins {
id("org.jetbrains.kotlin.multiplatform")
}
kotlin {
androidTarget()
iosX64(); iosArm64(); iosSimulatorArm64()
sourceSets {
commonMain.dependencies { /* 共有依存関係 */ }
commonTest.dependencies { implementation(kotlin("test")) }
}
}
モジュールで適用:
// domain/build.gradle.kts
plugins { id("kmp-library") }
避けるべきアンチパターン
domainに Android フレームワーククラスをインポートする — 純粋 Kotlin を維持すること- データベースエンティティや DTO を UI 層に公開する — 必ずドメインモデルにマッピングすること
- ビジネスロジックを ViewModel に置く — UseCase に抽出すること
GlobalScopeや非構造化コルーチンを使用する —viewModelScopeまたは構造化された並行性を使用すること- リポジトリ実装を肥大化させる — フォーカスした DataSource に分割すること
- 循環モジュール依存 — A が B に依存するなら、B は A に依存してはならない
参考
UI パターンについてはスキル compose-multiplatform-patterns を参照。
非同期パターンについてはスキル kotlin-coroutines-flows を参照。