现成的MVI框架——mavericks

前语

Android架构演化：MVC、MVP、MVVM、MVI。

新技术层出不穷，架构一天一个样。像我这种懒散又不自律的人，能学习上最新的技术，就现已佩服我自己了。

所以造轮子是不或许造轮子的，这辈子都不或许造轮子！

于是乎我就在github上审阅各种轮子，默默的star，以备不时之需。这便是我和mavericks的缘分。

废话已毕，下面咱们开启正文。

文章提纲

• mavericks是什么？
• mavericks怎样用？
• mavericks合作其他库运用

mavericks是什么？

mavericks是Airbnb技术团队开源的符合MVI架构的技术计划。Github地址

据我了解Airbnb这家公司仍是很牛叉的，所以这种公司开源的东西仍是值得信赖。并且mavericks官方文档中也说了，他们公司许多产品都在用这套计划，所以这并不是KPI项目，可靠性仍是有保证的。

至于什么是MVI ，我信任各位大佬应该都看了许多文章了，这儿不再赘述。

mavericks怎样用？

现在咱们来说正事，关于MVI 架构该怎样落地，网上许多大佬都给出了自己的解决计划。

在我看来，不论是什么架构，无非是为了寻求两个目标：①易用；②易保护。易用就包含分层明晰，少写模板代码等等；易保护就包含迭代影响最小，多人协同不易出错，扩展性强等等。

mavericks能满意这些条件吗？咱们且往下看。

配置

第一步：

implementation 'com.airbnb.android:mavericks:2.7.0'

第二步：

在Application中初始化。

Mavericks.initialize(this)

简略的计数器

学习语言，咱们先输出Hello World，学习架构咱们就先写个计数器，这好像成了某种约好俗称。傻笑～～

//驱动UI的数据
data class CounterState(val count: Int = 0) : MavericksState
//等效官方的ViewModel
class CounterViewModel(initialState: CounterState) : MavericksViewModel<CounterState>(initialState) {
    fun incrementCount() = setState { copy(count = count + 1) }
}
//UI层
class CounterFragment : Fragment(R.layout.counter_fragment), MavericksView {
    private val viewModel: CounterViewModel by fragmentViewModel()
    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        counterText.setOnClickListener {
            viewModel.incrementCount()
        }
    }
    override fun invalidate() = withState(viewModel) { state ->
        counterText.text = "Count: ${state.count}"
    }
}

<?xml version="1.0" encoding="utf-8"?>
<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent">
    <TextView
        android:id="@+id/counterText"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:gravity="center"
        android:textSize="48dp" />
</FrameLayout>

代码很简略，其间呈现了三个要害词：MavericksState、MavericksViewModel、MavericksView。

MavericksState有必要遵从以下准则：

• 有必要是data class。由于data class默认实现了equals、hashCode等函数，便利结构核算两次更新是否是同一数据，假如两次State是彻底一样的，也没有必要告诉UI改写一次；
• 属性有必要是val，且有必要有初始值。一个瞬时就只要一份不可变的数据。不会呈现不可预期的状况，不会有彻底危险。Flutter、Compose等都有这样的设计理念。
• 字段类型有必要是不可变。如ArrayList等导致可改变的都不行。
• 有必要实现MavericksState接口。MavericksState只是一个标识接口。

MavericksViewModel和官方ViewModel功能是一样的。只需求额外传入一个初始化的state，这个后边会讲。

MavericksView是用来符号UI层的。现在我的运用经验，MavericksView是不支撑符号Activity的，只支撑符号Fragment。并且不论是Google 官方，仍是mavericks的技术人员都引荐咱们尽量不把Activity作为UI层。假如非要mavericks支撑activity，只能自己实现扩展。这是官方技术人员的原话：

activityViewModel() is designed to get an activity scoped view model from a Fragment. You want just by viewModel() github.com/airbnb/mave… However, I recommend using Fragments. Putting UI directly inside of an Activity is no longer recommended in general for Android.

说回MavericksView，其间有个invalidate()办法咱们有必要实现。每次数据更新，该办法都会被回调。能够在该办法中把数据和UI进行绑定。

虽然我上面啰里吧嗦说了许多，可是代码就那么一点。不知道各位大佬觉得和Flutter的计数器比，哪个更简略呢？

真正运用

学习一个新结构咱们不或许只拿来写个计数器。比方异步数据，反常处理等等。所以咱们接着往下看：

• 初始化ViewModel
• setState { copy(yourProp = newValue) }
• withState()
• onEach() 和 onAsync() 部分更新
• Async<T> 和 execute(...) 处理异步事务
• 派生字段
• 参数传递

初始化ViewModel

虽然咱们前面说了MavericksViewModel和ViewModel等效，但他们并没有直接关系。那咱们在初始化的时分就不能再运用官方的办法。而是经过 activityViewModel()、fragmentViewModel()、parentFragmentViewModel()、existingViewModel()和 navGraphViewModel(navGraphId: Int) 等代理获取 MavericksViewModel 。

从姓名上咱们能够看到不同作用域的办法都有，现已能满意绝大多数需求。假如不能满意的，也能够自行扩展。

setState()

setState完好长这样，能够看到android studio自动给咱们提示的this:CounterState。

这儿的this便是终究一次更新的State。所以咱们copy旧的State然后把count字段+1变成一个新的State。而setState的作用便是把新的State发送出去，终究回调MavericksView层中的invalidate()办法。是不是很简略理解？

withState()

咱们能够看到invalidate()办法中是没有参数的，那咱们该怎样拿到ViewModel那边发送过来的State的呢？这个时分就需求用到withState了。该办法是自动获取当时最新的State。

在MVC一把梭的架构中，咱们恳求个网络数据，回来的目标咱们通常赋值给一个成员变量，以供在其他地方运用；在MVP架构中，通常会在P层供给get办法自动获取，或许经过接口被迫接纳。

而在mavericks中，withState就能够搞定数据获取问题。所以在invalidate()被回调后，咱们自动获取到最新的State。就像下面这样it:CounterState。

注意：在MavericksView层运用withState能够同步获取到最新的State，可是在ViewModel里边运用withState并不一定获取到最新的State。

咱们看个比方

fun setAndRetrieveState() {
  println('A')
  setState {
    println('B')
    copy(count = 1)
  }
  println('C')
  withState { state ->
    println('D')
  }
  println('E')
}
//打印成果：ACEBD

这是由于setState并不是在主线程上立即更新。而是把更新的State存放到队列里边，顺次发送的。并且这个操作是在其他线程完成的，所以咱们才能看到上面的打印顺序。

在UI层运用withState，咱们彻底不需求忧虑是否是主线程的问题，结构会自动帮咱们处理。

onEach()和onAsync()

从上面咱们不难看出State其实描绘的便是UI的状况。那么越是杂乱的UI或许越是杂乱的事务，这个State中的字段肯定就越多。而这其间的任何一个字段值的改变都会触发invalidate()的回调。假如咱们把一切数据绑定，控件更新的代码都写在invalidate()中，其间任何一个字段发生改变，都会触发和本字段无关的控件改写，这肯定不是咱们想要的成果。所以onEach()和onAsync()就有用武之地了。

onEach()能够独自监听State中的某一个属性或许某几个属性。这样只要被监听的几个字段有值的改变，回调才会履行。

在Fragment中，一般在onCreate()中监听，在ViewModel中，一般在init{}中监听。

onAsync()也是独自监听的，从姓名咱们能够看出是监听异步逻辑的，下面咱们再细说。

Async和execute()

sealed class Async<out T>(private val value: T?) {
    open operator fun invoke(): T? = value
    object Uninitialized : Async<Nothing>(value = null)
    data class Loading<out T>(private val value: T? = null) : Async<T>(value = value)
    data class Success<out T>(private val value: T) : Async<T>(value = value) {
        override operator fun invoke(): T = value
    }
    data class Fail<out T>(val error: Throwable, private val value: T? = null) : Async<T>(value = value)
}

上面便是Async的源码了，没啥稀奇的，便是个密封类，我信任在座的各位大佬在运用kotlin之后就现已用的滚瓜纯熟了。

State中netData是Async类型的，默认Uninitialized。而网络恳求我直接用retrofit恳求了百度首页的内容。

而execute{}是结构封装的一个扩展函数，从this:CounterState能够看出，这和setState{}是一样的参数，所以这儿能够直接copy，一起自动把最新State发送出去。

咱们还能够看到判断了oldState是否是Loading，这有用避免过度恳求，和无效恳求。

异步数据怎么监听呢？咱们既能够在invalidate()一致处理（不引荐，由于需求判断状况，是Loading，仍是Success，仍是Fail），也能够经过onAsync{}来独自监听，如下

其间的onFail和onSuccess显而易见是干嘛的，不多说。现在咱们再来学习一个高能技术点。

高能技术点1

咱们能够看到异步处理，比方网络恳求，不论是成功仍是失败，都是经过Async这个字段来更新状况的。那就存在一个问题，比方一个能够改写，能够加载更多的列表。第一次恳求数据正常，回调到onSuccess正常显现，但我改写一次，这次或许就失败了，然后onFail回调把之前的onSuccess覆盖了。可是这在UI上的作用便是，我第二次一改写，整个页面的数据都没有了，只要一个错误在那里。这种体会肯定欠好，老板也不会让咱们这么干。

正常的逻辑应该是：不论后边是改写仍是加载更多，假如出错了，第一次的正常数据都应该保存。

而mavericks针对这种状况也给了很好的计划，如下：

只需求在execute()中把retainValue赋值为State中的异步字段，结构就会自动处理上面这种状况。上次正常数据任然保存，一起本次的反常信息也照旧分发。

高能技术点2

在onEach()和onAsync()中还有一个参数deliveryMode，如下：

这个参数结构供给了两个实现，RedeliverOnStart和UniqueOnly。默以为RedeliverOnStart。

从结构的注释看，RedeliverOnStart不论是锁定状况（处于生命周期onStop）的时分State的值有没有改变，再次监听（订阅）的时分，都会发送一次最新的值。

我举个比方阐明这个状况，比方主页面有个更新弹窗，State中有个字段showUpdateDialog字段来操控这个更新弹窗是否显现，为true就显现，为false就不显现。那么咱们进入主页面假如有更新，showUpdateDialog就会被setState{copy(showUpdateDialog=true)}，这个时分弹窗就显现出来了。假如咱们不更新，而是把弹窗手动封闭，然后点击恣意二级页面，然后再回来主页面，这个时分弹窗又会弹出来。这是由于State中的showUpdateDialog字段仍是true。UI和State从头绑定的时分会收到一次告诉，即便在我去往二级页面过程中，State没有改变过。

为了解决这个问题，咱们有两个计划：①在封闭弹窗的时分，手动把State中的showUpdateDialog字段置为false；②将deliveryMode设置为UniqueOnly。

而UniqueOnly的作用是，在锁定状况（处于生命周期onStop）State有改变，从头监听（订阅）后才会发送一次最新的值，不然不发送。

这就能很优点理比方Toast，Snack，Dialog等等只需求进入页面提示一次就能够了，而再次激活页面不需求提示的状况。

高能技术点3

其实这个也不算什么高能，许多资深Jetpack玩家早就纯熟于心了。代码如下：

viewModel.onAsync(CounterState::netData, onFail = {
      Timber.e(it)
}, onSuccess = {
      lifecycleScope.launch {
           repeatOnLifecycle(Lifecycle.State.STARTED){
                binding.tvNetworkContent.text = it.string()
           }
      }
})

毕竟是异步操作，网络数据回来，页面被销毁了，这就挺尴尬的。所以为了安全，该写的代码都给加上。

派生字段

已然State是data class类型的。那么data class一切的特性都能够运用。而这儿说道的派生字段更是在杂乱事务中，官方引荐运用的。

比方这儿的isError字段便是一个派生字段。派生字段有必要是val，其相关的字段只能是构造函数中的val字段，不然会报错。

在杂乱事务中，一些UI的状况或许不单单是某个字段解决议的，更多时分是几个字段联合决议的。而联合的这几个字段乃至是不同接口回来的数据。假如咱们需求监听多个接口的回来成果，处理起来是比较杂乱的，所以派生字段的优点便是，UI层只需求关心派生字段的更新，而不需求关心这个字段详细是怎么核算得来的。

参数传递

已然要遵从MVI中的数据源唯一的要求。那我咱们从上个页面带过来的id，比方商品详情页的会从上个页面带过来商品id，视频详情页会从上个页面带过来视频id等等。

那么这个id，咱们总不能等ViewModel初始化好了之后，手动传递过去吧？这看起来不太聪明的样子。并且这个id假如只是保存在UI这一层，咱们还得考虑onSaveInstanceState中保存，重建的时分康复等等操作。ViewModel本来就有保存状况的特性，咱们何不把id放到ViewModel中去，这样事务也愈加内聚。那针对mavericks，咱们该怎么操作呢？

首先从其他页面传递过来的参数咱们该怎么搞？

//需求传递的参数有必要是Parcelable或许Serializable
//所以满意条件的其他封装类型，比方String,ArrayList等等都是能够的，没必要非得封装成下面这个样子
@Parcelize
data class ProjectArgs(val id: Int) : Parcelable
//传递参数 mavericks供给了asMavericksArgs()这个扩展函数
//这和官方供给的一些扩展函数没啥不同，自己封装都能够
 fun instance(): ProjectFragment {
     val fragment = ProjectFragment()
     fragment.arguments = ProjectArgs(id = 20).asMavericksArgs()
     return fragment
 }
//获取参数
private val args by args<ProjectArgs>()

上面的注释现已写的很清楚了，不再多说。

假如把这个参数高雅的传递到ViewModel那边去呢？

咱们再来看一下这张图，其间还重载了一个构造函数。然后多了一个参数ProjectArgs，然后在this()中直接赋值给了State中的id，并且id最开始是没有初始值的。

就这样简略的一句代码，咱们就把Fragment中的id传递到了State中。而咱们在ViewModel中需求运用，直接withState就能获取到。是不是很便利？

这张图中还有个特别的注解@PersistState。那咱们就来学学他是干什么用的。

高能技术点4

咱们都知道在Activity或许Fragment中，一些要害数据，能够经过onSaveInstanceState()存储。

而mavericks除了上面的老办法，还供给了一个@PersistState给咱们来愈加高雅的做这件事。但凡被注解的字段，在低内存的时分，都会起到onSaveInstanceState()平等的作用，把该字段存储到本地磁盘。等康复的时分，再取出本地的数据从头赋值。

同样，onSaveInstanceState()能存储哪些类型，咱们这儿就支撑存储哪些类型。

mavericks合作其他库运用

和Jetpack Navigation一起运用

需求引入额外的库

implementation 'com.airbnb.android:mavericks-navigation:2.7.0'

初始化的时分有点小差异，如下：

Mavericks.initialize(this, viewModelDelegateFactory = DefaultNavigationViewModelDelegateFactory())

和Hilt一起运用

data class ExampleState(
    val data: String = "",
) : MavericksState
class ExampleViewModel @AssistedInject constructor(
    @Assisted initialState: ExampleState,
    private val exampleRepository: ExampleRepository,
) : MavericksViewModel<ExampleState>(initialState) {
    @AssistedFactory
    interface Factory : AssistedViewModelFactory<ExampleViewModel, ExampleState> {
        override fun create(state: ExampleState): ExampleViewModel
    }
    companion object : MavericksViewModelFactory<ExampleViewModel, ExampleState> by hiltMavericksViewModelFactory()
}
@Module
@InstallIn(MavericksViewModelComponent::class)
interface ExampleViewModelModule {
    @Binds
    @IntoMap
    @ViewModelKey(ExampleViewModel::class)
    fun exampleViewModelFactory(factory: ExampleViewModel.Factory): AssistedViewModelFactory<*, *>
}

需求注意:

• 注解@AssistedInject和Hilt不同
• initialState前面也有注解
• 下方的一串模板代码，能够在android studio中定制模板，打几个字母就搞定了
• ViewModule绑定到Components上去，注意是MavericksViewModelComponent::class，固定写法。

和Koin一起运用

我就觉得Hilt挺繁琐的，所以我运用Koin。

data class ExampleState(
    val data: String = "",
) : MavericksState
class ExampleViewModel (
    initialState: ExampleState,
    private val exampleRepository: ExampleRepository,
) : MavericksViewModel<ExampleState>(initialState) {
    companion object : MavericksViewModelFactory<ProjectViewModel, CounterState> {
        override fun create(
            viewModelContext: ViewModelContext,
            state: CounterState
        ): ProjectViewModel {
            val api: AppApi by viewModelContext.activity.inject()
            return ProjectViewModel(state, api)
        }
    }
}

下方仍是一个模板代码，可是只要写这一处就搞定了。

后话

mavericks我只用来写过一个较小型的商业项目，许多杂乱事务还没有遇到过。假如小伙伴在运用过程中有问题，或许有好的想法，能够留言，咱们一起交流交流！

别的该团队开源的别的一个神器Epoxy，也是用了就扔不掉，大家想看我的运用经验的话能够给我留言。