Kotlinでビルダーパターンを実装する方法

こんにちは、コトリンの世界の初心者です。これまで見てきたことが好きで、アプリケーションで使用するライブラリの一部をJavaからKotlinに変換しようと考え始めました。

これらのライブラリーは、setter、getter、およびBuilderクラスを備えたPojoでいっぱいです。今私はKotlinでビルダーを実装するための最良の方法を見つけましたが、成功しませんでした。

2番目の更新：問題は、Kotlinでいくつかのパラメーターを持つ単純なpojoのビルダーデザインパターンを作成する方法ですか？以下のコードは、javaコードを記述してから、eclipse-kotlin-pluginを使用してKotlinに変換するという私の試みです。

class Car private constructor(builder:Car.Builder) {
    var model:String? = null
    var year:Int = 0
    init {
        this.model = builder.model
        this.year = builder.year
    }
    companion object Builder {
        var model:String? = null
        private set

        var year:Int = 0
        private set

        fun model(model:String):Builder {
            this.model = model
            return this
        }
        fun year(year:Int):Builder {
            this.year = year
            return this
        }
        fun build():Car {
            val car = Car(this)
            return car
        }
    }
}

何よりもまず、デフォルトと名前付きの引数があるため、ほとんどの場合、Kotlinでビルダーを使用する必要はありません。これにより、

class Car(val model: String? = null, val year: Int = 0)

そしてそれを次のように使用します：

val car = Car(model = "X")

どうしてもビルダーを使用したい場合は、次の方法で実行できます。

sはシングルトンcompanion objectなので、ビルダーをaにしても意味がありませんobject。代わりに、ネストされたクラスとして宣言します（Kotlinではデフォルトで静的です）。

プロパティをコンストラクターに移動して、オブジェクトも通常の方法でインスタンス化できるようにし（必要でない場合はコンストラクターをプライベートにします）、ビルダーを取得してプライマリコンストラクターに委任するセカンダリコンストラクターを使用します。コードは次のようになります。

class Car( //add private constructor if necessary
        val model: String?,
        val year: Int
) {

    private constructor(builder: Builder) : this(builder.model, builder.year)

    class Builder {
        var model: String? = null
            private set

        var year: Int = 0
            private set

        fun model(model: String) = apply { this.model = model }

        fun year(year: Int) = apply { this.year = year }

        fun build() = Car(this)
    }
}

使用法： val car = Car.Builder().model("X").build()

このコードは、ビルダーDSLを使用してさらに短縮できます。

class Car (
        val model: String?,
        val year: Int
) {

    private constructor(builder: Builder) : this(builder.model, builder.year)

    companion object {
        inline fun build(block: Builder.() -> Unit) = Builder().apply(block).build()
    }

    class Builder {
        var model: String? = null
        var year: Int = 0

        fun build() = Car(this)
    }
}

使用法： val car = Car.build { model = "X" }

一部の値が必要で、デフォルト値がない場合は、ビルダーのコンストラクターとbuild定義したメソッドにそれらを配置する必要があります。

class Car (
        val model: String?,
        val year: Int,
        val required: String
) {

    private constructor(builder: Builder) : this(builder.model, builder.year, builder.required)

    companion object {
        inline fun build(required: String, block: Builder.() -> Unit) = Builder(required).apply(block).build()
    }

    class Builder(
            val required: String
    ) {
        var model: String? = null
        var year: Int = 0

        fun build() = Car(this)
    }
}

使用法： val car = Car.build(required = "requiredValue") { model = "X" }

1つのアプローチは、次のようなことです。

class Car(
  val model: String?,
  val color: String?,
  val type: String?) {

    data class Builder(
      var model: String? = null,
      var color: String? = null,
      var type: String? = null) {

        fun model(model: String) = apply { this.model = model }
        fun color(color: String) = apply { this.color = color }
        fun type(type: String) = apply { this.type = type }
        fun build() = Car(model, color, type)
    }
}

使用例：

val car = Car.Builder()
  .model("Ford Focus")
  .color("Black")
  .type("Type")
  .build()

JSONからオブジェクトを解析するためにJacksonライブラリーを使用しているため、空のコンストラクターが必要であり、オプションのフィールドを持つことはできません。また、すべてのフィールドは変更可能でなければなりません。次に、ビルダーパターンと同じことを行うこの構文を使用できます。

val car = Car().apply{ model = "Ford"; year = 2000 }

私は個人的にKotlinでビルダーを見たことがありませんが、多分それは私だけです。

必要なすべての検証はinitブロックで行われます。

class Car(val model: String,
          val year: Int = 2000) {

    init {
        if(year < 1900) throw Exception("...")
    }
}

ここで私はあなたが本当に望んでいたしないことを推測するために自由を取ったmodelし、year変更可能に。また、これらのデフォルト値は意味がないように見えますが（特にのnull場合name）、デモのために残しました。

意見： 名前付きパラメーターなしで生きるための手段としてJavaで使用されるビルダーパターン。名前付きパラメーターを持つ言語（KotlinやPythonなど）では、（おそらくオプションの）パラメーターの長いリストを持つコンストラクターを用意することをお勧めします。

ビルダーとして余分な楽しみを宣言する多くの例を見てきました。私は個人的にこのアプローチが好きです。ビルダーを書く手間を省きます。

package android.zeroarst.lab.koltinlab

import kotlin.properties.Delegates

class Lab {
    companion object {
        @JvmStatic fun main(args: Array<String>) {

            val roy = Person {
                name = "Roy"
                age = 33
                height = 173
                single = true
                car {
                    brand = "Tesla"
                    model = "Model X"
                    year = 2017
                }
                car {
                    brand = "Tesla"
                    model = "Model S"
                    year = 2018
                }
            }

            println(roy)
        }

        class Person() {
            constructor(init: Person.() -> Unit) : this() {
                this.init()
            }

            var name: String by Delegates.notNull()
            var age: Int by Delegates.notNull()
            var height: Int by Delegates.notNull()
            var single: Boolean by Delegates.notNull()
            val cars: MutableList<Car> by lazy { arrayListOf<Car>() }

            override fun toString(): String {
                return "name=$name, age=$age, " +
                        "height=$height, " +
                        "single=${when (single) {
                            true -> "looking for a girl friend T___T"
                            false -> "Happy!!"
                        }}\nCars: $cars"
            }
        }

        class Car() {

            var brand: String by Delegates.notNull()
            var model: String by Delegates.notNull()
            var year: Int by Delegates.notNull()

            override fun toString(): String {
                return "(brand=$brand, model=$model, year=$year)"
            }
        }

        fun Person.car(init: Car.() -> Unit): Unit {
            cars.add(Car().apply(init))
        }

    }
}

例外をスローする代わりにエラーを表示するなど、一部のフィールドをDSLで強制的に初期化する方法をまだ見つけていません。誰かが知っているなら教えてください。

単純なクラスの場合、別個のビルダーは必要ありません。Kirill Rakhmanが説明したように、オプションのコンストラクタ引数を使用できます。

より複雑なクラスがある場合、KotlinはGroovyスタイルのビルダー/ DSLを作成する方法を提供します。

タイプセーフなビルダー

次に例を示します。

Githubの例-ビルダー/アセンブラ

今日の人々はKotlinのType-Safe Buildersをチェックするべきです。

上記のオブジェクト作成方法を使用すると、次のようになります。

html {
    head {
        title {+"XML encoding with Kotlin"}
    }
    // ...
}

優れた「実際の」使用例は、vaadin-on-kotlinフレームワークで、タイプセーフビルダーを使用してビューとコンポーネントを組み立てます。

パーティーに遅れました。プロジェクトでビルダーパターンを使用する必要がある場合も、同じジレンマに遭遇しました。後で調査したところ、Kotlinはすでに名前付き引数とデフォルト引数を提供しているため、これは絶対に不要であることに気付きました。

本当に実装する必要がある場合、Kirill Rakhmanの答えは、最も効果的な方法で実装する方法に関する確かな答えです。あなたがそれが便利であると思うかもしれないもう一つはhttps://www.baeldung.com/kotlin-builder-patternであり、JavaとKotlinとの実装を比較することができます

Kotlinでもパターンと実装はほとんど同じです。デフォルト値のおかげでそれをスキップできることもありますが、より複雑なオブジェクトの作成では、ビルダーは省略できない便利なツールです。

kotlinの例ではオプションのパラメーターを使用できます。

fun myFunc(p1: String, p2: Int = -1, p3: Long = -1, p4: String = "default") {
    System.out.printf("parameter %s %d %d %s\n", p1, p2, p3, p4)
}

その後

myFunc("a")
myFunc("a", 1)
myFunc("a", 1, 2)
myFunc("a", 1, 2, "b")

class Foo private constructor(@DrawableRes requiredImageRes: Int, optionalTitle: String?) {

    @DrawableRes
    @get:DrawableRes
    val requiredImageRes: Int

    val optionalTitle: String?

    init {
        this.requiredImageRes = requiredImageRes
        this.requiredImageRes = optionalTitle
    }

    class Builder {

        @DrawableRes
        private var requiredImageRes: Int = -1

        private var optionalTitle: String? = null

        fun requiredImageRes(@DrawableRes imageRes: Int): Builder {
            this.intent = intent
            return this
        } 

        fun optionalTitle(title: String): Builder {
            this.optionalTitle = title
            return this
        }

        fun build(): Foo {
            if(requiredImageRes == -1) {
                throw IllegalStateException("No image res provided")
            }
            return Foo(this.requiredImageRes, this.optionalTitle)
        }

    }

}

基本的なビルダーパターンをKotlinに次のコードで実装しました。

data class DialogMessage(
        var title: String = "",
        var message: String = ""
) {


    class Builder( context: Context){


        private var context: Context = context
        private var title: String = ""
        private var message: String = ""

        fun title( title : String) = apply { this.title = title }

        fun message( message : String ) = apply { this.message = message  }    

        fun build() = KeyoDialogMessage(
                title,
                message
        )

    }

    private lateinit var  dialog : Dialog

    fun show(){
        this.dialog= Dialog(context)
        .
        .
        .
        dialog.show()

    }

    fun hide(){
        if( this.dialog != null){
            this.dialog.dismiss()
        }
    }
}

そして最後に

Java：

new DialogMessage.Builder( context )
       .title("Title")
       .message("Message")
       .build()
       .show();

コトリン：

DialogMessage.Builder( context )
       .title("Title")
       .message("")
       .build()
       .show()

私は、Javaクライアントが消費するAPIを公開するKotlinプロジェクトに取り組んでいました（Kotlin言語構造を利用できない）。Javaで使用できるようにビルダーを追加する必要があったため、@ Builderアノテーションを作成しました：https : //github.com/ThinkingLogic/kotlin-builder-annotation- これは、基本的にはKotlinのLombok @Builderアノテーションの代わりです。