为什么 Android 需要视图模型工厂？

Question

我们一直在讨论这个问题，但我们不知道创建视图模型工厂以创建视图模型而不是直接实例化视图模型的原因。创建一个只创建视图模型的工厂有什么好处？

我只是举了一个简单的例子来说明我在没有工厂的情况下是如何做到的

这里是kodein模块：

val heroesRepositoryModel = Kodein {
    bind<HeroesRepository>() with singleton {
        HeroesRepository()
    }

    bind<ApiDataSource>() with singleton {
        DataModule.create()
    }

    bind<MainViewModel>() with provider {
        MainViewModel()
    }
}

我在不使用工厂的情况下实例化视图模型的 Activity 部分

class MainActivity : AppCompatActivity() {
    private lateinit var heroesAdapter: HeroAdapter
    private lateinit var viewModel: MainViewModel
    private val heroesList = mutableListOf<Heroes.MapHero>()
    private var page = 0
    private var progressBarUpdated = false

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        viewModel = ViewModelProviders.of(this)
                .get(MainViewModel::class.java)
        initAdapter()
        initObserver()
        findHeroes()
    }

我直接实例化用例而不在构造函数中的 ViewModel

class MainViewModel : ViewModel(), CoroutineScope {

    private val heroesRepository: HeroesRepository = heroesRepositoryModel.instance()
    val data = MutableLiveData<List<Heroes.MapHero>>()

    private var job: Job = Job()
    override val coroutineContext: CoroutineContext
        get() = uiContext + job

    fun getHeroesFromRepository(page: Int) {
        launch {
            try {
                val response = heroesRepository.getHeroes(page).await()
                data.value = response.data.results.map { it.convertToMapHero() }
            } catch (e: HttpException) {
                data.value = null
            } catch (e: Throwable) {
                data.value = null
            }
        }
    }

    override fun onCleared() {
        super.onCleared()
        job.cancel()
    }
}

所以这里是一个使用工厂的例子

class ListFragment : Fragment(), KodeinAware, ContactsAdapter.OnContactListener {

    override val kodein by closestKodein()

    private lateinit var adapterContacts: ContactsAdapter

    private val mainViewModelFactory: MainViewModelFactory by instance()
    private val mainViewModel: MainViewModel by lazy {
        activity?.run {
            ViewModelProviders.of(this, mainViewModelFactory)
                .get(MainViewModel::class.java)
        } ?: throw Exception("Invalid Activity")
    }

    override fun onCreateView(
            inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
        return inflater.inflate(R.layout.fragment_list, container, false)
    }

视图模型工厂：

class MainViewModelFactory (private val getContacts: GetContacts) : ViewModelProvider.Factory {

    override fun <T : ViewModel?> create(modelClass: Class<T>): T {
        if (modelClass.isAssignableFrom(MainViewModel::class.java)) {
            return MainViewModel(getContacts) as T
        }
        throw IllegalArgumentException("Unknown ViewModel class")
    }
}

还有视图模型：

class MainViewModel(private val getContacts: GetContacts) : BaseViewModel() {
    lateinit var gamesList: LiveData<PagedList<Contact>>
    var contactsSelectedData: MutableLiveData<List<Contact>> = MutableLiveData()
    var contactsSelected: ArrayList<Contact> = ArrayList()
    private val pagedListConfig by lazy {
        PagedList.Config.Builder()
                .setEnablePlaceholders(false)
                .setInitialLoadSizeHint(PAGES_CONTACTS_SIZE)
                .setPageSize(PAGES_CONTACTS_SIZE)
                .setPrefetchDistance(PAGES_CONTACTS_SIZE*2)
                .build()
    }

这是完整的第一个示例：

https://github.com/ibanarriolaIT/Marvel/tree/mvvm

还有完整的第二个例子：

https://github.com/AdrianMeizoso/Payment-App

Answer 1

当我们只是使用 ViewModel 时，我们无法将参数传递给该 ViewModel

class GameViewModel() : ViewModel() {

    init {
        Log.d(TAG, "GameViewModel created")
    }
}

但是，在某些情况下，我们需要将自己的参数传递给 ViewModel。这可以使用 ViewModelFactory 来完成。

class ScoreViewModel(finalScore: Int) : ViewModel() {

    val score = finalScore

    init {
        Log.d(TAG, "Final score: $finalScore")
    }
}

要实例化这个 ViewModel，我们需要一个 ViewModelProvider.Factory，因为简单的 ViewModel 无法实例化它。

class ScoreViewModelFactory(private val finalScore: Int) : ViewModelProvider.Factory {

    override fun <T : ViewModel?> create(modelClass: Class<T>): T {
        if (modelClass.isAssignableFrom(ScoreViewModel::class.java)) {
            return ScoreViewModel(finalScore) as T
        }
        throw IllegalArgumentException("Unknown ViewModel class")
    }
}

在实例化此 ViewModel 的对象时，即使用 ViewModelProvider，我们将 ViewModelFactory 作为参数传递，其中包含有关我们想要传递的自定义参数的信息。它是这样的：

viewModelFactory = ScoreViewModelFactory(score)
viewModel = ViewModelProvider(this,viewModelFactory).get(ScoreViewModel::class.java)

这就是工厂方法存在的原因。

Answer 2

总之，

如果我们需要传递一些input data 到viewModel 的constructor，我们需要为viewModel 创建一个factory class。

例如：-

class MyViewModelFactory constructor(private val repository: DataRepository): ViewModelProvider.Factory {

     override fun <T : ViewModel> create(modelClass: Class<T>): T {
        return if (modelClass.isAssignableFrom(MyViewModel::class.java!!)) {
            MyViewModel(this.repository) as T
        } else {
            throw IllegalArgumentException("ViewModel Not Found")
        }
    }
}

原因

我们不能直接创建ViewModel 的对象，因为它不会知道lifecyclerOwner。所以我们使用：-

ViewModelProviders.of(this, MyViewModelFactory(repository)).get(MyViewModel::class.java)

Answer 3

我们一直在讨论这个问题，但我们不知道创建视图模型工厂以创建视图模型而不是直接实例化视图模型的原因。创建一个只创建视图模型的工厂有什么好处？

因为 Android 只会在尚未为特定给定 ViewModelStoreOwner 创建的情况下为您提供一个新实例。

我们也不要忘记 ViewModel 会在配置更改时保持活动状态，因此如果您旋转手机，则不应创建新的 ViewModel。

如果您要返回之前的 Activity 并重新打开此 Activity，那么之前的 ViewModel 应该会收到 onCleared()，而新的 Activity 应该有一个新的 ViewModel。

除非您自己这样做，否则您应该只信任 ViewModelProviders.Factory 来完成它的工作。

(而且你需要工厂，因为你通常不只是有一个 no-arg 构造函数，你的 ViewModel 有构造函数参数，并且 ViewModelProvider 必须知道如何在你使用非构造函数时填写构造函数参数-默认构造函数）。

Answer 4

我们不能自己创建 ViewModel。我们需要 Android 提供的 ViewModelProviders 实用程序来创建 ViewModel。

但是 ViewModelProviders 只能实例化没有 arg 构造函数的 ViewModels。

因此，如果我有一个带有多个参数的 ViewModel，那么我需要使用一个可以传递给 ViewModelProviders 以在需要 MyViewModel 实例时使用的工厂。

例如——

public class MyViewModel extends ViewModel {
    private final MyRepo myrepo;
    public MyViewModel(MyRepo myrepo) {
         this.myrepo = myrepo;
    }
}

要实例化这个 ViewModel，我需要有一个 ViewModelProviders 可以用来创建它的实例的工厂。

ViewModelProviders Utility 无法使用参数构造函数创建 ViewModel 的实例，因为它不知道如何以及在构造函数中传递什么对象。