Bidirektionale Datenbindung

Mit der unidirektionalen Datenbindung können Sie einen Wert für ein Attribut festlegen und einen Listener einrichten, der auf eine Änderung dieses Attributs reagiert:

<CheckBox
    android:id="@+id/rememberMeCheckBox"
    android:checked="@{viewmodel.rememberMe}"
    android:onCheckedChanged="@{viewmodel.rememberMeChanged}"
/>

Die bidirektionale Datenbindung bietet eine Abkürzung für diesen Prozess:

<CheckBox
    android:id="@+id/rememberMeCheckBox"
    android:checked="@={viewmodel.rememberMe}"
/>

Die Notation @={}, die das Zeichen „=“ enthält, empfängt Datenänderungen an der Property und überwacht gleichzeitig Nutzeraktualisierungen.

Wenn Sie auf Änderungen in den zugrunde liegenden Daten reagieren möchten, können Sie Ihre Layoutvariable als Implementierung von Observable, in der Regel BaseObservable, festlegen und eine @Bindable-Annotation verwenden, wie im folgenden Code-Snippet gezeigt:

Kotlin

class LoginViewModel : BaseObservable {
    // val data = ...

    @Bindable
    fun getRememberMe(): Boolean {
        return data.rememberMe
    }

    fun setRememberMe(value: Boolean) {
        // Avoids infinite loops.
        if (data.rememberMe != value) {
            data.rememberMe = value

            // React to the change.
            saveData()

            // Notify observers of a new value.
            notifyPropertyChanged(BR.remember_me)
        }
    }
}

Java

public class LoginViewModel extends BaseObservable {
    // private Model data = ...

    @Bindable
    public Boolean getRememberMe() {
        return data.rememberMe;
    }

    public void setRememberMe(Boolean value) {
        // Avoids infinite loops.
        if (data.rememberMe != value) {
            data.rememberMe = value;

            // React to the change.
            saveData();

            // Notify observers of a new value.
            notifyPropertyChanged(BR.remember_me);
        }
    }
}

Da die Getter-Methode der bindbaren Property getRememberMe() heißt, verwendet die entsprechende Setter-Methode der Property automatisch den Namen setRememberMe().

Weitere Informationen zur Verwendung von BaseObservable und @Bindable finden Sie unter Mit beobachtbaren Datenobjekten arbeiten.

Zwei-Wege-Datenbindung mit benutzerdefinierten Attributen

Die Plattform bietet Implementierungen für die bidirektionale Datenbindung für die gängigsten bidirektionalen Attribute und Änderungs-Listener, die Sie in Ihrer App verwenden können. Wenn Sie die bidirektionale Datenbindung mit benutzerdefinierten Attributen verwenden möchten, müssen Sie die Annotationen @InverseBindingAdapter und @InverseBindingMethod verwenden.

Wenn Sie beispielsweise die bidirektionale Datenbindung für ein "time"-Attribut in einer benutzerdefinierten Ansicht namens MyView aktivieren möchten, führen Sie die folgenden Schritte aus:

  1. Annotieren Sie die Methode, die den Anfangswert festlegt und aktualisiert, wenn sich der Wert ändert, mit @BindingAdapter:

    Kotlin

    @BindingAdapter("time")
    @JvmStatic fun setTime(view: MyView, newValue: Time) {
        // Important to break potential infinite loops.
        if (view.time != newValue) {
            view.time = newValue
        }
    }
    

    Java

    @BindingAdapter("time")
    public static void setTime(MyView view, Time newValue) {
        // Important to break potential infinite loops.
        if (view.time != newValue) {
            view.time = newValue;
        }
    }
    
  2. Annotieren Sie die Methode, die den Wert aus der Ansicht liest, mit @InverseBindingAdapter:

    Kotlin

    @InverseBindingAdapter("time")
    @JvmStatic fun getTime(view: MyView) : Time {
        return view.getTime()
    }
    

    Java

    @InverseBindingAdapter("time")
    public static Time getTime(MyView view) {
        return view.getTime();
    }
    

An dieser Stelle weiß die Datenbindung, was zu tun ist, wenn sich die Daten ändern (sie ruft die mit @BindingAdapter annotierte Methode auf) und was aufgerufen werden soll, wenn sich das Ansichtsattribut ändert (sie ruft die InverseBindingListener auf). Sie weiß jedoch nicht, wann oder wie sich das Attribut ändert.

Dazu müssen Sie einen Listener für die Ansicht festlegen. Das kann ein benutzerdefinierter Listener sein, der mit Ihrer benutzerdefinierten Ansicht verknüpft ist, oder ein allgemeines Ereignis, z. B. ein Fokusverlust oder eine Textänderung. Fügen Sie die Annotation @BindingAdapter der Methode hinzu, die den Listener für Änderungen am Attribut festlegt:

Kotlin

@BindingAdapter("app:timeAttrChanged")
@JvmStatic fun setListeners(
        view: MyView,
        attrChange: InverseBindingListener
) {
    // Set a listener for click, focus, touch, etc.
}

Java

@BindingAdapter("app:timeAttrChanged")
public static void setListeners(
        MyView view, final InverseBindingListener attrChange) {
    // Set a listener for click, focus, touch, etc.
}

Der Listener enthält einen InverseBindingListener als Parameter. Mit InverseBindingListener teilen Sie dem Datenbindungssystem mit, dass sich das Attribut geändert hat. Das System kann dann die mit @InverseBindingAdapter annotierte Methode aufrufen.

In der Praxis enthält dieser Listener eine nicht triviale Logik, einschließlich Listenern für die unidirektionale Datenbindung. Ein Beispiel finden Sie im Adapter für die Änderung des Textattributs TextViewBindingAdapter.

Nutzer mit Conversion

Wenn die Variable, die an ein View-Objekt gebunden ist, vor der Anzeige formatiert, übersetzt oder anderweitig geändert werden muss, kann ein Converter-Objekt verwendet werden.

Beispiel: Ein EditText-Objekt, das ein Datum anzeigt:

<EditText
    android:id="@+id/birth_date"
    android:text="@={Converter.dateToString(viewmodel.birthDate)}"
/>

Das Attribut viewmodel.birthDate enthält einen Wert vom Typ Long und muss daher mit einem Konverter formatiert werden.

Da ein bidirektionaler Ausdruck verwendet wird, ist auch ein inverser Konverter erforderlich, damit die Bibliothek weiß, wie der vom Nutzer bereitgestellte String wieder in den zugrunde liegenden Datentyp konvertiert wird, in diesem Fall Long. Fügen Sie dazu die Annotation @InverseMethod zu einem der Konverter hinzu und lassen Sie diese Annotation auf den inversen Konverter verweisen. Ein Beispiel für diese Konfiguration finden Sie im folgenden Code-Snippet:

Kotlin

object Converter {
    @InverseMethod("stringToDate")
    @JvmStatic fun dateToString(
        view: EditText, oldValue: Long,
        value: Long
    ): String {
        // Converts long to String.
    }

    @JvmStatic fun stringToDate(
        view: EditText, oldValue: String,
        value: String
    ): Long {
        // Converts String to long.
    }
}

Java

public class Converter {
    @InverseMethod("stringToDate")
    public static String dateToString(EditText view, long oldValue,
            long value) {
        // Converts long to String.
    }

    public static long stringToDate(EditText view, String oldValue,
            String value) {
        // Converts String to long.
    }
}

Endlosschleifen bei Verwendung der bidirektionalen Datenbindung

Achten Sie darauf, dass Sie bei der Verwendung der bidirektionalen Datenbindung keine Endlosschleifen einführen. Wenn der Nutzer ein Attribut ändert, wird die mit @InverseBindingAdapter annotierte Methode aufgerufen und der Wert wird der zugrunde liegenden Property zugewiesen. Dadurch wird wiederum die mit @BindingAdapter annotierte Methode aufgerufen, die einen weiteren Aufruf der mit @InverseBindingAdapter annotierten Methode auslöst, wodurch die Schleife fortgesetzt wird.

Aus diesem Grund ist es wichtig, mögliche Endlosschleifen zu unterbrechen, indem neue und alte Werte in den mit @BindingAdapter annotierten Methoden verglichen werden.

Zweiseitige Attribute

Die Plattform bietet integrierte Unterstützung für die bidirektionale Datenbindung, wenn Sie die Attribute in der folgenden Tabelle verwenden. Weitere Informationen dazu, wie die Plattform diese Unterstützung bietet, finden Sie in den Implementierungen für die entsprechenden Bindungsadapter:

Klasse Attribut(e) Bindungsadapter
AdapterView android:selectedItemPosition
android:selection
AdapterViewBindingAdapter
CalendarView android:date CalendarViewBindingAdapter
CompoundButton android:checked CompoundButtonBindingAdapter
DatePicker android:year
android:month
android:day
DatePickerBindingAdapter
NumberPicker android:value NumberPickerBindingAdapter
RadioButton android:checkedButton RadioGroupBindingAdapter
RatingBar android:rating RatingBarBindingAdapter
SeekBar android:progress SeekBarBindingAdapter
TabHost android:currentTab TabHostBindingAdapter
TextView android:text TextViewBindingAdapter
TimePicker android:hour
android:minute
TimePickerBindingAdapter

Zusätzliche Ressourcen

Weitere Informationen zur Datenbindung finden Sie in den folgenden zusätzlichen Ressourcen.

Beispiele

Blogposts