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去实现。