Kotlin中companion、object、扩展函数、顶层函数的最佳使用

记录一下初学kotlin时的一些疑惑。
当我们需要添加属于类的常量或者方法时,通常我们需要在java中使用static关键字,而kotlin中去掉了static并且没有提供对应得关键字,那我们该如何在kotlin中实现呢?

  • companion伴生对象
  • object class
  • 扩展函数
  • 顶层方法和属性等

实现的方式多种多样,各自的使用场景是什么呢?其实只要将相关的代码和“翻译”成对应得java代码或者看一下在java中如何调用对应得kotlin属性或者方法,就可以很清楚的看出来其使用场景了。

1. companion伴生对象

//kotlin实现代码
class CompanionTest {
    companion object {
        const val TAG = "this is a static message"
        fun testFunction() {}
    }
}
//对应的java代码
public final class CompanionTest {
   @NotNull
   public static final String TAG = "this is a static message";
   public static final Test.Companion Companion = new Test.Companion((DefaultConstructorMarker)null);

   public static final class Companion {
      public final void testFunction() {
      }

      private Companion() {
      }

      // $FF: synthetic method
      public Companion(DefaultConstructorMarker $constructor_marker) {
         this();
      }
   }
}

可以看到在Java中companion其实是一个名为Companion的静态内部类,并且在外部类中生成一个该内部类的实例。在java中调用则用如下方式:

String test = Test.TAG;
CompanionTest.Companion.testFunction();

2. object关键字

//kotlin中的object实现
object ObjectTest {
    const val TAG = "this is a static message"
    fun testFunction() {}
}
//对应的java代码
public final class ObjectTest {
   @NotNull
   public static final String TAG = "this is a static message";
   public static final ObjectTest INSTANCE;

   public final void testFunction() {
   }

   static {
      ObjectTest var0 = new ObjectTest();
      INSTANCE = var0;
   }
}

可以看到object的实现和java中的饿汉式单例是一致的,在类加载的时候即生成一个该类的实例。companion则是在类加载的时候实现一个静态内部类的实例,严格来说这两种实现方法并不是java中的静态方法。

String objectStr = ObjectTest.TAG;
ObjectTest.INSTANCE.testFunction();

3. 扩展函数

//kotlin中的扩展函数
fun String?.testFunction() {}
//对应的java代码
public final class ExtendTestKt {
   public static final void testFunction(@Nullable String $receiver) {
   }
}

扩展方法和我们java中常用的static方法是比较相似的,只是会将调用的对象作为方法的参数。另外如果kotlin file会生成对应得kotlinFileNameKT的class,如果不想使用默认的名字可以在kotlin中使用 @file:JvmName("StringUtil") 注解指定生成的类名。

//使用上面的注解后在java中调用该扩展方法
StringUtil.testFunction("");

4.顶层函数和顶层属性

//kotlin顶层函数和属性
const val CONSTANT_STRING = "test string"
val VAL_STRING = "test string"
fun testFunction() {}
//对应的java代码
public final class TopTestKt {
   @NotNull
   public static final String CONSTANT_STRING = "test string";
   @NotNull
   private static final String VAL_STRING = "test string";

   @NotNull
   public static final String getVAL_STRING() {
      return VAL_STRING;
   }

   public static final void testFunction() {
   }
}

顶层函数的使用和java中类方法的定义是一模一样的。

TopTestKt.getVAL_STRING();
String topStr = TopTestKt.CONSTANT_STRING;
TopTestKt.testFunction();

这里插入一个const的分析,可以看到加了const关键字会被编译成public static final的常量,而不加的话则是private static final并且生成一个get方法供外部使用。
另外const val必须是编译时常量,而val则没有这个要求,如下图


Screen Shot 2019-02-19 at 16.27.21.png

总结

对于常量的声明,几种方法最后的效果都是一致的。加上const更加符合java通常的写法,并且可以减少不必要的方法。
对于方法,如果想达到java中static function的效果,使用扩展函数或者顶层函数更好。使用companion会额外的生成内部类对象,只有在确定需要使用单例时才使用object去实现。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容