[Android] findViewByIdの代わりにView Bindingを使ってみた

View BindingはViewを操作するコードを簡単に記述できる機能で、XMLレイアウトごとBindすることができます。
View Binding が「大概のケース」でfindViewByIdの後継として使えます。例外もありまったりしますが…

Android Studio
2021.1.1

View Binding の設定

　
XMLレイアウトファイルからIDを読みだして、findViewById を使ってコードと結びつけるのが昔からの方法です。

findViewById の不都合なことがある場合として、

nullable
- findViewByIdの戻り値はnullableでタイミングが悪いあるいは間違ったidを読んでnullなる可能性が潜んでいる
型の指定
- 型安全ではないので型を指定して呼び出す必要がある
紐づけが面倒
- たくさんの紐づけをする場合に顕著に表れる冗長的な作業、バグの元

等があります。１つ２つであればfindViewById は簡単ですが大きなプロジェクトでは
View Binding が推奨されるでしょう。
　
Kotlinでは以下で説明しています。
　

cat44 00 100x100 - [Android] findViewByIdの代わりにView Bindingを使ってみた

[Android & Kotlin] View Binding はfindViewByIdの後継

Kotlinでは以前は「Kotlin Android Extensions」を使ってコードを簡略化できていましたが非推奨となりました。 V...

目次
1. build.gradleの設定
2. Binding Classを生成
3. Activityへの実装
4. サンプルコード

build.gradleの設定

　
build.gradle ファイルに viewBinding 要素を追加し true にします。

同じ名前のファイルが2つあり、プロジェクト用（Project: xxx）とモジュール用（Module: xxx.app）で、モジュール用を使用します。
ターゲットのAPIレベルやライブラリーの情報が設定されます。

　
build.gradle(Module: xxx)

...
android {
    ...
    buildFeatures { 
        viewBinding true 
    }
}
...

...

android {

...

buildFeatures {

viewBinding true

}

...

この他に以下のような設定でも通りました。

viewBinding {
    enabled = true
}

viewBinding {

enabled = true

}

あるいは、gradle.properties に以下のような記述を追加しても可能です

android.defaults.buildfeatures.viewbinding=true

1	android.defaults.buildfeatures.viewbinding=true

設定後に「Sync Now」を実行するのを忘れずに
また反映されるのに時間がかかることもあります

Binding Classを生成

　
プロジェクトのレイアウトファイル毎にViewBinding Class を作成します。

package com.example.testbutton
...
import com.example.testbutton.databinding.ActivityMainBinding

package com.example.testbutton

...

import com.example.testbutton.databinding.ActivityMainBinding

例えば、activity_main.xml の場合はactivity_mainをキャメルケースに変換して、package name とdatabindingを頭に付け、末尾に「Binding」を追加することで生成します。

[package name].databinding.[XMLレイアウトファイル名から]Binding

activity_main.xml	>>	ActivityMainBinding
sub_layout.xml	>>	SubLayoutBinding
main.xml	>>	MainBinding

activity_main.xmが以下のような場合

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
    ...
    >
 
    <TextView
        android:id="@+id/text_view"
        ... />
 
    <ImageView
        android:src="@drawable/image"
        ... />
 
    <EditText
        android:id="@+id/edittext"
        .../>
 
    <Button
        android:id="@+id/button"
        ... />
 
</androidx.constraintlayout.widget.ConstraintLayout>

<?xml version="1.0" encoding="utf-8"?>

<androidx.constraintlayout.widget.ConstraintLayout

...

<TextView

android:id="@+id/text_view"

... />

<ImageView

android:src="@drawable/image"

... />

<EditText

android:id="@+id/edittext"

.../>

<Button

android:id="@+id/button"

... />

</androidx.constraintlayout.widget.ConstraintLayout>

Binding Class のActivityMainBindingには3つのフィールドがあります。

text_view という名前の TextView フィールド
edittext という名前の EditText フィールド
button という名前の Button フィールド

bindingで以下のように参照できます

binding.textView...

binding.edittext...

binding.button...

binding.textView...

binding.edittext...

binding.button...

ImageViewには ID が無いので、このバインディングクラス内にそのビューへの参照は存在しません。

Binding Classには getRoot() メソッドも含まれるので、レイアウトファイルの
root viewを直接参照できます。上記のActivityMainBindingクラスでは getRoot() により
constraintlayout の root view を返します。

Activityへの実装

　
MainActivityの onCreate() で次の手順を実施

Binding Classのインスタンスを生成
- Binding Classに含まれる静的 inflate() メソッドを呼び出し生成
getRoot()を呼び出してroot viewへの参照を取得
root view を setContentView() に渡す

// View Binding Class のインスタンス
// lateinit で宣言し初期化タイミングを onCreate() まで遅らせる
private ActivityMainBinding binding;

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // bindingのイニシャライズ
    // Binding Classに含まれる静的 inflate() メソッドを呼び出す
    binding = ActivityMainBinding.inflate(getLayoutInflater());

    // root view への参照を取得
    View view = binding.getRoot();

    // view をsetContentView()にセット
    setContentView(view)

    binding.button.setOnClickListener(new View.OnClickListener() {
        ...
    });
}

// View Binding Class のインスタンス

// lateinit で宣言し初期化タイミングを onCreate() まで遅らせる

private ActivityMainBinding binding;

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

// bindingのイニシャライズ

// Binding Classに含まれる静的 inflate() メソッドを呼び出す

binding = ActivityMainBinding.inflate(getLayoutInflater());

// root view への参照を取得

View view = binding.getRoot();

// view をsetContentView()にセット

setContentView(view)

binding.button.setOnClickListener(new View.OnClickListener() {

...

});

}

冗長なので短縮できます

 // view をsetContentView()にセット
 setContentView(binding.getRoot());

1 2	// view をsetContentView()にセット setContentView(binding.getRoot());

以上で設定ができました。

サンプルコード

　
ButtonとTextViewを使ったJavaコードのサンプルをView Bindingにしてみます。
　

Android の Button アプリを作ってみると簡単だった

アプリの作り方の基本を習得するために、ボタンを押したら文字が変わるという簡単なアプリを作ってみます。

MainActivity.java

//package com.example.testbuttonviewbinding;

import androidx.appcompat.app.AppCompatActivity;
import android.os.Bundle;
import com.example.testbuttonviewbinding.databinding.ActivityMainBinding;

public class MainActivity extends AppCompatActivity {

    private ActivityMainBinding binding;
    private boolean buttonTap = false;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
//        setContentView(R.layout.activity_main);

        binding = ActivityMainBinding.inflate(getLayoutInflater());
        setContentView(binding.getRoot());

        binding.button.setOnClickListener( v -> {
            // flagがtrueの時
            if (buttonTap) {
                binding.textView.setText(R.string.hello);
                buttonTap = false;
            }
            // flagがfalseの時
            else {
                binding.textView.setText(R.string.world);
                buttonTap = true;
            }
        });
    }
}

//package com.example.testbuttonviewbinding;

import androidx.appcompat.app.AppCompatActivity;

import android.os.Bundle;

import com.example.testbuttonviewbinding.databinding.ActivityMainBinding;

public class MainActivity extends AppCompatActivity {

private ActivityMainBinding binding;

private boolean buttonTap = false;

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

// setContentView(R.layout.activity_main);

binding = ActivityMainBinding.inflate(getLayoutInflater());

setContentView(binding.getRoot());

binding.button.setOnClickListener( v -> {

// flagがtrueの時

if (buttonTap) {

binding.textView.setText(R.string.hello);

buttonTap = false;

}

// flagがfalseの時

else {

binding.textView.setText(R.string.world);

buttonTap = true;

}

});

}

　
activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:padding="20dp"
    tools:context=".MainActivity">

    <TextView
        android:id="@+id/text_view"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="@string/hello"
        android:textSize="50sp"
        android:textColor="#00ff00"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintVertical_bias="0.4" />

    <Button
        android:id="@+id/button"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="@string/button"
        android:textSize="20sp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintVertical_bias="0.6" />

</androidx.constraintlayout.widget.ConstraintLayout>

<?xml version="1.0" encoding="utf-8"?>

<androidx.constraintlayout.widget.ConstraintLayout

xmlns:android="http://schemas.android.com/apk/res/android"

xmlns:app="http://schemas.android.com/apk/res-auto"

xmlns:tools="http://schemas.android.com/tools"

android:layout_width="match_parent"

android:layout_height="match_parent"

android:padding="20dp"

tools:context=".MainActivity">

<TextView

android:id="@+id/text_view"

android:layout_width="wrap_content"

android:layout_height="wrap_content"

android:text="@string/hello"

android:textSize="50sp"

android:textColor="#00ff00"

app:layout_constraintBottom_toBottomOf="parent"

app:layout_constraintLeft_toLeftOf="parent"

app:layout_constraintRight_toRightOf="parent"

app:layout_constraintTop_toTopOf="parent"

app:layout_constraintVertical_bias="0.4" />

<Button

android:id="@+id/button"

android:layout_width="match_parent"

android:layout_height="wrap_content"

android:text="@string/button"

android:textSize="20sp"

app:layout_constraintBottom_toBottomOf="parent"

app:layout_constraintLeft_toLeftOf="parent"

app:layout_constraintRight_toRightOf="parent"

app:layout_constraintTop_toTopOf="parent"

app:layout_constraintVertical_bias="0.6" />

</androidx.constraintlayout.widget.ConstraintLayout>

　
strings.xml

<resources>
    <string name="app_name">TestButtonViewBinding</string>
    <string name="hello">Hello</string>
    <string name="world">World</string>
    <string name="button">Button</string>
</resources>

<string name="app_name">TestButtonViewBinding</string>

<string name="hello">Hello</string>

<string name="world">World</string>

<string name="button">Button</string>

</resources>

　
build.gradle

plugins {
    id 'com.android.application'
}

android {
    ...
    buildFeatures {
        viewBinding true
    }
}

dependencies {
    ...
}

plugins {

id 'com.android.application'

}

android {

...

buildFeatures {

viewBinding true

}

dependencies {

...

}

References:
ビューバインディング – Android Developers
findViewById
BuildFeatures | Android Developers