IDEA:使用 Groovy 脚本扩展自动生成 model 类(Kotlin 版)

代码生成已经是目前软件开发框架中的标配功能了,大多数代码生成都使用内置到项目中模块来实现,如果有调整需要修改项目代码,这里介绍一下 IDEA 内置的代码生成功能:使用 Groovy 脚本扩展来进行代码生成,同时附上本人在用的生成 KotlinModel 类的脚本。

使用方法

IDEA 连接数据库

IDEA 旗舰版内置了 DataGrip 的大部分功能用于管理数据库,可在侧边栏找到,创建连接后连接到开发数据库(步骤略)。

20220301_121255.png

定位 Groovy 脚本目录

IDEA 已经内置了几个用于生成模型类的脚本,我们可以根据自己需求创建自己的脚本。

在任意表中右键选择脚本扩展 - 转到脚本目录

20220301_121434.png

然后就可以看到内置的脚本文件,双击就可以编辑,也可以新增。

20220301_121530.png

编写 Groovy 脚本文件

这里分享目前自用的生成 KotlinModel 类的脚本:

注意:请将脚本中的 author 作者换成自己名字~

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 = ""

//正则说明:
// ~:正则
// /:定界符
// ^:开始
// (?i):后面不区分大小写
typeMapping = [
        (~/^(?i)(tinyint|smallint|int|mediumint)$/)  : "Int",
        (~/^(?i)(bigint)$/)                          : "Long",
        (~/^(?i)(bool|bit)$/)                        : "Boolean",
        (~/^(?i)(float|double|decimal|real)$/)       : "Double",
        (~/^(?i)(date)$/)                            : "LocalDate",
        (~/^(?i)(datetime|timestamp|time)$/)         : "LocalDateTime",
        (~/^(?i)(blob|binary|bfile|clob|raw|image)$/): "InputStream",
        (~/(?i)/)                                    : "String"
]

FILES.chooseDirectoryAndSave("选择路径", "选择生成文件存放路径") { dir ->
    SELECTION.filter { it instanceof DasTable && it.getKind() == ObjectKind.TABLE }.each { generate(it, dir) }
}

def generate(table, dir) {
    def className = javaName(table.getName(), true) + "" //文件名可以加后缀
    def fields = calcFields(table)
    packageName = getPackageName(dir)
    PrintWriter printWriter = new PrintWriter(new OutputStreamWriter(new FileOutputStream(new File(dir, className + ".kt")), "UTF-8"))
    printWriter.withPrintWriter { out -> generate(out, className, fields, table) }

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

// 获取包所在文件夹路径
static 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 com.baomidou.mybatisplus.annotation.TableName"
    out.println "import com.baomidou.mybatisplus.annotation.TableField"

    Set types = new HashSet()

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

        //推测主键
        if (Case.LOWER.apply(it.name).equals("id") || Case.LOWER.apply(it.name).equals("guid") || Case.LOWER.apply(it.name).equals("uuid")) {
            out.println "import com.baomidou.mybatisplus.annotation.TableId"
        }
    }

    if (types.contains("LocalDate")) {
        out.println "import java.time.LocalDate;"
    }

    if (types.contains("LocalDateTime")) {
        out.println "import java.time.LocalDateTime;"
    }

    if (types.contains("InputStream")) {
        out.println "import java.io.InputStream;"
    }

    out.println ""

    // 生成类注释
    generateClassComments(out, table)
    out.println "@TableName(\"" + table.getName() + "\")"
    out.println "data class $className("
    //out.println genSerialID()
    fields.each() {
        out.println ""
        // 输出注释
        if (isNotEmpty(it.commoent)) {
            out.println "    /**"
            out.println "     * ${it.commoent.toString()}"
            out.println "     */"
        }

        if (it.annos != "") {
            out.println "    ${it.annos}"
        }

        // 输出成员变量
        out.println "    var ${it.name}: ${it.type}? = null,"
    }

// 输出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 ")"
}

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   : ""]
        //annos: "\t@Column(name = \""+col.getName()+"\" )"]

        //判断主键(暂时从字段名推测)
        if (Case.LOWER.apply(col.getName()).equals("id") || Case.LOWER.apply(col.getName()).equals("guid") || Case.LOWER.apply(col.getName()).equals("uuid")) {
            comm.annos += "@TableId(\"" + col.getName() + "\")"
        } else {
            comm.annos += "@TableField(\"" + col.getName() + "\")"
        }

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

static 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 void generateClassComments(out, table) {
    /* 生成类注释 */
    ["/**",
     " * ${table.getComment() == null ? "xxx" : table.getComment()} model",
     " *",
     " * @author xinggang",
     " * @create " + new SimpleDateFormat("yyyy-MM-dd").format(new Date()),
     " */"
    ].each() {
        out.println "${it}"
    }
}

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

代码生成

选择需要代码生成的数据库表,然后点击右键-脚本扩展,我这里选择 Generate POJOs.MyBatis-Plus.Kotlin.groovy

弹出目录选择窗口,选择要保存的位置,点击确定即可。

20220301_115625.png

生成的代码

20220301_115759.png

完~🏝️

最后修改:2022 年 03 月 01 日 12 : 20 PM
如果觉得我的文章对你有用,请随意赞赏

发表评论