Kotlin Singletons:对象与具有私有构造函数的 Class

Kotlin Singletons: Object vs a Class with private constructor

sunflower example app by Google 使用带有伴随对象的私有 Class 来实现其存储库的单例模式,而不是简单地将存储库实现为(固有的单例)对象。

这是我第一次看到单例在 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 }
      }
  }
}

如果您的单例实例需要参数,那么使用 object 是一个问题,就像在本例中使用 GardenPlantingDao,因为它们不能接受构造函数参数。这在 Android 上经常出现,因为在许多情况下,单例需要 Context 才能运行。

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

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

因此 "traditional" 使用私有构造函数和工厂方法实现单例的方法。