前言

最近寫需求時需要新建許多新表，設計完表結構還要一一寫成對應的 POJO，很麻煩，就 Google 了一下。網上相關資料不多，借鑒了一篇博客，并在其基礎上進行了完善。

前置步驟

使用 IDEA 自帶的插件 Database 連接數據庫

在數據庫的表上右鍵 Scripted Extensions -> Go to Scripts Directory

在打開的目錄下放入腳本文件

源碼

腳本用的 Groovy 語言，語法類似 Java，并能調用 Java 類庫，自己修改也很方便。唯一的麻煩是執行入口在 Intellij 內部，想 debug 很麻煩。

PO 的路徑一般都是統一的，如果要在新的模塊中使用需要改一下路徑。另外類注釋需要替換成自己的。

還有一點需要注意的是枚舉類型，腳本中將 tinyint 統一映射成了 Boolean 類型，如果要映射成自定義枚舉類型，需要在實體類中自行修改。

用于生成帶 Lombok 注釋的實體類的腳本

Generate Lombok POJOs.groovy:

import com.intellij.database.model.DasTableimport com.intellij.database.util.Caseimport com.intellij.database.util.DasUtilimport java.time.LocalDate/* * Available context bindings: * SELECTION Iterable * PROJECT project * FILES files helper */// 此處指定包路徑，路徑需要自行維護;packageName = "com.xxx.xxx.entity;"// 此處指定對應的類型映射，可按需修改，目前tinyint如果要映射到自定義枚舉類型，只能手動修改typeMapping = [ (~/(?i)bigint/) : "Long", (~/(?i)int/) : "Integer", (~/(?i)tinyint/) : "Boolean", (~/(?i)float|double|decimal|real/): "BigDecimal", (~/(?i)time|datetime|timestamp/) : "LocalDateTime", (~/(?i)date/) : "LocalDate", (~/(?i)/) : "String"]// 上面用到類和它的導入路徑的之間的映射importMap = [ "BigDecimal" : "java.math.BigDecimal", "LocalDate" : "java.time.LocalDate", "LocalDateTime" : "java.time.LocalDateTime",]// 導入路徑列表，下面引用的時候會去重，也可以直接聲明成一個 HashSetimportList = []// 彈出選擇文件的對話框FILES.chooseDirectoryAndSave("Choose directory", "Choose where to store generated files") { dir -> SELECTION.filter { it instanceof DasTable }.each { generate(it, dir) }}def generate(table, dir) { def className = javaName(table.getName(), true) + "PO" def fields = calcFields(table) new PrintWriter(new OutputStreamWriter(new FileOutputStream(new File(dir, className + ".java")), "utf-8")).withPrintWriter { out -> generate(out, className, fields, table) }}// 從這里開始，拼實體類的具體邏輯代碼def generate(out, className, fields, table) { out.println "package $packageName" out.println "" out.println "" // 引入所需的包 out.println "import lombok.Data;" out.println "import javax.persistence.Id;" out.println "import javax.persistence.Table;" out.println "import javax.persistence.GeneratedValue;" // 去重后導入列表 importList.unique().each() { pkg -> out.println "import " + pkg + ";" } out.println "" // 添加類注釋 out.println "/**" // 如果添加了表注釋，會加到類注釋上 if (isNotEmpty(table.getComment())) { out.println " * " + table.getComment() } out.println " *" out.println " * @author xxx" out.println " * @date " + LocalDate.now() out.println " */" // 添加類注解 out.println "@Data" out.println "@Table(name = \"${table.getName()}\")" out.println "public class $className {" out.println "" boolean isId = true // 遍歷字段，按下面的規則生成 fields.each() { // 輸出注釋 if (isNotEmpty(it.comment)) { out.println "\t/**" out.println "\t * ${it.comment}" out.println "\t */" } // 這邊默認第一個字段為主鍵，實際情況大多數如此，遇到特殊情況可能需要手動修改 if (isId) { out.println "\t@Id" out.println "\t@GeneratedValue(generator = \"JDBC\")" isId = false } out.println "\tprivate ${it.type} ${it.name};" out.println "" } out.println "" out.println "}"}def calcFields(table) { DasUtil.getColumns(table).reduce([]) { fields, col -> def spec = Case.LOWER.apply(col.getDataType().getSpecification()) def typeStr = typeMapping.find { p, t -> p.matcher(spec).find() }.value if (importMap.containsKey(typeStr)) { importList.add(importMap.get(typeStr)) } fields += [[ name : javaName(col.getName(), false), type : typeStr, comment: col.getComment() ]] }}def isNotEmpty(content) { return content != null && content.toString().trim().length() > 0}def javaName(str, capitalize) { def s = com.intellij.psi.codeStyle.NameUtil.splitNameIntoWords(str) .collect { Case.LOWER.apply(it).capitalize() } .join("") .replaceAll(/[^\p{javaJavaIdentifierPart}[_]]/, "_") capitalize || s.length() == 1 ? s : Case.LOWER.apply(s[0]) + s[1..-1]}

用于生成帶 Lombok 注釋并繼承基類的實體類的腳本

Generate Lombok POJOs extend BaseEntity.groovy:

import com.intellij.database.model.DasTableimport com.intellij.database.util.Caseimport com.intellij.database.util.DasUtilimport java.time.LocalDate/* * Available context bindings: * SELECTION Iterable * PROJECT project * FILES files helper */// 此處指定包路徑，路徑需要自行維護;packageName = "com.xxx.xxx.entity;"// 此處指定對應的類型映射，可按需修改，目前tinyint如果要映射到自定義枚舉類型，只能手動修改typeMapping = [ (~/(?i)bigint/) : "Long", (~/(?i)int/) : "Integer", (~/(?i)tinyint/) : "Boolean", (~/(?i)float|double|decimal|real/): "BigDecimal", (~/(?i)time|datetime|timestamp/) : "LocalDateTime", (~/(?i)date/) : "LocalDate", (~/(?i)/) : "String"]// 上面用到類和它的導入路徑的之間的映射importMap = [ "BigDecimal" : "java.math.BigDecimal", "LocalDate" : "java.time.LocalDate", "LocalDateTime" : "java.time.LocalDateTime",]// 導入路徑列表，下面引用的時候會去重，也可以直接聲明成一個 HashSetimportList = []// 基類中已經有的屬性，就無需在新生成的類中聲明了userTimeList = [ "create_user_id", "update_user_id", "create_time", "update_time"]// 彈出選擇文件的對話框FILES.chooseDirectoryAndSave("Choose directory", "Choose where to store generated files") { dir -> SELECTION.filter { it instanceof DasTable }.each { generate(it, dir) }}def generate(table, dir) { def className = javaName(table.getName(), true) + "PO" def writer = new PrintWriter(new OutputStreamWriter(new FileOutputStream(new File(dir, className + ".java")), "utf-8")) def fields = calcFields(table) writer.withPrintWriter { out -> generate(out, className, fields, table) }}// 從這里開始，拼實體類的具體邏輯代碼def generate(out, className, fields, table) { out.println "package $packageName" out.println "" out.println "" // 引入所需的包 out.println "import com.xxx.xxx.entity.BaseEntity;" out.println "import lombok.Data;" out.println "import lombok.EqualsAndHashCode;" out.println "import java.io.Serializable;" out.println "import javax.persistence.Id;" out.println "import javax.persistence.Table;" out.println "import javax.persistence.GeneratedValue;" // 去重后導入列表 importList.unique().each() { pkg -> out.println "import " + pkg + ";" } out.println "" // 添加類注釋 out.println "/**" // 如果添加了表注釋，會加到類注釋上 if (isNotEmpty(table.getComment())) { out.println " * " + table.getComment() } out.println " *" out.println " * @author xxx" out.println " * @date " + LocalDate.now() out.println " */" // 添加類注解 out.println "@Data" out.println "@EqualsAndHashCode(callSuper = false)" out.println "@Table(name = \"${table.getName()}\")" out.println "public class $className extends BaseEntity implements Serializable {" out.println "" boolean isId = true // 遍歷字段，按下面的規則生成 fields.each() { // 輸出注釋 if (isNotEmpty(it.comment)) { out.println "\t/**" out.println "\t * ${it.comment}" out.println "\t */" } // 這邊默認第一個字段為主鍵，實際情況大多數如此，遇到特殊情況可能需要手動修改 if (isId) { out.println "\t@Id" out.println "\t@GeneratedValue(generator = \"JDBC\")" isId = false } out.println "\tprivate ${it.type} ${it.name};" out.println "" } out.println "}"}def calcFields(table) { DasUtil.getColumns(table).reduce([]) { fields, col -> def spec = Case.LOWER.apply(col.getDataType().getSpecification()) def typeStr = typeMapping.find { p, t -> p.matcher(spec).find() }.value // 如果是BaseTimeUserIdPO中已有的字段，則不再添加 if (!userTimeList.contains(col.getName())) { // 如果是需要導入的類型，則往list里面添加 if (importMap.containsKey(typeStr)) { importList.add(importMap.get(typeStr)) } fields += [[ name : javaName(col.getName(), false), type : typeStr, dbType : col.getDataType(), comment: col.getComment() ]] } else { fields += [] } }}def isNotEmpty(content) { return content != null && content.toString().trim().length() > 0}def javaName(str, capitalize) { def s = com.intellij.psi.codeStyle.NameUtil.splitNameIntoWords(str) .collect { Case.LOWER.apply(it).capitalize() } .join("") .replaceAll(/[^\p{javaJavaIdentifierPart}[_]]/, "_") capitalize || s.length() == 1 ? s : Case.LOWER.apply(s[0]) + s[1..-1]}

使用方法

在 Database 中選中需要生成實體類的表(可以多選)，右鍵 Scripted Extensions 選擇需要執行的腳本，在彈出的對話框中選擇生成文件的目標目錄，OK。

參考資料

[1]?idea通過數據庫生成java實體類(lombok版)

如果覺得寫的不錯，請記得轉發或者在看，這是對我最大的認可和鼓勵！

作者：sisibeloved
來源：https://juejin.im/post/5ca5d01f5188257e1d45707a 《新程序員》：云原生和全面數字化實踐50位技術專家共同創作，文字、視頻、音頻交互閱讀

總結

以上是生活随笔為你收集整理的idea persistence生成_真厉害！竟然可以这样用IDEA通过数据库生成lombok版的POJO...的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。