Welcome to Software Development on Codidact!
Will you help us build our independent community of developers helping developers? We're small and trying to grow. We welcome questions about all aspects of software development, from design to code to QA and more. Got questions? Got answers? Got code you'd like someone to review? Please join us.
Proper way of sending large amount of data from View to ViewModel
The problem
I am working on a simple drawing app for Android. I have a custom view on which the user can draw. This means that a lot of data (a list of points) is generated in this View.
I want to store this data in the ViewModel.
If I need to update a View after something changes in the ViewModel, I can just use LiveData in the ViewModel and put an observer in the View.
However, what I need is the other direction: changes in the View should lead to an update of the data in the ViewModel.
What I've learnt so far
I can use MutableLiveData for this, however, it is unclear to me what the right way is to give the View access to the MutableLiveData.
I can access a ViewModel from an Activity, by calling:
viewModel = new ViewModelProvider(this).get(MyViewModel.class);
But, I cannot access the ViewModel from the View. ViewModelProvider takes a ViewModelStoreOwner as its parameter. An Activity is a ViewModelStoreOwner, but a View is not.
I believe this is intentional, otherwise the View would be a ViewModelStoreOwner itself. I could pass a reference to the Activity or the ViewModel itself to the View, but this feels wrong.
It seems that I need to use MutableLiveData. I could then use setValue or postValue on the MutableLiveData whenever the View has more data to send.
However, that just shifts the problem: how should the View get access to the MutableLiveData?
What I've tried
For now, I have a workaround.
I have created an interface ListOfPoints that is implemented by the Activity. The View has a method setPointsOwner(ListOfPoints) . So, effectively, the View still gets a reference to the Activity, but can only use it to manipulate the data. The implementation of the interface, inside the Activity, then updates the MutableLiveData it gets from the ViewModel.
This works, but still feels wrong.
The question
How can I send a lot of data from a View to a ViewModel?
Is it proper coding style to give the View access to MutableLiveData from the owning Activity?
Or is there a way in which I can make the ViewModel observe the View, without letting it have a direct reference to the View?
1 answer
I agree with you in that using MutableLiveData for achieving this feels wrong. I think this is because:
-
LiveDatais meant for sending data toLifecycleOwners such asActivityorFragment, abstracting the lifecycle away, and your workaround sends data in the opposite direction. - as a result, if your
Viewhappens to send data by throughMutableLiveDatawhile the lifecycle is stopped or paused, any callback you attach on theMutableLiveDataon theViewModelside simply will not run, which is probably not what you would expect. - afaik
Views are notLifecycleOwners in the first place.
What I've seen in most projects when they want to react to a Button click is that the Activity sets a View.OnClickListener as an anonymous class:
class MyActivity: Activity() {
private lateinit var viewModel: MyViewModel
override fun onCreate(...) {
super.onCreate(...)
viewModel = ....
myButton.setOnClickListener {
viewModel.myActionTriggered(...)
}
}
}
So to me, it makes sense to do something along those lines in your case too:
class MyActivity: Activity() {
private lateinit var viewModel: MyViewModel
override fun onCreate(...) {
super.onCreate(...)
viewModel = ....
myCanvas.setListOfPointsListener { points ->
viewModel.onListOfPointsChanged(points)
}
}
}
This way:
- neither the
Activitynor theViewModelneed to implement the ad-hoc interface - the
ViewModeldoesn't need to expose anything "mutable" - the
LiveDataget data out of theViewModelto theActivityas it should, not the other way around - the
ViewModelcan still get the data from theVieweven when the lifecycle is "off", and it still can change its internal state in this case (other than posting to otherLiveData, which would not work until the lifecycle is back "on")
A little off-topic comment: I think the name of ListOfPoints does not reflect what your interface does does. Your Activity doesn't become a "list of points", but rather a list of points listener. It doesn't contain the points itself, it just does something whenever that list changes.
1 comment thread
1 comment thread