使用idea插件生成jpa实体类

本文介绍如何在IntelliJ IDEA中使用Groovy脚本自动生成MySQL数据库对应的实体类,包括配置数据源、引入Maven依赖、编写逆向工程脚本及实体类生成流程。
  • 打开视图
    • view -> Tool Windows -> Database
  • 新建mysql数据源,配置数据库信息
    • 点击+ -> Data source -> MySQL
  • 在项目引入必要maven依赖
    • <!-- JPA Data (We are going to use Repositories, Entities, Hibernate, etc...) -->
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-data-jpa</artifactId>
      </dependency>
      <!-- Use MySQL Connector-J -->
      <dependency>
          <groupId>mysql</groupId>
          <artifactId>mysql-connector-java</artifactId>
      </dependency>
      
      <dependency>
          <groupId>org.projectlombok</groupId>
          <artifactId>lombok</artifactId>
          <optional>true</optional>
      </dependency>
  • 建立存放实体的包
  • 编写逆向工程的脚本文件Generate POJOs.groovy
    • 在database视图区域任意地方右键,点击 Scripted Extensions -> Go to Scripts Directory
    • 编辑Generate POJOs.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.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 javax.persistence.Column;"
        out.println "import javax.persistence.Entity;"
        out.println "import javax.persistence.Table;"
        out.println "import java.io.Serializable;"
        out.println "import lombok.Data;"
      
        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" +
                " * @Title "+ table.getName()+" \n" +
                " * @Description  \n" +
                " * @author tlj \n" +
                " * @Date "+ new SimpleDateFormat("yyyy-MM-dd").format(new Date()) + " \n" +
                " */"
        out.println ""
        out.println "@Entity"
        out.println "@Table ( name =\""+table.getName() +"\" )"
        out.println "@Data"
        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};"
        }
      
        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()+"\" , columnDefinition = \""+spec+" DEFAULT NULL"+ " COMMENT \'"+col.getComment()+"\'\")"]
          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;"
      }

       

  • 生成实体java类
    • 选中数据库表:
    • 在database视图区域任意地方右键,然后Scripted Extensions ->Generate POJOs.groovy
    • 选择实体存放路径
    • 生成目标实体
### 如何在 IntelliJ IDEA生成 JPA 实体类 #### 配置数据库连接 要实现自动生成功能,首先需要确保 IntelliJ IDEA 已经正确配置了与目标数据库的连接。这一步可以通过打开 **Database Tool Window** 并设置数据源完成[^1]。 #### 创建项目结构 在开始之前,需确认项目的 Maven 或 Gradle 构建文件已引入必要的依赖项(如 Hibernate、Spring Data JPA 等),以便支持 JPA 功能[^2]。 #### 使用 IDEA 的内置功能生成实体类 IntelliJ IDEA 提供了一种便捷的方式来自动生成基于数据库表结构的 JPA 实体类: 1. 打开 **Database Tool Window**,右键点击所需的 Schema 或表格。 2. 选择菜单中的 `Generate` -> `Entity from DB...` 来启动向导对话框[^3]。 3. 在弹出窗口中勾选希望转换成实体类的目标表,并指定生成位置以及命名约定。 4. 完成配置后单击 OK 开始处理;完成后可以在设定目录下找到对应的 Java 文件及其关联注解。 #### 解决常见问题 如果发现生成后的代码存在语法错误提示或其他异常情况,则可能是因为缺少某些必需库或是插件未启用所致。此时可以尝试以下措施: - 检查是否安装并启用了 "Hibernate/JPA" 插件; - 更新至最新版 JDBC Driver 和相关框架版本; - 清理缓存重建索引以消除潜在冲突[^3]。 ```java @Entity @Table(name = "example_table") public class ExampleEntity { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id; @Column(nullable = false, length = 50) private String name; // Getters and Setters omitted for brevity. } ``` 以上展示了一个简单的由工具生成的标准 JPA 实体样例。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值