如何使用IDEA的groovy腳本文件生成帶JPA注解的實(shí)體類(圖文詳解)
牛逼!IDEA不愧為神器,結(jié)合Groovy腳本,簡直天下無敵,如今, 有許許多多的插件或者編輯器都支持根據(jù)數(shù)據(jù)表自動生成數(shù)據(jù)實(shí)體類了, 比如IDEA, 各種MyBatis的代碼生成工具, 等等;本篇介紹一下如何使用IDEA的groovy腳本文件生成帶JPA注解的實(shí)體類。
# 使用IDEA連接數(shù)據(jù)庫
注意
- 正式版IDEA才有此功能, 社區(qū)版木有
- 演示圖片使用的IDEA版本為2018.3, 不同版本界面可能有細(xì)小差別
1、創(chuàng)建新的數(shù)據(jù)連接
如果沒有, 可以上方菜單欄: 視圖-工具窗口-Database打開(新建Oracle數(shù)據(jù)庫也是相同操作)。
2、配置數(shù)據(jù)連接
- 填寫一個連接名,隨便填什么都行
- 不用選擇,默認(rèn)就行
- 填寫數(shù)據(jù)庫連接的 IP地址,比如本地?cái)?shù)據(jù)庫可以填寫:localhost或者127.0.0.1
- 填寫數(shù)據(jù)庫開放的端口號,一般沒設(shè)置的話默認(rèn)都是3306
- 填寫你需要連接的數(shù)據(jù)庫名
- 填寫數(shù)據(jù)庫的用戶名
- 填寫數(shù)據(jù)庫密碼
- 這里會有一個驅(qū)動需要點(diǎn)擊下載,圖中是已經(jīng)下載好了
- 填寫自己的數(shù)據(jù)庫連接url,然后可以點(diǎn)擊9所在按鈕進(jìn)行測試連接,本地連接失敗檢查是否開啟了mysql服務(wù)
# IDEA自帶的兩種創(chuàng)建實(shí)體類的方法
1、如果只是創(chuàng)建簡單的, 只有屬性, getter, setter的實(shí)體類, 而不需要JPA/Hibernate的實(shí)體類注解。
單擊打開剛剛創(chuàng)建的數(shù)據(jù)連接
打開schemas, 找到自己需要創(chuàng)建實(shí)體類的表(可以使用ctrl或shift多選)
右鍵: Scripted Extensions - Generate POJOs.groovy
選擇生成路徑就OK了
注意:生成的包名可能有問題, 默認(rèn)是package com.sample, 需要自己手動修改。
2、使用了Hibernate/Jpa框架, 需要的是有注解的實(shí)體類, Idea也提供了相應(yīng)的方法
添加JPA模塊
- 打開項(xiàng)目結(jié)構(gòu)
- 打開模塊, 點(diǎn)擊+號添加模塊
- 選擇JPA
- 點(diǎn)擊右下角確定后, 關(guān)閉項(xiàng)目結(jié)構(gòu)
使用Persistence工具生成帶注解的實(shí)體類-1
如果上一步?jīng)]問題的話, IDEA左下角側(cè)邊欄會出現(xiàn)Persistence工具欄打開Persistence工具欄, 右鍵項(xiàng)目: Generate Persistence Mapping - By Database Schema
使用Persistence工具生成帶注解的實(shí)體類-2
- 選擇數(shù)據(jù)庫連接
- 選擇生成類所在包
- 選擇要生成的表
- 選擇要生成的字段(選擇表后字段默認(rèn)除了外鍵全選)
- 修改要生成的屬性名
- 修改要生成的屬性類型
- 勾上即為生成帶注解的實(shí)體類
生成的類實(shí)例如下
# 更進(jìn)一步, 使用自己的Groovy生成帶注解的實(shí)體類
上面介紹了兩個使用IDEA生成實(shí)體類的方法, 各有優(yōu)缺點(diǎn)。生成不帶注解的實(shí)體類簡單高效, 但缺點(diǎn)就是如果使用的是Jpa/Hibernate框架就不適合;生成帶注解的實(shí)體類能生成注解實(shí)體類, 但缺點(diǎn)就是生成的實(shí)體類的注解可能不太符合我們的注解, 只能生成到當(dāng)前項(xiàng)目包下, 面對一些復(fù)雜的數(shù)據(jù)庫如Oracle會顯示很多系統(tǒng)表而且表空間切換不太方便。
我們知道Idea生成不帶注解的實(shí)體類是通過Groovy腳本文件生成的, 我們也能找到這個文件, 那我們能不能修改這個文件, 讓它生成帶注解的實(shí)體類呢?
1、使用自己的Groovy生成帶注解的實(shí)體類的好處
- 在Database工具欄里, 操作簡單方便
- 可以自己對腳本進(jìn)行一些編輯, 使生成的實(shí)體類達(dá)到自己的定制需求
- 對Oracle這樣的數(shù)據(jù)庫生成實(shí)體類時, 避免了系統(tǒng)表的影響, 可以自己選擇表空間進(jìn)行操作
- 可以生成在電腦上的任何位置, 不受限制
2、使用自己的Groovy生成帶注解的實(shí)體類的不足
- @author 作者名需要自己修改腳本
- @Table(Schema="") 的表空間名不能讀取, 需要自己修改腳本, 設(shè)定表空間名(mysql可以直接刪除這個屬性的定義)(IDEA的Persistence工具可以讀取(Schema=""屬性并生成, 但我們不知道它是怎么獲取的)
- @Id的主鍵生成方式不可知, 需要生成后自己確定(mysql用戶可以直接修改腳本設(shè)定主鍵生成方式, 但Oracle用戶需要生成實(shí)體類后再逐個確認(rèn))
3、使用自己的Groovy生成帶注解的實(shí)體類可以繼續(xù)完善的地方
如果需要hashcode()和equals()方法, 也修改腳本, 使其自動生成。
4、新建一個Groovy腳本文件
Database工具欄里, 右鍵右鍵: Scripted Extensions - Go to Scripts Directory
在目錄下新建一個Generate MyPOJOs.groovy
添加里面的內(nèi)容:
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] } } // 已經(jīng)修改為使用javaName, 如果有需要可以在def className = javaName(table.getName(), true)中修改為javaClassName // 處理類名(這里是因?yàn)槲业谋矶际且詔_命名的,所以需要處理去掉生成類名時的開頭的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;" }
表上右鍵, 選擇自己寫的腳本生成實(shí)體類,效果如下:
最后,不知道你是否get到本文的技巧,是不是覺得Groovy腳本挺好用啊,關(guān)于更多的玩法需要你慢慢去挖掘
到此這篇關(guān)于如何使用IDEA的groovy腳本文件生成帶JPA注解的實(shí)體類的文章就介紹到這了,更多相關(guān)IDEA的groovy腳本 JPA注解實(shí)體類內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
查看SpringBoot和JDK版本對應(yīng)關(guān)系的方法
在進(jìn)行一些自主學(xué)習(xí)的時候,發(fā)現(xiàn)使用maven方式創(chuàng)建的SpringBoot項(xiàng)目啟動失敗,最終發(fā)現(xiàn)是SpringBoot版本和JDK版本不對應(yīng)導(dǎo)致的,所以本文就給大家介紹了如何查看SpringBoot和JDK版本的對應(yīng)關(guān)系,需要的朋友可以參考下2024-03-03IDEA運(yùn)行java程序時總彈出提示配置Edit Configurations問題
更新IDEA后,運(yùn)行Java程序時可能需要手動配置JDK版本,通過統(tǒng)一設(shè)置默認(rèn)JDK可以解決每次彈出EditConfigurations的問題,此操作可以簡化開發(fā)流程,提高效率2024-09-09Spring Cloud 服務(wù)網(wǎng)關(guān)Zuul的實(shí)現(xiàn)
這篇文章主要介紹了Spring Cloud 服務(wù)網(wǎng)關(guān)Zuul的實(shí)現(xiàn),文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-07-07synchronized?和?Lock?的異同點(diǎn)(如何讓選擇)
這篇文章主要介紹了?synchronized和Lock的異同點(diǎn)(如何讓選擇),文章圍繞主題展開詳細(xì)的內(nèi)容介紹,具有一定的參考價值,需要的小伙伴可以參考一下2022-09-09SpringBoot基于RabbitMQ實(shí)現(xiàn)消息可靠性的方法
RabbitMQ 提供了 publisher confirm 機(jī)制來避免消息發(fā)送到 MQ 過程中丟失,這種機(jī)制必須給每個消息指定一個唯一ID,消息發(fā)送到MQ以后,會返回一個結(jié)果給發(fā)送者,表示消息是否處理成功,本文給大家介紹了SpringBoot基于RabbitMQ實(shí)現(xiàn)消息可靠性的方法,需要的朋友可以參考下2024-04-04Java如何解決發(fā)送Post請求報(bào)Stream?closed問題
這篇文章主要介紹了Java如何解決發(fā)送Post請求報(bào)Stream?closed問題,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-06-06Java實(shí)現(xiàn)幾十萬條數(shù)據(jù)插入實(shí)例教程(30萬條數(shù)據(jù)插入MySQL僅需13秒)
這篇文章主要給大家介紹了關(guān)于Java如何實(shí)現(xiàn)幾十萬條數(shù)據(jù)插入的相關(guān)資料,30萬條數(shù)據(jù)插入MySQL僅需13秒,文中通過實(shí)例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2023-04-04關(guān)于SpringBoot接收json格式的Demo案例
這篇文章主要介紹了關(guān)于SpringBoot接收json格式的Demo案例,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-05-05