Kodein DI のDSLを紐解いてみる。

# TL;DR


Kodein DIのドキュメント[^samplecode]にはこういうサンプルコードが載っています。

[^samplecode]: http://kodein.org/Kodein-DI/?5.2/getting-started#_declaration

``` codeInGettingStarted.kt
val kodein = Kodein {
  bind<Random>() with provider { SecureRandom() }
  bind<Database>() with singleton { SQLiteDatabase() }
}
```

正直なところ初見では全く読めませんでした。書いてあることはシンプルですが、プログラミング言語には見えません。そこで、Kotlinの文法の勉強も兼ねて内容を整理してみました。

この記事では一旦このコードを省略をなるべくやらない形に置き換えた後、省略のルールを一つ一つ当てはめて元のコードに戻す過程を記載しています。これをネタに文法の理解が進んだら良いかなと思います。Kodein DIの中の仕組みや挙動は扱いません。


識者のマサカリ歓迎します。言語仕様警察どんとこい。間違い探し遊びに付き合ってくれたら幸甚です。


# 本家のサンプルをそのまま動かす

まずは、サンプルコードがそのまま動くような最小限のコードを作ってみます。 設定して取得してちょっと動かして見るようなものです。


``` KodeinSample0.kt
package sample0

import org.kodein.di.Kodein
import org.kodein.di.generic.bind
import org.kodein.di.generic.instance
import org.kodein.di.generic.provider
import java.security.SecureRandom
import java.util.Random

fun main(args: Array<String>) {
  // 設定して取得するコードとして本家のサンプルをコピペ。簡単のためRandomだけにする。
  val kodein = Kodein {
    bind<Random>() with provider { SecureRandom() }
  }

  // 設定された SecureRandom() を取得してnextInt()してprintln
  val randValue: Random by kodein.instance()
  println(randValue.nextInt())
}
```

# 省略をしないで同じことをするコードに書き直す

次はこのコードを省略をなるべくやめて古めの言語みたいな書き方で、でも同じ動作になるように書き直してみます。

``` KodeinSample1.kt
package sample1

import org.kodein.di.Kodein
import org.kodein.di.bindings.NoArgBindingKodein
import org.kodein.di.generic.bind
import org.kodein.di.generic.instance
import org.kodein.di.generic.provider
import java.security.SecureRandom
import java.util.Random

// 関数。ただし、NoArgBindingKodein<Any?>に、関数を貼り付ける形。（拡張関数）
fun NoArgBindingKodein<Any?>.setRandom(): SecureRandom {
  return SecureRandom()
}

// 同じく拡張関数
fun Kodein.MainBuilder.bindSettings(): Unit {
  // thisについているメソッドを呼ぶ。
  // this は、MainBuilderのインスタンス。
  // bind() も、provider() も、MainBuilderの親クラスないしインターフェースに拡張関数として追加されている。
  // setRandom() が、 :: によるCallable Referenceの形でprovider()の引数に渡されている。
  this.bind<Random>().with(this.provider(NoArgBindingKodein<Any?>::setRandom))
}


fun main(args: Array<String>) {
  // bindSettings() のCallable Referenceが、パラメータに渡されている
  val kodein = Kodein.Companion.invoke(false, Kodein.MainBuilder::bindSettings)

  // 設定された SecureRandom() を取得してnextInt()してprintln
  val randValue: Random by kodein.instance()
  println(randValue.nextInt())
}
```

## 補足説明

関数 `setRandom()`は、だいたい普通の関数ですが、`NoArgBindingKodein<Any?>`クラスに関数を追加する形になっています。こういうものを拡張関数[^extension]と呼びます。

[^extension]: https://kotlinlang.org/docs/reference/extensions.html#extension-functions

関数 `bindSettings()` も、`Kodein.MainBuilder` への拡張関数です。中に、`this`というものがありますが、`Kodein.MainBuilder`のインスタンスを意味します。中で呼んでいる`bind()` も、`provider()`も、`Kodein.MainBuilder`の関数です。また、`provider()`の引数に`setRandom()`のCallable Reference[^callable]を渡しています。

[^callable]: https://kotlinlang.org/docs/reference/reflection.html#callable-references

参考に、`Kodein.MainBuilder`付近のクラス図[^plantUml]を書いてみました。親クラスなどに関数の定義がある体裁ですね。

[^plantUml]: http://plantuml.com/ で描きました。

![classdiagram.png](https://qiita-image-store.s3.amazonaws.com/0/44538/67c8633f-97eb-11cd-844e-49e012a615cb.png)

# 簡単にしていく

## setRandom() を無名関数にしてbindSettings()の中に入れる

`setRandom()` を無名関数にして`bindSettings()`の中に入れてみました。無名関数とするため名前が消えました。無名関数だと関数名考えなくて良いので楽できますね。[^noNameIsGood]

[^noNameIsGood]: 名前って規約とか設計とかポリシーとか色々あるじゃないですか。

``` KodeinSample2.kt
package sample2

import org.kodein.di.Kodein
import org.kodein.di.generic.bind
import org.kodein.di.generic.instance
import org.kodein.di.generic.provider
import java.security.SecureRandom
import java.util.Random

fun Kodein.MainBuilder.bindSettings(): Unit {
// setRandom()を無名関数にして、providerの引数に入れる
  this.bind<Random>().with(this.provider(
    fun NoArgBindingKodein<Any?>.(): SecureRandom {
      return SecureRandom()
    }
  ))
}

fun main(args: Array<String>) {

  val kodein = Kodein.Companion.invoke(false, Kodein.MainBuilder::bindSettings)

  // 設定された SecureRandom() を取得してnextInt()してprintln
  val randValue: Random by kodein.instance()
  println(randValue.nextInt())
}
```

さて、これから`bindSettings()`の中身にこれを簡素化する記法を適用していきます。


- 無名関数をラムダに変更。レシーバの型とか戻り値の型とかreturnは削除

``` lambda.kt
  this.bind<Random>().with(this.provider({ SecureRandom() }))
```

- 最後のパラメータがラムダだった場合は丸括弧の後ろに移動できる。それ以外にパラメータがないので丸括弧は省略できる。これらを`provider()`に適用。

``` moveAfterParentheses.kt
this.bind<Random>().with(this.provider { SecureRandom() })
``` 

- withは中置演算子(infix)なので、ピリオドと丸かっこを削除できる。

``` withIsInfix.kt
  this.bind<Random>() with this.provider { SecureRandom() }
```

- レシーバ付き関数リテラル内なので `this` は省略可能

``` removeThis.kt
  bind<Random>() with provider { SecureRandom() }
```

結果、`bindSettings()`はこうなりました。

``` newBindSetting.kt
fun Kodein.MainBuilder.bindSettings(): Unit {
  bind<Random>() with provider { SecureRandom() }
}
```
では次へ行きます。[^math]

[^math]: なんだか数学の授業で式変形をどんどんやっているみたいですね！説明の変形が飛びすぎると聞く方はついていけなくなるんですよね。

## bindSettings()を無名関数にして、invokeの中に入れる

`bindSettings()` を無名関数にしてinvoke()の中に入れてみました。無名関数とするためさっきと同様に名前が消えました。

``` KodeinSample3.kt
package sample3

import org.kodein.di.Kodein
import org.kodein.di.generic.bind
import org.kodein.di.generic.instance
import org.kodein.di.generic.provider
import java.security.SecureRandom
import java.util.Random


fun main(args: Array<String>) {
  // bindSettings()を無名関数にして、invokeの引数に入れる
  val kodein = Kodein.Companion.invoke(false,
    fun Kodein.MainBuilder.(): Unit {
      bind<Random>() with provider { SecureRandom() }
    }
  )

  // 設定された SecureRandom() を取得してnextInt()してprintln
  val randValue: Random by kodein.instance()
  println(randValue.nextInt())
}
```


さて、これから`val kodein` へ代入する右辺を簡素化する記法を適用していきます。

- 無名関数をラムダに変更。レシーバの型とか戻り値の型は削除

``` lambda2.kt 
val kodein = Kodein.Companion.invoke(false, { bind<Random>() with provider { SecureRandom() } })
```

- 最後のパラメータがラムダなので丸括弧の外に出す。第1引数はデフォルト値の設定があるので省略。

``` moveAfterParentheses2.kt
val kodein = Kodein.Companion.invoke { bind<Random>() with provider { SecureRandom() } }
```

- 演算子オーバーロードでinvokeというメソッドがあるので、コンパニオンオブジェクトをメソッドのように呼べる。

``` invokeOperator.kt
  val kodein = Kodein.Companion { bind<Random>() with provider { SecureRandom() } }
```

- `Companion`という名前は省略できる。

``` omitCompanion.kt
  val kodein = Kodein { bind<Random>() with provider { SecureRandom() } }
```

ここまでの変形でこの記事の最初に出したソースと同じになりました。色々省略されていましたが、内部的には関数オブジェクトなどをパラメータにして関数を呼びまくっていたということですね。

# まとめ

省略記法のために出てきた言語仕様をもう一度まとめてみます。

- 拡張関数 [^extension]
- Callable Reference[^callable]
- 無名関数 [^anonymous]
- ラムダ式 [^lambda]
- 中置演算子 [^infix]
- コンパニオンオブジェクト[^companion]
- オペレーターオーバーロードでのinvoke [^invoke]
- 最後のパラメータがラムダのときは丸括弧の後ろに移動して良い。[^lambdaAsLastParam]
- デフォルト引数が設定されていたら省略して良い。[^defaultArgs]


[^anonymous]: https://kotlinlang.org/docs/reference/lambdas.html#anonymous-functions

[^lambda]: https://kotlinlang.org/docs/reference/lambdas.html

[^infix]: https://kotlinlang.org/docs/reference/functions.html#infix-notation

[^companion]: https://kotlinlang.org/docs/reference/object-declarations.html#companion-objects

[^invoke]: https://kotlinlang.org/docs/reference/operator-overloading.html#invoke

[^lambdaAsLastParam]: https://kotlinlang.org/docs/reference/lambdas.html#passing-a-lambda-to-the-last-parameter

[^defaultArgs]: https://kotlinlang.org/docs/reference/functions.html#default-arguments

この辺の文法を押さえておけば、今後どんなDSLを見てもついて行けそうな気がしますね！仕組みがわかってしまえばどうってことはありません。[^2]

[^2]: 「やり方さえ分かっちゃえば簡単なもんだね」


# おまけ：値の取得の by ってなんですか？

値の取得の方の話です。サンプルでは、値の取得はLocal Delegated Properties[^ldp]でやっていますが、直接KodeinのAPIから取ることもできます。[^directRetrieval] つまり、以下のコードは同じ動作をします。

元々のコード

``` retrieveWithLocalDelegatedProperties.kt
  // 設定された SecureRandom() を取得してnextInt()してprintln
  val randValue: Random by kodein.instance()
  println(randValue.nextInt())
```

直接取得するコード

``` retrieveWithDirectRetrieval.kt
  // by というLocal Delegated Properties ではなく、KodeinのAPIから直接値を取得できる。
  val randValue: Random = kodein.direct.instance()
  println(randValue.nextInt())
```

機能的なご利益があるのでプロパティで取得しましょうというのが第一のようです。でも直接取ることもできますよと。[^reason]

[^reason]: これはDSLではないのでおまけ扱いにしました。

[^ldp]: https://kotlinlang.org/docs/reference/delegated-properties.html#local-delegated-properties-since-11

[^directRetrieval]: https://kodein.org/Kodein-DI/?5.2/core#direct-retrieval



# おまけ２：どうでもいいポエム

コードには説明用のコメントをいれるというよくあるスタイルでやりましたが、あなたが実際に書いて本番で動かすコードには文法を説明するコメントを入れたりしないでくださいね！　[^1]  

[^1]: コンストラクタのjavadocコメントに、`コンストラクタ` って書く人がいるんですよね。

# バージョン番号など

- Kotlin 1.2.70
- Kodein DI 5.2.0