结合Groovy脚本在IDEA可以为所欲为——根据已有的entity信息使用freemarker模板

已于 2024-03-20 18:52:04 修改
阅读量196 收藏 3
点赞数
分类专栏： 工具使用 文章标签： intellij-idea java
于 2023-09-05 11:32:42 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/monkeyhi/article/details/132685059
版权

前言

网上有很多都是通过groovy从数据库表生成实体类，那可不可以通过groovy获取已经存在的实体类信息呢？答案当然是可以的。本文就是说明如何在IDEA的Groovy控制台，根据已有的entity，获取entity的信息，然后根据获取的信息使用freemarker模板进行输出。
对于已经存在的项目，它的实体类可能不是那么轻易能覆盖的（涉及字段的类型的确定、注解的组合…）。如何快速校验一个字段超多的实体类字段；如何通过已有的实体类生成DTO、BO、VO等等，从已有的实体获取字段信息无疑是完美的解决方案。
不需要看步骤的直接跳到本文的总结
不需要看步骤的直接跳到本文的总结
不需要看步骤的直接跳到本文的总结

一个例子

下面将结合mybatis-plus的注解标注的实体类举例，如果是实体类是JPA的注解标注的，只需要将脚本中获取信息的注解换成JPA的注解即可；

已有一个UserInfo的实体类，其实体类代码假设如下：

package com.test.bean;

import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * 用户信息详情
 * @author 
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName("USER_INFO")
@ApiModel(value = "UserInfo 对象", description = "用户信息详情")
public class UserInfo {
	@ApiModelProperty(value = "主键ID")
	@TableId(value = "ID")
	private String id;
	
	/** 用户名 */
	@ApiModelProperty(value = "用户名name")
	@TableField(value = "USER_NAME")
	private String userName;

	/** 用户密码 */
	@ApiModelProperty(value = "用户密码")
	@TableField(value = "USER_PW")
	private String userPw;
}

由上可以看到，实体类的其他信息都由 TableName、TableId、TableField、ApiModelProperty等注解标注清楚了，在IDEA的groovy控制台就可以通过注解获取这些值，使用如下脚本获取实体的信息：
打开Groovy控制台
Groovy控制台截图
文件groovy_console.groovy内容：

import com.baomidou.mybatisplus.annotation.TableField
import com.baomidou.mybatisplus.annotation.TableId
import com.baomidou.mybatisplus.annotation.TableName
import com.test.bean.UserInfo
import freemarker.template.Configuration
import freemarker.template.Template
import io.swagger.annotations.ApiModel
import io.swagger.annotations.ApiModelProperty
import org.apache.commons.lang3.StringUtils

import java.lang.annotation.Annotation

// 获取entity
def entity = UserInfo

// 字段信息
class filedInfo {
    def String name; // 默认驼峰命名法
    def String capitalName; // 首字母大写
    def String dbName; // 数据库的名字
    def String type; // 类型名称
    def String typeFull; // 类型全称
    def String comment; // 字段注释
    def boolean ifPk = false;
}

def entityInfo = [
        dir: System.getProperty("user.dir"), // 获取工程的目录
        package : entity.getPackage().name, // 获取包名
        name: entity.getSimpleName(), // 获取类名
        tableName: "",
        tableComment: "",
        fieldName: entity.getDeclaredFields().name, // 获取所有字段名
        pkField: [], // 获取id字段
        field: [], // 字段
        fieldAll: [], // 全部字段
]

def model = entity.getAnnotation(ApiModel)
if (model != null) {
    entityInfo.tableComment = model.description()
}
def table = entity.getAnnotation(TableName)
if (table != null) {
    entityInfo.tableName = table.value()
}

// 填充 field
for(def field in entity.getDeclaredFields()) {
    def info = new filedInfo()
    info.name = field.name
    info.capitalName = StringUtils.upperCase(field.name[0]) + field.name[1..field.name.length()-1]
    info.type = field.type.simpleName
    info.typeFull = field.type.name

    def tableField = field.getAnnotation(TableField)
    def tableId = field.getAnnotation(TableId)
    if (tableField != null) {
        info.dbName = tableField.value()
        info.ifPk = false
        entityInfo.field.add(info)
    } else if (tableId != null) {
        info.dbName = tableId.value()
        info.ifPk = true
        entityInfo.pkField.add(info)
    } else {
        info.dbName = ""
    }
    def comment = field.getAnnotation(ApiModelProperty)
    if (comment != null) {
        info.comment = comment.value()
    }
    entityInfo.fieldAll.add(info)
}

println(entityInfo)

控制台输出如下信息

[
	dir:D:\work\workspaces\workspace-an\test,
	package:com.test.bean,
	name:UserInfo,
	tableName:USER_INFO,
	tableComment:用户信息详情,
	fieldName:[id, userName, userPw],
	pkField:[filedInfo@56f0cc85],
	field:[filedInfo@62e20a76, filedInfo@2cc44ad],
	fieldAll:[filedInfo@56f0cc85, filedInfo@62e20a76, filedInfo@2cc44ad]
]

其中id的filedInfo信息如下
name id;
capitalName  Id;
dbName  ID;
type  String;
typeFull  java.lang.String;
comment  主键ID;
ifPk true;

其中userName的filedInfo信息如下
name userName;
capitalName  UserName;
dbName  USER_NAME;
type  String;
typeFull  java.lang.String;
comment  用户名name;
ifPk false;

使用FreeMarker模板

还可以使用模板输出信息

//1.创建freeMarker配置实例
Configuration cfg = new Configuration(Configuration.VERSION_2_3_0);
//2.设置模板加载器：开始加载模板 scratches 文件夹为IDEA的临时文件夹
cfg.setDirectoryForTemplateLoading(new File("C:\\Users\\admin\\AppData\\Roaming\\JetBrains\\IntelliJIdea2023.2\\scratches"));

//4.获取模板
Template template = cfg.getTemplate("scratch.ftl");
template.process(entityInfo, new PrintWriter(System.out)); //在控制台输出

scratch.ftl 模板

package ${package};

<#list field as f>
    name ${f.name}; capitalName  ${f.capitalName}; dbName  ${f.dbName}; type  ${f.type}; typeFull  ${f.typeFull}; comment  ${f.comment}; ifPk ${f.ifPk?c};
</#list>

${dir}
${name}

<#list field as f>
    @ApiModelProperty(value = "${f.comment}")
    @TableField(value = "${f.dbName}")
    private ${f.type} ${f.name};
</#list>

package ${package};
@TableName("${tableName}")
@ApiModel(value = "${name}对象", description = "${tableComment}")
public class ${name} {
}

输出信息如下

package com.test.bean;

    name userName; capitalName  UserName; dbName  USER_NAME; type  String; typeFull  java.lang.String; comment  用户名name; ifPk true;
    name userPw; capitalName  UserPw; dbName  USER_PW; type  String; typeFull  java.lang.String; comment  用户密码; ifPk true;

D:\work\workspaces\workspace-an\test
UserInfo

    @ApiModelProperty(value = "用户名name")
    @TableField(value = "USER_NAME")
    private String userName;
    @ApiModelProperty(value = "用户密码")
    @TableField(value = "USER_PW")
    private String userPw;

package com.test.bean;
@TableName("USER_INFO")
@ApiModel(value = "UserInfo对象", description = "用户信息详情")
public class UserInfo {
}

总结

完全的脚本，只需要更换entity的变量即可,在下面的注释获取entity处，加载自己的临时文件夹获取自己定义的模板文件。

groovy_console.groovy

import com.baomidou.mybatisplus.annotation.TableField
import com.baomidou.mybatisplus.annotation.TableId
import com.baomidou.mybatisplus.annotation.TableName
import com.test.bean.UserInfo
import freemarker.template.Configuration
import freemarker.template.Template
import io.swagger.annotations.ApiModel
import io.swagger.annotations.ApiModelProperty
import org.apache.commons.lang3.StringUtils

import java.lang.annotation.Annotation

// 获取entity
def entity = UserInfo

// 字段信息
class filedInfo {
    def String name; // 默认驼峰命名法
    def String capitalName; // 首字母大写
    def String dbName; // 数据库的名字
    def String type; // 类型名称
    def String typeFull; // 类型全称
    def String comment; // 字段注释
    def boolean ifPk = false;
}

def entityInfo = [
        dir: System.getProperty("user.dir"), // 获取工程的目录
        package : entity.getPackage().name, // 获取包名
        name: entity.getSimpleName(), // 获取类名
        tableName: "",
        tableComment: "",
        fieldName: entity.getDeclaredFields().name, // 获取所有字段名
        pkField: [], // 获取id字段
        field: [], // 字段
        fieldAll: [], // 全部字段
]

def model = entity.getAnnotation(ApiModel)
if (model != null) {
    entityInfo.tableComment = model.description()
}
def table = entity.getAnnotation(TableName)
if (table != null) {
    entityInfo.tableName = table.value()
}

// 填充 field
for(def field in entity.getDeclaredFields()) {
    def info = new filedInfo()
    info.name = field.name
    info.capitalName = StringUtils.upperCase(field.name[0]) + field.name[1..field.name.length()-1]
    info.type = field.type.simpleName
    info.typeFull = field.type.name

    def tableField = field.getAnnotation(TableField)
    def tableId = field.getAnnotation(TableId)
    if (tableField != null) {
        info.dbName = tableField.value()
        info.ifPk = false
        entityInfo.field.add(info)
    } else if (tableId != null) {
        info.dbName = tableId.value()
        info.ifPk = true
        entityInfo.pkField.add(info)
    } else {
        info.dbName = ""
    }
    def comment = field.getAnnotation(ApiModelProperty)
    if (comment != null) {
        info.comment = comment.value()
    }
    entityInfo.fieldAll.add(info)
}

println(entityInfo)

//1.创建freeMarker配置实例
Configuration cfg = new Configuration(Configuration.VERSION_2_3_0);
//2.设置模板加载器：开始加载模板
cfg.setDirectoryForTemplateLoading(new File("C:\\Users\\admin\\AppData\\Roaming\\JetBrains\\IntelliJIdea2023.2\\scratches"));

//4.获取模板
Template template = cfg.getTemplate("scratch.ftl");
template.process(entityInfo, new PrintWriter(System.out)); //在控制台输出

scratch.ftl模板

可以根据自己需要进行定制

package ${package};

<#list field as f>
    name ${f.name}; capitalName  ${f.capitalName}; dbName  ${f.dbName}; type  ${f.type}; typeFull  ${f.typeFull}; comment  ${f.comment}; ifPk ${f.ifPk?c};
</#list>

<#--项目工程的主目录-->
${dir}
${name}

<#--循环非主键字段-->
<#list field as f>
    @ApiModelProperty(value = "${f.comment}")
    @TableField(value = "${f.dbName}")
    private ${f.type} ${f.name};
</#list>

package ${package};
@TableName("${tableName}")
@ApiModel(value = "${name}对象", description = "${tableComment}")
public class ${name} {
}

一些 entity 的信息

变量名称使用举例
dir获取工程的目录${dir}D:\work\workspaces\workspace-an\test
package获取包名${package}com.test.bean
name类名${name}UserInfo
tableName表名${tableName}USER_INFO
tableComment表注释${tableComment}用户信息详情
fieldName字段名称${fieldName}[id, userName, userPw]
pkField主键字段<#list pkField as f></#list>[filedInfo]
field非主键字段<#list field as f></#list>[filedInfo]
fieldAll全部字段（主键字段、非主键字段）<#list fieldAll as f></#list>[filedInfo]

field 字段信息 filedInfo

变量名称使用举例
name字段名称${f.name}userName
capitalName首字母大写${f.capitalName}UserName
dbName数据库字段名${f.dbName}USER_NAME
type类型名称${f.type}String
typeFull类型全称${f.typeFull}java.lang.String
comment字段注释${f.comment}用户名name
ifPk是否主键${f.ifPk?c}true|false

一些常用的模板

<#--循环主键字段-->
<#list pkField as f>
    @ApiModelProperty(value = "${f.comment}")
    @TableId(value = "${f.dbName}")
    private ${f.type} ${f.name};
</#list>

<#--循环非主键字段-->
<#list field as f>
    @ApiModelProperty(value = "${f.comment}")
    @TableField(value = "${f.dbName}")
    private ${f.type} ${f.name};
</#list>

<#--类class-->
package ${package};

@TableName("${tableName}")
@ApiModel(value = "${name}对象", description = "${tableComment}")
public class ${name} {
}

<#--getter和setter-->
<#list fieldAll as f>
	public ${f.type} get${f.capitalName}() {
        return ${f.name};
    }
    public void set${f.capitalName}(${f.type} ${f.name}) {
        this.${f.name}= ${f.name};
    }
</#list>

<#--生成json信息-->
[
<#list field as f>
    {
        "name": "${f.name}",
        "type": "${f.type}",
        "comment": "${f.comment}"
    },
</#list>
]
monkeyhi
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
如何使用IDEA的groovy脚本文件生成带JPA注解的实体类(图文详解)
08-18
主要介绍了如何使用IDEA的groovy脚本文件生成带JPA注解的实体类,本文通过图文并茂实例相结合给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
JAVA Freemarker(2)---在IDEA中 SpringMVC整合Freemarker的详细步骤
lovoo的博客
09-27 1095
第一步：build.gradle配置引入jar包，group 'wyscha' version '1.0-SNAPSHOT'apply plugin: 'java' apply plugin: 'war'webAppDirName = 'webapp'sourceCompatibility = 1.8repositories { mavenCentral() }sourceSets {
IDEA中使用Freemarker以及报Cannot resolve MVC View 'xxx'错
weixin_36344134的博客
03-19 2902
一开始新建，添加web、Apathe freemarker模版，这是项目的主要目录内容： // User.java package org.selina.freemarker2.User; public class User { private Long id; private String username; private String password; ...
【Groovy】Groovy 脚本调用 ( Java 类中调用 Groovy 脚本 )
让 学习 成为一种 习惯 ( 韩曙亮 の 技术博客 )
01-15 4418
前言、 一、Groovy 类中调用 Groovy 脚本、 1、参考 Script#evaluate 方法分析 Groovy 类中调用 Groovy 脚本、 2、创建 Binding 对象并设置 args 参数、 3、创建 GroovyShell 对象并执行 Groovy 脚本、 4、代码示例、 二、完整代码示例、 1、调用者 Groovy 脚本的类、 2、被调用者 Groovy 脚本、 3、执行结果
【Groovy】Groovy 脚本调用 ( 命令行执行 Groovy 脚本并传入参数 | 获取 Groovy 脚本执行参数 )
让 学习 成为一种 习惯 ( 韩曙亮 の 技术博客 )
01-12 5164
前言、 一、 命令行执行 Groovy 脚本并传入参数、 二、获取 Groovy 脚本执行参数、
【Groovy】Groovy 脚本调用 ( Groovy 脚本编译 | Groovy 脚本字节码文件分析 )
让 学习 成为一种 习惯 ( 韩曙亮 の 技术博客 )
01-13 3705
一、Groovy 脚本编译、 二、Groovy 脚本字节码文件分析
groovy-loader:在文件目录中动态加载Groovy脚本
05-14
动态加载指定目录下的groovy脚本，并将其注册为groovy bean，放置于ApplicationContext容器中，并使用命名空间进行分类区分(一个namespace对应于一个ApplicationContext)。同时能够动态感知到groovy脚本的新增、修改...
在* .docx文档中使用Groovy脚本
04-03
docx文档中功能齐全的groovy模板scriptlet
Java调用Groovy，实时动态加载数据库groovy脚本
06-08
Java调用Groovy，实时动态加载数据库groovy脚本，java读取mongoDB的groovy脚本，加载实时运行，热部署
groovy-loader-v2:在文件目录中动态加载Groovy脚本
05-12
动态加载指定目录下的groovy脚本，并将其注册为groovy bean，放置于ApplicationContext容器中，并使用命名空间进行分类区分(一个namespace对应于一个ApplicationContext)。同时能够动态感知到groovy脚本的新增、修改...
IDEA 创建Servlet-HelloWorldServlet
weixin_44201223的博客
04-29 588
创建servlet Tomcat运行servlet
【IDEA】IDEA常用快捷键
weixin_44078354的博客
05-03 145
Ctrl+YCtrl+Windows 键和Ctrl + R是不一样的，不要弄混。这个感觉比较常用一些，有些时候可能需要加上Fn按键。
IDEA 申请学生许可证
HONEY MOOSE
04-27 633
如果你有学生账号，并且账号是 EDU 结尾的，可以申请 IDEA 的学生许可证。有效期一年，完全免费。在界面上输入邮件地址，然后单击按钮提交。
IntelliJ IDEA - Auto filling Java call arguments 插件教程
牧码的博客
04-29 400
IntelliJ IDEA - Auto filling Java call arguments 插件教程
IDEA 中 git fetch 验证报错 The provided password or token is incorrect
棉花泡泡糖的博客
04-30 476
这个时候你直接IDEA里面用GitToolBox第一次需要你输入这个令牌，后面失效了，他也不会叫你去改，直接报错。【这种情况导致的直接现象是你每次在命令行执行的时候都会报错】【这种情况是：你在命令行是OK的，但是IDEA里面不行】先说为什么，其实有很多情况都会导致这个问题的发生。去这里重新创建一个，最长365天过期，默认是7天。我们就需要去把IDEA记住的密码删掉。我的解决了，这是网上找的图。windwos记录的旧密码。IDEA记录的旧密码。
IDEA2024版本控制台乱码怎么解决？
十三月的博客
04-30 283
Setting>>Build，Execution,Deployment>>Runnr中的VM Options配置，这里默认是GB2312。在网上找了很多办法，修改了IDEA的vmoptions文件也没有用,最后发现原来是要修改这里。在使用最新版本的IDEA时，可能会遇到控制台输出乱码问题？我们把它改成使用 UTF-8 编码即可！
【保姆级教程】用IDEA2023版本给RuoYi-Vue添加子模块
ordinary_brony的博客
04-29 909
若依前后端分离框架RuoYi-Vue能够极大方便当前开发任务，并且使用的技术栈也相当丰富，但是目前只提供了一些基础的模块，如果要添加新的模块，需要自己手动添加。这里面会存在一大堆问题。
IDEA 多模块项目报错 Cannot Save Settings 问题
最新发布
段子手168的博客
05-03 207
# IDEA 多模块项目报错 Cannot Save Settings 问题
idea 新建spring maven项目、ioc和依赖注入
好好学习，天天向上！
05-03 607
spring、IOC和依赖注入
idea database怎么调试Groovy脚本
05-05
在 IDEA 中调试 Groovy 脚本，可以按照以下步骤进行： 1. 在 IDEA 中打开 Groovy 脚本文件。 2. 点击脚本文件中任意一行代码的左侧行号，添加一个断点。 3. 点击 IDEA 上方的 “Run” 菜单，选择 “Edit Configurations”。 4. 在弹出的窗口中，选择 “Groovy Script” 类型，并点击 “+” 新增一个配置。 5. 在 “Script path” 中选择要运行的 Groovy 脚本文件。 6. 在 “Script arguments” 中添加需要传递给脚本的参数。 7. 在 “Working directory” 中选择脚本文件所在的工作目录。 8. 点击 “OK” 保存配置。 9. 点击 IDEA 上方的 “Debug” 菜单，选择刚才新增的 Groovy 配置。 10. 等待 IDEA 运行并弹出 Debug 窗口，在窗口中可以查看变量的值、调用栈等信息。 通过上述步骤，你就可以在 IDEA 中调试 Groovy 脚本了。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值