Wenn Sie die Navigation für Ihre App entwerfen, möchten Sie möglicherweise basierend auf einer bedingten Logik zu einem bestimmten Ziel navigieren. Beispielsweise kann ein Nutzer einem Deeplink zu einem Ziel folgen, für das er angemeldet sein muss, oder Sie haben in einem Spiel unterschiedliche Ziele, je nachdem, ob der Spieler gewinnt oder verliert.
Nutzeranmeldung
In diesem Beispiel versucht ein Nutzer, zu einem Profilbildschirm zu navigieren, für den eine Authentifizierung erforderlich ist. Da für diese Aktion eine Authentifizierung erforderlich ist, sollte der Nutzer zu einem Anmeldebildschirm weitergeleitet werden, wenn er noch nicht authentifiziert ist.
Der Navigationsgraph für dieses Beispiel könnte etwa so aussehen:
Zur Authentifizierung muss die App zur login_fragment navigieren, wo der Nutzer einen Nutzernamen und ein Passwort eingeben kann. Wenn der Nutzer die Bedingungen akzeptiert, wird er zum Bildschirm profile_fragment zurückgeleitet. Wenn sie nicht akzeptiert werden, wird der Nutzer mit einem Snackbar darüber informiert, dass seine Anmeldedaten ungültig sind. Wenn der Nutzer zum Profilbildschirm zurückkehrt, ohne sich anzumelden, wird er zum Bildschirm main_fragment weitergeleitet.
Hier ist der Navigationsgraph für diese 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 enthält eine Schaltfläche, auf die der Nutzer klicken kann, um sein Profil aufzurufen.
Wenn der Nutzer den Profilbildschirm sehen möchte, muss er sich zuerst authentifizieren. Diese Interaktion wird mit zwei separaten Fragmenten modelliert, hängt aber von einem gemeinsamen Nutzerstatus ab. Diese Statusinformationen fallen nicht in die Zuständigkeit dieser beiden Fragmente und werden besser in einem freigegebenen UserViewModel gespeichert.
Dieses ViewModel wird zwischen den Fragmenten geteilt, indem es auf die Aktivität beschränkt wird, die ViewModelStoreOwner implementiert. Im folgenden Beispiel wird requireActivity() in MainActivity aufgelöst, da MainActivity ProfileFragment hostet:
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);
...
}
...
}
Die Nutzerdaten in UserViewModel werden mit LiveData verfügbar gemacht. Sie sollten sich diese Daten also ansehen, um zu entscheiden, wohin Sie navigieren möchten. Wenn Sie zu ProfileFragment wechseln, wird in der App eine Willkommensnachricht angezeigt, wenn die Nutzerdaten vorhanden sind. Wenn die Nutzerdaten null sind, navigieren Sie zu LoginFragment, da sich der Nutzer authentifizieren muss, bevor er sein Profil sehen kann. Definieren Sie die Entscheidungslogik in Ihrer ProfileFragment, wie im folgenden Beispiel gezeigt:
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() {
...
}
}
Wenn die Nutzerdaten null sind, wenn sie die ProfileFragment erreichen, werden sie zur LoginFragment weitergeleitet.
Mit NavController.getPreviousBackStackEntry können Sie den NavBackStackEntry für das vorherige Ziel abrufen, der den NavController-spezifischen Status für das Ziel enthält. LoginFragment verwendet den SavedStateHandle des vorherigen NavBackStackEntry, um einen Anfangswert festzulegen, der angibt, ob sich der Nutzer erfolgreich angemeldet hat. Das ist der Zustand, der zurückgegeben werden soll, wenn der Nutzer sofort den Button „Zurück“ des Systems drückt.
Wenn Sie diesen Status mit SavedStateHandle festlegen, bleibt er auch bei einer Prozessbeendigung erhalten.
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);
}
}
Sobald der Nutzer einen Nutzernamen und ein Passwort eingibt, werden diese zur Authentifizierung an den UserViewModel übergeben. Wenn die Authentifizierung erfolgreich ist, speichert der UserViewModel die Nutzerdaten. LoginFragment aktualisiert dann den Wert LOGIN_SUCCESSFUL in SavedStateHandle und entfernt sich selbst aus dem 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
}
}
Beachten Sie, dass die gesamte Logik für die Authentifizierung in UserViewModel enthalten ist. Das ist wichtig, da weder LoginFragment noch ProfileFragment dafür verantwortlich sind, wie Nutzer authentifiziert werden. Wenn Sie Ihre Logik in einem ViewModel kapseln, lässt sie sich nicht nur leichter freigeben, sondern auch einfacher testen. Wenn Ihre Navigationslogik komplex ist, sollten Sie sie unbedingt testen. Weitere Informationen zum Strukturieren der Architektur Ihrer App mit testbaren Komponenten finden Sie im Leitfaden zur App-Architektur.
Zurück in der ProfileFragment kann der in der SavedStateHandle gespeicherte LOGIN_SUCCESSFUL-Wert in der Methode onCreate() beobachtet werden. Wenn der Nutzer zur ProfileFragment zurückkehrt, wird der Wert LOGIN_SUCCESSFUL geprüft. Wenn der Wert false ist, kann der Nutzer zurück zur MainFragment weitergeleitet werden.
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);
}
});
}
...
}
Wenn sich der Nutzer erfolgreich angemeldet hat, wird in der ProfileFragment eine Willkommensnachricht angezeigt.
Mit der hier verwendeten Methode zur Überprüfung des Ergebnisses können Sie zwischen zwei verschiedenen Fällen unterscheiden:
- Der Nutzer ist nicht angemeldet und sollte aufgefordert werden, sich anzumelden.
- Der Nutzer ist nicht angemeldet, weil er sich gegen die Anmeldung entschieden hat (ein Ergebnis von
false).
Wenn Sie diese Anwendungsfälle unterscheiden, können Sie vermeiden, dass der Nutzer wiederholt zur Anmeldung aufgefordert wird. Die Geschäftslogik für die Behandlung von Fehlerfällen liegt bei Ihnen. Sie können beispielsweise ein Overlay anzeigen, in dem erklärt wird, warum sich der Nutzer anmelden muss, die gesamte Aktivität beenden oder den Nutzer zu einem Ziel weiterleiten, für das keine Anmeldung erforderlich ist, wie im vorherigen Codebeispiel.