[kotlin]kotlin中的伴生对象(companion object)到底是个什么东西?

写在前面

写作不易,转载注明出处:
https://blog.csdn.net/qq_34676644/article/details/119178392
或者我同步更新的简书博客:
https://www.jianshu.com/p/ddfed1df606c

相信初学kotlin的人,对与kotlin中的companion object会有疑惑,也有不少人将这个东西当作java的静态来使用,今天就来扒一扒到底什么是companion object

话不多说,直接上例子,注:以下测试基于kotlin 211-1.4.32-release-IJ7628.19版本

第一步,写出kotlin代码


class SingleInstance {

    companion object {
        var num1 = 10
        val num2 = 11

        @JvmStatic
        var num3 = 12

        @JvmStatic
        val num4 = 13

        fun test1() {
            println("test1")
        }

        @JvmStatic
        fun test2() {
            println("test2")
        }
    }
}

companion object中定义了2个变量:num1num3,两个常量:num2num4,同时定义了两个方法:test1()test2()。其中:num3num4test2()@JvmStatic修饰

第二步,转成Java代码

InterIj IDEA中的tools->Kotlin->show Kotlin Bytecode可以查看kotlin代码的字节码

kotlin字节码

然后点击字节码右上角的Decompile可以将字节码转为java代码,如图
java代码

第三步,查看java代码

public final class SingleInstance {
   private static int num1 = 10;
   private static final int num2 = 11;
   private static int num3 = 12;
   private static final int num4 = 13;
   @NotNull
   public static final SingleInstance.Companion Companion = new SingleInstance.Companion((DefaultConstructorMarker)null);

   public static final int getNum3() {
      SingleInstance.Companion var10000 = Companion;
      return num3;
   }

   public static final void setNum3(int var0) {
      SingleInstance.Companion var10000 = Companion;
      num3 = var0;
   }

   public static final int getNum4() {
      SingleInstance.Companion var10000 = Companion;
      return num4;
   }

   @JvmStatic
   public static final void test2() {
      Companion.test2();
   }

   @Metadata(
      mv = {1, 4, 2},
      bv = {1, 0, 3},
      k = 1,
      d1 = {"\u0000\u001c\n\u0002\u0018\u0002\n\u0002\u0010\u0000\n\u0002\b\u0002\n\u0002\u0010\b\n\u0002\b\u000e\n\u0002\u0010\u0002\n\u0002\b\u0002\b\u0086\u0003\u0018\u00002\u00020\u0001B\u0007\b\u0002¢\u0006\u0002\u0010\u0002J\u0006\u0010\u0012\u001a\u00020\u0013J\b\u0010\u0014\u001a\u00020\u0013H\u0007R\u001a\u0010\u0003\u001a\u00020\u0004X\u0086\u000e¢\u0006\u000e\n\u0000\u001a\u0004\b\u0005\u0010\u0006\"\u0004\b\u0007\u0010\bR\u0014\u0010\t\u001a\u00020\u0004X\u0086D¢\u0006\b\n\u0000\u001a\u0004\b\n\u0010\u0006R$\u0010\u000b\u001a\u00020\u00048\u0006@\u0006X\u0087\u000e¢\u0006\u0014\n\u0000\u0012\u0004\b\f\u0010\u0002\u001a\u0004\b\r\u0010\u0006\"\u0004\b\u000e\u0010\bR\u001c\u0010\u000f\u001a\u00020\u00048\u0006X\u0087D¢\u0006\u000e\n\u0000\u0012\u0004\b\u0010\u0010\u0002\u001a\u0004\b\u0011\u0010\u0006¨\u0006\u0015"},
      d2 = {"Ldesign_pattern/singleInstance/SingleInstance$Companion;", "", "()V", "num1", "", "getNum1", "()I", "setNum1", "(I)V", "num2", "getNum2", "num3", "getNum3$annotations", "getNum3", "setNum3", "num4", "getNum4$annotations", "getNum4", "test1", "", "test2", "leetcode2"}
   )
   public static final class Companion {
      public final int getNum1() {
         return SingleInstance.num1;
      }

      public final void setNum1(int var1) {
         SingleInstance.num1 = var1;
      }

      public final int getNum2() {
         return SingleInstance.num2;
      }

      /** @deprecated */
      // $FF: synthetic method
      @JvmStatic
      public static void getNum3$annotations() {
      }

      public final int getNum3() {
         return SingleInstance.num3;
      }

      public final void setNum3(int var1) {
         SingleInstance.num3 = var1;
      }

      /** @deprecated */
      // $FF: synthetic method
      @JvmStatic
      public static void getNum4$annotations() {
      }

      public final int getNum4() {
         return SingleInstance.num4;
      }

      public final void test1() {
         String var1 = "test1";
         boolean var2 = false;
         System.out.println(var1);
      }

      @JvmStatic
      public final void test2() {
         String var1 = "test2";
         boolean var2 = false;
         System.out.println(var1);
      }

      private Companion() {
      }

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

第四步、得出结论

1.companion object的作用

使用 companion object会在原类中生成一个内部类public static final class Companion,同时在原类中创建这个内部类的对象 (这么看,伴生对象是不是就理解了)

2. 写在companion object中的变量和方法

  • 变量全部定义在原类中,例如上面的kotlin代码中的变量转成java是:
   private static int num1 = 10;
   private static final int num2 = 11;
   private static int num3 = 12;
   private static final int num4 = 13;

并且会在内部类中自动生成变量的get/set方法,val变量没有set方法

      public final int getNum1() {
         return SingleInstance.num1;
      }

      public final void setNum1(int var1) {
         SingleInstance.num1 = var1;
      }

      public final int getNum2() {
         return SingleInstance.num2;
      }
...
  • 方法全部定义在内部类中,修饰符是public final :
     public final void test1() {
         String var1 = "test1";
         boolean var2 = false;
         System.out.println(var1);
      }

      @JvmStatic
      public final void test2() {
         String var1 = "test2";
         boolean var2 = false;
         System.out.println(var1);
      }

3. 被@JvmStatic修饰的变量和方法

  • 变量:在原类中生成get/set静态方法
    • 注意:此时原类内部类都有该变量的get/set方法。
      • 区别:原类中的是静态方法,内部类中的是非静态方法
      • 联系:无
  • 方法:在原类中生成对应的静态方法
    • 注意:此时原类内部类都有该方法
      • 区别:原类中的是静态方法,内部类中的是非静态方法。
      • 联系:在原类的静态方法中调用了内部类的非静态方法
 @JvmStatic
   public static final void test2() {
      //Companion是内部类的对象
      Companion.test2();
   }

以上测试基于kotlin 211-1.4.32-release-IJ7628.19版本

推荐阅读更多精彩内容