如何使用IDEA的groovy脚本文件生成带JPA注解的实体类(图文详解)

牛逼!IDEA不愧为神器,结合Groovy脚本,简直天下无敌,如今, 有许许多多的插件或者编辑器都支持根据数据表自动生成数据实体类了, 比如IDEA, 各种MyBatis的代码生成工具, 等等;本篇介绍一下如何使用IDEA的groovy脚本文件生成带JPA注解的实体类。

# 使用IDEA连接数据库

注意

  • 正式版IDEA才有此功能, 社区版木有
  • 演示图片使用的IDEA版本为2018.3, 不同版本界面可能有细小差别

1、创建新的数据连接

如果没有, 可以上方菜单栏: 视图-工具窗口-Database打开(新建Oracle数据库也是相同操作)。

2、配置数据连接

  • 填写一个连接名,随便填什么都行
  • 不用选择,默认就行
  • 填写数据库连接的 IP地址,比如本地数据库可以填写:localhost或者127.0.0.1
  • 填写数据库开放的端口号,一般没设置的话默认都是3306
  • 填写你需要连接的数据库名
  • 填写数据库的用户名
  • 填写数据库密码
  • 这里会有一个驱动需要点击下载,图中是已经下载好了
  • 填写自己的数据库连接url,然后可以点击9所在按钮进行测试连接,本地连接失败检查是否开启了mysql服务

# IDEA自带的两种创建实体类的方法

1、如果只是创建简单的, 只有属性, getter, setter的实体类, 而不需要JPA/Hibernate的实体类注解。

单击打开刚刚创建的数据连接

打开schemas, 找到自己需要创建实体类的表(可以使用ctrl或shift多选)

右键: Scripted Extensions - Generate POJOs.groovy

选择生成路径就OK了

注意:生成的包名可能有问题, 默认是package com.sample, 需要自己手动修改。

2、使用了Hibernate/Jpa框架, 需要的是有注解的实体类, Idea也提供了相应的方法

添加JPA模块

  • 打开项目结构
  • 打开模块, 点击+号添加模块
  • 选择JPA
  • 点击右下角确定后, 关闭项目结构

使用Persistence工具生成带注解的实体类-1

如果上一步没问题的话, IDEA左下角侧边栏会出现Persistence工具栏打开Persistence工具栏, 右键项目: Generate Persistence Mapping - By Database Schema

使用Persistence工具生成带注解的实体类-2

  • 选择数据库连接
  • 选择生成类所在包
  • 选择要生成的表
  • 选择要生成的字段(选择表后字段默认除了外键全选)
  • 修改要生成的属性名
  • 修改要生成的属性类型
  • 勾上即为生成带注解的实体类

生成的类实例如下

# 更进一步, 使用自己的Groovy生成带注解的实体类

上面介绍了两个使用IDEA生成实体类的方法, 各有优缺点。生成不带注解的实体类简单高效, 但缺点就是如果使用的是Jpa/Hibernate框架就不适合;生成带注解的实体类能生成注解实体类, 但缺点就是生成的实体类的注解可能不太符合我们的注解, 只能生成到当前项目包下, 面对一些复杂的数据库如Oracle会显示很多系统表而且表空间切换不太方便。

我们知道Idea生成不带注解的实体类是通过Groovy脚本文件生成的, 我们也能找到这个文件, 那我们能不能修改这个文件, 让它生成带注解的实体类呢?

1、使用自己的Groovy生成带注解的实体类的好处

  • 在Database工具栏里, 操作简单方便
  • 可以自己对脚本进行一些编辑, 使生成的实体类达到自己的定制需求
  • 对Oracle这样的数据库生成实体类时, 避免了系统表的影响, 可以自己选择表空间进行操作
  • 可以生成在电脑上的任何位置, 不受限制

2、使用自己的Groovy生成带注解的实体类的不足

  • @author 作者名需要自己修改脚本
  • @Table(Schema="") 的表空间名不能读取, 需要自己修改脚本, 设定表空间名(mysql可以直接删除这个属性的定义)(IDEA的Persistence工具可以读取(Schema=""属性并生成, 但我们不知道它是怎么获取的)
  • @Id的主键生成方式不可知, 需要生成后自己确定(mysql用户可以直接修改脚本设定主键生成方式, 但Oracle用户需要生成实体类后再逐个确认)

3、使用自己的Groovy生成带注解的实体类可以继续完善的地方

如果需要hashcode()和equals()方法, 也修改脚本, 使其自动生成。

4、新建一个Groovy脚本文件

Database工具栏里, 右键右键: Scripted Extensions - Go to Scripts Directory

在目录下新建一个Generate MyPOJOs.groovy

添加里面的内容:

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.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 = javaName(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 javax.persistence.Column;"
 out.println "import javax.persistence.Entity;"
 out.println "import javax.persistence.Table;"
 out.println "import javax.persistence.Id;"
 out.println "import javax.persistence.GeneratedValue;"
 out.println "import java.io.Serializable;"
 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 "/**\n" +
  " * @Description \n" +
  " * @Author idea\n" + //1. 修改idea为自己名字
  " * @Date " + new SimpleDateFormat("yyyy-MM-dd").format(new Date()) + " \n" +
  " */"
 out.println ""
 out.println "@Entity"
 out.println "@Table ( name =\"" + table.getName() + "\" , schema = \"\")" //2. schema = \"后面添加自己的表空间名称(mysql可以不添加, 不用这个schema属性也行)
 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+"").indexOf("[@Id]") >= 0) out.println "\t@Id"

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

 // 输出toString方法
 out.println ""
 out.println "\t@Override"
 out.println "\tpublic String toString() {"
 out.println "\t\treturn \"TpApiConfig{\" +"
 fields.each() {
 out.println "\t\t\t\t\"${it.name}='\" + ${it.name} + '\\'' +"
 }
 out.println "\t\t\t\t'}';"
 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]
 }
}

// 已经修改为使用javaName, 如果有需要可以在def className = javaName(table.getName(), true)中修改为javaClassName
// 处理类名(这里是因为我的表都是以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;"
}

表上右键, 选择自己写的脚本生成实体类,效果如下:

最后,不知道你是否get到本文的技巧,是不是觉得Groovy脚本挺好用啊,关于更多的玩法需要你慢慢去挖掘

到此这篇关于如何使用IDEA的groovy脚本文件生成带JPA注解的实体类的文章就介绍到这了,更多相关IDEA的groovy脚本 JPA注解实体类内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • 使用JPA中@Query 注解实现update 操作方法(必看)

    使用JPA中@Query 注解实现update 操作,代码如下: @Transactional @Modifying(clearAutomatically = true) @Query(value = "update info p set p.status =?1 where p.id = ?2",nativeQuery = true)  int updateStatusById( String status,  String id); 备注: 1.更新info表下指定id的statu

  • 理解JPA注解@GeneratedValue的使用方法

    一.JPA通用策略生成器 通过annotation来映射hibernate实体的,基于annotation的hibernate主键标识为@Id, 其生成规则由@GeneratedValue设定的.这里的@id和@GeneratedValue都是JPA的标准用法, JPA提供四种标准用法,由@GeneratedValue的源代码可以明显看出. Target({METHOD,FIELD}) @Retention(RUNTIME) public @interface GeneratedValue{ G

  • JPA中EntityListeners注解的使用详解

    使用场景 EntityListeners在jpa中使用,如果你是mybatis是不可以用的 它的意义 对实体属性变化的跟踪,它提供了保存前,保存后,更新前,更新后,删除前,删除后等状态,就像是拦截器一样,你可以在拦截方法里重写你的个性化逻辑. 它的使用 定义接口,如实体追踪 /** * 数据建立与更新. */ public interface DataEntity { Timestamp getDateCreated(); void setDateCreated(Timestamp dateCr

  • 详解Spring Data JPA使用@Query注解(Using @Query)

    经过几天的折腾,终于到了学习一个重量级的查询方式上,使用@Query注解,使用注解有两种方式,一种是JPQL的SQL语言方式,一种是原生SQL的语言,略有区别,后者我们更熟悉一些.话不多说,看代码. 1.在CustomerRepository里添加 /** * 模糊匹配 * @param bauer * @return */ @Query("select c from Customer c where c.firstName=?1") Customer findByFirstName2

  • 在JPA的@Query注解中使用limit条件(详解)

    在@Query注解注释的JPQL语句中写limit语句是会报错的 unexpected token :limit near line .... 解决方法是讲@Query注解中的limit语句去掉,然后传一个Pageable pageable=new PageRequest(offset,limit)进去 示例代码: controller import java.util.List; import org.springframework.beans.factory.annotation.Autow

  • 如何使用IDEA的groovy脚本文件生成带JPA注解的实体类(图文详解)

    牛逼!IDEA不愧为神器,结合Groovy脚本,简直天下无敌,如今, 有许许多多的插件或者编辑器都支持根据数据表自动生成数据实体类了, 比如IDEA, 各种MyBatis的代码生成工具, 等等:本篇介绍一下如何使用IDEA的groovy脚本文件生成带JPA注解的实体类. # 使用IDEA连接数据库 注意 正式版IDEA才有此功能, 社区版木有 演示图片使用的IDEA版本为2018.3, 不同版本界面可能有细小差别 1.创建新的数据连接 如果没有, 可以上方菜单栏: 视图-工具窗口-Databas

  • Intellij IDEA 如何通过数据库表生成带注解的实体类(图文详细教程)

    第一步:新建一个Maven项目.项目的名称为JpaDemo. 我这里是通过idea插件对应的spring项目生成器https://start.spring.io,直接生成项目.如图: 下一步,修改成对应项目的基本信息.如图: 选择相应的依赖jar包. 选择项目的位置 完成创建 温馨提示,之前需要安装好maven. 第二步:配置数据库连接. 选择Mysql. 配置数据库基本信息 其实配置了这个数据库连接之后,是可以直接通过脚本进行导出数据库实体类了,但是这个导出的实体类比较简陋,需要进行修改比较多

  • Android Studio 中运行 groovy 程序的方法图文详解

    Groovy简介 Groovy是一种基于JVM(Java虚拟机)的敏捷开发语言,它结合了Python.Ruby和Smalltalk的许多强大的特性,Groovy 代码能够与 Java 代码很好地结合,也能用于扩展现有代码.由于其运行在 JVM 上的特性,Groovy也可以使用其他非Java语言编写的库. Groovy 是 用于Java虚拟机的一种敏捷的动态语言,它是一种成熟的面向对象编程语言,既可以用于面向对象编程,又可以用作纯粹的脚本语言.使用该种语言不必编写过多的代码,同时又具有闭包和动态语

  • python2利用wxpython生成投影界面工具的图文详解

    本投影界面工具的功能: 准备好.prj投影文件,将输入文件夹内的WGS84经纬度坐标shp文件,投影为平面文件,成果自动命名为prj_***并新建在输入文件夹同一路径下. 下一步目标: 利用pyinstaller或其他打包库生成exe文件,目前停滞在python2语法.arcpy打包出错相关问题上. 参考文献: <Using Py2exe with Arcpy- It can be done easily!> <如何使用py2exe打包arcpy脚本?> GUI界面示意图 投影文件

  • C++数据结构之文件压缩(哈夫曼树)实例详解

    C++数据结构之文件压缩(哈夫曼树)实例详解 概要: 项目简介:利用哈夫曼编码的方式对文件进行压缩,并且对压缩文件可以解压 开发环境:windows vs2013 项目概述:         1.压缩 a.读取文件,将每个字符,该字符出现的次数和权值构成哈夫曼树 b.哈夫曼树是利用小堆构成,字符出现次数少的节点指针存在堆顶,出现次数多的在堆底 c.每次取堆顶的两个数,再将两个数相加进堆,直到堆被取完,这时哈夫曼树也建成 d.从哈夫曼树中获取哈夫曼编码,然后再根据整个字符数组来获取出现了得字符的编

  • Django用数据库表反向生成models类知识点详解

    Django根据已有数据库表反向生成models类 一. 创建一个Django项目 django-admin startproject 'xxxx' 二.修改settings文件 在setting里面设置你要连接的数据库名称,地址,账号密码之类的信息,和创建新项目的时候一致 DATABASES = { 'default': { 'ENGINE': 'django.db.backends.mysql', 'NAME': 'djangodemo', # 数据库名称 'USER': 'root', '

  • SpringBoot通过redisTemplate调用lua脚本并打印调试信息到redis log(方法步骤详解)

    第一次写Lua脚本,并通过springboot的redisTemplate调用脚本,进行脚本与应用的交互.不熟悉真的折腾了好久,现在总结一下学习过程: 第一次写完lua时,想到的就是如何在应用调用脚本的时候,去调试脚本.在网上海搜了一把,能找到的有点相关的寥寥无几. 有一种方法是通过执行redis命令,调用redis客户端,加载lua脚本,然后出现基于命令行调试的交互界面,输入调试命令去调试脚本.如下: 在终端输入命令:redis-cli.exe --ldb --eval LimitLoadTi

  • Android三种方式生成矢量图之VectorDrawable类使用详解

    目录 生成矢量图VectorDrawable的三种方式 静态VectorDrawable的使用 配置引用和参数 在控件中使用 生成矢量图VectorDrawable的三种方式 第一种: 选中drawable文件夹,右键New --> Vector Asset --> 选中Clip Art ,在这里面可以选择一些矢量图 ,点击Next,然后 Finish即可. 第二种:(前提:自己有一张svg或psd的图片) 选中drawable文件夹,右键New --> Vector Asset --&

  • php文件包含目录配置open_basedir的使用与性能详解

    1.open_basedir介绍 open_basedir 将php所能打开的文件限制在指定的目录树中,包括文件本身.当程序要使用例如fopen()或file_get_contents()打开一个文件时,这个文件的位置将会被检查.当文件在指定的目录树之外,程序将拒绝打开. 本指令不受安全模式打开或关闭的影响. 2.open_basedir设置方法 1.在php.ini 加入 open_basedir="指定目录" 2.在程序中使用 ini_set('open_basedir', '指定

  • jsp中点击图片弹出文件上传界面及实现预览实例详解

    jsp中点击图片弹出文件上传界面及实现预览实例详解 花了两天时间琢磨一下图片预览的功能 任务需求如下: 1:jsp页面中有一个图片(pic_1) 2:点击图片弹出类似于资源管理器的界面 3:选择完某一个图片之后在pic_1处预览 我在IE8上试验下面这段代码,可以实现上述功能,没有在别的浏览器中测试,如果各位朋友知道多种浏览器的支持方法,请赐教,共同学习,谢谢. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN&qu

随机推荐