Kotlinのcompanion objectのメリットがわからない

Question

companion object のメリットがイマイチ理解できません。

companion objectはJavaだとstaticに相当するとのことですが、
JavaからKotlinへstaticメソッドをIDEで変換してみたら次のようになりました。

object Test {

    fun testMethod() {

    }
}

companion object というキーワードが出てきません。

また、objectとcompanion objectの違いを調べるために、次のようなコードを書いてみました

class Test1 {
    companion object {
        fun test1Method() {
            println("1")
        }
    }
}

class Test2 {
    object Test2Inner {
        fun test2Method() {
            println("2")
        }
    }
}

class Test3 {
    companion object Test3Inner {
        fun test3Method() {
            println("3")
        }
    }
}

fun main(args: Array<String>) {
    Test1.test1Method()

    Test2.Test2Inner.test2Method()

    Test3.Test3Inner.test3Method()
    Test3.test3Method()
}

companion objectもobjectも、ほぼ同じ動作をしました。
唯一の違いは、objectの方がメソッドの呼び出すときに、冗長な表現になってしまうことくらいです。

companion objectのメリット、objectとcompanion objectの違いはなんですか？

Answer 1

https://dogwood008.github.io/kotlin-web-site-ja/docs/reference/object-declarations.html

を読むとポイントがわかるのではないでしょうか？質問者さんが指摘しておられるとおり「アクセス構文」の違いの他に以下の意味的な違いもあることがわかります。

• オブジェクト宣言は、初回アクセス時に 遅延して 初期化されます

• コンパニオンオブジェクトは、対応するクラスが読み込まれた（解決）されたときに初期化され、これは Java の静的初期化子のセマンティクスに一致します

つまり

class MyClass {
  companion object {
    ... (A)
  }
  ...
}

こうかくと(A)はMyClassの最初の参照時点で実行されますが、companionでないobjectではそのobjectを最初にアクセスした時点まで(A)は実行されないというわけです。あまりよい例が思いつきませんが、例えばJNIにより一部のメソッドがNativeなものだったとき、MyClassを利用するにはまずダイナミックライブラリーをロードせねばなりません。そういうような場面ではcompanion objectが必要ということになりましょうか。

Comments

[redhat98]

回答ありがとうございます。
初期化のタイミングが違うとのことですが、仰る通り使い所が難しいですね。

実質的にcompanion objectは、表記が短くなるというメリットがなさそう...
companion objectを使いこなすには、かなりの技術料が必要そうに感じました。

[KSwordOfHaste]

> 表記が短くなるというメリットがなさそう...

自分が挙げたリンクに「コンパニオンオブジェクトのメンバーは修飾子として単にクラス名を使用して呼び出すことができます」とあり

class MyClass {
　companion object Factory {
　　fun create(): MyClass = MyClass()
　}
}
...
MyClass.create()って書けるとありますがこれは表記の短縮とはいえないんでしょうか・・・

[KSwordOfHaste]

> companion objectを使いこなすには、かなりの技術料が必要
そうかなｗ；
インスタンスメソッドではなくてクラスメソッドを書きたい場面はけっこうあると思います。そういう場面でcompanionを使うのが自然じゃないでしょうか？

[redhat98]

> 表記が短くなるというメリットがなさそう
すいません、間違えて入力していました。
おっしゃる通り、companion objectを表記は短くなるメリットがあると思います。

>インスタンスメソッドではなくてクラスメソッドを書きたい場面はけっこうあると思います
Builderパターンやprivate constructor()にアクセスするとかですか？

[KSwordOfHaste]

> Builderパターンや・・・
そうですね。個人的にはファクトリーパターンをよく使う気がします。

Answer 2

top-level / companion object / objectについて、こちらのブログで考察されています。参考になれば。

companion object vs. top-level - hydrakecat's blog - はてなブログ

Kotlinにstaticが無いのなんで？(Why doesn't Kotlin have static members inside a class?) - プログラマのはしくれダイアリー