百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 热门文章 > 正文

一个优雅的 Kotlin 单例封装,解决 object 单例无法传参的问题!

bigegpt 2024-08-28 12:14 7 浏览

一. 序

单例模式是我们在日常编程中,比较常用的设计模式。一个好的单例,必然需要满足唯一性和线程安全性。而 Java 中,关于单例的文章讲解已经很完善了,单例模式已经成为一种编程范式。

在谷歌强推 Kotlin 的今天,不少人使用 Kotlin 时,还带着 Java 的编程思维,并没有有效的利用 Kotlin 的一些特性。如果还用 Java 的编程思想来写 Kotlin 的单例,会有种四不像的感觉。

在 Kotlin 里,想要实现单例模式,只需要将类增加 object 关键字即可,这就是一个线程安全的单例模式,很方便。

但是这存在一个问题,object class 无法实现构造方法,也就是我们无法在初始化的时候,从外部传递一些参数来让这个单例类初始化。

本文就来聊聊 Kotlin 下的单例模式的实现,以及如何优雅的构造一个带参数的单例模式。

二. Kotlin 的单例

2.1 object class 的单例

虽然无法在构造的时候,从外部传递参数,但是 object 关键字依然是 Kotlin 下,最常用的构造单例方法,我们先来了解它的特性。

object 关键字使用起来非常简单,只需要直接作用在 class 上就好。

object SomeSingleton{
 fun sayHi(){}
}

这就是在 Kotlin 下,最简单的单例模式,如果想要有一些初始化的动作,可以放在 init 块中。

object SomeSingleton{
 init{
 // init
 }
 fun sayHi(){}
}

使用方法也非常简单,需要注意的是,在 Kotlin 中调用和 Java 调用存在一些差异。

// Kotlin Language
SomeSingleton.sayHi()
// Java Language
SomeSingleton.INSTANCE.sayHi()

我们知道,Kotlin 和 Java 是可以无缝互通的,而 Kotlin 最终编译的字节码,其实也是可以转成类 Java 的代码。

那我们继续看看 Kotlin 的 object 关键字后,在 Java 中的表现到底如何。通过这种转码的分析,可以便于我们理解 Kotlin 的特性。

借助 AS 的 Tools → Kotlin → Show Kotlin Bytecode,就可以查看 Kotlin 文件的字节码,再点击 Decompile 按钮,就可以将字节码转成 Java 代码

有对比就清晰了,Kotlin 的 object 关键字,在 Java 表现的特点如下:

  1. 为一个 final 类,标记不可变性。
  2. 内部声明一个 static final 的当前类的对象 INSATNCE。
  3. 在静态代码块中,进行 INSTANCE 对象的初始化。

可以看到,在 Kotlin 的 object 中,是使用类的初始化锁来保证线程安全的。

那什么是类的初始化锁?

简单来说, JVM 在类的初始化阶段(即在 Class 被加载后,且被线程使用之前),会执行类的初始化,在初始化期间,JVM 会去获取一个锁。这个锁可以同步多个线程对同一个类的初始化,避免多线程调用时,引发线程安全的问题。

上图很清晰的表明了类的初始化锁的工作流程。

而 Kotlin 中的 object 关键字,就是利用类的初始化锁来保证线程安全的,在我们不需要为单例的初始化传递外部参数的场景下,可以放心使用。

那可能有人担心另一个问题,类加载的时候就初始化构造单例对象,是不是对资源的利用不友好?

这一点问题不大,虚拟机在运行程序的时候,并不是在启动时就将所有的类,都加载进来并初始化完成,而是一种按需加载的策略,在真正使用它的时候,才会初始化。

例如:new Class、调用静态方法、反射、调用 Class.forName() 方法等。这一点可以通过本文介绍的单例实现,在 init 块中输出 Log,看看 Log 何时输出来验证,相关资料很多,就不多说了。

也就是说,通常只有在你真实使用这个类时,它才会真的被虚拟机初始化。当然,不同虚拟机的实现方式不同,这并不是强制的,但是大多数为了性能都会准守此规则。

2.2 传参数的单例

无参单例可以用 object 关键字,但如果想通过一些外部参数初始化单例呢?Kotlin 的 object 是不能有任何构造函数的,所以也无法传递任何参数。

带参单例在 Android 中也是有一些使用场景的,例如 Android 中的 LocalBroadcastManager,就是一个带参的单例模式。

LocalBroadcastManager.getInstance(context).sendBroadcast(intent)

那换个思路想想,在 Java 中,带参数的单例如何实现?通常都会用双重检查锁(Double Checked Locking) + volatile 关键字来解决。

public class DoubleCheckSingleton {
 private volatile static DoubleCheckSingleton sInstance;
 private DoubleCheckSingleton(Context ctx) {
 // init
 }
 public static DoubleCheckSingleton getInstance(Context ctx) {
 if (sInstance == null) {
 synchronized (DoubleCheckSingleton.class) {
 if (sInstance == null) {
 sInstance = new DoubleCheckSingleton(ctx);
 }
 }
 }
 return sInstance;
 }
}

加上 volatile 是为了可见性和禁止重排序,这样就可以保证把参数传递进去的同时,确保线程安全。

不过在 Kotlin 中是没有 volatile 关键字的,取而代之的是 @Volatile 注解,同时需要配合 Kotlin 的伴生对象进行单例模式的构建。

伴生对象可以简单的使用类名作为限定符来调用其方法,类似 Java 中的静态方法。

final class SomeSingleton(context: Context) {
 private val mContext: Context = context
 companion object {
 @Volatile
 private var instance: SomeSingleton? = null
 fun getInstance(context: Context): SomeSingleton {
 val i = instance
 if (i != null) {
 return i
 }
 return synchronized(this) {
 val i2 = instance
 if (i2 != null) {
 i2
 } else {
 val created = SomeSingleton(context)
 instance = created
 created
 }
 }
 }
 }
}

这段代码是直接借鉴的 Kotlin 的 lazy(),lazy 在默认情况下的实现是 SynchronizedLazyImpl,从类名上就能看出来,它使用 synchroinzed 来保证线程安全。

用这样的方式,就可以实现一个可以传参数去构造的单例模式。

2.3 封装一个带参单例

支持传参的单例,我们实现了。但为了实现这个单例,写了 20+ 行代码。每次写单例都要把这一堆代码复制一遍,还挺麻烦,为了使用方便,还可以将其再封装一下。

open class SingletonHolder<out T, in A>(creator: (A) -> T) {
 private var creator: ((A) -> T)? = creator
 @Volatile
 private var instance: T? = null
 fun getInstance(arg: A): T {
 val i = instance
 if (i != null) {
 return i
 }
 return synchronized(this) {
 val i2 = instance
 if (i2 != null) {
 i2
 } else {
 val created = creator!!(arg)
 instance = created
 creator = null
 created
 }
 }
 }
}

用一个支持继承的 open class 加上泛型就可以简单的将其进行封装,此封装方式支持一个参数的构造方法,有需要可以继续扩展或者封装。

class SomeSingleton private constructor(context: Context) {
 init {
 // Init using context argument
 context.getString(R.string.app_name)
 }
 companion object : SingletonHolder<SomeSingleton, Context>(::SomeSingleton)
}

封装成 SingletonHolder 类之后,再想使用单例,关键代码一行就搞定了。

2.4 使用 lazy

前面在介绍带参单例的时候,也提到了lazy(),它是 Kotlin 的一种标准委托,可以接受一个 lambda 并返回一个实例的函数。

如果我们想要延迟初始化,可以使用 lazy() 这个代理来实现,它会在第一次调用 get() 方法时,执行 lazy() 的 lambda 表达式并记录结果,之后再调用 get() 就只会返回之前记录的结果,非常适合延迟初始化的场景。

class SomeSingleton{
 companion object {
 val instance: SomeSingleton by lazy { SomeSingleton() }
 }
}

lazy() 默认情况下,内部就是依赖同步锁(synchronized)来实现的,所以它也是线程安全的。

但是正如我前面提到的,类本身也是按需加载的,调用它的下一步肯定是也需要使用它,所以只要我们正确的使用单例模式,其实没必要使用 lazy(),这里仅做一个介绍,大家知道一下就好了。

三. 小结时刻

本文介绍了在 Kotlin 下,实现单例模式的一些代码技巧,希望对大家有所帮助。最后再简单总结一下。

  1. 无参单例模式,直接使用 Kotlin 的 object 即可,它是依赖类的初始化锁来保证线程安全。
  2. 带参单例模式,可以使用双重检查锁 + @Volatile 来实现,如果嫌麻烦还可以封装成 SingletonHolder。
  3. lazy() 委托确实可以实现延迟加载,但是在单例模式的场景下,不如直接用 object 方便。

本文对你有帮助吗?留言、转发、点赞是最大的支持,谢谢!


在头条号私信我。我会送你一些我整理的学习资料,包含:Android反编译、算法、设计模式、虚拟机、Linux、Kotlin、Python、爬虫、Web项目源码。

相关推荐

当Frida来“敲”门(frida是什么)

0x1渗透测试瓶颈目前,碰到越来越多的大客户都会将核心资产业务集中在统一的APP上,或者对自己比较重要的APP,如自己的主业务,办公APP进行加壳,流量加密,投入了很多精力在移动端的防护上。而现在挖...

服务端性能测试实战3-性能测试脚本开发

前言在前面的两篇文章中,我们分别介绍了性能测试的理论知识以及性能测试计划制定,本篇文章将重点介绍性能测试脚本开发。脚本开发将分为两个阶段:阶段一:了解各个接口的入参、出参,使用Python代码模拟前端...

Springboot整合Apache Ftpserver拓展功能及业务讲解(三)

今日分享每天分享技术实战干货,技术在于积累和收藏,希望可以帮助到您,同时也希望获得您的支持和关注。架构开源地址:https://gitee.com/msxyspringboot整合Ftpserver参...

Linux和Windows下:Python Crypto模块安装方式区别

一、Linux环境下:fromCrypto.SignatureimportPKCS1_v1_5如果导包报错:ImportError:Nomodulenamed'Crypt...

Python 3 加密简介(python des加密解密)

Python3的标准库中是没多少用来解决加密的,不过却有用于处理哈希的库。在这里我们会对其进行一个简单的介绍,但重点会放在两个第三方的软件包:PyCrypto和cryptography上,我...

怎样从零开始编译一个魔兽世界开源服务端Windows

第二章:编译和安装我是艾西,上期我们讲述到编译一个魔兽世界开源服务端环境准备,那么今天跟大家聊聊怎么编译和安装我们直接进入正题(上一章没有看到的小伙伴可以点我主页查看)编译服务端:在D盘新建一个文件夹...

附1-Conda部署安装及基本使用(conda安装教程)

Windows环境安装安装介质下载下载地址:https://www.anaconda.com/products/individual安装Anaconda安装时,选择自定义安装,选择自定义安装路径:配置...

如何配置全世界最小的 MySQL 服务器

配置全世界最小的MySQL服务器——如何在一块IntelEdison为控制板上安装一个MySQL服务器。介绍在我最近的一篇博文中,物联网,消息以及MySQL,我展示了如果Partic...

如何使用Github Action来自动化编译PolarDB-PG数据库

随着PolarDB在国产数据库领域荣膺桂冠并持续获得广泛认可,越来越多的学生和技术爱好者开始关注并涉足这款由阿里巴巴集团倾力打造且性能卓越的关系型云原生数据库。有很多同学想要上手尝试,却卡在了编译数据...

面向NDK开发者的Android 7.0变更(ndk android.mk)

订阅Google官方微信公众号:谷歌开发者。与谷歌一起创造未来!受Android平台其他改进的影响,为了方便加载本机代码,AndroidM和N中的动态链接器对编写整洁且跨平台兼容的本机...

信创改造--人大金仓(Kingbase)数据库安装、备份恢复的问题纪要

问题一:在安装KingbaseES时,安装用户对于安装路径需有“读”、“写”、“执行”的权限。在Linux系统中,需要以非root用户执行安装程序,且该用户要有标准的home目录,您可...

OpenSSH 安全漏洞,修补操作一手掌握

1.漏洞概述近日,国家信息安全漏洞库(CNNVD)收到关于OpenSSH安全漏洞(CNNVD-202407-017、CVE-2024-6387)情况的报送。攻击者可以利用该漏洞在无需认证的情况下,通...

Linux:lsof命令详解(linux lsof命令详解)

介绍欢迎来到这篇博客。在这篇博客中,我们将学习Unix/Linux系统上的lsof命令行工具。命令行工具是您使用CLI(命令行界面)而不是GUI(图形用户界面)运行的程序或工具。lsoflsof代表&...

幻隐说固态第一期:固态硬盘接口类别

前排声明所有信息来源于网络收集,如有错误请评论区指出更正。废话不多说,目前固态硬盘接口按速度由慢到快分有这几类:SATA、mSATA、SATAExpress、PCI-E、m.2、u.2。下面我们来...

新品轰炸 影驰SSD多款产品登Computex

分享泡泡网SSD固态硬盘频道6月6日台北电脑展作为全球第二、亚洲最大的3C/IT产业链专业展,吸引了众多IT厂商和全球各地媒体的热烈关注,全球存储新势力—影驰,也积极参与其中,为广大玩家朋友带来了...