Ansichtsbindung Teil von Android Jetpack
View Binding ist eine Funktion, mit der sich Code, der mit Ansichten interagiert, einfacher schreiben lässt. Sobald die Ansichtsbindung in einem Modul aktiviert ist, wird für jede XML-Layoutdatei in diesem Modul eine Bindungsklasse generiert. Eine Instanz einer Bindungsklasse enthält direkte Verweise auf alle Ansichten, die im entsprechenden Layout eine ID haben.
In den meisten Fällen ersetzt die Ansichtsbindung findViewById.
Einrichtung
Die Ansichtsbindung wird für jedes Modul einzeln aktiviert. Wenn Sie die Ansichtsbindung in einem Modul aktivieren möchten, legen Sie in der Datei build.gradle auf Modulebene die Build-Option viewBinding auf true fest, wie im folgenden Beispiel gezeigt:
Groovy
android { ... buildFeatures { viewBinding true } }
Kotlin
android { ... buildFeatures { viewBinding = true } }
Wenn eine Layoutdatei beim Generieren von Bindungsklassen ignoriert werden soll, fügen Sie der Stammansicht dieser Layoutdatei das Attribut tools:viewBindingIgnore="true" hinzu:
<LinearLayout
...
tools:viewBindingIgnore="true" >
...
</LinearLayout>
Nutzung
Wenn die Ansichtsbindung für ein Modul aktiviert ist, wird für jede XML-Layoutdatei, die das Modul enthält, eine Bindungsklasse generiert. Jede Bindungsklasse enthält Verweise auf die Stammansicht und alle Ansichten mit einer ID. Der Name der Bindungsklasse wird generiert, indem der Name der XML-Datei in die Pascal-Schreibweise konvertiert und am Ende das Wort „Binding“ hinzugefügt wird.
Angenommen, Sie haben eine Layoutdatei namens result_profile.xml mit folgendem Inhalt:
<LinearLayout ... >
<TextView android:id="@+id/name" />
<ImageView android:cropToPadding="true" />
<Button android:id="@+id/button"
android:background="@drawable/rounded_button" />
</LinearLayout>
Die generierte Bindungsklasse heißt ResultProfileBinding. Diese Klasse hat zwei Felder: ein TextView mit dem Namen name und ein Button mit dem Namen button. ImageView im Layout hat keine ID, daher gibt es in der Bindungsklasse keinen Verweis darauf.
Jede Bindungsklasse enthält auch eine getRoot()-Methode, die einen direkten Verweis auf die Stammansicht der entsprechenden Layoutdatei bereitstellt. In diesem Beispiel gibt die Methode getRoot() in der Klasse ResultProfileBinding die Stammansicht LinearLayout zurück.
In den folgenden Abschnitten wird die Verwendung generierter Bindungsklassen in Aktivitäten und Fragmenten veranschaulicht.
View Binding in Aktivitäten verwenden
So richten Sie eine Instanz der Bindungsklasse für die Verwendung mit einer Aktivität ein: Führen Sie die folgenden Schritte in der onCreate()-Methode der Aktivität aus:
- Rufen Sie die statische Methode
inflate()auf, die in der generierten Bindungsklasse enthalten ist. Dadurch wird eine Instanz der Bindungsklasse für die Aktivität erstellt. - Rufen Sie einen Verweis auf die Stammansicht ab, indem Sie entweder die Methode
getRoot()aufrufen oder die Kotlin-Attributsyntax verwenden. - Übergeben Sie die Stammansicht an
setContentView(), um sie zur aktiven Ansicht auf dem Bildschirm zu machen.
Diese Schritte werden im folgenden Beispiel veranschaulicht:
Kotlin
private lateinit var binding: ResultProfileBinding
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
binding = ResultProfileBinding.inflate(layoutInflater)
val view = binding.root
setContentView(view)
}
Java
private ResultProfileBinding binding;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
binding = ResultProfileBinding.inflate(getLayoutInflater());
View view = binding.getRoot();
setContentView(view);
}
Du kannst jetzt die Instanz der Bindungsklasse verwenden, um auf eine der Ansichten zu verweisen:
Kotlin
binding.name.text = viewModel.name
binding.button.setOnClickListener { viewModel.userClicked() }
Java
binding.name.setText(viewModel.getName());
binding.button.setOnClickListener(new View.OnClickListener() {
viewModel.userClicked()
});
View Binding in Fragmenten verwenden
So richten Sie eine Instanz der Bindungsklasse für die Verwendung mit einem Fragment ein: Führen Sie die folgenden Schritte in der onCreateView()-Methode des Fragments aus:
- Rufen Sie die statische Methode
inflate()auf, die in der generierten Bindungsklasse enthalten ist. Dadurch wird eine Instanz der Bindungsklasse erstellt, die das Fragment verwenden kann. - Rufen Sie einen Verweis auf die Stammansicht ab, indem Sie entweder die Methode
getRoot()aufrufen oder die Kotlin-Attributsyntax verwenden. - Geben Sie die Stammansicht aus der Methode
onCreateView()zurück, um sie zur Active View auf dem Bildschirm zu machen.
Kotlin
private var _binding: ResultProfileBinding? = null
// This property is only valid between onCreateView and
// onDestroyView.
private val binding get() = _binding!!
override fun onCreateView(
inflater: LayoutInflater,
container: ViewGroup?,
savedInstanceState: Bundle?
): View? {
_binding = ResultProfileBinding.inflate(inflater, container, false)
val view = binding.root
return view
}
override fun onDestroyView() {
super.onDestroyView()
_binding = null
}
Java
private ResultProfileBinding binding;
@Override
public View onCreateView (LayoutInflater inflater,
ViewGroup container,
Bundle savedInstanceState) {
binding = ResultProfileBinding.inflate(inflater, container, false);
View view = binding.getRoot();
return view;
}
@Override
public void onDestroyView() {
super.onDestroyView();
binding = null;
}
Du kannst jetzt die Instanz der Bindungsklasse verwenden, um auf eine der Ansichten zu verweisen:
Kotlin
binding.name.text = viewModel.name
binding.button.setOnClickListener { viewModel.userClicked() }
Java
binding.name.setText(viewModel.getName());
binding.button.setOnClickListener(new View.OnClickListener() {
viewModel.userClicked()
});
Hinweise für verschiedene Konfigurationen bereitstellen
Wenn Sie Ansichten über mehrere Konfigurationen hinweg deklarieren, ist es manchmal sinnvoll, je nach Layout einen anderen Ansichtstyp zu verwenden. Das folgende Code-Snippet zeigt ein Beispiel dafür:
# in res/layout/example.xml
<TextView android:id="@+id/user_bio" />
# in res/layout-land/example.xml
<EditText android:id="@+id/user_bio" />
In diesem Fall erwarten Sie möglicherweise, dass die generierte Klasse ein Feld userBio vom Typ TextView verfügbar macht, da TextView die gemeinsame Basisklasse ist. Aufgrund technischer Einschränkungen kann der Codegenerator für die Ansichtsbindung dies nicht ermitteln und generiert stattdessen ein View-Feld. Dazu muss das Feld später mit binding.userBio as TextView umgewandelt werden.
Um diese Einschränkung zu umgehen, unterstützt die Ansichtsbindung ein tools:viewBindingType-Attribut, mit dem Sie dem Compiler mitteilen können, welcher Typ im generierten Code verwendet werden soll.
Im vorherigen Beispiel können Sie dieses Attribut verwenden, damit der Compiler das Feld als TextView generiert:
# in res/layout/example.xml (unchanged)
<TextView android:id="@+id/user_bio" />
# in res/layout-land/example.xml
<EditText android:id="@+id/user_bio" tools:viewBindingType="TextView" />
Ein weiteres Beispiel: Angenommen, Sie haben zwei Layouts, eines mit einem BottomNavigationView und eines mit einem NavigationRailView. Beide Klassen erweitern NavigationBarView, das die meisten Implementierungsdetails enthält. Wenn Ihr Code nicht genau wissen muss, welche Unterklasse im aktuellen Layout vorhanden ist, können Sie mit tools:viewBindingType den generierten Typ in beiden Layouts auf NavigationBarView festlegen:
# in res/layout/navigation_example.xml
<BottomNavigationView android:id="@+id/navigation" tools:viewBindingType="NavigationBarView" />
# in res/layout-w720/navigation_example.xml
<NavigationRailView android:id="@+id/navigation" tools:viewBindingType="NavigationBarView" />
Die Ansichtsbindung kann den Wert dieses Attributs beim Generieren von Code nicht validieren. Um Kompilierungs- und Laufzeitfehler zu vermeiden, muss der Wert die folgenden Bedingungen erfüllen:
- Der Wert muss eine Klasse sein, die von
android.view.Viewerbt. Der Wert muss eine Basisklasse des Tags sein, auf dem er platziert wird. Die folgenden Werte funktionieren beispielsweise nicht:
<TextView tools:viewBindingType="ImageView" /> <!-- ImageView is not related to TextView. --> <TextView tools:viewBindingType="Button" /> <!-- Button is not a superclass of TextView. -->Der endgültige Typ muss in allen Konfigurationen einheitlich aufgelöst werden.
Unterschiede zu findViewById
Die Ansichtsbindung bietet wichtige Vorteile gegenüber der Verwendung von findViewById:
- Null-Sicherheit: Da die Ansichtsbindung direkte Verweise auf Ansichten erstellt, besteht kein Risiko einer NullPointerException aufgrund einer ungültigen Ansichts-ID.
Wenn eine Ansicht nur in einigen Konfigurationen eines Layouts vorhanden ist, wird das Feld mit dem Verweis in der Bindungsklasse mit
@Nullablegekennzeichnet. - Typsicherheit: Die Felder in jeder Bindungsklasse haben Typen, die den Ansichten entsprechen, auf die sie in der XML-Datei verweisen. Es besteht also kein Risiko einer ClassCastException.
Diese Unterschiede bedeuten, dass Inkompatibilitäten zwischen Ihrem Layout und Ihrem Code dazu führen, dass Ihr Build zur Kompilierzeit und nicht zur Laufzeit fehlschlägt.
Vergleich mit der Datenbindung
Sowohl die Ansichtsbindung als auch die Datenbindung generieren Bindungsklassen, mit denen Sie direkt auf Ansichten verweisen können. Die Ansichtsbindung ist jedoch für einfachere Anwendungsfälle gedacht und bietet gegenüber der Datenbindung die folgenden Vorteile:
- Schnellere Kompilierung: Für die Ansichtsbindung ist keine Annotationsverarbeitung erforderlich, sodass die Kompilierung schneller erfolgt.
- Nutzerfreundlichkeit: Für die Ansichtsbindung sind keine speziell getaggten XML-Layoutdateien erforderlich, sodass sie schneller in Ihre Apps übernommen werden kann. Sobald Sie die Ansichtsbindung in einem Modul aktivieren, wird sie automatisch auf alle Layouts dieses Moduls angewendet.
Andererseits hat die Ansichtsbindung im Vergleich zur Datenbindung die folgenden Einschränkungen:
- Die Ansichtsbindung unterstützt keine Layoutvariablen oder Layoutausdrücke. Daher kann sie nicht verwendet werden, um dynamische UI-Inhalte direkt aus XML-Layoutdateien zu deklarieren.
- Die Ansichtsbindung unterstützt keine bidirektionale Datenbindung.
Aufgrund dieser Überlegungen ist es in einigen Fällen am besten, sowohl die Ansichtsbindung als auch die Datenbindung in einem Projekt zu verwenden. Sie können Datenbindung in Layouts verwenden, die erweiterte Funktionen erfordern, und Ansichtsbindung in Layouts, die diese nicht erfordern.
Zusätzliche Ressourcen
Weitere Informationen zur Ansichtsbindung finden Sie in den folgenden zusätzlichen Ressourcen:
Blogs
Videos
Empfehlungen für Sie
- Hinweis: Der Linktext wird angezeigt, wenn JavaScript deaktiviert ist.
- Von Kotlin Synthetics zu Jetpack View Binding migrieren
- Layouts und Bindungsausdrücke
- App-Architektur: UI-Ebene – Erste Schritte – Android-Entwickler