Kotlin之在Gradle中無參（no-arg）編譯器插件的使用詳解

1、前言

最近在用Kotlin+Spring Boot寫一個後端項目，實體類習慣性地用了Kotlin中的data class，但是Spring要求要有一個無參的構造函數，否則可能會抛出java.sql.SQLDataException。要使data class能夠生成一個無參的構造函數，有兩種方法可以做到：

1.給data class的構造函數中的每一個參數都賦上預設值。比如：

data class User(
  @TableId(value = "id", type = IdType.AUTO)
  var id: Int?=-1,
  var userName: String?=null, //使用者名
  var age: Int?=null, //年齡
  var password: String?=null, //密碼
  var name: String?=null, //姓名
  var email: String?=null  //郵箱
) : Serializable           

複制

2.使用無參編譯器插件no-arg。下面我們就來看看這種方法。

2、具體步驟

2.1 添加插件依賴

首先需要在工程的build.gradle中添加no-arg插件的依賴，版本跟Kotlin的版本一緻：

plugins {
    ……
  id "org.jetbrains.kotlin.plugin.noarg" version "1.3.41"
}           

複制

我用的是plugins的形式，如果你使用的是buildscript 塊的話就可以這樣添加：

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

apply plugin: "kotlin-noarg"           

複制

2.2 指定無參注解清單

說實話，在看官方文檔時這一步并不好了解，這裡隻描述我經過自己的實踐之後得出的經驗。首先建立一個注解類，類名我們可以定為NoArg：

annotation class NoArg           

複制

然後最關鍵一步來了，回到工程的build.gradle檔案，添加無參注解清單：

noArg {
  annotation("com.lindroid.projectname.annotation.NoArg")
}           

複制

annotation中的路徑就是我們建立的NoArg注解類所在的包目錄。路徑一定要寫好，不要出錯！此時無參插件就已經配置好了。我們可以在data class前面添加@NoArg注解，這樣編譯器就能為其生成一個無參構造函數。使用示例如下：

@NoArg
data class User(
  @TableId(value = "id", type = IdType.AUTO)
  var id: Int?,
  var userName: String?, //使用者名
  var age: Int?, //年齡
  var password: String?, //密碼
  var name: String?, //姓名
  var email: String?  //郵箱
) : Serializable           

複制

2.3 kotlin-jpa中的無參注解

如果你的項目中已經添加了kotlin-jpa插件，那麼基本上就不必單獨添加無參插件了。kotlin-jpa對無參插件做了包裝，當你使用 @Entity、 @Embeddable 與 @MappedSuperclass這幾個注解時，都會預設支援無參注解的。

3、參考文章

Kotlin官方文檔

以上就是本文的全部内容，希望對大家的學習有所幫助。