2018.07.30

Android Architecture ComponentsのViewModelを使ってみる

Android Architecture Componentsの背景

Android開発において、近年は、大きな変化が訪れています。

その中でも特に注目したいものが、Android Architecture Components(AAC)です。

AACは、Androidで今まで面倒だったライフサイクルの管理やデータの保持などを扱いやすくするためのライブラリです。

そのAACの中のViewModelについて、今回は紹介したいと思います。

ViewModelの適用手順

それでは、AACのViewModelを実際に使ってみながら、説明していきます。

ViewModelをプロジェクトに導入する

まずは、ViewModelのライブラリを追加していきます

build.gradle (project) にgoogleのリポジトリがなければ、下記のように追加しておきます。

buildscript {
    ・・・
}

allprojects {
    repositories {
        google()
        ・・・
    }
}

次にbuild.gradle (app) に　下記のようにライブラリを追加します。

android {
    ・・・
}
dependencies {
    ・・・
    implementation "android.arch.lifecycle:extensions:1.1.1"
    ・・・
}

これでViewModelが使用できるようになります。

ViewModelを生成する

ライブラリのViewModelを継承したクラスを作成します。
Activityに反映するデータなどは、すべてViewModelで保持するようにします。

import android.arch.lifecycle.ViewModel

class MainViewModel : ViewModel() {
    var name : String  = ""
}

下記のようにViewModelはViewModelProvidersを経由してインスタンスを取得します。

class MainActivity : AppCompatActivity() {

    private lateinit var viewmodel: MainViewModel

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        viewmodel = ViewModelProviders.of(this).get(MainViewModel::class.java)
    }
}

このViewModelProvidersで、ViewModelが管理されています。
ViewModelProviders.of()の引数に渡されたActivityやFragmentに紐付いたViewModelのインスタンスを返してくれます。
この例だとMainActivityを渡していますが、ここに仮に別のFragmentを渡した場合には、別のインスタンスが返されます。

ViewModelの値を画面に反映する

ViewModelのインスタンスを取得した後は、ViewModelに対して、値をセットしたり、取得を行います。
ViewModelの値でViewに反映するように記述していきます。

class MainActivity : AppCompatActivity() {

    private lateinit var viewmodel: MainViewModel

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        viewmodel = ViewModelProviders.of(this).get(MainViewModel::class.java)

        buttonSet.setOnClickListener {
            viewmodel.name = editName.text.toString()
        }

        buttonGet.setOnClickListener {
            textName.text = viewmodel.name
        }
    }
}