具有交互器/用例的MVVM体系结构

时间:2019-03-30 14:29:31

标签: android mvvm android-livedata android-viewmodel

上下文

因此,我一直在为几个项目使用MVVM体系结构。我仍在尝试找出并改进体系结构的工作方式。我始终使用MVP架构,使用常用的工具集Dagger for DI,通常是多模块项目,在Presenter层中注入了一堆Interactors / UseCases,并且在每个Interactor中注入了不同的存储库以执行后端API调用。

现在,我进入了MVVM,我通过ViewModel更改了Presenter层,从ViewModel到UI层的通信是通过LiveData进行的,而不是使用View回调接口,等等。

看起来像这样:

class ProductDetailViewModel @inject constructor(
    private val getProductsUseCase: GetProductsUseCase,
    private val getUserInfoUseCase: GetUserInfoUseCase,
) : ViewModel(), GetProductsUseCase.Callback, GetUserInfoUseCase.Callback {
    // Sealed class used to represent the state of the ViewModel
    sealed class ProductDetailViewState {
        data class UserInfoFetched(
            val userInfo: UserInfo
        ) : ProductDetailViewState(),
        data class ProductListFetched(
            val products: List<Product>
        ) : ProductDetailViewState(),
        object ErrorFetchingInfo : ProductDetailViewState()
        object LoadingInfo : ProductDetailViewState()
    }
    ...
    // Live data to communicate back with the UI layer
    val state = MutableLiveData<ProductDetailViewState>()
    ...
    // region Implementation of the UseCases callbacks
    override fun onSuccessfullyFetchedProducts(products: List<Product>) {
        state.value = ProductDetailViewState.ProductListFetched(products)
    }

    override fun onErrorFetchingProducts(e: Exception) {
        state.value = ProductDetailViewState.ErrorFetchingInfo
    }

    override fun onSuccessfullyFetchedUserInfo(userInfo: UserInfo) {
        state.value = ProductDetailViewState.UserInfoFetched(userInfo)
    }

    override fun onErrorFetchingUserInfo(e: Exception) {
        state.value = ProductDetailViewState.ErrorFetchingInfo
    }

    // Functions to call the UseCases from the UI layer
    fun fetchUserProductInfo() {
        state.value = ProductDetailViewState.LoadingInfo
        getProductsUseCase.execute(this)
        getUserInfoUseCase.execute(this)
    }
}

这里没有火箭科学,有时我更改实现以使用多个LiveData属性来跟踪更改。顺便说一下,这只是我即时编写的一个示例,所以不要指望它可以编译。就是这样,ViewModel注入了很多UseCases,它实现了UseCases回调接口,当我从UseCases中获得结果时,我便通过LiveData将其传达给UI层。

我的用例通常是这样的:

// UseCase interface
interface GetProductsUseCase {
    interface Callback {
        fun onSuccessfullyFetchedProducts(products: List<Product>)
        fun onErrorFetchingProducts(e: Exception)
    }
    fun execute(callback: Callback) 
}

// Actual implementation
class GetProductsUseCaseImpl(
    private val productRepository: ApiProductRepostory
) : GetProductsUseCase {
    override fun execute(callback: Callback) {
        productRepository.fetchProducts() // Fetches the products from the backend through Retrofit
            .subscribe(
                {
                    // onNext()
                    callback.onSuccessfullyFetchedProducts(it)
                },
                {
                    // onError()
                    callback.onErrorFetchingProducts(it)
                }
            )
    }
}

我的存储库类通常是Retrofit实例的包装器,它们负责设置适当的Scheduler,以便所有内容都在适当的线程上运行并将后端响应映射到模型类中。后端响应是指用Gson映射的类(例如  ApiProductResponse列表),然后将它们映射到模型类中(例如,我在整个App中使用的产品列表)

问题

我的问题是,自从我开始使用MVVM体系结构的所有文章和所有示例以来,人们要么将存储库直接注入到ViewModel中(复制代码以处理错误并映射响应),要么使用Single真相来源模式(使用Room's Flowables从Room获取信息)。但是我还没有看到有人将UseCases与ViewModel图层一起使用。我的意思是,这非常方便,我将事情分开,在UseCases中进行了后端响应的映射,我在那里处理任何错误。但是,仍然感到奇怪的是,我没有看到任何人这样做,是否有某种方法可以改善UseCases,使它们在API方面对ViewModels更友好?除了回调接口以外,还可以执行UseCases和ViewModel之间的通信吗?

如果您需要更多有关此信息,请告诉我。对不起这些示例,我知道这些并不是最好的示例,我只是想出一些简单的方法来更好地解释它。

谢谢

编辑#1

这是我的存储库类的样子:

// ApiProductRepository interface
interface ApiProductRepository {
    fun fetchProducts(): Single<NetworkResponse<List<ApiProductResponse>>>
}

// Actual implementation
class ApiProductRepositoryImpl(
    private val retrofitApi: ApiProducts, // This is a Retrofit API interface
    private val uiScheduler: Scheduler, // AndroidSchedulers.mainThread()
    private val backgroundScheduler: Scheduler, // Schedulers.io()
) : GetProductsUseCase {
    override fun fetchProducts(): Single<NetworkResponse<List<ApiProductResponse>>> {
        return retrofitApi.fetchProducts() // Does the API call using the Retrofit interface. I've the RxAdapter set.
            .wrapOnNetworkResponse() // Extended function that converts the Retrofit's Response object into a NetworkResponse class
            .observeOn(uiScheduler)
            .subscribeOn(backgroundScheduler)
    }
}

// The network response class is a class that just carries the Retrofit's Response class status code

3 个答案:

答案 0 :(得分:1)

更新您的用例,使其返回 Single<List<Product>>

class GetProducts @Inject constructor(private val repository: ApiProductRepository) {
    operator fun invoke(): Single<List<Product>> {
        return repository.fetchProducts()
    }
}

然后,更新您的 ViewModel 以使其订阅产品流:

class ProductDetailViewModel @Inject constructor(
    private val getProducts: GetProducts
): ViewModel() {

    val state: LiveData<ProductDetailViewState> get() = _state
    private val _state = MutableLiveData<ProductDetailViewState>()

    private val compositeDisposable = CompositeDisposable()

    init {
        subscribeToProducts()
    }

    override fun onCleared() {
        super.onCleared()
        compositeDisposable.clear()
    }

    private fun subscribeToProducts() {
        getProducts()
            .subscribeOn(Schedulers.io())
            .observeOn(AndroidSchedulers.main())
            .subscribe(
                {
                    // onNext()
                    _state.value = ProductListFetched(products = it)
                },
                {
                    // onError()
                    _state.value = ErrorFetchingInfo
                }
            ).addTo(compositeDisposable)
    }

}

sealed class ProductDetailViewState {
    data class ProductListFetched(
        val products: List<Product>
    ): ProductDetailViewState()
    object ErrorFetchingInfo : ProductDetailViewState()
}

我遗漏的一件事是 List<ApiProductResponse>>List<Product> 的改编,但这可以通过使用辅助函数映射列表来处理。

答案 1 :(得分:0)

我刚刚开始为我的最后两个项目使用MVVM。我可以与您分享我在ViewModel中使用 REST API 的过程。希望它能对您和其他人有所帮助。

  • 使用其回调创建 Generic Retrofit Executer 类。它将使用改造对象并为您提供数据。
  • 为您的特定程序包或模块创建一个存储库,您可以在其中处理所有API请求。就我而言,我是从API通过其ID吸引一个用户的。 这是用户存储库。

class UserRepository {


    @Inject
    lateinit var mRetrofit: Retrofit

    init {
        MainApplication.appComponent!!.inject(this)
    }

    private val userApi = mRetrofit.create(UserApi::class.java)

    fun getUserbyId(id: Int): Single<NetworkResponse<User>> {
        return Single.create<NetworkResponse<User>>{
            emitter ->
            val callbyId = userApi.getUserbyId(id)
            GenericReqExecutor(callbyId).executeCallRequest(object : ExecutionListener<User>{
                override fun onSuccess(response: User) {
                    emitter.onSuccess(NetworkResponse(success = true,
                            response = response
                            ))
                }

                override fun onApiError(error: NetworkError) {
                    emitter.onSuccess(NetworkResponse(success = false,
                            response = User(),
                            networkError = error
                            ))
                }

                override fun onFailure(error: Throwable) {
                    emitter.onError(error)
                }

            })
        }
    }

}

  • 然后在ViewModel中使用此存储库。就我而言,这是我的 LoginViewModel代码

 class LoginViewModel : ViewModel()  {

     var userRepo = UserRepository()

     fun getUserById(id :Int){
         var diposable = userRepo.getUserbyId(id).subscribe({

             //OnNext

         },{
             //onError
         })
     }
}

我希望这种方法可以帮助您减少一些样板代码。 谢谢

答案 2 :(得分:0)

前一段时间,我开始使用MVVM时遇到了同样的问题。我基于Kotlin暂停函数和协同程序提出了以下解决方案:

  1. 将ApiProductRepositoryImpl.fetchProducts()更改为同步运行。为此,请更改改造接口以返回Call <...>,然后将存储库实现更改为
// error handling omitted for brevity
override fun fetchProducts() = retrofitApi.fetchProducts().execute().body()
  1. 使您的用例实现以下接口:
interface UseCase<InputType, OutputType> {
    suspend fun execute(input: InputType): OutputType
}

所以您的GetProductsUseCase看起来像这样:

class GetProductsUseCase: UseCase<Unit, List<Product>> {
    suspend fun execute(input: Unit): List<Product> = withContext(Dispatchers.IO){
        // withContext causes this block to run on a background thread 
        return@withContext productRepository.fetchProducts() 
}
  1. 在您的ViewModel中执行用例
launch {
   state.value = ProductDetailViewState.ProductListFetched(getProductsUseCase.execute())
}

有关更多信息和示例,请参见https://github.com/snellen/umvvm