I have a fragment A which sends a search query to the network, and if the result is positive uses Android navigation component to navigate to fragment B, and its done using observers.
After navigation to fragment B, i click on "<-" arrow on the top of the screen, but instead of navigating back to fragment A it reloads fragment B again. And if using the native "back" button on the device, the app crashes with "illegalArgumentException navigation destination unknown" error.
I check the internet for clues on this issue, but all i learned is that this happens because i am using .observe in onViewCreated() and when i go back, it gets called again, and because livedata has something in it already, it just navigates me back to B.
I have tried observing in onActivityCreated(), and using getViewLifeCycleOwner, but no success... the only thing that helped is checking if livedata has observers and returning if true, before using .observe, but it seems incorrect.
This is the viewModel:
private val getAssetResult = MutableLiveData<GeneralResponse<Asset>>()
private val updateAssetResult = MutableLiveData<GeneralResponse<Int>>()
private val deleteAssetResult = MutableLiveData<GeneralResponse<Int>>()
init {
state.value = ViewState(false)
Log.d(TAG, "State in init: $state")
}
fun getAssetResult(): LiveData<GeneralResponse<Asset>>{
return getAssetResult
}
fun findAsset(req: GetAssetRequest) {
scope.launch {
setProgressIndicator(true)
val result = repository.getAsset(req)
getAssetResult.postValue(result)
setProgressIndicator(false)
}
}
This is the fragment:
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
super.onViewCreated(view, savedInstanceState)
viewModel = ViewModelProvider(this).get(EditAssetViewModel::class.java)
setupViewModel()
initFields()
}
private fun setupViewModel() {
if (viewModel.getAssetResult().hasObservers()) // <- This is the part that prevents the app from crashing.
return
viewModel.getAssetResult().observe(this, Observer {
if (it == null) return#Observer
handleSearchResult(it)
})
if (viewModel.getState().hasObservers())
return
viewModel.getState().observe(this, Observer { handleState(it) })
}
private fun handleSearchResult(response: GeneralResponse<Asset>) {
if (response.singleValue == null) {
Toast.makeText(context!!, response.errorMessage, Toast.LENGTH_SHORT).show()
return
}
targetFragment?.let { it ->
val bundle = bundleOf("asset" to response.singleValue)
when(it) {
"UpdateLocation" ->
Navigation.findNavController(view!!).navigate(R.id.updateLocation, bundle)
"EditAsset" -> {
Navigation.findNavController(view!!).navigate(R.id.editAsset, bundle)
}
}
}
}
if i remove this part from the setupViewModel function:
if (viewModel.getAssetResult().hasObservers())
return
the app will either crash when clicked "back" using the device button or go back to fragment A, just to be navigated back to fragment B because of the .observe function.
Override the method onBackPressed() to handle the "<-" arrow
Seems like the LiveData that you use to signal to fragment A that it should navigate to fragment B is actually an event. An event happens only once and once it is consumed (navigation event is done), it is gone. Therefore, after navigating you need to send a message to the viewmodel that the navigation took place and that the corresponding data holder should be (e.g.) null again. In Fragment A you check that the new value is unequal to null, and only if this is the case, you issue the navigation event. This would prevent fragment A to immediatelly switch to B again in the back scenario.
If you want to learn more about ways to use live data for events, please refer to this article.
I am working with Android architecture components.
What i want is when user type "0" in Edittext and click on Button to replace Fragment with new one , and if type anything else post Toast error message. In Problem is when i back from new Fragment(BlankFragment) and click on button again and type "0" again and click, onchange() is called multiple times so Fragment is get created multiple times
FragmentExample.class:
#Override
public View onCreateView(LayoutInflater inflater, ViewGroup container,
Bundle savedInstanceState) {
manager = getActivity().getSupportFragmentManager();
viewmModel = ViewModelProviders.of(getActivity(), viewModelFactory)
.get(VModel.class);
View v = inflater.inflate(R.layout.fragment_list, container, false);
b = (Button) v.findViewById(R.id.b);
et = (EditText) v.findViewById(R.id.et);
viewmModel.observeData().observe(getActivity(), new Observer<String>() {
#Override
public void onChanged(#Nullable String s) {
if(s.equals("0")) {
BlankFragment fragment = (BlankFragment) manager.findFragmentByTag(DETAIL_FRAG);
if (fragment == null) {
fragment = BlankFragment.newInstance();
}
addFragmentToActivity(manager,
fragment,
R.id.root_activity_detail,
DETAIL_FRAG
);
} else {
Toast.makeText(getContext(), "Wrong text", Toast.LENGTH_SHORT).show();
}
}
});
b.setOnClickListener(new View.OnClickListener() {
#Override
public void onClick(View v) {
viewmModel.setData(et.getText().toString());
}
});
return v;
}
private void addFragmentToActivity(FragmentManager fragmentManager, BlankFragment fragment, int root_activity_detail, String detailFrag) {
android.support.v4.app.FragmentTransaction transaction = fragmentManager.beginTransaction();
transaction.replace(root_activity_detail, fragment, detailFrag).addToBackStack(detailFrag);
transaction.commit();
}
Repository class:
public class Repository {
MutableLiveData<String> dataLive = new MutableLiveData<>();
public Repository() {
}
public void setListData(String data) {
dataLive.setValue(data);
}
public MutableLiveData<String> getData() {
return dataLive;
}
}
BlankFragment.class:
#Override
public View onCreateView(LayoutInflater inflater, ViewGroup container,
Bundle savedInstanceState) {
listItemViewModel = ViewModelProviders.of(this, viewModelFactory)
.get(VModel.class);
listItemViewModel.setData("");
return inflater.inflate(R.layout.fragment_blank, container, false);
}
Here is an example how i solve this problem .[TESTED AND WORKING]
viewModel.getLoginResponse().observe(getViewLifecycleOwner(), new Observer<String>() {
#Override
public void onChanged(String response) {
if(getViewLifecycleOwner().getLifecycle().getCurrentState()== Lifecycle.State.RESUMED){
// your code here ...
}
}
});
The problem here is that when you dettach the fragment from the acitivity, both fragment and its viewmodel are not destroyed. When you come back, you add a new observer to the livedata when the old observer is still there in the same fragment （If you add the observer in onCreateView()）.
There is an article (Even a SO thread in fact) talking about it (with solution).
The easy way to fix it (also in the article) is that remove any observer from the livedata before you add observer to it.
Update:
In the support lib v28, a new LifeCycleOwner called ViewLifeCycleOwner should fix that more info in here
here is what you are doing wrong...
viewmModel.observeData().observe(getActivity(), new Observer<String>() {
#Override
public void onChanged(#Nullable String s) {
if(s.equals("0")) {
BlankFragment fragment = (BlankFragment) manager.findFragmentByTag(DETAIL_FRAG);
if (fragment == null) {
fragment = BlankFragment.newInstance();
}
addFragmentToActivity(manager,
fragment,
R.id.root_activity_detail,
DETAIL_FRAG
);
} else {
Toast.makeText(getContext(), "Wrong text", Toast.LENGTH_SHORT).show();
}
}
});
in above code instead of "getActivity()" either you can use "this" or "viewLifecycleOwner".
Because as you are passing the getActivity() in observe method, whenever you open your fragment you are attaching the new instance of the observer with the Activity not with the fragment. So observer will keep alive even if you kill your fragment.
So when livedata postvalue, it will send data to all the observers,
as there are too many observers observing livedata, then all will get notified.
Because of this, your observer gets called too many times.
so you have to observe live data in fragment something like this.
viewmModel.observeData().observe(this, new Observer<String>() {
#Override
public void onChanged(#Nullable String s) {
if(s.equals("0")) {
BlankFragment fragment = (BlankFragment) manager.findFragmentByTag(DETAIL_FRAG);
if (fragment == null) {
fragment = BlankFragment.newInstance();
}
addFragmentToActivity(manager,
fragment,
R.id.root_activity_detail,
DETAIL_FRAG
);
} else {
Toast.makeText(getContext(), "Wrong text", Toast.LENGTH_SHORT).show();
}
}
});
But still your onchanged method will get called two times.
You can stop this by checking one condition inside your onchanged method..
dash_viewModel.getDashLiveData().observe(viewLifecycleOwner, object : Observer<AsyncResponse> {
override fun onChanged(t: AsyncResponse?) {
if(viewLifecycleOwner.lifecycle.currentState==Lifecycle.State.RESUMED){
setData(t)
}
}
})
from my research, I have found out that, if fragment using the ViewModel of its corresponding activity,
So when even you start observing the livedata, it will first send you the most recently emitted item. even if you didn't call it from your fragment.
so onChange method got called two times
When the fragment is on start state - to receive the most recently emitted item
When the fragment is on Resumed state - to receive the call made by fragment either for api.
so on changed I always check the state of the fragment with the help of viewLifecycleOwner like this
if(viewLifecycleOwner.lifecycle.currentState==Lifecycle.State.RESUMED){
// if the fragment in resumed state then only start observing data
}
viewlifecycleowner is provided by both Fragments and Activity as Google implemented this solution directly in support library 28.0.0 and androidx with getViewLifecycleOwner() method. viewlifecycleowner contains info about the lifecycle of the component.
in java you can use getViewLifecycleOwner() intead of viewlifecycleowner .
Instead of using getActivity as LifecycleOwner, you should use fragment.
Change
viewModel.observeData().observe(getActivity(), new Observer<String>() {
to
viewModel.observeData().removeObservers(this);
viewModel.observeData().observe(this, new Observer<String>() {
You shouldn't create your viewmModel in onCreateView but rather in onCreate so you don't add a listener to your data each time view is created.
Solution for similar issue with Flow
If you`re using Flow instead of LiveData then don't forget to use viewLifecycleOwner.lifecycleScope.launch instead of lifecycleScope.launch:
viewLifecycleOwner.lifecycleScope.launch {
flow.flowOn(Default).collect {
requireContext()
}
}
Or with extension:
extension:
fun <T> Flow<T>.launchWhenStarted(lifecycleOwner: LifecycleOwner) {
lifecycleOwner.lifecycleScope.launchWhenStarted {
this#launchWhenStarted.collect()
}
}
in fragment`s onViewCreated:
availableLanguagesFlow
.onEach {
//update view
}.launchWhenStarted(viewLifecycleOwner)
to add an observer to a LiveData, you should initialize your observer in onViewCreated (as you did) and attach the viewLifecycleOwner. So, it should look like this:
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
super.onViewCreated(view, savedInstanceState)
viewModel.yourVariable.observe(viewLifecycleOwner, Observer{ newValue ->
// todo your function
})
See Kotlin Android Training Livedata for more information!
Just declare your Observer as a field variable so you don't create a new observer every time the lifecycle calls that part of your code. ;)
i.e. with kotlin:
YourFragment: Fragment() {
private val dataObserver = Observer<Data> { data ->
manageData(data)
}
...
//now you should subscribe your data after you instantiate your viewModel either in onCreate, onCreateView, onViewCreated, depends on your case..
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
super.onViewCreated(view, savedInstanceState)
viewModel.liveData.observe(this, dataObserver)
}
...
}
To be clear, to instantiate a ViewModel we pass either the context of the Fragment itself, in which this viewmodel will be scoped to, or we pass the activity that holds this fragment as the context.
Is not the same and they have different purposes, if we do this
listItemViewModel = ViewModelProvider(requireActivity(), viewModelFactory)
.get(VModel.class);
We attach this instance of the viewmodel to the parent activity of the fragment, after this fragment dies , the instance of that viewmodel will be kept in memory holding the reference to the parent activity.
If we do this
// requireContext() or this
listItemViewModel = ViewModelProvider(requireContext(), viewModelFactory)
.get(VModel.class);
We scope the instance of the viewmodel in the parent itself, so whenever the fragment dies, this viewmodel instance also gets removed.
Now, the observers are the same, we need to specify that we only want to observer to the lifetime span of the Fragment, for example, we want to observer untill this fragment is destroyed and then detach any observer if we are not in this fragment, for this, here it comes viewLyfeCycleOwner which will observe until this fragment dies or pauses to go to antoher fragment, it's important to use it in each fragment:
viewmModel.observeData().observe(viewLyfeCycleOwner, new Observer<String>() { ... }
if we attach this observer to the activity with
viewmModel.observeData().observe(getActivity(), new Observer<String>() { ... }
It will keep observing until the parent activity holding the fragment dies, and is not a good idea since it will subscribe multiple observers to the same livedata.
viewmModel = ViewModelProviders.of(getActivity(), viewModelFactory)
.get(VModel.class);
As your viewmModel's LifecycleOwner is activity, so the observer will only be automatically removed when the state of lifecycle is Lifecycle.State.DESTROYED.
In your situation, the observer will not be automatically removed.So you have to remove the previous observer manually or pass the same instance of observer every time.
I had the same problem, when I created a fragment and declared an observer into onCreate() or onCreateView(), after a rotation of screen, my livedata runned twice times.
In order to solve this problem, I tried kotlin extension in order to remove observer just before to create an other one, I tried to remove into onDestroyView(), I tried to change the lifecyclcleOwner when the viewmodel declaration (requiredActivity - this - viewLifecycleOwner) but all tests failed.
But finally I found a solution with coroutines. I don't know if it's a good practice but it work :
override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
// ......
// observer
CoroutineScope(Dispatchers.Main).launch {
delay(100)
mMainViewModel.getMailings().observe(viewLifecycleOwner, Observer { showViewModelMailingsList(it) })
}
// call
mMainViewModel.responseMailingList(preferences.userEmailAccount, preferences.deviceToken)
// ....
}
Adding some useful information after #Samuel-Eminet,
it's true that onCreate(Bundle?) is called only once on the Fragment creation and when you press back, the view is recreated but not the fragment (hence why the ViewModel is the same. If you subscribe in any method of the lifecycle that affects the view, it will resubscribe again and again.
Observers would have been gone and you won't be able to tell even if you ask for liveData.hasObservers().
The best thing to do is subscribing when onCreate(Bundle?) but many of us are using the binding, and the view isn't created at this time, so this is the best way to do it:
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
lifecycleScope.launchWhenStarted {
subscribeUI()
}
}
now you're telling the Fragment's lifecycle to do something when it starts the Fragment and it will call it only once.
Observe the livedata only once in a fragment. For that call the observe method in onCreate() rather than onCreateView(). When we press back button the onCreateView() method is called which makes the viewmodel to observe data again.
#Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
mPatientViewModel.getGetCaseDetailLiveData().observe(this, jsonObjectResponse -> parseViewSentResponse(jsonObjectResponse));
}
#Override
public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
// TODO: inflate a fragment view
View rootView = super.onCreateView(inflater, container, savedInstanceState);
return rootView;
}
I want to show dialog when user press back or quit from fragment if there are some data unsaved. I am trying to override onbackpressed but unfortunately I got error lateinit property barcodeList has not been initialized. how to solve it?
here is my script on activity:
override fun onBackPressed() {
val theFragment = supportFragmentManager.fragments
for(i in 0 until theFragment.size)
{
if(theFragment[i].tag == "stocker_fragment")
{
StockerFragment().onBackPressed()
}
}
}
and this is in fragment:
fun onBackPressed() {
var check = false
// this barcodeList variable error.
for(i in 0 until barcodeList.size)
{
if(barcodeList[i].barcode.trim()=="")
{
check = true
break
}
}
if (check)
{
AlertHelper(context).onBackPressedAlert()
}
}
FYI: I have initialized barcodeList on onCreateView and everything is fine. only error in onBackPressed.
And my last question is, how do i know if user quit from fragment without pressing back button?
I think the problem is in your onBackPressed() implementation in the Activity. With the line StockerFragment().onBackPressed() you are creating a new instance of the StockerFragment and calling onBackPressed() on it, rather than calling it on the instance that is actively being used.
You should be able to adjust your Activity onBackPressed() like so:
override fun onBackPressed() {
val theFragment = supportFragmentManager.fragments
for(i in 0 until theFragment.size)
{
if(theFragment[i].tag == "stocker_fragment")
{
(theFragment[i] as StockerFragment).onBackPressed()
}
}
}
You can also make this a bit more kotliny like so:
override fun onBackPressed() {
supportFragmentManager.fragments.forEach { fragment ->
if (fragment is StockerFragment) {
fragment.onBackPressed()
}
}
}
You'll probably also want to figure out a way to decide whether the fragment's onBackPressed has determined that the Activity should stick around or not. Then, if the fragment is happy, you should call super.onBackPressed() in the Activity so that the expected back behavior (leave the Activity) happens.