您的位置:

Clean Architecture详解

一、什么是Clean Architecture

Clean Architecture,即“干净架构”,是由 Robert C. Martin 等人提出的一套软件开发架构思想。它旨在解决软件开发中常见的耦合、依赖问题,使得软件系统更容易维护和扩展。

核心原则是将软件系统分为各层次,每个层次具有清晰的职责分离,从而实现可替换性、可测试性和可扩展性。整个架构遵循依赖倒转原则(Dependency Inversion Principle)。

同时,为了保证代码的可读性和简洁性,在实现过程中要尽可能地遵循 SOLID 原则(Single Responsibility、Open-Closed、Liskov Substitution、Interface Segregation、Dependency Inversion)。

二、Clean Architecture的核心思想

1、架构的分层

package com.example.cleanarchitecture

interface UserRepository {
    fun getUser(userId: Int): User
    fun saveUser(user: User)
}

interface UserPresenter {
    fun getUser(userId: Int): UserViewModel
    fun saveUser(userViewModel: UserViewModel)
}

class UserInteractor(
        private val userRepository: UserRepository,
        private val userPresenter: UserPresenter
) {
    fun getUser(userId: Int) {
        val user = userRepository.getUser(userId)
        val userViewModel = UserViewModel(
                user.id,
                user.name,
                user.avatarUrl
        )
        userPresenter.getUser(userViewModel)
    }

    fun saveUser(userViewModel: UserViewModel) {
        val user = User(
                userViewModel.id,
                userViewModel.name,
                userViewModel.avatarUrl
        )
        userRepository.saveUser(user)
    }
}

2、层次之间的依赖关系

package com.example.cleanarchitecture

class UserController(
        private val userInteractor: UserInteractor
) {

    fun getUser(userId: Int): UserViewModel {
        return userInteractor.getUser(userId)
    }

    fun saveUser(userViewModel: UserViewModel) {
        userInteractor.saveUser(userViewModel)
    }
}

3、数据流的单向性

package com.example.cleanarchitecture.data

@Entity(tableName = "user")
data class UserEntity(
        @PrimaryKey val id: Int,
        val name: String,
        val avatarUrl: String
)

interface UserDao {
    @Query("SELECT * FROM user WHERE id=:userId")
    fun getUser(userId: Int): UserEntity

    @Insert(onConflict = OnConflictStrategy.REPLACE)
    fun saveUser(userEntity: UserEntity)
}

class UserRepositoryImpl(
        private val userDao: UserDao
) : UserRepository {
    override fun getUser(userId: Int): User {
        val userEntity = userDao.getUser(userId)
        return User(
                userEntity.id,
                userEntity.name,
                userEntity.avatarUrl
        )
    }

    override fun saveUser(user: User) {
        userDao.saveUser(
                UserEntity(
                    user.id,
                    user.name,
                    user.avatarUrl
                )
        )
    }
}

三、Clean Architecture的好处

1、可测试性

Clean Architecture的分层原则,使得各个模块具有良好的职责分离和独立性,从而可以更容易地进行单元测试、集成测试等等,保证代码的稳定性和质量。

2、可维护性

Clean Architecture的依赖倒转原则,使得整个架构更加灵活、可扩展。在需要改动某个模块时,只需要关注该模块的上下游依赖关系,而不需要对整个系统进行大的改动。从而节省了维护成本,提高了开发效率。

3、可替代性

Clean Architecture的分层原则,使得各个模块具有良好的职责分离和独立性。这就为模块之间的替换提供了方便。对于某个模块的实现,我们可以根据实际需求替换为其他更优秀的实现。这种方便性,也极大的增加了软件系统的可维护性和可扩展性。

四、Clean Architecture的实践建议

1、层次严谨

在实现Clean Architecture时,要保证各个模块的职责分离、层次鲜明,不能出现跨层、混乱的现象。按照依赖倒置原则,各层次应该向下依赖,而不是向上污染。

2、业务无关性

在实现Clean Architecture时,要保证各个模块的业务无关性。这样可以让整个系统具有更强的通用性和可重复利用性,从而提高软件架构的质量。

3、编程规范

在实现Clean Architecture时,要保持代码的可读性和简洁性,尽可能遵循 SOLID 原则。这样可以让代码更加易于维护、扩展、重构。

五、结语

Clean Architecture是一套优秀的软件开发架构思想,它具有良好的可测试性、可维护性、可替代性。在实现过程中,需要严格遵循架构原则、业务无关性、编程规范等,才能为软件系统的发展提供更好的保障。