在Kotlin中具有参数的Singleton

我正在尝试将Android应用程序从Java转换为Kotlin。应用中有一些单例。对于没有构造函数参数的单例，我使用了一个伴随对象。还有另一个采用构造函数参数的单例。

Java代码：

public class TasksLocalDataSource implements TasksDataSource {

    private static TasksLocalDataSource INSTANCE;

    private TasksDbHelper mDbHelper;

    // Prevent direct instantiation.
    private TasksLocalDataSource(@NonNull Context context) {
        checkNotNull(context);
        mDbHelper = new TasksDbHelper(context);
    }

    public static TasksLocalDataSource getInstance(@NonNull Context context) {
        if (INSTANCE == null) {
            INSTANCE = new TasksLocalDataSource(context);
        }
        return INSTANCE;
    }
}

我在Kotlin中的解决方案：

class TasksLocalDataSource private constructor(context: Context) : TasksDataSource {

    private val mDbHelper: TasksDbHelper

    init {
        checkNotNull(context)
        mDbHelper = TasksDbHelper(context)
    }

    companion object {
        lateinit var INSTANCE: TasksLocalDataSource
        private val initialized = AtomicBoolean()

        fun getInstance(context: Context) : TasksLocalDataSource {
            if(initialized.getAndSet(true)) {
                INSTANCE = TasksLocalDataSource(context)
            }
            return INSTANCE
        }
    }
}

我有什么想念的吗？线程安全？懒惰？

有一些类似的问题，但我不喜欢答案:)

这是使用该函数的Google体系结构组件示例代码的一种很好的替代方案also：

class UsersDatabase : RoomDatabase() {

    companion object {

        @Volatile private var INSTANCE: UsersDatabase? = null

        fun getInstance(context: Context): UsersDatabase =
            INSTANCE ?: synchronized(this) {
                INSTANCE ?: buildDatabase(context).also { INSTANCE = it }
            }

        private fun buildDatabase(context: Context) =
            Room.databaseBuilder(context.applicationContext,
                    UsersDatabase::class.java, "Sample.db")
                    .build()
    }
}

• Thread-Safe Solution＃Write Once; Use Many;

创建一个实现单例逻辑的类是一个很好的解决方案，该类也包含单例实例，如下所示。

它使用同步块中的Double-Check Locking实例化实例，以消除在多线程环境中出现竞争状况的可能性。

SingletonHolder.kt

open class SingletonHolder<out T, in A>(private val constructor: (A) -> T) {

    @Volatile
    private var instance: T? = null

    fun getInstance(arg: A): T {
        return when {
            instance != null -> instance!!
            else -> synchronized(this) {
                if (instance == null) instance = constructor(arg)
                instance!!
            }
        }
    }
}

• Usage

现在，在要成为单例的每个类中，编写一个companion object扩展上述类的类。SingletonHolder是一个通用类，它接受目标类的类型及其要求的参数作为通用参数。它还需要对用于实例化实例的目标类的构造函数的引用：

class MyManager private constructor(context: Context) {

    fun doSomething() {
        ...
    }

    companion object : SingletonHolder<MyManager, Context>(::MyManager)
}

最后：

MyManager.getInstance(context).doSomething()

我不完全确定您为什么需要这样的代码，但是这是我的最佳选择：

class TasksLocalDataSource private constructor(context: Context) : TasksDataSource {
    private val mDbHelper = TasksDbHelper(context)

    companion object {
        private var instance : TasksLocalDataSource? = null

        fun  getInstance(context: Context): TasksLocalDataSource {
            if (instance == null)  // NOT thread safe!
                instance = TasksLocalDataSource(context)

            return instance!!
        }
    }
}

这类似于您编写的内容，并且具有相同的API。

一些注意事项：

• 不要lateinit在这里使用。它有不同的用途，在这里，可为空的变量是理想的。

• 怎么checkNotNull(context)办？context在这里永远不会为空，这是Kotlin保证的。编译器已经实现了所有检查和断言。

更新：

如果您需要的TasksLocalDataSource只是class的延迟初始化实例，则只需使用一堆惰性属性（在对象内部或在程序包级别）：

val context = ....

val dataSource by lazy {
    TasksLocalDataSource(context)
}

您可以声明Kotlin对象，重载“ invoke”运算符。

object TasksLocalDataSource: TasksDataSource {
    private lateinit var mDbHelper: TasksDbHelper

    operator fun invoke(context: Context): TasksLocalDataSource {
        this.mDbHelper = TasksDbHelper(context)
        return this
    }
}

无论如何，我认为您应该将TasksDbHelper注入TasksLocalDataSource而不是注入上下文

如果您想以更简单的方式将参数传递给单例，我认为这是更好和更短的方法

object SingletonConfig {

private var retrofit: Retrofit? = null
private const val URL_BASE = "https://jsonplaceholder.typicode.com/"

fun Service(context: Context): Retrofit? {
    if (retrofit == null) {
        retrofit = Retrofit.Builder().baseUrl(URL_BASE)
                .addConverterFactory(GsonConverterFactory.create())
                .build()
    }
    return retrofit
}

}

你以这种简单的方式来称呼它

val api = SingletonConfig.Service(this)?.create(Api::class.java)

该方法synchronized()在通用标准库中被标记为已弃用，因此可以选择以下方法：

class MySingleton private constructor(private val param: String) {

    companion object {
        @Volatile
        private var INSTANCE: MySingleton? = null

        @Synchronized
        fun getInstance(param: String): MySingleton = INSTANCE ?: MySingleton(param).also { INSTANCE = it }
    }
}

class CarsRepository(private val iDummyCarsDataSource: IDummyCarsDataSource) {

    companion object {
        private var INSTANCE: CarsRepository? = null
        fun getInstance(iDummyCarsDataSource: IDummyCarsDataSource): CarsRepository {
            if (INSTANCE == null) {
                INSTANCE = CarsRepository(
                    iDummyCarsDataSource = iDummyCarsDataSource)
            }
            return INSTANCE as CarsRepository
        }
    }

}

如果您唯一需要的参数是application Context，则可以像Firebase SDK一样val在a的早期将其初始化为顶层ContentProvider。

由于声明aContentProvider有点麻烦，因此我制作了一个库，该库提供了一个顶级属性appCtx，该属性为所有不需要Activity或其他特殊生命周期绑定上下文的地方命名。

如果要查找具有多个自变量的基本SingletonHolder类。我已经创建了SingletonHolder泛型类，该类仅支持创建具有一个参数，两个参数和三个参数的Singleton类的一个实例。

在这里链接基类的Github

非参数（Kotlin的默认值）：

object AppRepository 

一个参数（来自上面链接中的示例代码）：

class AppRepository private constructor(private val db: Database) {
    companion object : SingleArgSingletonHolder<AppRepository, Database>(::AppRepository)
}
// Use
val appRepository =  AppRepository.getInstance(db)

两个参数：

class AppRepository private constructor(private val db: Database, private val apiService: ApiService) {
    companion object : PairArgsSingletonHolder<AppRepository, Database, ApiService>(::AppRepository)
}
// Use
val appRepository =  AppRepository.getInstance(db, apiService)

三个论点：

class AppRepository private constructor(
   private val db: Database,
   private val apiService: ApiService,
   private val storage : Storage
) {
   companion object : TripleArgsSingletonHolder<AppRepository, Database, ApiService, Storage>(::AppRepository)
}
// Use
val appRepository =  AppRepository.getInstance(db, apiService, storage)

超过3个参数：

为了实现这种情况，我建议创建一个配置对象以传递给单例构造函数。

懒惰的解决方案

class LateInitLazy<T>(private var initializer: (() -> T)? = null) {

    val lazy = lazy { checkNotNull(initializer) { "lazy not initialized" }() }

    fun initOnce(factory: () -> T) {
        initializer = factory
        lazy.value
        initializer = null
    }
}

val myProxy = LateInitLazy<String>()
val myValue by myProxy.lazy

println(myValue) // error: java.lang.IllegalStateException: lazy not inited

myProxy.initOnce { "Hello World" }
println(myValue) // OK: output Hello World

myProxy.initOnce { "Never changed" } // no effect
println(myValue) // OK: output Hello World

我看到了所有答案。我知道这是一个重复的答案，但是如果我们在方法声明中使用synced关键字，它将把整个方法同步到对象或类。并且尚未弃用同步块。

您可以使用以下实用程序类来获取单例行为。

open class SingletonWithContextCreator<out T : Any>(val creator: (Context) -> T) {
    @Volatile
    private var instance: T? = null

    fun with(context: Context): T = instance ?: synchronized(this) {
        instance ?: creator(context).apply { instance = this }
    }
}

您可以扩展上述类，使其成为单例。

在您的情况下，以下是使TasksLocalDataSource类单例的代码。

companion object : SingletonWithContextCreator<TasksDataSource>(::TasksLocalDataSource)

Singletons

单例经常被使用，以创建它们的简单方法。Kotlin使用对象表示法，而不是通常的静态实例，getInstance（）方法和私有构造函数。为了保持一致性，对象符号还用于定义静态方法。

 object CommonApiConfig {
private var commonApiConfig: CommonApiConfig? = null
fun getInstance(): CommonApiConfig {
    if (null == commonApiConfig) {
        commonApiConfig = CommonApiConfig
       }
    return CommonApiConfig.commonApiConfig!!
   }
}