IDEA 逆向生成实体类 Groovy JPA

环境说明

IDEA版本：2020.1.3 MySQL版本：8.0.16

1、通过IDEA连接数据

1.打开数据库连接面板

image.png
或
image.png

2.选择MySQL数据库连接

image.png

3.配置连接信息

image.png

4.连接成功并读取到表结构信息

image.png

2、选择表逆向生成POJO

1.选择逆向生成的表

2.表名上右键: Scripted Extensions -> Generate POJOs.groovy

image.png

3.选择生成POJO的文件夹（Java的包）

image.png

4.修改生成的类文件的包名（逆向生成稍有问题，包错误）

image.png

3、使用Hibernate/JPA框架生成有注解的实体类

1.配置jpa框架

image.png

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

image.png
image.png

3.设置生成的配置信息

image.png

4.生成带有JPA注解的Java Bean

image.png

4、使用自己的Groovy生成带注解的实体类

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

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

  1. 在Database工具栏里, 操作简单方便
  2. 可以自己对脚本进行一些编辑, 使生成的实体类达到自己的定制需求
  3. 对Oracle这样的数据库生成实体类时, 避免了系统表的影响, 可以自己选择表空间进行操作

  4. 可以生成在电脑上的任何位置, 不受限制

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

  5. @author 作者名需要自己修改脚本

  6. @Table(Schema=””) 的表空间名不能读取, 需要自己修改脚本, 设定表空间名(mysql可以直接删除这个属性的定义)(IDEA的Persistence工具可以读取(Schema=””属性并生成, 但不知道它是怎么获取的)

  7. @Id的主键生成方式不可知, 需要生成后自己确定(mysql用户可以直接修改脚本设定主键生成方式, 但Oracle用户需要生成实体类后再逐个确认)

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

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

    (4)操作步骤

    ①新建一个自定义的Groovy脚本文件

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

image.png

  1. 在目录下新建一个GenerateToPOJOs.groovy

image.png

②脚本内容

  1. import com.intellij.database.model.DasTable
  2. import com.intellij.database.model.ObjectKind
  3. import com.intellij.database.util.Case
  4. import com.intellij.database.util.DasUtil
  6. import java.text.SimpleDateFormat
  8. /*
  9.  * Available context bindings:
  10.  *   SELECTION   Iterable<DasObject>
  11.  *   PROJECT     project
  12.  *   FILES       files helper
  13.  */
  14. packageName = ""
  15. typeMapping = [
  16.         (~/(?i)tinyint|smallint|mediumint/)      : "Integer",
  17.         (~/(?i)int/)                             : "Long",
  18.         (~/(?i)bool|bit/)                        : "Boolean",
  19.         (~/(?i)float|double|decimal|real/)       : "Double",
  20.         (~/(?i)datetime|timestamp|date|time/)    : "Date",
  21.         (~/(?i)blob|binary|bfile|clob|raw|image/): "InputStream",
  22.         (~/(?i)/)                                : "String"
  23. ]
  26. FILES.chooseDirectoryAndSave("Choose directory", "Choose where to store generated files") { dir ->
  27.     SELECTION.filter { it instanceof DasTable && it.getKind() == ObjectKind.TABLE }.each { generate(it, dir) }
  28. }
  30. def generate(table, dir) {
  31.     def className = javaName(table.getName(), true)
  32.     def fields = calcFields(table)
  33.     packageName = getPackageName(dir)
  34.     PrintWriter printWriter = new PrintWriter(new OutputStreamWriter(new FileOutputStream(new File(dir, className + ".java")), "UTF-8"))
  35.     printWriter.withPrintWriter { out -> generate(out, className, fields, table) }
  37. //    new File(dir, className + ".java").withPrintWriter { out -> generate(out, className, fields,table) }
  38. }
  40. // 获取包所在文件夹路径
  41. def getPackageName(dir) {
  42.     return dir.toString().replaceAll("\\\\", ".").replaceAll("/", ".").replaceAll("^.*src(\\.main\\.java\\.)?", "") + ";"
  43. }
  45. def generate(out, className, fields, table) {
  46.     out.println "package $packageName"
  47.     out.println ""
  48.     out.println "import javax.persistence.Column;"
  49.     out.println "import javax.persistence.Entity;"
  50.     out.println "import javax.persistence.Table;"
  51.     out.println "import javax.persistence.Id;"
  52.     out.println "import javax.persistence.GeneratedValue;"
  53.     out.println "import java.io.Serializable;"
  54.     Set types = new HashSet()
  56.     fields.each() {
  57.         types.add(it.type)
  58.     }
  60.     if (types.contains("Date")) {
  61.         out.println "import java.util.Date;"
  62.     }
  64.     if (types.contains("InputStream")) {
  65.         out.println "import java.io.InputStream;"
  66.     }
  67.     out.println ""
  68.     out.println "/**\n" +
  69.             " * @Description  \n" +
  70.             " * @Author Fcant\n" + //1. 修改为自己名字
  71.             " * @Date " + new SimpleDateFormat("yyyy-MM-dd").format(new Date()) + " \n" +
  72.             " */"
  73.     out.println ""
  74.     out.println "@Entity"
  75.     out.println "@Table ( name =\"" + table.getName() + "\")" //2. schema = \"后面添加自己的表空间名称(mysql可以不添加, 不用这个schema属性也行)
  76.     out.println "public class $className  implements Serializable {"
  77.     out.println ""
  78.     out.println genSerialID()
  79.     fields.each() {
  80.         out.println ""
  81.         // 输出注释
  82.         if (isNotEmpty(it.commoent)) {
  83.             out.println "\t/**"
  84.             out.println "\t * ${it.commoent.toString()}"
  85.             out.println "\t */"
  86.         }
  88.         if ((it.annos+"").indexOf("[@Id]") >= 0) out.println "\t@Id"
  90.         if (it.annos != "") out.println "   ${it.annos.replace("[@Id]", "")}"
  93.         // 输出成员变量
  94.         out.println "\tprivate ${it.type} ${it.name};"
  95.     }
  97.     // 输出get/set方法
  98.     fields.each() {
  99.         out.println ""
  100.         out.println "\tpublic ${it.type} get${it.name.capitalize()}() {"
  101.         out.println "\t\treturn this.${it.name};"
  102.         out.println "\t}"
  103.         out.println ""
  105.         out.println "\tpublic void set${it.name.capitalize()}(${it.type} ${it.name}) {"
  106.         out.println "\t\tthis.${it.name} = ${it.name};"
  107.         out.println "\t}"
  108.     }
  110.     // 输出toString方法
  111.     out.println ""
  112.     out.println "\t@Override"
  113.     out.println "\tpublic String toString() {"
  114.     out.println "\t\treturn \"TpApiConfig{\" +"
  115.     fields.each() {
  116.         out.println "\t\t\t\t\"${it.name}='\" + ${it.name} + '\\'' +"
  117.     }
  118.     out.println "\t\t\t\t'}';"
  119.     out.println "\t}"
  121.     out.println ""
  122.     out.println "}"
  123. }
  125. def calcFields(table) {
  126.     DasUtil.getColumns(table).reduce([]) { fields, col ->
  127.         def spec = Case.LOWER.apply(col.getDataType().getSpecification())
  129.         def typeStr = typeMapping.find { p, t -> p.matcher(spec).find() }.value
  130.         def comm = [
  131.                 colName : col.getName(),
  132.                 name    : javaName(col.getName(), false),
  133.                 type    : typeStr,
  134.                 commoent: col.getComment(),
  135.                 annos   : "\t@Column(name = \"" + col.getName() + "\" )"]
  136.         if ("id".equals(Case.LOWER.apply(col.getName())))
  137.             comm.annos += ["@Id"]
  138.         fields += [comm]
  139.     }
  140. }
  142. // 已经修改为使用javaName, 如果有需要可以在def className = javaName(table.getName(), true)中修改为javaClassName
  143. // 处理类名（这里是因为我的表都是以t_命名的，所以需要处理去掉生成类名时的开头的T，
  144. // 如果你不需要那么请查找用到了 javaClassName这个方法的地方修改为 javaName 即可）
  145. def javaClassName(str, capitalize) {
  146.     def s = com.intellij.psi.codeStyle.NameUtil.splitNameIntoWords(str)
  147.             .collect { Case.LOWER.apply(it).capitalize() }
  148.             .join("")
  149.             .replaceAll(/[^\p{javaJavaIdentifierPart}[_]]/, "_")
  150.     // 去除开头的T  http://developer.51cto.com/art/200906/129168.htm
  151.     s = s[1..s.size() - 1]
  152.     capitalize || s.length() == 1 ? s : Case.LOWER.apply(s[0]) + s[1..-1]
  153. }
  155. def javaName(str, capitalize) {
  156. //    def s = str.split(/(?<=[^\p{IsLetter}])/).collect { Case.LOWER.apply(it).capitalize() }
  157. //            .join("").replaceAll(/[^\p{javaJavaIdentifierPart}]/, "_")
  158. //    capitalize || s.length() == 1? s : Case.LOWER.apply(s[0]) + s[1..-1]
  159.     def s = com.intellij.psi.codeStyle.NameUtil.splitNameIntoWords(str)
  160.             .collect { Case.LOWER.apply(it).capitalize() }
  161.             .join("")
  162.             .replaceAll(/[^\p{javaJavaIdentifierPart}[_]]/, "_")
  163.     capitalize || s.length() == 1 ? s : Case.LOWER.apply(s[0]) + s[1..-1]
  164. }
  166. def isNotEmpty(content) {
  167.     return content != null && content.toString().trim().length() > 0
  168. }
  170. static String changeStyle(String str, boolean toCamel) {
  171.     if (!str || str.size() <= 1)
  172.         return str
  174.     if (toCamel) {
  175.         String r = str.toLowerCase().split('_').collect { cc -> Case.LOWER.apply(cc).capitalize() }.join('')
  176.         return r[0].toLowerCase() + r[1..-1]
  177.     } else {
  178.         str = str[0].toLowerCase() + str[1..-1]
  179.         return str.collect { cc -> ((char) cc).isUpperCase() ? '_' + cc.toLowerCase() : cc }.join('')
  180.     }
  181. }
  183. static String genSerialID() {
  184.     return "\tprivate static final long serialVersionUID =  " + Math.abs(new Random().nextLong()) + "L;"
  185. }

③选择自己的脚本文件执行

image.png

④成功生成自定义JavaBean

image.png