Navigazione condizionale

Quando progetti la navigazione per la tua app, potresti voler passare a una destinazione rispetto a un'altra in base alla logica condizionale. Ad esempio, un utente potrebbe seguire un deep link a una destinazione che richiede l'accesso oppure potresti avere destinazioni diverse in un gioco a seconda che il giocatore vinca o perda.

Accesso utente

In questo esempio, un utente tenta di accedere a una schermata del profilo che richiede l'autenticazione. Poiché questa azione richiede l'autenticazione, l'utente deve essere reindirizzato a una schermata di accesso se non ha già eseguito l'autenticazione.

Il grafico di navigazione per questo esempio potrebbe avere il seguente aspetto:

un flusso di accesso viene gestito indipendentemente dal flusso di navigazione principale dell'app.
Figura 1. Un flusso di accesso viene gestito indipendentemente dal flusso di navigazione principale dell'app.

Per l'autenticazione, l'app deve accedere alla login_fragment, dove l'utente può inserire un nome utente e una password per l'autenticazione. Se l'utente accetta, viene reindirizzato alla schermata profile_fragment. In caso contrario, l'utente viene informato che le sue credenziali non sono valide tramite un Snackbar. Se l'utente torna alla schermata del profilo senza eseguire l'accesso, viene indirizzato alla schermata main_fragment.

Ecco il grafico di navigazione per questa app:

<navigation xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:app="http://schemas.android.com/apk/res-auto"
        xmlns:tools="http://schemas.android.com/tools"
        android:id="@+id/nav_graph"
        app:startDestination="@id/main_fragment">
    <fragment
            android:id="@+id/main_fragment"
            android:name="com.google.android.conditionalnav.MainFragment"
            android:label="fragment_main"
            tools:layout="@layout/fragment_main">
        <action
                android:id="@+id/navigate_to_profile_fragment"
                app:destination="@id/profile_fragment"/>
    </fragment>
    <fragment
            android:id="@+id/login_fragment"
            android:name="com.google.android.conditionalnav.LoginFragment"
            android:label="login_fragment"
            tools:layout="@layout/login_fragment"/>
    <fragment
            android:id="@+id/profile_fragment"
            android:name="com.google.android.conditionalnav.ProfileFragment"
            android:label="fragment_profile"
            tools:layout="@layout/fragment_profile"/>
</navigation>

MainFragment contiene un pulsante su cui l'utente può fare clic per visualizzare il proprio profilo. Se l'utente vuole visualizzare la schermata del profilo, deve prima autenticarsi. Questa interazione viene modellata utilizzando due frammenti separati, ma dipende dallo stato utente condiviso. Queste informazioni sullo stato non sono di responsabilità di nessuno dei due frammenti ed è più appropriato conservarle in un UserViewModel condiviso. Questo ViewModel è condiviso tra i frammenti limitandone l'ambito all'attività, che implementa ViewModelStoreOwner. Nell'esempio seguente, requireActivity() viene risolto in MainActivity, perché MainActivity ospita ProfileFragment:

Kotlin

class ProfileFragment : Fragment() {
    private val userViewModel: UserViewModel by activityViewModels()
    ...
}

Java

public class ProfileFragment extends Fragment {
    private UserViewModel userViewModel;
    @Override
    public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
        super.onViewCreated(view, savedInstanceState);
        userViewModel = new ViewModelProvider(requireActivity()).get(UserViewModel.class);
        ...
    }
    ...
}

I dati utente in UserViewModel vengono esposti utilizzando LiveData, quindi per decidere dove navigare, devi osservare questi dati. Quando l'utente accede a ProfileFragment, l'app mostra un messaggio di benvenuto se i dati utente sono presenti. Se i dati utente sono null, vai a LoginFragment, perché l'utente deve autenticarsi prima di visualizzare il proprio profilo. Definisci la logica decisionale in ProfileFragment, come mostrato nell'esempio seguente:

Kotlin

class ProfileFragment : Fragment() {
    private val userViewModel: UserViewModel by activityViewModels()

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
        val navController = findNavController()
        userViewModel.user.observe(viewLifecycleOwner, Observer { user ->
            if (user != null) {
                showWelcomeMessage()
            } else {
                navController.navigate(R.id.login_fragment)
            }
        })
    }

    private fun showWelcomeMessage() {
        ...
    }
}

Java

public class ProfileFragment extends Fragment {
    private UserViewModel userViewModel;

    @Override
    public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
        super.onViewCreated(view, savedInstanceState);
        userViewModel = new ViewModelProvider(requireActivity()).get(UserViewModel.class);
        final NavController navController = Navigation.findNavController(view);
        userViewModel.user.observe(getViewLifecycleOwner(), (Observer<User>) user -> {
            if (user != null) {
                showWelcomeMessage();
            } else {
                navController.navigate(R.id.login_fragment);
            }
        });
    }

    private void showWelcomeMessage() {
        ...
    }
}

Se i dati utente sono null quando raggiungono ProfileFragment, l'utente viene reindirizzato a LoginFragment.

Puoi utilizzare NavController.getPreviousBackStackEntry per recuperare NavBackStackEntry per la destinazione precedente, che incapsula lo stato specifico di NavController per la destinazione. LoginFragment utilizza il SavedStateHandle del NavBackStackEntry precedente per impostare un valore iniziale che indica se l'utente ha eseguito l'accesso correttamente. Questo è lo stato che vuoi restituire se l'utente preme immediatamente il pulsante Indietro del sistema. L'impostazione di questo stato utilizzando SavedStateHandle garantisce che lo stato persista durante l'interruzione del processo.

Kotlin

class LoginFragment : Fragment() {
    companion object {
        const val LOGIN_SUCCESSFUL: String = "LOGIN_SUCCESSFUL"
    }

    private val userViewModel: UserViewModel by activityViewModels()
    private lateinit var savedStateHandle: SavedStateHandle

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        savedStateHandle = findNavController().previousBackStackEntry!!.savedStateHandle
        savedStateHandle.set(LOGIN_SUCCESSFUL, false)
    }
}

Java

public class LoginFragment extends Fragment {
    public static String LOGIN_SUCCESSFUL = "LOGIN_SUCCESSFUL"

    private UserViewModel userViewModel;
    private SavedStateHandle savedStateHandle;

    @Override
    public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
        userViewModel = new ViewModelProvider(requireActivity()).get(UserViewModel.class);

        savedStateHandle = Navigation.findNavController(view)
                .getPreviousBackStackEntry()
                .getSavedStateHandle();
        savedStateHandle.set(LOGIN_SUCCESSFUL, false);
    }
}

Una volta che l'utente inserisce un nome utente e una password, questi vengono passati a UserViewModel per l'autenticazione. Se l'autenticazione va a buon fine, UserViewModel memorizza i dati utente. LoginFragment aggiorna quindi il valore LOGIN_SUCCESSFUL su SavedStateHandle e si rimuove dal back stack.

Kotlin

class LoginFragment : Fragment() {
    companion object {
        const val LOGIN_SUCCESSFUL: String = "LOGIN_SUCCESSFUL"
    }

    private val userViewModel: UserViewModel by activityViewModels()
    private lateinit var savedStateHandle: SavedStateHandle

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        savedStateHandle = findNavController().previousBackStackEntry!!.savedStateHandle
        savedStateHandle.set(LOGIN_SUCCESSFUL, false)

        val usernameEditText = view.findViewById(R.id.username_edit_text)
        val passwordEditText = view.findViewById(R.id.password_edit_text)
        val loginButton = view.findViewById(R.id.login_button)

        loginButton.setOnClickListener {
            val username = usernameEditText.text.toString()
            val password = passwordEditText.text.toString()
            login(username, password)
        }
    }

    fun login(username: String, password: String) {
        userViewModel.login(username, password).observe(viewLifecycleOwner, Observer { result ->
            if (result.success) {
                savedStateHandle.set(LOGIN_SUCCESSFUL, true)
                findNavController().popBackStack()
            } else {
                showErrorMessage()
            }
        })
    }

    fun showErrorMessage() {
        // Display a snackbar error message
    }
}

Java

public class LoginFragment extends Fragment {
    public static String LOGIN_SUCCESSFUL = "LOGIN_SUCCESSFUL"

    private UserViewModel userViewModel;
    private SavedStateHandle savedStateHandle;

    @Override
    public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
        userViewModel = new ViewModelProvider(requireActivity()).get(UserViewModel.class);

        savedStateHandle = Navigation.findNavController(view)
                .getPreviousBackStackEntry()
                .getSavedStateHandle();
        savedStateHandle.set(LOGIN_SUCCESSFUL, false);

        EditText usernameEditText = view.findViewById(R.id.username_edit_text);
        EditText passwordEditText = view.findViewById(R.id.password_edit_text);
        Button loginButton = view.findViewById(R.id.login_button);

        loginButton.setOnClickListener(v -> {
            String username = usernameEditText.getText().toString();
            String password = passwordEditText.getText().toString();
            login(username, password);
        });
    }

    private void login(String username, String password) {
        userViewModel.login(username, password).observe(viewLifecycleOwner, (Observer<LoginResult>) result -> {
            if (result.success) {
                savedStateHandle.set(LOGIN_SUCCESSFUL, true);
                NavHostFragment.findNavController(this).popBackStack();
            } else {
                showErrorMessage();
            }
        });
    }

    private void showErrorMessage() {
        // Display a snackbar error message
    }
}

Tieni presente che tutta la logica relativa all'autenticazione è contenuta in UserViewModel. Questo è importante, in quanto non è responsabilità di LoginFragment o ProfileFragment determinare il modo in cui gli utenti vengono autenticati. L'incapsulamento della logica in un ViewModel non solo ne semplifica la condivisione, ma anche i test. Se la logica di navigazione è complessa, devi verificarla in modo particolare tramite i test. Per ulteriori informazioni sulla strutturazione dell'architettura della tua app attorno a componenti testabili, consulta la Guida all'architettura delle app.

Tornando a ProfileFragment, il valore LOGIN_SUCCESSFUL archiviato in SavedStateHandle può essere osservato nel metodo onCreate(). Quando l'utente torna alla ProfileFragment, viene controllato il valore LOGIN_SUCCESSFUL. Se il valore è false, l'utente può essere reindirizzato alla pagina MainFragment.

Kotlin

class ProfileFragment : Fragment() {
    ...

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        val navController = findNavController()

        val currentBackStackEntry = navController.currentBackStackEntry!!
        val savedStateHandle = currentBackStackEntry.savedStateHandle
        savedStateHandle.getLiveData<Boolean>(LoginFragment.LOGIN_SUCCESSFUL)
                .observe(currentBackStackEntry, Observer { success ->
                    if (!success) {
                        val startDestination = navController.graph.startDestination
                        val navOptions = NavOptions.Builder()
                                .setPopUpTo(startDestination, true)
                                .build()
                        navController.navigate(startDestination, null, navOptions)
                    }
                })
    }

    ...
}

Java

public class ProfileFragment extends Fragment {
    ...

    @Override
    public void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        NavController navController = NavHostFragment.findNavController(this);

        NavBackStackEntry navBackStackEntry = navController.getCurrentBackStackEntry();
        SavedStateHandle savedStateHandle = navBackStackEntry.getSavedStateHandle();
        savedStateHandle.getLiveData(LoginFragment.LOGIN_SUCCESSFUL)
                .observe(navBackStackEntry, (Observer<Boolean>) success -> {
                    if (!success) {
                        int startDestination = navController.getGraph().getStartDestination();
                        NavOptions navOptions = new NavOptions.Builder()
                                .setPopUpTo(startDestination, true)
                                .build();
                        navController.navigate(startDestination, null, navOptions);
                    }
                });
    }

    ...
}

Se l'utente ha eseguito l'accesso, ProfileFragment visualizza un messaggio di benvenuto.

La tecnica utilizzata qui per controllare il risultato ti consente di distinguere tra due casi diversi:

  • Il caso iniziale, in cui l'utente non ha eseguito l'accesso e deve essere invitato ad accedere.
  • L'utente non ha eseguito l'accesso perché ha scelto di non farlo (un risultato di false).

Distinguendo questi casi d'uso, puoi evitare di chiedere ripetutamente all'utente di accedere. La logica di business per la gestione dei casi di errore è a tua discrezione e potrebbe includere la visualizzazione di un overlay che spiega perché l'utente deve eseguire l'accesso, completare l'intera attività o reindirizzare l'utente a una destinazione che non richiede l'accesso, come nel caso dell'esempio di codice precedente.