之前做SSM项目时,一直使用的是Mybatis的Generator自动生成代码工具,也是蛮好使的。现在换了SpringBoot,自动生成代码使用的是人人开源项目修改来的,可以直接生成简单的CRUD代码和HTML页面。
一次偶然的机会,帮群里一个老弟看代码时,发现他们自动生成代码是用的JPA,之前听说过这个,但是没有用过,所以也是一脸懵逼的。于是查了查怎么用,之后发现也是很神奇的,也是可以直接生成实体类,然后Dao层和Service直接继承就可以完成简单的CRUD了,自己刚接触,这里记录一下简单的使用过程。
今天是第一次使用JPA生成代码,在查了半天之后,发现自动生成的脚本的样式是千奇百怪的,那个老弟还非要按照别人的代码格式生成,但是人家又不给他生成代码的脚本,让他自己百度找,对于小白的我就很懵逼了。
这里使用的是IDEA,其自带的生成实体类的脚本Generate POJOs.groovy
有点过于简单了,那么下面先看看自带的这个脚本怎么用。
首先是打开DataSource
这时会在右边弹出如下图的窗口,由于我这里已经添加过数据库了,第一次打开会提示使用Alt + Insert
进行添加数据库,我这里使用的是MySQL。
输入需要连接的数据库的信息,然后点击左下角的下载工具,然后点击Test Connection,如果提示Success 证明连接成功了,这时点击Apply,ok即可。
下面还是使用的之前添加的jpa-demo这个数据库,可以看到这里只有一张User表,我们就拿这个来生成。右键我们需要生成实体类的表格,这里可以多选,可以看到如下图。如果使用默认的脚本,可以直接点击最后的Generate POJOs.groovy
,这里我们简单的扩展一下,自定义我们自己的脚本。
可以看到,IDEA跳转到这个页面了,这个文件的内容就是系统自动带的生成实体类的脚本。
第一次用的时候没有仔细看,直接按照网上的博客直接生成了,感觉蛮神奇的,后来发现生成的跟那个项目里面别人写的不一样,这才反应过来,看一下这个脚本文件的内容,发现这个脚本也是有固定的套路的。
这里贴上一个简单的生成实体类的脚本,可以随意自己定制:
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/) : "BigDecimal",
(~/(?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("BigDecimal")) {
out.println "import java.math.BigDecimal;"
}
if (types.contains("InputStream")) {
out.println "import java.io.InputStream;"
}
out.println ""
out.println "/**\n" +
" * @Description \n" +
" * @Author linmengmeng\n" + //1. 修改idea为自己名字
" * @Date " + new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").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 \"{\" +"
fields.each() {
out.println "\t\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]
}
}
// 这里是处理数据库表前缀的方法,这里处理的是t_xxx命名的表
// 已经修改为使用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('')
}
}
//生成序列化的serialVersionUID
static String genSerialID() {
return "\tprivate static final long serialVersionUID = " + Math.abs(new Random().nextLong()) + "L;"
}
脚本里面的注释相信已经可以帮你进行自定义自己的脚本了,在自定义的时候,需要注意有个方法generate
,这里面有个生成文件的方法,里面的参数需要保持一致,在我第一次修改整合几个不同的模板的时候,就因为这个报错了,后来检查了半天才发现这个问题。
脚本修改完了之后,就是自动生成了,还是打开之前的DataSource,右键需要生成的表,开始生成。由于上面脚本中packageName
是默认的,这里会有弹窗,需要我们选择生成实体类的位置。
修改之后,再次生成,可以直接覆盖掉原来生成的文件,这点还是蛮方便的。脚本生成的实体类如下:
package com.lin.model.jpaDemo.entity;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Table;
import javax.persistence.Id;
import javax.persistence.GeneratedValue;
import java.io.Serializable;
/**
* @Description
* @Author linmengmeng
* @Date 2019-09-28 11:06:00
*/
@Entity
@Table ( name ="user" , schema = "")
public class User implements Serializable {
private static final long serialVersionUID = 7415787526169091091L;
/**
* 主键ID
*/
@Id
@Column(name = "id" )
private Long id;
/**
* 姓名
*/
@Column(name = "name" )
private String name;
/**
* 年龄
*/
@Column(name = "age" )
private Long age;
/**
* 邮箱
*/
@Column(name = "email" )
private String email;
public Long getId() {
return this.id;
}
public void setId(Long id) {
this.id = id;
}
public String getName() {
return this.name;
}
public void setName(String name) {
this.name = name;
}
public Long getAge() {
return this.age;
}
public void setAge(Long age) {
this.age = age;
}
public String getEmail() {
return this.email;
}
public void setEmail(String email) {
this.email = email;
}
@Override
public String toString() {
return "{" +
"id='" + id + '\'' +
"name='" + name + '\'' +
"age='" + age + '\'' +
"email='" + email + '\'' +
'}';
}
}