Kotlin 单例:对象与具有私有构造函数的类

Mat*_*son 5 singleton kotlin

Google 的向日葵示例应用程序使用带有伴随对象的私有类来实现其存储库的单例模式,而不是简单地将存储库实现为(本质上单例)对象。

这是我第一次看到单例在 Kotlin 中以这种方式实现,而不是作为对象实现。在什么情况下应该使用这个私有构造函数实现而不是更常见的对象实现?

class GardenPlantingRepository private constructor(
  private val gardenPlantingDao: GardenPlantingDao
) {
  suspend fun createGardenPlanting(plantId: String) {
    withContext(IO) {
      val gardenPlanting = GardenPlanting(plantId)
      gardenPlantingDao.insertGardenPlanting(gardenPlanting)
    }
  }

  suspend fun removeGardenPlanting(gardenPlanting: GardenPlanting) {
    withContext(IO) {
      gardenPlantingDao.deleteGardenPlanting(gardenPlanting)
    }
  }

  fun getGardenPlantingForPlant(plantId: String) =

    gardenPlantingDao.getGardenPlantingForPlant(plantId)

  fun getGardenPlantings() = gardenPlantingDao.getGardenPlantings()

  fun getPlantAndGardenPlantings() = gardenPlantingDao.getPlantAndGardenPlantings()

  companion object {
    // For Singleton instantiation
    @Volatile private var instance: GardenPlantingRepository? = null

    fun getInstance(gardenPlantingDao: GardenPlantingDao) =
      instance ?: synchronized(this) {
        instance ?: GardenPlantingRepository(gardenPlantingDao).also { instance = it }
      }
  }
}
Run Code Online (Sandbox Code Playgroud)

zsm*_*b13 3

如果您的单例实例需要参数(就像本例中的 with ),那么使用 anobject是一个问题GardenPlantingDao,因为它们不能接受构造函数参数。这种情况在 Android 上经常出现,因为在很多情况下单例都需要 aContext来操作。

在这些情况下您仍然可以object使用 an ,但它要么不安全,要么不方便:

  • 第一个选项是在使用任何其他方法之前使用 setter 方法为其提供依赖项。这意味着所有其他方法都必须检查依赖项是否已初始化,如果没有初始化,则可能会抛出异常,这会导致运行时问题。
  • 或者,您可能需要任何依赖项作为单例的每个方法的参数,这在调用站点上是乏味的。

因此,使用私有构造函数和工厂方法来实现单例的“传统”方法。