このページは Cloud Translation API によって翻訳されました。

レイアウトビューをアーキテクチャコンポーネントにバインドする

AndroidX ライブラリに含まれるアーキテクチャコンポーネントを使用すると、堅牢でテストとメンテナンスが容易なアプリを設計できます。データバインディングライブラリはアーキテクチャコンポーネントとシームレスに連携し、UI の開発をさらに簡素化します。アプリのレイアウトはアーキテクチャコンポーネントのデータにバインドできます。これにより、UI コントローラ��イ��イ��管理し、データの変更を UI に通知できます。

このページでは、アーキテクチャコンポーネントをアプリに組み込み、データバインディングライブラリを最大限に活用する方法について説明します。

LiveData を使用してデータの変更について UI に通知する

LiveData オブジェクトをデータバインディングソースとして使用すると、データの変更について UI に自動的に通知できます。このアーキテクチャコンポーネントについて詳しくは、LiveData の概要をご覧ください。

監視可能フィールドなどの Observable を実装するオブジェクトとは異なり、LiveData オブジェクトはデータ変更に登録されたオブザーバーのライフサイクルを認識しています。この知識には多くの利点があります。詳しくは LiveData を使用するメリットをご覧ください。Android Studio バージョン 3.1 以降では、データバインディングコード内で監視可能なフィールドを LiveData オブジェクトに置き換えることができます。

バインディングクラスで LiveData オブジェクトを使用するには、ライフサイクルオーナーを指定して LiveData オブジェクトのスコープを定義する必要があります。次の例では、バインディングクラスをインスタンス化した後、アクティビティをライフサイクルオーナーとして指定しています。

Kotlin

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.setLifecycleOwner(this)
    }
}

Java

class ViewModelActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        // Inflate view and obtain an instance of the binding class.
        UserBinding binding = DataBindingUtil.setContentView(this, R.layout.user);

        // Specify the current activity as the lifecycle owner.
        binding.setLifecycleOwner(this);
    }
}

次のセクションで説明するように、ViewModel ��ンポーネントを使用してデータをレイアウトにバインドできます。ViewModel コンポーネントでは、LiveData オブジェクトを使用してデータの変換や複数のデータソースの結合を行うことができます。次の例は、ViewModel 内のデータを変換する方法を示しています。

Kotlin

class ScheduleViewModel : ViewModel() {
    val userName: LiveData

    init {
        val result = Repository.userName
        userName = Transformations.map(result) { result -> result.value }
    }
}

Java

class ScheduleViewModel extends ViewModel {
    LiveData username;

    public ScheduleViewModel() {
        String result = Repository.userName;
        userName = Transformations.map(result, result -> result.value);
    }
}

ViewModel を使用して UI 関連のデータを管理する

データバインディングライブラリは ViewModel コンポーネントとシームレスに連携します。ViewModel は、レイアウトが監視してその変化に対応するデータを公開します。データバインディングライブラリで ViewModel コンポーネントを使用すると、UI ロジックをレイアウトからコンポーネントに移動でき、テストが容易になります。必要に応じて、データバインディングライブラリにより、ビューがデータソースからバインドまたはバインド解除されるようにします。残りの作業のほとんどは、正しいデータが公開されていることを確認することです。このアーキテクチャコンポーネントについて詳しくは、ViewModel の概要をご覧ください。

ViewModel コンポーネントをデータバインディングライブラリで使用するには、ViewModel クラスから継承したコンポーネントをインスタンス化し、バインディングクラスのインスタンスを取得して、ViewModel コンポーネントをバインディングクラスのプロパティに割り当てる必要があります。次の例は、ライブラリでコンポーネントを使用する方法を示しています。

Kotlin

class ViewModelActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        // Obtain the ViewModel component.
        val userModel: UserModel by viewModels()

        // Inflate view and obtain an instance of the binding class.
        val binding: UserBinding = DataBindingUtil.setContentView(this, R.layout.user)

        // Assign the component to a property in the binding class.
        binding.viewmodel = userModel
    }
}

Java

class ViewModelActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        // Obtain the ViewModel component.
        UserModel userModel = new ViewModelProvider(this).get(UserModel.class);

        // Inflate view and obtain an instance of the binding class.
        UserBinding binding = DataBindingUtil.setContentView(this, R.layout.user);

        // Assign the component to a property in the binding class.
        binding.viewmodel = userModel;
    }
}

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

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

監視可能な ViewModel を使用して、バインディングアダプターを詳細に管理する

Observable インターフェースを実装する ViewModel コンポーネントを使用して、データの変更について他のアプリコンポーネントに通知できます。LiveData オブジェクトの使用方法と同様です。

LiveData のライフサイクル管理機能が失われた場合でも、LiveData オブジェクトを使用するよりも、Observable インターフェースを実装する ViewModel コンポーネントを使用することをおすすめします。Observable を実装する ViewModel コンポーネントを使用すると、アプリ内のバインディングアダプターをより詳細に制御できます。たとえば、このパターンでは、データが変更��れたときの通知をより細かく制御できます。また、カスタムメソッドを指定して、双方向データバインディングの属性の値を設定することもできます。

監視可能な ViewModel コンポーネントを実装するには、ViewModel クラスから継承して Observable インターフェースを実装するクラスを作成する必要があります。オブザーバーが addOnPropertyChangedCallback() メソッドと removeOnPropertyChangedCallback() メソッドを使用して通知を登録または登録解除するときに、カスタムロジックを指定できます。notifyPropertyChanged() メソッドでプロパティが変更されたときに実行されるカスタムロジックを指定することもできます。次のコード例は、監視可能な ViewModel を実装する方法を示しています。

Kotlin

/**
 * A ViewModel that is also an Observable,
 * to be used with the Data Binding Library.
 */
open class ObservableViewModel : ViewModel(), Observable {
    private val callbacks: PropertyChangeRegistry = PropertyChangeRegistry()

    override fun addOnPropertyChangedCallback(
            callback: Observable.OnPropertyChangedCallback) {
        callbacks.add(callback)
    }

    override fun removeOnPropertyChangedCallback(
            callback: Observable.OnPropertyChangedCallback) {
        callbacks.remove(callback)
    }

    /**
     * Notifies observers that all properties of this instance have changed.
     */
    fun notifyChange() {
        callbacks.notifyCallbacks(this, 0, null)
    }

    /**
     * Notifies observers that a specific property has changed. The getter for the
     * property that changes must be marked with the @Bindable annotation to
     * generate a field in the BR class to be used as the fieldId parameter.
     *
     * @param fieldId The generated BR id for the Bindable field.
     */
    fun notifyPropertyChanged(fieldId: Int) {
        callbacks.notifyCallbacks(this, fieldId, null)
    }
}

Java

/**
 * A ViewModel that is also an Observable,
 * to be used with the Data Binding Library.
 */
class ObservableViewModel extends ViewModel implements Observable {
    private PropertyChangeRegistry callbacks = new PropertyChangeRegistry();

    @Override
    protected void addOnPropertyChangedCallback(
            Observable.OnPropertyChangedCallback callback) {
        callbacks.add(callback);
    }

    @Override
    protected void removeOnPropertyChangedCallback(
            Observable.OnPropertyChangedCallback callback) {
        callbacks.remove(callback);
    }

    /**
     * Notifies observers that all properties of this instance have changed.
     */
    void notifyChange() {
        callbacks.notifyCallbacks(this, 0, null);
    }

    /**
     * Notifies observers that a specific property has changed. The getter for the
     * property that changes must be marked with the @Bindable annotation to
     * generate a field in the BR class to be used as the fieldId parameter.
     *
     * @param fieldId The generated BR id for the Bindable field.
     */
    void notifyPropertyChanged(int fieldId) {
        callbacks.notifyCallbacks(this, fieldId, null);
    }
}