IDEA自動生成實體類

qq_40809236發表於2020-09-24

IDEA根據資料表自動生成實體類

第一次根據需求建了庫,寫實體類的時候一條條寫太過麻煩,於是上網查詢了一些資料一勞永逸一下。之前看到過別人使用自動生成的工具,不知道是Navicat自帶的還是其他的工具,這次我使用的是idea的工具進行操作,記錄一下操作步驟以便後續使用也分享一下。

簡單的流程介紹

  1. 首先使用IDEA的Database連結資料庫
  2. 修改Generate POJOs.groovy檔案
  3. 選擇指定的包下生成實體類

具體操作

IDEA頂部選單欄選擇View—Tool Windows—Database
在這裡插入圖片描述
點選Test Connection可以測試連結,進行相關的配置後點選Apply/OK

這時候右側就可以找到Database的選單欄了
在這裡插入圖片描述
右鍵點選一張表,選擇Scripted Extensions — Generate POJOs.groovy,在彈出的對話方塊中選擇想要建立實體類的包,點選ok就可以自動生成了
在這裡插入圖片描述
但是!自帶的生成格式可能無法滿足需求,比方說類名未必符合需求,沒有使用Lombok自動生成get/set等方法,也沒有生成註解等問題,所以需要修改Generate POJOs.groovy檔案,用來自定義生成實體類的樣式

同樣的右鍵點選一張表,選擇Scripted Extensions — Go To Scripts Directory可以找到生成實體類的相關配置檔案,在此包下新建一個配置檔案,這裡我取名為Generate MyPOJOs.groovy,附上程式碼

  1. 使用了Lombok的@Data註解來處理get/set等方法,簡化了原始碼
  2. 修改使用@TableName註解來設定對應表名
  3. 去除了@Column註解

可以根據個人不同的需求再進行其他的修改

import com.intellij.database.model.DasTable
import com.intellij.database.model.ObjectKind
import com.intellij.database.util.Case
import com.intellij.database.util.DasUtil
import java.io.*
import java.text.SimpleDateFormat

/*
 * Available context bindings:
 *   SELECTION   Iterable<DasObject>
 *   PROJECT     project
 *   FILES       files helper
 */
packageName = ""
typeMapping = [
        (~/(?i)tinyint|smallint|mediumint/)      : "Integer",
        (~/(?i)int/)                             : "Long",
        (~/(?i)bool|bit/)                        : "Boolean",
        (~/(?i)float|double|decimal|real/)       : "Double",
        (~/(?i)datetime|timestamp|date|time/)    : "Date",
        (~/(?i)blob|binary|bfile|clob|raw|image/): "InputStream",
        (~/(?i)/)                                : "String"
]


FILES.chooseDirectoryAndSave("Choose directory", "Choose where to store generated files") { dir ->
    SELECTION.filter { it instanceof DasTable && it.getKind() == ObjectKind.TABLE }.each { generate(it, dir) }
}

def generate(table, dir) {
    def className = javaClassName(table.getName(), true)
    def fields = calcFields(table)
    packageName = getPackageName(dir)
    PrintWriter printWriter = new PrintWriter(new OutputStreamWriter(new FileOutputStream(new File(dir, className + ".java")), "UTF-8"))
    printWriter.withPrintWriter {out -> generate(out, className, fields,table)}

//    new File(dir, className + ".java").withPrintWriter { out -> generate(out, className, fields,table) }
}

// 獲取包所在資料夾路徑
def getPackageName(dir) {
    return dir.toString().replaceAll("\\\\", ".").replaceAll("/", ".").replaceAll("^.*src(\\.main\\.java\\.)?", "") + ";"
}

def generate(out, className, fields,table) {
    out.println "package $packageName"
    out.println ""
    out.println "import java.io.Serializable;"
    out.println "import lombok.Data;"
    out.println "import com.baomidou.mybatisplus.annotation.TableName;"
    Set types = new HashSet()

    fields.each() {
        types.add(it.type)
    }

    if (types.contains("Date")) {
        out.println "import java.util.Date;"
    }

    if (types.contains("InputStream")) {
        out.println "import java.io.InputStream;"
    }
    out.println ""
    out.println "@Data"
    out.println "@TableName(\""+table.getName() +"\")"
    out.println "public class $className implements Serializable {"
    out.println ""
    out.println genSerialID()
    fields.each() {
        out.println ""
        // 輸出註釋
        if (isNotEmpty(it.commoent)) {
            out.println "\t/**"
            out.println "\t * ${it.commoent.toString()}"
            out.println "\t */"
        }

//        if (it.annos != "") out.println "   ${it.annos.replace("[@Id]", "")}"

        // 輸出成員變數
        out.println "\tprivate ${it.type} ${it.name};"
    }

    // 輸出get/set方法
//    fields.each() {
//        out.println ""
//        out.println "\tpublic ${it.type} get${it.name.capitalize()}() {"
//        out.println "\t\treturn this.${it.name};"
//        out.println "\t}"
//        out.println ""
//
//        out.println "\tpublic void set${it.name.capitalize()}(${it.type} ${it.name}) {"
//        out.println "\t\tthis.${it.name} = ${it.name};"
//        out.println "\t}"
//    }
    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
        def comm =[
                colName : col.getName(),
                name :  javaName(col.getName(), false),
                type : typeStr,
                commoent: col.getComment()]
//                annos: "\t@Column(name = \""+col.getName()+"\" )"]
//        if("id".equals(Case.LOWER.apply(col.getName())))
//            comm.annos +=["@Id"]
        fields += [comm]
    }
}

// 處理類名(這裡是因為我的表都是以t_命名的,所以需要處理去掉生成類名時的開頭的T,
// 如果你不需要那麼請查詢用到了 javaClassName這個方法的地方修改為 javaName 即可)
def javaClassName(str, capitalize) {
    def s = com.intellij.psi.codeStyle.NameUtil.splitNameIntoWords(str)
            .collect { Case.LOWER.apply(it).capitalize() }
            .join("")
            .replaceAll(/[^\p{javaJavaIdentifierPart}[_]]/, "_")
    // 去除開頭的T  http://developer.51cto.com/art/200906/129168.htm
    s = s[1..s.size() - 1]
    capitalize || s.length() == 1? s : Case.LOWER.apply(s[0]) + s[1..-1]
}

def javaName(str, capitalize) {
//    def s = str.split(/(?<=[^\p{IsLetter}])/).collect { Case.LOWER.apply(it).capitalize() }
//            .join("").replaceAll(/[^\p{javaJavaIdentifierPart}]/, "_")
//    capitalize || s.length() == 1? s : Case.LOWER.apply(s[0]) + s[1..-1]
    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]
}

def isNotEmpty(content) {
    return content != null && content.toString().trim().length() > 0
}

static String changeStyle(String str, boolean toCamel){
    if(!str || str.size() <= 1)
        return str

    if(toCamel){
        String r = str.toLowerCase().split('_').collect{cc -> Case.LOWER.apply(cc).capitalize()}.join('')
        return r[0].toLowerCase() + r[1..-1]
    }else{
        str = str[0].toLowerCase() + str[1..-1]
        return str.collect{cc -> ((char)cc).isUpperCase() ? '_' + cc.toLowerCase() : cc}.join('')
    }
}

static String genSerialID() {
    return "\tprivate static final long serialVersionUID =  " + Math.abs(new Random().nextLong()) + "L;"
}

修改後再次右鍵點選表名,選我們剛剛新建的檔案,再選擇包進行建立實體類

這次建立的實體類中可以看到使用了Lombok並且表中對應的註解也寫了進來,也進行了駝峰命名轉換,完美符合了我的需求
在這裡插入圖片描述
至此,問題解決,可以不再為建實體類而發愁了。

PS. 如果有幫助歡迎採用轉載

相關文章