Files
everything-claude-code/docs/zh-CN/rules/kotlin/patterns.md
2026-03-13 17:45:44 +08:00

3.6 KiB
Raw Blame History

paths
paths
**/*.kt
**/*.kts

Kotlin 模式

此文件扩展了 common/patterns.md 的内容,增加了 Kotlin 和 Android/KMP 特定的内容。

依赖注入

首选构造函数注入。使用 KoinKMP或 Hilt仅限 Android

// Koin — declare modules
val dataModule = module {
    single<ItemRepository> { ItemRepositoryImpl(get(), get()) }
    factory { GetItemsUseCase(get()) }
    viewModelOf(::ItemListViewModel)
}

// Hilt — annotations
@HiltViewModel
class ItemListViewModel @Inject constructor(
    private val getItems: GetItemsUseCase
) : ViewModel()

ViewModel 模式

单一状态对象、事件接收器、单向数据流:

data class ScreenState(
    val items: List<Item> = emptyList(),
    val isLoading: Boolean = false
)

class ScreenViewModel(private val useCase: GetItemsUseCase) : ViewModel() {
    private val _state = MutableStateFlow(ScreenState())
    val state = _state.asStateFlow()

    fun onEvent(event: ScreenEvent) {
        when (event) {
            is ScreenEvent.Load -> load()
            is ScreenEvent.Delete -> delete(event.id)
        }
    }
}

仓库模式

  • suspend 函数返回 Result<T> 或自定义错误类型
  • 对于响应式流使用 Flow
  • 协调本地和远程数据源
interface ItemRepository {
    suspend fun getById(id: String): Result<Item>
    suspend fun getAll(): Result<List<Item>>
    fun observeAll(): Flow<List<Item>>
}

用例模式

单一职责,operator fun invoke

class GetItemUseCase(private val repository: ItemRepository) {
    suspend operator fun invoke(id: String): Result<Item> {
        return repository.getById(id)
    }
}

class GetItemsUseCase(private val repository: ItemRepository) {
    suspend operator fun invoke(): Result<List<Item>> {
        return repository.getAll()
    }
}

expect/actual (KMP)

用于平台特定的实现:

// commonMain
expect fun platformName(): String
expect class SecureStorage {
    fun save(key: String, value: String)
    fun get(key: String): String?
}

// androidMain
actual fun platformName(): String = "Android"
actual class SecureStorage {
    actual fun save(key: String, value: String) { /* EncryptedSharedPreferences */ }
    actual fun get(key: String): String? = null /* ... */
}

// iosMain
actual fun platformName(): String = "iOS"
actual class SecureStorage {
    actual fun save(key: String, value: String) { /* Keychain */ }
    actual fun get(key: String): String? = null /* ... */
}

协程模式

  • 在 ViewModels 中使用 viewModelScope,对于结构化的子工作使用 coroutineScope
  • 对于来自冷流的 StateFlow 使用 stateIn(viewModelScope, SharingStarted.WhileSubscribed(5_000), initialValue)
  • 当子任务失败应独立处理时使用 supervisorScope

使用 DSL 的构建器模式

class HttpClientConfig {
    var baseUrl: String = ""
    var timeout: Long = 30_000
    private val interceptors = mutableListOf<Interceptor>()

    fun interceptor(block: () -> Interceptor) {
        interceptors.add(block())
    }
}

fun httpClient(block: HttpClientConfig.() -> Unit): HttpClient {
    val config = HttpClientConfig().apply(block)
    return HttpClient(config)
}

// Usage
val client = httpClient {
    baseUrl = "https://api.example.com"
    timeout = 15_000
    interceptor { AuthInterceptor(tokenProvider) }
}

参考

有关详细的协程模式,请参阅技能:kotlin-coroutines-flows。 有关模块和分层模式,请参阅技能:android-clean-architecture