Làm cách nào để triển khai mẫu Builder trong Kotlin?

Xin chào Tôi là một người mới trong thế giới Kotlin. Tôi thích những gì tôi thấy cho đến nay và bắt đầu nghĩ để chuyển đổi một số thư viện mà chúng tôi sử dụng trong ứng dụng của mình từ Java sang Kotlin.

Các thư viện này chứa đầy Pojos với các lớp setters, getters và Builder. Bây giờ tôi đã googled để tìm ra cách tốt nhất để triển khai các Nhà xây dựng trong Kotlin nhưng không thành công.

Cập nhật lần 2: Câu hỏi đặt ra là làm thế nào để viết một mẫu thiết kế Builder cho một pojo đơn giản với một số tham số trong Kotlin? Mã dưới đây là nỗ lực của tôi bằng cách viết mã java và sau đó sử dụng plugin eclipse-kotlin để chuyển đổi sang 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
        }
    }
}

Đầu tiên và quan trọng nhất, trong hầu hết các trường hợp, bạn không cần sử dụng các trình xây dựng trong Kotlin vì chúng tôi có các đối số mặc định và được đặt tên. Điều này cho phép bạn viết

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

và sử dụng nó như vậy:

val car = Car(model = "X")

Nếu bạn hoàn toàn muốn sử dụng các trình xây dựng, đây là cách bạn có thể làm điều đó:

Làm cho Builder companion objectkhông có ý nghĩa vì objects là singletons. Thay vào đó khai báo nó là một lớp lồng nhau (mặc định là tĩnh trong Kotlin).

Di chuyển các thuộc tính đến hàm tạo để đối tượng cũng có thể được khởi tạo theo cách thông thường (làm cho hàm tạo riêng tư nếu không nên) và sử dụng một hàm tạo thứ cấp có một hàm tạo và ủy quyền cho hàm tạo chính. Mã này sẽ như sau:

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)
    }
}

Sử dụng: val car = Car.Builder().model("X").build()

Mã này có thể được rút ngắn thêm bằng cách sử dụng DSL xây dựng :

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)
    }
}

Sử dụng: val car = Car.build { model = "X" }

Nếu một số giá trị là bắt buộc và không có giá trị mặc định, bạn cần đặt chúng vào hàm tạo của trình tạo và cả trong buildphương thức chúng ta vừa xác định:

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)
    }
}

Sử dụng: val car = Car.build(required = "requiredValue") { model = "X" }

Một cách tiếp cận là làm một cái gì đó như sau:

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)
    }
}

Mẫu sử dụng:

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

Vì tôi đang sử dụng thư viện Jackson để phân tích cú pháp các đối tượng từ JSON, tôi cần có một hàm tạo trống và tôi không thể có các trường tùy chọn. Ngoài ra tất cả các lĩnh vực phải được đột biến. Sau đó, tôi có thể sử dụng cú pháp hay này thực hiện tương tự như mẫu Builder:

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

Cá nhân tôi chưa bao giờ thấy một người xây dựng trong Kotlin, nhưng có lẽ đó chỉ là tôi.

Tất cả các xác nhận một nhu cầu xảy ra trong initkhối:

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

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

Ở đây tôi đã tự do đoán rằng bạn không thực sự muốn modelvà yearcó thể thay đổi. Ngoài những giá trị mặc định dường như không có ý nghĩa, (đặc biệt là nullcho name) nhưng tôi lại một cho mục đích biểu tình.

Một ý kiến: Mẫu trình xây dựng được sử dụng trong Java như một phương tiện để sống mà không có các tham số được đặt tên. Trong các ngôn ngữ có tham số được đặt tên (như Kotlin hoặc Python), nên có các hàm tạo với danh sách dài các tham số (có thể là tùy chọn).

Tôi đã thấy nhiều ví dụ tuyên bố thêm những niềm vui như những người xây dựng. Cá nhân tôi thích cách tiếp cận này. Tiết kiệm công sức để viết các nhà xây dựng.

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))
        }

    }
}

Tôi chưa tìm thấy một cách có thể buộc một số trường được khởi tạo trong DSL như hiển thị lỗi thay vì ném ngoại lệ. Hãy cho tôi biết nếu có ai biết.

Đối với một lớp đơn giản, bạn không cần một người xây dựng riêng. Bạn có thể sử dụng các đối số hàm tạo tùy chọn như Kirill Rakhman đã mô tả.

Nếu bạn có lớp phức tạp hơn thì Kotlin cung cấp cách tạo Trình tạo / DSL theo kiểu Groovy:

Nhà xây dựng loại an toàn

Đây là một ví dụ:

Ví dụ về Github - Trình tạo / Trình biên dịch

Mọi người ngày nay nên kiểm tra Nhà xây dựng an toàn loại của Kotlin .

Sử dụng cách tạo đối tượng đã nói sẽ trông giống như thế này:

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

Một ví dụ sử dụng 'hoạt động' tuyệt vời là khung vaadin-on-kotlin , sử dụng các trình xây dựng kiểu an toàn để lắp ráp các khung nhìn và các thành phần .

Tôi đến bữa tiệc muộn. Tôi cũng gặp phải tình huống khó xử tương tự nếu tôi phải sử dụng mẫu Builder trong dự án. Sau này, sau khi nghiên cứu tôi đã nhận ra điều đó là hoàn toàn không cần thiết vì Kotlin đã cung cấp các đối số được đặt tên và các đối số mặc định.

Nếu bạn thực sự cần phải thực hiện, câu trả lời của Kirill Rakhman là câu trả lời chắc chắn về cách thực hiện theo cách hiệu quả nhất. Một điều khác mà bạn có thể thấy hữu ích là https://www.baeldung.com/kotlin-builder-potype bạn có thể so sánh và đối chiếu với Java và Kotlin khi triển khai chúng

Tôi có thể nói rằng mô hình và cách triển khai vẫn khá giống nhau trong Kotlin. Đôi khi bạn có thể bỏ qua nó nhờ các giá trị mặc định, nhưng để tạo đối tượng phức tạp hơn, các trình xây dựng vẫn là một công cụ hữu ích không thể bỏ qua.

bạn có thể sử dụng tham số tùy chọn trong ví dụ 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)
}

sau đó

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)
        }

    }

}

Tôi đã triển khai một mẫu Builder cơ bản trong Kotlin với mã sau:

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()
        }
    }
}

Và cuối cùng

Java:

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

Kotlin:

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

Tôi đã làm việc với một dự án Kotlin đã phơi bày một API được sử dụng bởi các máy khách Java (không thể tận dụng các cấu trúc ngôn ngữ của Kotlin). Chúng tôi đã phải thêm các trình xây dựng để làm cho chúng có thể sử dụng được trong Java, vì vậy tôi đã tạo một chú thích @Builder: https://github.com/ThinkingLogic/kotlin-builder-annotation - về cơ bản nó là sự thay thế cho chú thích Lombok @Builder cho Kotlin.