[译] Kotlin中关于Companion Object的那些事

一时失言乱红尘 2022-02-21 13:28 302阅读 0赞

**翻译说明:**

**原标题: A few facts about Companion objects**

**原文地址: [https://blog.kotlin-academy.com/a-few-facts-about-companion-objects-37e18429b725][https_blog.kotlin-academy.com_a-few-facts-about-companion-objects-37e18429b725]\]([https://blog.kotlin-academy.com/a-few-facts-about-companion-objects-37e18429b725][https_blog.kotlin-academy.com_a-few-facts-about-companion-objects-37e18429b725])**

**原文作者: [David Blanc][]**

Kotlin给Java开发者带来最大改变之一就是废弃了`static`修饰符。与Java不同的是在Kotlin的类中不允许你声明静态成员或方法。相反，你必须向类中添加Companion对象来包装这些静态引用: 差异看起来似乎很小，但是它有一些明显的不同。

![16a0657792331996_w_515_h_235_f_png_s_61998][]

首先，companion伴生对象是个实际对象的单例实例。你实际上可以在你的类中声明一个单例，并且可以像companion伴生对象那样去使用它。**这就意味着在实际开发中，你不仅仅只能使用一个静态对象来管理你所有的静态属性!** `companion`这个关键字实际上只是一个快捷方式，允许你通过类名访问该对象的内容(如果伴生对象存在一个特定的类中，并且只是用到其中的方法或属性名称，那么伴生对象的类名可以省略不写)。就编译而言，下面的`testCompanion（）`方法中的三行都是有效的语句。

class TopLevelClass {
        
    
        companion object {
        
            fun doSomeStuff() {
        
                ...
            }
        }
    
        object FakeCompanion {
        
            fun doOtherStuff() {
        
                ...
            }
        }
    }
    
    fun testCompanion() {
        
        TopLevelClass.doSomeStuff()
        TopLevelClass.Companion.doSomeStuff()
        TopLevelClass.FakeCompanion.doOtherStuff()
    }

为了兼容的公平性，`companion`关键字还提供了更多选项，尤其是与Java互操作性相关选项。果您尝试在Java类中编写相同的测试代码，调用方式可能会略有不同：

public void testCompanion() {
        
        TopLevelClass.Companion.doSomeStuff();
        TopLevelClass.FakeCompanion.INSTANCE.doOtherStuff();
    }

区别在于: Companion作为Java代码中静态成员开放(实际上它是一个对象实例，但是由于它的名称是以大写的`C`开头，所以有点存在误导性)，而FakeCompanion引用了我们的第二个单例对象的类名。在第二个方法调用中，我们需要使用它的`INSTANCE`属性来实际访问Java中的实例(你可以打开IntelliJ IDEA或AndroidStudio中的"Show Kotlin Bytecode"菜单栏，并点击里面"Decompile"按钮来查看反编译后对应的Java代码)

在这两种情况下(不管是Kotlin还是Java)，使用伴生对象`Companion`类比`FakeCompanion`类那种调用语法更加简短。此外，由于Kotlin提供一些注解，可以让编译器生成一些简短的调用方式，以便于在Java代码中依然可以像在Kotlin中那样简短形式调用。

**@JvmField**注解，例如告诉编译器不要生成`getter`和`setter`,而是生成Java中成员。在伴生对象的作用域内使用该注解标记某个成员，它产生的副作用是标记这个成员不在伴生对象内部作用域，而是作为一个Java最外层类的静态成员存在。从Kotlin的角度来看，这没有什么太大区别，但是如果你看一下反编译的字节代码，你就会注意到伴生对象以及他的成员都声明和最外层类的静态成员处于同一级别。

另一个有用的注解 **@JvmStatic**.这个注解允许你调用伴生对象中声明的方法就像是调用外层的类的静态方法一样。但是需要注意的是：在这种情况下，方法不会和上面的成员一样移出伴生对象的内部作用域。因为编译器只是向外层类中添加一个**额外的静态方法**，然后在该方法内部又委托给伴生对象。

一起来看一下这个简单的Kotlin类例子:

class MyClass {
        
        companion object {
        
            @JvmStatic
            fun aStaticFunction() {
        }
        }
    }

这是相应编译后的Java简化版代码:

public class MyClass {
        
        public static final MyClass.Companion Companion = new MyClass.Companion();
        fun aStaticFunction() {
        //外层类中添加一个额外的静态方法
            Companion.aStaticFunction();//方法内部又委托给伴生对象的aStaticFunction方法
        }
        public static final class Companion {
        
             public final void aStaticFunction() {
        }
        }
    }

这里存在一个非常细微的差别，但在某些特殊的情况下可能会出问题。例如，考虑一下Dagger中的module(模块)。当定义一个Dagger模块时，你可以使用静态方法去提升性能，但是如果你选择这样做，如果您的模块包含静态方法以外的任何内容，则编译将失败。由于Kotlin在类中既包含静态方法，也保留了静态伴生对象，因此无法以这种方式编写仅仅包含静态方法的Kotlin类。

但是不要那么快放弃! 这并不意味着你不能这样做，只是它需要一个稍微不同的处理方式：在这种特殊的情况下，**你可以使用Kotlin单例(使用object对象表达式而不是class类)替换含有静态方法的Java类并在每个方法上使用@JvmStatic注解**。如下例所示：在这种情况下，生成的字节代码不再显示任何伴生对象，静态方法会附加到类中。

@Module
    object MyModule {
        
    
        @Provides
        @Singleton
        @JvmStatic
        fun provideSomething(anObject: MyObject): MyInterface {
        
            return myObject
        }
    }

这又让你再一次明白了伴生对象仅仅是单例对象的一个特例。但它至少表明与许多人的认知是相反的，**你不一定需要一个伴生对象来维护静态方法或静态变量**。你甚至根本不需要一个对象来维护，只要考虑顶层函数或常量：它们将作为静态成员被包含在一个自动生成的类中(默认情况下，例如MyFileKt会作为MyFile.kt文件生成的类名，一般生成类名以Kt为后缀结尾)

我们有点偏离这篇文章的主题了，所以让我们继续回到伴生对象上来。现在你已经了解了伴生对象实质就是对象，也应该意识到它开放了更多的可能性，例如继承和多态。

这意味着你的伴生对象并不是没有类型或父类的匿名对象。**它不仅可以拥有父类，而且它甚至可以实现接口以及含有对象名**。它不需要被称为companion。这就是为什么你可以这样写一个Parcelable类：

class ParcelableClass() : Parcelable {
        
    
        constructor(parcel: Parcel) : this()
    
        override fun writeToParcel(parcel: Parcel, flags: Int) {
        }
    
        override fun describeContents() = 0
    
        companion object CREATOR : Parcelable.Creator<ParcelableClass> {
        
            override fun createFromParcel(parcel: Parcel): ParcelableClass = ParcelableClass(parcel)
    
            override fun newArray(size: Int): Array<ParcelableClass?> = arrayOfNulls(size)
        }
    }

这里, 伴生对象名为CREATOR，它实现了Android中的Parcelable.Creator接口，允许遵守Parcelable约定，同时保持比使用@JvmField注释在伴随对象内添加Creator对象更直观。Kotlin中引入了@Parcelize注解，以便于可以获得所有样板代码，但是在这不是重点…

为了使它变得更简洁，如果你的伴生对象可以实现接口，它甚至可以使用Kotlin中的代理来执行此操作：

class MyObject {
        
        companion object : Runnable by MyRunnable()
    }

这将允许您同时向多个对象中添加静态方法！请注意，伴生对象在这种情况下甚至不需要作用域体，因为它是由代理提供的。

最后但同样重要的是，你可以为伴生对象定义扩展函数! 这就意味着你可以在现有的类中添加静态方法或静态属性，如下例所示:

class MyObject {
        
    
        companion object
    
        fun useCompanionExtension() {
        
            someExtension()
        }
    
    }
    
    fun MyObject.Companion.someExtension() {
        }//定义扩展函数

这样做有什么意义？我真的不知道。虽然Marcin Moskala建议使用此操作将静态工厂方法以Companion的扩展函数的形式添加到类中。

总而言之，伴生对象不仅仅是为了给缺少`static`修饰符的使用场景提供解决方案:

*  它们是真正的Kotlin对象，包括名称和类型，以及一些额外的功能。
 *  他们甚至可以不用于仅仅为了提供静态成员或方法场景。可以有更多其他选择，比如他们可以用作单例对象或替代顶层函数的功能。

与大多数场景一样，Kotlin意味着在你设计过程需要有一点点转变，但与Java相比，它并没有真正限制你的选择。如果有的话，也会通过提供一些新的、更简洁的方式让你去使用它。

![1635c3fb0ba21ec1_w_430_h_430_f_jpeg_s_39536][]

**欢迎关注Kotlin开发者联盟，这里有最新Kotlin技术文章，每周会不定期翻译一篇Kotlin国外技术文章。如果你也喜欢Kotlin，欢迎加入我们~~~**

### Kotlin系列文章，欢迎查看: ###

> Kotlin邂逅设计模式系列:

*  **[当Kotlin完美邂逅设计模式之单例模式(一)][Kotlin]**

> 数据结构与算法系列:

*  **[每周一算法之二分查找(Kotlin描述)][Kotlin 1]**

> Kotlin 原创系列：

*  **[教你如何完全解析Kotlin中的类型系统][Kotlin 2]**
 *  **[如何让你的回调更具Kotlin风味][Kotlin 3]**
 *  **[Jetbrains开发者日见闻(三)之Kotlin1.3新特性(inline class篇)][Jetbrains_Kotlin1.3_inline class]**
 *  **[JetBrains开发者日见闻(二)之Kotlin1.3的新特性(Contract契约与协程篇)][JetBrains_Kotlin1.3_Contract]**
 *  **[JetBrains开发者日见闻(一)之Kotlin/Native 尝鲜篇][JetBrains_Kotlin_Native]**
 *  **[教你如何攻克Kotlin中泛型型变的难点(实践篇)][Kotlin 4]**
 *  **[教你如何攻克Kotlin中泛型型变的难点(下篇)][Kotlin 5]**
 *  **[教你如何攻克Kotlin中泛型型变的难点(上篇)][Kotlin 6]**
 *  **[Kotlin的独门秘籍Reified实化类型参数(下篇)][Kotlin_Reified]**
 *  **[有关Kotlin属性代理你需要知道的一切][Kotlin 7]**
 *  **[浅谈Kotlin中的Sequences源码解析][Kotlin_Sequences]**
 *  **[浅谈Kotlin中集合和函数式API完全解析-上篇][Kotlin_API_-]**
 *  **[浅谈Kotlin语法篇之lambda编译成字节码过程完全解析][Kotlin_lambda]**
 *  **[浅谈Kotlin语法篇之Lambda表达式完全解析][Kotlin_Lambda]**
 *  **[浅谈Kotlin语法篇之扩展函数][Kotlin 8]**
 *  **[浅谈Kotlin语法篇之顶层函数、中缀调用、解构声明][Kotlin 9]**
 *  **[浅谈Kotlin语法篇之如何让函数更好地调用][Kotlin 10]**
 *  **[浅谈Kotlin语法篇之变量和常量][Kotlin 11]**
 *  **[浅谈Kotlin语法篇之基础语法][Kotlin 12]**

> Effective Kotlin翻译系列

*  **[\[译\]Effective Kotlin系列之考虑使用原始类型的数组优化性能(五)][Effective Kotlin]**
 *  **[\[译\]Effective Kotlin系列之使用Sequence来优化集合的操作(四)][Effective Kotlin_Sequence]**
 *  **[\[译\]Effective Kotlin系列之探索高阶函数中inline修饰符(三)][Effective Kotlin_inline]**
 *  **[\[译\]Effective Kotlin系列之遇到多个构造器参数要考虑使用构建器(二)][Effective Kotlin 1]**
 *  **[\[译\]Effective Kotlin系列之考虑使用静态工厂方法替代构造器(一)][Effective Kotlin 2]**

> 翻译系列：

*  **[\[译\]记一次Kotlin官方文档翻译的PR(内联类)][Kotlin_PR]**
 *  **[\[译\]Kotlin中内联类的自动装箱和高性能探索(二)][Kotlin 13]**
 *  **[\[译\]Kotlin中内联类(inline class)完全解析(一)][Kotlin_inline class]**
 *  **[\[译\]Kotlin的独门秘籍Reified实化类型参数(上篇)][Kotlin_Reified 1]**
 *  **[\[译\]Kotlin泛型中何时该用类型形参约束?][Kotlin 14]**
 *  **[\[译\] 一个简单方式教你记住Kotlin的形参和实参][_Kotlin]**
 *  **[\[译\]Kotlin中是应该定义函数还是定义属性?][Kotlin 15]**
 *  **[\[译\]如何在你的Kotlin代码中移除所有的!!(非空断言)][Kotlin 16]**
 *  **[\[译\]掌握Kotlin中的标准库函数: run、with、let、also和apply][Kotlin_ run_with_let_also_apply]**
 *  **[\[译\]有关Kotlin类型别名(typealias)你需要知道的一切][Kotlin_typealias]**
 *  **[\[译\]Kotlin中是应该使用序列(Sequences)还是集合(Lists)?][Kotlin_Sequences_Lists]**
 *  **[\[译\]Kotlin中的龟(List)兔(Sequence)赛跑][Kotlin_List_Sequence]**

> 实战系列:

*  **[用Kotlin撸一个图片压缩插件ImageSlimming-导学篇(一)][Kotlin_ImageSlimming-]**
 *  **[用Kotlin撸一个图片压缩插件-插件基础篇(二)][Kotlin_-]**
 *  **[用Kotlin撸一个图片压缩插件-实战篇(三)][Kotlin_- 1]**
 *  **[浅谈Kotlin实战篇之自定义View图片圆角简单应用][Kotlin_View]**

[https_blog.kotlin-academy.com_a-few-facts-about-companion-objects-37e18429b725]: https://blog.kotlin-academy.com/a-few-facts-about-companion-objects-37e18429b725
[David Blanc]: https://blog.kotlin-academy.com/@david.e.blanc
[16a0657792331996_w_515_h_235_f_png_s_61998]: https://user-gold-cdn.xitu.io/2019/4/10/16a0657792331996?w=515&h=235&f=png&s=61998
[1635c3fb0ba21ec1_w_430_h_430_f_jpeg_s_39536]: https://user-gold-cdn.xitu.io/2018/5/14/1635c3fb0ba21ec1?w=430&h=430&f=jpeg&s=39536
[Kotlin]: https://juejin.im/post/5ca9ac0fe51d452b616f2c7d
[Kotlin 1]: https://juejin.im/post/5ca4b511518825440a4ba0af
[Kotlin 2]: https://juejin.im/post/5c88709a5188251bbf2ee8d1
[Kotlin 3]: https://juejin.im/post/5c4f106a6fb9a049de6dc410
[Jetbrains_Kotlin1.3_inline class]: https://juejin.im/post/5c0558fa51882545e24edead
[JetBrains_Kotlin1.3_Contract]: https://juejin.im/post/5c0150f8e51d4540611e15e0
[JetBrains_Kotlin_Native]: https://juejin.im/post/5c03fadff265da6165015211
[Kotlin 4]: https://juejin.im/post/5bfca603f265da61441fbcf9
[Kotlin 5]: https://juejin.im/post/5beb1031f265da61441f9a9f
[Kotlin 6]: https://juejin.im/post/5be442afe51d451def13d76d
[Kotlin_Reified]: https://juejin.im/post/5bd45ae16fb9a05d2a1db51b
[Kotlin 7]: https://juejin.im/post/5ba64572e51d4527ed0024dd
[Kotlin_Sequences]: https://juejin.im/post/5b8958bdf265da43351d6d29
[Kotlin_API_-]: https://juejin.im/post/5ac0dd32f265da237d03271e
[Kotlin_lambda]: https://juejin.im/post/5adfdb8d6fb9a07ab773dc40
[Kotlin_Lambda]: https://juejin.im/post/5ac0dca8f265da237e09ddc1
[Kotlin 8]: https://juejin.im/post/5acb7ad16fb9a028e33bc0ea
[Kotlin 9]: https://juejin.im/post/5ac0dc18f265da2397070124
[Kotlin 10]: https://juejin.im/post/5ac0dabaf265da237a4d2941
[Kotlin 11]: https://juejin.im/post/5ac0d9d9f265da237d032713
[Kotlin 12]: https://juejin.im/post/5aba47ca5188255c56687783
[Effective Kotlin]: https://juejin.im/post/5c12636ae51d45068340f081
[Effective Kotlin_Sequence]: https://juejin.im/post/5c113881f265da61715e3361
[Effective Kotlin_inline]: https://juejin.im/post/5c0e6b31f265da612637fd7d
[Effective Kotlin 1]: https://juejin.im/post/5b8698bce51d4538a423dd70
[Effective Kotlin 2]: https://juejin.im/post/5b78f805e51d4538c2108951
[Kotlin_PR]: https://juejin.im/post/5c1d09195188251ae7601997
[Kotlin 13]: https://juejin.im/post/5c0a6a00e51d45524146dd1d
[Kotlin_inline class]: https://juejin.im/post/5c0928766fb9a049d131eff3
[Kotlin_Reified 1]: https://juejin.im/post/5bd1d590518825288b398f46
[Kotlin 14]: https://juejin.im/post/5bceb5915188255c6b654cec
[_Kotlin]: https://juejin.im/post/5bc5f41f6fb9a05d1a1305e1
[Kotlin 15]: https://juejin.im/post/5afc23446fb9a07ab979abdf
[Kotlin 16]: https://juejin.im/post/5afd9090f265da0ba46a0429
[Kotlin_ run_with_let_also_apply]: https://juejin.im/post/5b0048ed518825428a2619ed
[Kotlin_typealias]: https://juejin.im/post/5b052f806fb9a07ac0229ce3
[Kotlin_Sequences_Lists]: https://juejin.im/post/5b13fdace51d450696590828
[Kotlin_List_Sequence]: https://juejin.im/post/5b28f4946fb9a00e3a5a9b8c
[Kotlin_ImageSlimming-]: https://juejin.im/post/5b3453fe6fb9a00e883f37fa
[Kotlin_-]: https://juejin.im/post/5b34fdb26fb9a00e356844b8
[Kotlin_- 1]: https://juejin.im/post/5b34fe66e51d4558ba1a8445
[Kotlin_View]: https://juejin.im/post/5ae1755d6fb9a07ab9792da4