データ反映も自動化できるデータバインディング
前節で紹介したビューバインディングを利用することで、画面部品の取得コードから解放され、バンディングオブジェクトを通じて画面部品へアクセスできるようになりました。ただし、まだ、バンディングオブジェクトを通して画面部品へのデータの反映やリスナの設定を手動で行わないといけない問題が残っています。これらの問題を解決するのがデータバインディングです。
データバインディングの利用設定
ビューバインディング同様、データバインディングもその利用設定を行う必要があります。この設定は、リスト3と同様に、build.gradle.kts(Module: app)のandroidブロックへのbuildFeaturesブロックの追記です。ただし、そのプロパティは、リスト8のようにdataBindingです。
android {
:
buildFeatures {
dataBinding = true
}
}
バインドするデータをレイアウトxmlに設定
データバインディングの特徴は、画面部品に反映させるデータを、レイアウトxmlファイルに設定し、そのデータの反映コードもレイアウトxmlに記述することです。これは、リスト9のようなコードになります。
<?xml version="1.0" encoding="utf-8"?>
<layout (1)
xmlns:android="http://schemas.android.com/apk/res/android"
…>
<data> (2)
<variable name="randNum" type="String" /> (3)
</data>
<androidx.constraintlayout.widget.ConstraintLayout (4)
…>
:
<TextView
android:id="@+id/tvRand"
:
android:text="@{randNum}"/> (5)
:
</androidx.constraintlayout.widget.ConstraintLayout>
</layout>
本来、レイアウトxmlファイルは、リスト9の（4）のようなConstraintLayoutやLinearLayoutなどで開始されています。データバインディングを利用する場合は、それらの本来の画面レイアウトタグを、さらに（1）のlayoutタグでラップします。
そして、そのlayoutタグと本来の画面レイアウトタグの間に、（2）のようにdataタグを記述し、この画面で利用する「変数」を定義します。この定義は、（3）のようにvariableタグで行い、name属性に画面の変数名、つまり、データ名を、typeにそのデータ型を記述します。リスト9の（3）では、String型のrandNum変数を定義しています。
そして、一度、このように定義した変数は、そのレイアウトxmlファイル内では、@{ }の形式で呼び出すことができます。それが、（5）です。（5）では、android:text属性としてこのrandNum変数の値を指定することで、アクティビティから渡されたデータが自動的に、tvRandのTextViewに表示されることになります。後述するように、アクティビティ側では、findViewById()で画面部品を取得する必要もなければ、バインディングオブジェクトを通じて該当画面部品に対してデータをセットする必要もありません。
アクティビティでのバインディングオブジェクトの用意
ビューバインディング同様に、データバインディングも、リスト8の設定を行なった上で、リスト9のようなコードをレイアウトxmlに記述することで、自動的にバインディングクラスが定義されています。よってアクティビティでは、バインディングオブジェクトを取得し、そのオブジェクトに対して操作を行なっていきます。これは、Javaではリスト10のようなコードとなります。
private ActivityMainBinding _activityMainBinding; // (1)
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
_activityMainBinding = DataBindingUtil.setContentView(MainActivity.this, R.layout.activity_main); // (2)
:
_activityMainBinding.setRandNum(_mainViewModel.getRandNumStr()); // (3)
_activityMainBinding.btnRand.setOnClickListener(new ButtonClickListener()); // (4)
}
データバインディングを利用する際も、そのバインディングオブジェクトの命名規則は、ビューバインディング同様です。したがって、リスト10のように、activity_main.xmlに記述したバインディングクラスは、（1）のように、ActivityMainBindingとなり、これも、ビューバインディング同様に、フィールドとして保持しています。
そして、このバインディングオブジェクトの取得コードが（2）です。実は、データバインディングも、ビューバインディングと同様に以下のコードを記述しても問題ありません。
_activityMainBinding = ActivityMainBinding.inflate(getLayoutInflater()); View contentView = _activityMainBinding.getRoot(); setContentView(contentView);
一方で、この3行をまとめて行なってくれるコードが、（2）です。DataBindingUtilのsetContentView()メソッドを実行し、第1引数にアクティビティオブジェクトを、第2引数に該当レイアウトxmlファイルのR値を渡します。
画面へのデータの反映はバインディングオブジェクトに直接セット
ここまでは、ビューバインディングとあまり変わりません。それが証拠に、リスト10の（4）のように、画面部品であるボタンのbtnRandに対してリスナを設定するコードは、リスト4の（6）と全く同じです。
一方、データを反映させるコードが全く違います。データの反映は、リスト9のレイアウトxmlでの画面変数の定義、および、その反映コードがすでに定義されているので、アクティビティでは、その変数に対して値を格納するコードを記述するだけです。それが、リスト10の（3）です。レイアウトxmlのdataタグ内のvariableタグで画面変数を定義すると、その画面変数に該当するアクセサメソッドが自動的にバインディングオブジェクト内に定義されます。そこで、そのセッタに対して値を格納するだけで、自動的に画面に反映されるようになります。
なお、Kotlinコードでも、同様で、リスト10をKotlinに置き換えたコードとなります。
private lateinit var _activityMainBinding: ActivityMainBinding // (1)
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState);
_activityMainBinding = DataBindingUtil.setContentView(this@MainActivity, R.layout.activity_main) // (2)
:
_activityMainBinding.randNum = _mainViewModel.getRandNumStr() // (3)
_activityMainBinding.btnRand.setOnClickListener(ButtonClickListener()) // (4)
}
フラグメントでの利用
アクティビティでは、リスト10やリスト11のようにDataBindingUtilのsetContentView()メソッドが利用できますが、フラグメントでは、このコードは利用できません。そこで、ビューバインディング同様に、リスト6やリスト7のコードのように、バインディングオブジェクトのinflate()メソッドを利用して、その戻り値をonCreateView()の戻り値とするコードとなります。この点は注意しておいてください。
まとめ
Android Jetpackについて紹介していく本連載の第6回は、いかがでしたでしょうか。
今回は、画面部品へのアクセスを効率よく行える、ビューバインディングとその上位互換に当たるデータバインディングを紹介しました。
そのデータバインディングに関して、今回のリスト10やリスト11では、リスナの設定コードとして、ビューバインディングと同様の方法をとっています。これが、本来もっと洗練された方法が可能です。その辺りも含めて、次回は、データバインディングを掘り下げていきます。
