2023/9/14

【Kotlin/Android Studio】Companion objectとは？staticなシングルトン

この記事からわかること

Android Studio/KotlinでCompanion objectの使い方
シングルトンオブジェクトの作成方法
staticな構造の作り方

index

[open]

Companion objectsとは？
シングルトンの使用例

＼アプリをリリースしました／

友達や家族の誕生日をメモ！通知も届く-みんなの誕生日-

posted withアプリーチ

参考文献：公式リファレンス：Companion objects

環境

Android Studio：Flamingo
Kotlin：1.8.20

Companion objectsとは？

KotlinのCompanion objectsとはクラス内で静的なメンバー変数やメソッドを定義するためのオブジェクトです。Companion objectsで定義されたオブジェクトはシングルトンになり、アプリ内でインスタンスは1つだけになります。実装するにはcompanion objectキーワードを付与するだけです。

これはJavaやSwiftでいうstaticと同じような振る舞いをします。

クラス内ではCompanion objectは1クラス内に1つだけしか定義できません。クラス内など関係なくシングルトンを実装できるobjectキーワードであればクラス内でも複数定義することが可能です。

class Database {
    
    object Info {
        const val capacity = 10
    }
    
    companion object {
        fun create(): Database {
            return Database()
        }
    }
}

Companion objectとobjectの違いはアクセスする際に現れます。objectにはオブジェクト名を付与する必要があり、アクセスする際もオブジェクト名を挟む必要があります。一方Companion objectでは名前を省略することができるのでDatabase直下の静的プロパティや静的メソッドのようにアクセスすることができます。

val capacity = Database.Info.capacity
var instance = Database.create()

もちろん名前をつけることも可能です。

companion object Factory {
    fun create(): Database {
        return Database()
    }
}

その場合は以下のどちらでもアクセス可能です。

var instance = Database.create()
var instance = Database.Factory.create()

ちなみにインスタンス化用のcreateメソッドのようなデザインパターンをFactory Methodと呼びます。

シングルトンの使用例

Androidで使用できるローカルデータベースライブラリのRoomでもUserDatabaseクラスをシングルトンで実装するために以下のように実装することがあります。このようにシングルトンにすることで定型的なインスタンス化時の設定などを仕込むことができます。

@Database(entities = [User::class], version = 1, exportSchema = false)
abstract class UserDatabase : RoomDatabase() {
    abstract fun userDao(): UserDao

    companion object {
        @Volatile
        private var INSTANCE: UserDatabase? = null
        fun getDatabase(context: Context): UserDatabase {
            return INSTANCE ?: synchronized(this) {
                val instance = Room.databaseBuilder(
                    context.applicationContext,
                    UserDatabase::class.java,
                    "user_database"
                )
                    .fallbackToDestructiveMigration()
                    .build()
                INSTANCE = instance
                return instance
            }
        }
    }
}