Android Clean Architecture

Android Clean Architecture は何をしますか？

AndroidおよびKMPプロジェクト向けのクリーンアーキテクチャパターン。モジュール境界、依存関係逆転、UseCase/Repositoryパターン、Room、SQLDelight、Ktorを用いたデータ層設計をカバーします。

アクティブにするタイミング

• AndroidまたはKMPプロジェクトのモジュール構造化時
• UseCase、Repository、DataSourceの実装時
• レイヤー（ドメイン、データ、プレゼンテーション）間のデータフロー設計時
• KoinまたはHiltを使用した依存性注入の設定時
• 階層化アーキテクチャでのRoom、SQLDelight、Ktorの利用時

モジュール構造

推奨レイアウト

project/
├── app/                  # Androidエントリポイント、DI配線、Applicationクラス
├── core/                 # 共有ユーティリティ、基底クラス、エラータイプ
├── domain/               # UseCase、ドメインモデル、リポジトリインターフェース（純粋Kotlin）
├── data/                 # Repository実装、DataSource、DB、ネットワーク
├── presentation/         # 画面、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 }

リポジトリインターフェース

ドメインで定義され、データレイヤーで実装されます：

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対応）

// ドメインモジュール
val domainModule = module {
    factory { GetItemsByCategoryUseCase(get()) }
    factory { ObserveUserProgressUseCase(get()) }
}

// データモジュール
val dataModule = module {
    single<ItemRepository> { ItemRepositoryImpl(get(), get()) }
    single { ItemLocalDataSource(get()) }
    single { ItemRemoteDataSource(get()) }
}

// プレゼンテーションモジュール
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) }
    }
}

コンベンションプラグイン（Gradle）

KMPプロジェクトでは、コンベンションプラグインを使用してビルドファイルの重複を削減します：

// 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 を参照。