Котлін з JPA: конструктор за пеклами

Як вимагає JPA, @Entityкласи повинні мати конструктор за замовчуванням (не-аргумент) для екземпляру об'єктів під час отримання їх з бази даних.

У Kotlin властивості дуже зручно декларувати у первинному конструкторі, як у наступному прикладі:

class Person(val name: String, val age: Int) { /* ... */ }

Але коли конструктор non-arg оголошується як вторинний, він вимагає передачі значень первинному конструктору, тому для них потрібні деякі дійсні значення, як тут:

@Entity
class Person(val name: String, val age: Int) {
    private constructor(): this("", 0)
}

У випадку, коли властивості мають більш складний тип, ніж просто, Stringі Intвони не нульові, надати значення для них абсолютно погано, особливо коли в первинному конструкторі та initблоках є багато коду та коли параметри активно використовуються - - коли вони повинні бути призначені за допомогою відображення, більша частина коду буде виконуватися знову.

Більше того, valвластивості-властивості не можна перепризначити після виконання конструктора, тому незмінність також втрачається.

Тож виникає питання: як код Котліна можна адаптувати для роботи з JPA без дублювання коду, вибираючи "магічні" початкові значення та втрату незмінності?

PS Чи правда, що в сплячку в сторону JPA можна створювати об'єкти без конструктора за замовчуванням?

Станом на Kotlin 1.0.6 , kotlin-noargплагін компілятора генерує синтетичні конфігуратори за замовчуванням для класів, які були позначені вибраними анотаціями.

Якщо ви використовуєте gradle, застосування kotlin-jpaплагіна достатньо для створення конструкторів за замовчуванням для класів, позначених @Entity:

buildscript {
    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-noarg:$kotlin_version"
    }
}

apply plugin: "kotlin-jpa"

Для Мейвена:

<plugin>
    <artifactId>kotlin-maven-plugin</artifactId>
    <groupId>org.jetbrains.kotlin</groupId>
    <version>${kotlin.version}</version>

    <configuration>
        <compilerPlugins>
            <plugin>jpa</plugin>
        </compilerPlugins>
    </configuration>

    <dependencies>
        <dependency>
            <groupId>org.jetbrains.kotlin</groupId>
            <artifactId>kotlin-maven-noarg</artifactId>
            <version>${kotlin.version}</version>
        </dependency>
    </dependencies>
</plugin>

просто надайте значення за замовчуванням для всіх аргументів, Kotlin зробить конструктор за замовчуванням для вас.

@Entity
data class Person(val name: String="", val age: Int=0)

дивіться NOTEполе нижче наступного розділу:

https://kotlinlang.org/docs/reference/classes.html#secondary-constructors

@ D3xter має хорошу відповідь для однієї моделі, інша - новіша функція в Котліні під назвою lateinit:

class Entity() {
    constructor(name: String, age: Date): this() {
        this.name = name
        this.birthdate = age
    }

    lateinit var name: String
    lateinit var birthdate: Date
}

Ви б використовували це, коли впевнені, що щось заповнить значення під час створення або дуже скоро після (і до першого використання екземпляра).

Ви можете помітити , я змінив ageдо , birthdateтому що ви не можете використовувати примітивні значення з , lateinitі вони також в той момент , має бути var(обмеження може бути випущено в майбутньому).

Тож не ідеальна відповідь на незмінність, та сама проблема, що й інша відповідь у цьому плані. Рішення для цього - плагіни до бібліотек, які вміють розуміти конструктор Котліна та відображати властивості параметрів конструктора, замість того, щоб вимагати конструктора за замовчуванням. Модуль Котліна для Джексона робить це, тому це однозначно можливо.

Дивіться також: https://stackoverflow.com/a/34624907/3679676 щодо вивчення подібних варіантів.

@Entity data class Person(/*@Id @GeneratedValue var id: Long? = null,*/
                          var name: String? = null,
                          var age: Int? = null)

Початкові значення необхідні, якщо ви хочете повторно використовувати конструктор для різних полів, kotlin не дозволяє нульових значень. Тож коли ви плануєте пропустити поле, використовуйте цю форму в конструкторі:var field: Type? = defaultValue

jpa не потрібен конструктор аргументів:

val entity = Person() // Person(name=null, age=null)

немає дублювання коду. Якщо вам потрібна конструкція сутності та лише вік налаштування, скористайтеся цією формою:

val entity = Person(age = 33) // Person(name=null, age=33)

немає ніякої магії (просто читайте документацію)

Не вдається зберегти незмінність, як це. Vals ОБОВ'ЯЗКОВО бути ініціалізованим при побудові екземпляра.

Один із способів зробити це без незмінності:

class Entity() {
    public constructor(name: String, age: Int): this() {        
        this.name = name
        this.age = age
    }

    public var name: String by Delegates.notNull()

    public var age: Int by Delegates.notNull()
}

Я працюю з Kotlin + JPA досить довгий час, і створив власну ідею, як писати курси Entity.

Я лише трохи розширюю вашу початкову ідею. Як ви вже говорили, ми можемо створити приватний аргумент без аргументів і надати значення за замовчуванням для примітивів , але коли ми намагаємося використовувати інші класи, він стає трохи безладним. Моя ідея - створити статичний об’єкт STUB для класу сутності, який ви зараз пишете, наприклад:

@Entity
data class TestEntity(
    val name: String,
    @Id @GeneratedValue val id: Int? = null
) {
    private constructor() : this("")

    companion object {
        val STUB = TestEntity()
    }
}

і коли у мене є клас особи, який пов'язаний з TestEntity, я можу легко використовувати заглушку, яку я тільки що створив. Наприклад:

@Entity
data class RelatedEntity(
        val testEntity: TestEntity,
        @Id @GeneratedValue val id: Long? = null
) {
    private constructor() : this(TestEntity.STUB)

    companion object {
        val STUB = RelatedEntity()
    }
}

Звичайно, це рішення не є ідеальним. Ще потрібно створити код котла, який не повинен бути потрібним. Крім того, є один випадок, який неможливо вирішити непогано за допомогою стрибкування - відношення батько-дитина в межах одного класу сутності - ось такий:

@Entity
data class TestEntity(
        val testEntity: TestEntity,
        @Id @GeneratedValue val id: Long? = null
) {
    private constructor() : this(STUB)

    companion object {
        val STUB = TestEntity()
    }
}

Цей код створить NullPointerException завдяки проблемі з курячим яйцем - нам потрібно STUB для створення STUB. На жаль, нам потрібно зробити це поле змінним (або якесь подібне рішення), щоб зробити код кодовим.

Крім того, на мою думку, наявність Id як останнього поля (і нульового) є цілком оптимальним. Ми не повинні призначати це вручну, а дозволити базі даних робити це за нас.

Я не кажу, що це ідеальне рішення, але я думаю, що він використовує читабельність коду сутності та функції Котліна (наприклад, нульова безпека). Я просто сподіваюся, що майбутні випуски JPA та / або Kotlin зроблять наш код ще простішим та приємнішим.

Як зазначено вище, ви повинні використовувати no-argплагін, який надає Jetbrains.

Якщо ви використовуєте Eclispe , можливо, вам доведеться редагувати налаштування компілятора Kotlin.

Вікно> Налаштування> Kotlin> Компілятор

Активуйте no-argплагін у розділі Плагіни компілятора.

Дивіться: https://discuss.kotlinlang.org/t/kotlin-allopen-plugin-doesnt-work-with-sts/13277/10

Я сам нуб, але, здається, вам доведеться явно ініціалізувати і відновлювати нульове значення, як це

@Entity
class Person(val name: String? = null, val age: Int? = null)

Подібно до @pawelbial Я використовував супутні об'єкти для створення екземпляра за замовчуванням, однак замість визначення вторинного конструктора просто використовуйте аргументи конструктора за замовчуванням, як @iolo. Це заощаджує вам потребувати визначення декількох конструкторів і зберігає код простішим (хоча надано, визначення об'єктів-супутників "STUB" не зовсім просто)

@Entity
data class TestEntity(
    val name: String = "",
    @Id @GeneratedValue val id: Int? = null
) {

    companion object {
        val STUB = TestEntity()
    }
}

А потім для занять, які стосуються TestEntity

@Entity
data class RelatedEntity(
    val testEntity: TestEntity = TestEntity:STUB,
    @Id @GeneratedValue val id: Int? = null
)

Як зазначав @pawelbial, це не буде працювати там, де TestEntityклас "має" TestEntityклас, оскільки STUB не буде ініціалізований при запуску конструктора.

Ці лінійки побудови Gradle допомогли мені:
https://plugins.gradle.org/plugin/org.jetbrains.kotlin.plugin.jpa/1.1.50 .
Принаймні, це будується в IntelliJ. Наразі це не в командному рядку.

І у мене є

class LtreeType : UserType

і

    @Column(name = "path", nullable = false, columnDefinition = "ltree")
    @Type(type = "com.tgt.unitplanning.data.LtreeType")
    var path: String

var path: LtreeType не працював.

Якщо ви додали плагін gradle https://plugins.gradle.org/plugin/org.jetbrains.kotlin.plugin.jpa, але він не працював, ймовірно, версія застаріла. Я був 1.3.30, і це не працювало для мене. Після того як я перейшов до 1.3.41 (останній час написання), він працював.

Примітка: версія kotlin повинна бути такою ж, як і цей плагін, наприклад: ось як я додав обидва:

buildscript {
    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath "org.jetbrains.kotlin:kotlin-noarg:$kotlin_version"
    }
}