監視可能なデータ オブジェクトを操作する

オブザーバビリティとは、オブジェクトがデータの変更を他のオブジェクトに通知する機能のことです。データ バインディング ライブラリを使用すると、オブジェクト、フィールド、コレクションをオブザーバブルにできます。

データ バインディングには任意のオブジェクトを使用できますが、オブジェクトを変更しても UI は自動的に更新されません。データ バインディングを使用すると、データ オブジェクトに、データが変更されたときに他のオブジェクト(リスナー)に通知する機能を与えることができます。監視可能なクラスには、フィールド、コレクション、オブジェクトの 3 種類があります。

これらの監視可能なデータ オブジェクトのいずれかが UI にバインドされ、データ オブジェクトのプロパティが変更されると、UI が自動的に更新されます。

監視可能なフィールド

クラスにプロパティが数個しかない場合は、Observable インターフェースを実装するクラスを作成する価値はないかもしれません。この場合、汎用の Observable クラスと、次のプリミティブ固有のクラスを使用して、フィールドを監視可能にできます。

監視可能フィールドは、単一のフィールドを持つ自己完結型の監視可能オブジェクトです。プリミティブ バージョンでは、アクセス オペレーション中のボクシングとアンボクシングが回避されます。このメカニズムを使用するには、次の例に示すように、Java プログラミング言語で public final プロパティを作成するか、Kotlin で読み取り専用プロパティを作成します。

Kotlin

class User {
    val firstName = ObservableField<String>()
    val lastName = ObservableField<String>()
    val age = ObservableInt()
}

Java

private static class User {
    public final ObservableField<String> firstName = new ObservableField<>();
    public final ObservableField<String> lastName = new ObservableField<>();
    public final ObservableInt age = new ObservableInt();
}

フィールド値にアクセスするには、set() アクセサ メソッドと get() アクセサ メソッドを使用するか、Kotlin プロパティ構文を使用します。

Kotlin

user.firstName = "Google"
val age = user.age

Java

user.firstName.set("Google");
int age = user.age.get();

監視可能なコレクション

アプリによっては、データを保持するために動的な構造を使用することがあります。監視可能なコレクションでは、キーを使用してこれらの構造にアクセスできます。次の例に示すように、キーが String などの参照型の場合、ObservableArrayMap クラスが役立ちます。

Kotlin

ObservableArrayMap<String, Any>().apply {
    put("firstName", "Google")
    put("lastName", "Inc.")
    put("age", 17)
}

Java

ObservableArrayMap<String, Object> user = new ObservableArrayMap<>();
user.put("firstName", "Google");
user.put("lastName", "Inc.");
user.put("age", 17);

レイアウトでは、次の例に示すように、文字列キーを使用してマップを検索できます。

<data>
    <import type="android.databinding.ObservableMap"/>
    <variable name="user" type="ObservableMap&lt;String, Object&gt;"/>
</data>
…
<TextView
    android:text="@{user.lastName}"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"/>
<TextView
    android:text="@{String.valueOf(1 + (Integer)user.age)}"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"/>

ObservableArrayList クラスは、次のようにキーが整数の場合に便利です。

Kotlin

ObservableArrayList<Any>().apply {
    add("Google")
    add("Inc.")
    add(17)
}

Java

ObservableArrayList<Object> user = new ObservableArrayList<>();
user.add("Google");
user.add("Inc.");
user.add(17);

レイアウトでは、次の例に示すように、インデックスを介してリストにアクセスできます。

<data>
    <import type="android.databinding.ObservableList"/>
    <import type="com.example.my.app.Fields"/>
    <variable name="user" type="ObservableList&lt;Object&gt;"/>
</data>
…
<TextView
    android:text='@{user[Fields.LAST_NAME]}'
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"/>
<TextView
    android:text='@{String.valueOf(1 + (Integer)user[Fields.AGE])}'
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"/>

監視可能なオブジェクト

Observable インターフェースを実装するクラスを使用すると、監視可能なオブジェクトからプロパティの変更通知を受け取るリスナーを登録できます。

Observable インターフェースにはリスナーを追加、削除するメカニズムがありますが、通知を送信するタイミングはデベロッパーが決定します。開発を容易にするため、データ バインディング ライブラリには、リスナー登録メカニズムを実装する BaseObservable クラスが用意されています。BaseObservable を実装するデータクラスは、プロパティが変更されたときに通知する役割を担います。これを行うには、次の例に示すように、Bindable アノテーションをゲッターに割り当て、セッターで notifyPropertyChanged() メソッドを呼び出します。

Kotlin

class User : BaseObservable() {

    @get:Bindable
    var firstName: String = ""
        set(value) {
            field = value
            notifyPropertyChanged(BR.firstName)
        }

    @get:Bindable
    var lastName: String = ""
        set(value) {
            field = value
            notifyPropertyChanged(BR.lastName)
        }
}

Java

private static class User extends BaseObservable {
    private String firstName;
    private String lastName;

    @Bindable
    public String getFirstName() {
        return this.firstName;
    }

    @Bindable
    public String getLastName() {
        return this.lastName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
        notifyPropertyChanged(BR.firstName);
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
        notifyPropertyChanged(BR.lastName);
    }
}

データ バインディングは、モジュール パッケージに BR という名前のクラスを生成します。このクラスには、データ バインディングに使用されるリソースの ID が含まれています。Bindable アノテーションは、コンパイル時に BR クラスファイルにエントリを生成します。データクラスの基本クラスを変更できない場合は、PropertyChangeRegistry オブジェクトを使用して Observable インターフェースを実装し、リスナーを効率的に登録して通知できます。

ライフサイクル対応オブジェクト

アプリのレイアウトは、データの変更を UI に自動的に通知するデータ バインディング ソースにバインドすることもできます。そうすることで、バインディングはライフサイクルを認識し、UI が画面に表示されているときにのみトリガーされます。

データ バインディングは StateFlow と LiveData をサポートしています。データ バインディングで LiveData を使用する方法については、LiveData を使用してデータの変更を UI に通知するをご覧ください。

StateFlow を使用する

アプリで Kotlin とコルーチンを使用している場合は、StateFlow オブジェクトをデータ バインディング ソースとして使用できます。バインディング クラスで StateFlow オブジェクトを使用するには、ライフサイクル オーナーを指定して StateFlow オブジェクトのスコープを定義します。次の例では、バインディング クラスがインスタンス化された後に、アクティビティをライフサイクル オーナーとして指定しています。

class ViewModelActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        // Inflate view and obtain an instance of the binding class.
        val binding: UserBinding = DataBindingUtil.setContentView(this, R.layout.user)

        // Specify the current activity as the lifecycle owner.
        binding.lifecycleOwner = this
    }
}

レイアウト ビューをアーキテクチャ コンポーネントにバインドするで説明したように、データ バインディングは ViewModel オブジェクトとシームレスに連携します。StateFlow と ViewModel は次のように組み合わせて使用できます。

class ScheduleViewModel : ViewModel() {

    private val _username = MutableStateFlow<String>("")
    val username: StateFlow<String> = _username

    init {
        viewModelScope.launch {
            _username.value = Repository.loadUserName()
        }
    }
}

レイアウトで、次の例に示すように、バインディング式を使用して ViewModel オブジェクトのプロパティとメソッドを対応するビューに割り当てます。

<TextView
    android:id="@+id/name"
    android:text="@{viewmodel.username}" />

ユーザーの名前の値が変更されるたびに、UI が自動的に更新されます。

StateFlow のサポートを無効にする

Kotlin と AndroidX を使用するアプリの場合、StateFlow のサポートはデータ バインディングに自動的に含まれます。つまり、コルーチンの依存関係がまだ利用できない場合は、アプリに自動的に含まれます。

この機能を無効にするには、build.gradle ファイルに次のコードを追加します。

Groovy

android {
    ...
    dataBinding {
        addKtx = false
    }
}

Kotlin

android {
    ...
    dataBinding {
        addKtx = false
    }
}

または、gradle.properties ファイルに次の行を追加して、プロジェクトで StateFlow をグローバルに無効にすることもできます。

Groovy

android.defaults.databinding.addKtx = false

Kotlin

android.defaults.databinding.addKtx = false

参考情報

データ バインディングの詳細については、以下のリソースをご覧ください。

サンプル

ブログ投稿