ビューバインディング

ビューバインディングとは、ビューを操作するコードを簡単に記述できる機能です。モジュール内でビューバインディングを有効にすると、そのモジュール内に存在する XML レイアウトファイルごとにバインディングクラスが生成されます。バインディングクラスのインスタンスには、対象レイアウト内で ID を持つすべてのビューへの直接参照が組み込まれます。

ほとんどの場合、ビューバインディングは findViewById の後継となります。

セットアップ手順

ビューバインディングは、モジュール単位で有効化します。モジュール内でビューバインディングを有効にするには、次の例に示すように、build.gradle ファイルに viewBinding 要素を追加します。

android {
        ...
        viewBinding {
            enabled = true
        }
    }

バインディングクラスの生成中にレイアウトファイルを無視する場合、そのレイアウトファイルのルートビューに tools:viewBindingIgnore="true" 属性を追加します。

<LinearLayout
            ...
            tools:viewBindingIgnore="true" >
        ...
    </LinearLayout>

使用方法

モジュールに対してビューバインディングを有効にすると、そのモジュールに含まれる XML レイアウトファイルごとにバインディングクラスが生成されます。各バインディングクラスには、ルートビューへの参照と、ID を持つすべてのビューへの参照が組み込まれます。バインディングクラスの名前は、XML ファイルの名前をキャメルケースに変換して、末尾に「Binding」という単語を追加することで生成されます。

たとえば、result_profile.xml というレイアウトファイルがあるとします。

<LinearLayout ... >
        <TextView android:id="@+id/name" />
        <ImageView android:cropToPadding="true" />
        <Button android:id="@+id/button"
            android:background="@drawable/rounded_button" />
    </LinearLayout>

生成されるバインディングクラスは、ResultProfileBinding という名前になります。このクラスには、2 つのフィールドがあります。name という名前の TextView フィールドと、button という名前の Button フィールドです。レイアウト内の ImageView には ID がないため、バインディングクラス内にそのビューへの参照は存在しません。

各バインディングクラスには getRoot() メソッドも含まれ、対象レイアウトファイルのルートビューを直接参照します。上記の例の場合、ResultProfileBinding クラスの getRoot() メソッドは、LinearLayout ルートビューを返します。

以下のセクションでは、アクティビティとフラグメントでの、生成されたバインディングクラスの使用について説明します。

アクティビティでビューバインディングを使用する

アクティビティで使用するバインディングクラスのインスタンスをセットアップするには、アクティビティの onCreate() メソッドで次の手順を実施します。

生成されたバインディングクラスに含まれる静的 inflate() メソッドを呼び出します。これにより、アクティビティで使用するバインディングクラスのインスタンスが作成されます。
getRoot() メソッドを呼び出すか、Kotlin プロパティ構文を使用して、ルートビューへの参照を取得します。
ルートビューを setContentView() に渡して、画面上のアクティブビューにします。

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);
    }

これで、バインディングクラスのインスタンスを使用して任意のビューを参照できるようになりました。

Kotlin

    binding.name.text = viewModel.name
    binding.button.setOnClickListener { viewModel.userClicked() }

Java

    binding.getName().setText(viewModel.getName());
    binding.button.setOnClickListener(new View.OnClickListener() {
        viewModel.userClicked()
    });

フラグメントでビューバインディングを使用する

フラグメントで使用するバインディングクラスのインスタンスを設定するには、フラグメントの onCreateView() メソッドで次の手順を実施します。

生成されたバインディングクラスに含まれる静的 inflate() メソッドを呼び出します。これにより、フラグメントが使用するバインディングクラスのインスタンスが作成されます。
getRoot() メソッドを呼び出すか、Kotlin プロパティ構文を使用して、ルートビューへの参照を取得します。
onCreateView() メソッドからルートビューを返して、画面上のアクティブビューにします。

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;
    }

これで、バインディングクラスのインスタンスを使用して任意のビューを参照できるようになりました。

Kotlin

    binding.name.text = viewModel.name
    binding.button.setOnClickListener { viewModel.userClicked() }

Java

    binding.getName().setText(viewModel.getName());
    binding.button.setOnClickListener(new View.OnClickListener() {
        viewModel.userClicked()
    });

findViewById との違い

ビューバインディングには、findViewById を使用するよりも大きなメリットがあります。

null の安全性: ビューバインディングは、ビューへの直接参照を作成するため、無効なビュー ID によって NullPointerException が発生することはありません。また、レイアウトの一部の構成内だけに存在するビューがあった場合、バインディングクラス内でそのビューへの参照を含むフィールドには @Nullable のマークが付きます。
型の安全性: 各バインディングクラス内のフィールドは、XML ファイル内で参照しているビューと合致する型を持ちます。そのため、ClassCastException のリスクがありません。

このような違いがあるため、レイアウトとコードとの間に互換性がない場合は、実行時ではなくコンパイル時にビルドが失敗することになります。

データバインディングとの比較

ビューバインディングとデータバインディングは、両方ともビューを直接参照できるバインディングクラスを生成します。ただし、ビューバインディングはよりシンプルなユースケースを扱うことを目的としており、データバインディングに比べて次のようなメリットがあります。

コンパイルが高速: ビューバインディングはアノテーション処理を必要としないため、コンパイル時間が短縮されます。
使いやすい: ビューバインディングは特別にタグ付けされた XML レイアウトファイルを必要としないため、より迅速にアプリで利用できます。モジュールでビューバインディングを有効にすると、そのモジュールのすべてのレイアウトに自動的に適用されます。

逆に、ビューバインディングには、データバインディングに比べて次のような制約があります。

ビューバインディングはレイアウト変数またはレイアウト式に対応していないため、動的 UI コンテンツを XML レイアウトファイルから直接宣言できません。
ビューバインディングは双方向データバインディングに対応していません。

これらの内容をふまえると、プロジェクトでビューバインディングとデータバインディングの両方を使用することが最適な場合があります。高度な機能を必要とするレイアウトではデータバインディングを使用でき、そうでないレイアウトではビューバインディングを使用できます。

ビュー バインディング

セットアップ手順

使用方法

アクティビティでビュー バインディングを使用する

Kotlin

Java

Kotlin

Java

フラグメントでビュー バインディングを使用する

Kotlin

Java

Kotlin

Java

findViewById との違い

データ バインディングとの比較

ビューバインディング

アクティビティでビューバインディングを使用する

フラグメントでビューバインディングを使用する

データバインディングとの比較