逆向生成字段类注释
自定义插 的实现方式有两种：
1，实现接口 **Plugin**
2, 继承抽象类：**PluginAdapter** （已经实现了接口Plugin ,功能更丰富）-推荐使用
自定义插件说明
我使用的是mybatis-generator-core 是 1.3.7 版本。
<dependencies>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.7</version>
</dependency>
</dependencies>
打开mybatis-generator-core-1.3.7.jar 我们看到org.mybatis.generator.plugins 下已经有很多插件了
我们自定义插件也要放在这个包下。所以，我们也要建一个包名为：org.mybatis.generator.plugins。
如果我们随意定的报名，在执行mybatis-generator 时，会找不到你自定义的包名。
下面开始上代码：
逆生成表字段说明
根据数据库表字段，字段说明。逆向生成java 类的时候，自动生成字段注释
MyCommentPlugin.java
package org.mybatis.generator.plugins;
import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.PluginAdapter;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.api.dom.java.JavaElement;
import org.mybatis.generator.api.dom.java.JavaVisibility;
import org.mybatis.generator.api.dom.java.TopLevelClass;
import org.mybatis.generator.internal.util.StringUtility;
import util.GsonUtil;
import java.util.LinkedHashMap;
import java.util.List;
/**
* 逆生成字段注释插件
* @author author
* @date 2020/7/30 16:54
*/
public class MyCommentPlugin extends PluginAdapter {
private static final String SEPARATION = ",";
private static final String JSON_PREFIX = "{";
private static final String JSON_SUFFIX = "}";
private boolean makeConstant = true;
/**
* 这里已经要返回true
* true : 插件生效
* false : 插件失效
* @param warnings
* @return
*/
@Override
public boolean validate(List<String> warnings) {
return true;
}
@Override
public boolean modelFieldGenerated(Field field, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
this.comment(field, topLevelClass, introspectedColumn, introspectedTable);
return true;
}
private void comment(JavaElement element, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable) {
element.getJavaDocLines().clear();
element.addJavaDocLine("/**");
//获取列字段注解
String remark = introspectedColumn.getRemarks();
if (remark != null && remark.length() > 1) {
element.addJavaDocLine(" * " + remark);
element.addJavaDocLine(" *");
}
// 根据项目要求，可以加上自定义的注解
// element.addJavaDocLine(" * Column: " + introspectedColumn.getActualColumnName());
// element.addJavaDocLine(" * Length: " + introspectedColumn.getLength());
// element.addJavaDocLine(" * DefaultValue: " + (StringUtility.stringHasValue(introspectedColumn.getDefaultValue()) ? introspectedColumn.getDefaultValue() : "无默认值"));
// element.addJavaDocLine(" * Nullable: " + introspectedColumn.isNullable());
// mysql 中自增主键，添加 AutoIncrement: true 说明
boolean autoIncrement = introspectedColumn.isAutoIncrement();
if (autoIncrement) {
element.addJavaDocLine(" * AutoIncrement: true");
}
element.addJavaDocLine(" */");
if (this.makeConstant) {
System.out.println("start constant " + introspectedColumn.getActualColumnName());
if (StringUtility.stringHasValue(remark) && remark.contains(JSON_PREFIX) && remark.contains(JSON_SUFFIX)) {
//截取常量字符串
String commentJson = remark.substring(remark.indexOf(JSON_PREFIX), remark.lastIndexOf(JSON_SUFFIX) + 1);
try {
LinkedHashMap<String, String> commentMap = GsonUtil.fromJson(commentJson,LinkedHashMap.class);
commentMap.forEach((key, value) -> {
Field field = new Field();
//常量字段属性名 以列字段名+_+json key 值为字段名
field.setName(introspectedColumn.getActualColumnName().toUpperCase() + "_" + key.toUpperCase());
field.setStatic(true);
field.setFinal(true);
//设置常量字段类型与列字段一致
field.setType(introspectedColumn.getFullyQualifiedJavaType());
//常量字段属性描述
String desc = "";
//常量字段属性值
String constant = "";
if (value.contains(SEPARATION)) {
String[] split = value.split(SEPARATION);
constant = split[0];
desc = split[1];
} else {
constant = value;
}
field.setInitializationString(constant);
field.setVisibility(JavaVisibility.PUBLIC);
field.addJavaDocLine("/**");
field.addJavaDocLine("* " + introspectedColumn.getActualColumnName() + ":" + desc);
field.addJavaDocLine("*/");
if (introspectedTable.getTargetRuntime() == IntrospectedTable.TargetRuntime.MYBATIS3_DSQL) {
context.getCommentGenerator().addFieldAnnotation(field, introspectedTable,
topLevelClass.getImportedTypes());
} else {
context.getCommentGenerator().addFieldComment(field, introspectedTable);
}
//将常量加入BD实体类
topLevelClass.addField(field);
});
} catch (Exception e) {
e.printStackTrace();
}
}
}
}
}
2，使用lombok 注解方式
MyLombokPlugin.java
package org.mybatis.generator.plugins;
import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.PluginAdapter;
import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
import org.mybatis.generator.api.dom.java.Interface;
import org.mybatis.generator.api.dom.java.Method;
import org.mybatis.generator.api.dom.java.TopLevelClass;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.List;
/**
* @author author
* @date 2020/7/30 16:52
*/
public class MyLombokPlugin extends PluginAdapter {
@Override
public boolean validate(List<String> list) {
return true;
}
@Override
public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
// 到入需要注解的包
topLevelClass.addImportedType("lombok.Data");
// topLevelClass.addImportedType("lombok.Builder");
// topLevelClass.addImportedType("lombok.NoArgsConstructor");
// topLevelClass.addImportedType("lombok.AllArgsConstructor");
// 添加domain的注解
topLevelClass.addAnnotation("@Data");
// topLevelClass.addAnnotation("@Builder");
// topLevelClass.addAnnotation("@NoArgsConstructor");
// topLevelClass.addAnnotation("@AllArgsConstructor");
// 添加domain的注释
topLevelClass.addJavaDocLine("/**");
// topLevelClass.addJavaDocLine("* @ClassName: " + topLevelClass.getType().getShortName());
// topLevelClass.addJavaDocLine("* @Description: ");
topLevelClass.addJavaDocLine("* @author: Mybatis Generator");
topLevelClass.addJavaDocLine("* @date " + date2Str(new Date()));
topLevelClass.addJavaDocLine("*/");
return true;
}
@Override
public boolean clientGenerated(Interface interfaze, TopLevelClass topLevelClass,
IntrospectedTable introspectedTable) {
// Mapper文件的注释
interfaze.addJavaDocLine("/**");
// interfaze.addJavaDocLine("* @ClassName: " + interfaze.getType().getShortName());
// interfaze.addJavaDocLine("* @Description: ");
interfaze.addJavaDocLine("* @author: Mybatis Generator");
interfaze.addJavaDocLine("* @date " + date2Str(new Date()));
interfaze.addJavaDocLine("*/");
return true;
}
@Override
public boolean modelSetterMethodGenerated(Method method, TopLevelClass topLevelClass,
IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
// 不生成getter
return false;
}
@Override
public boolean modelGetterMethodGenerated(Method method, TopLevelClass topLevelClass,
IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
// 不生成setter
return false;
}
/**
* 格式化时间字符串
*
* @param date
* @return
* @author: renkai721
* @date: 2018年7月13日 上午11:17:52
* @Title: date2Str
* @Description:
*/
private String date2Str(Date date) {
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
return sdf.format(date);
}
}
generatorConfig.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<!--引入mysql 连接 数据库的jar-->
<classPathEntry location="D:\m2e\repository\mysql\mysql-connector-java\8.0.15\mysql-connector-java-8.0.15.jar"/>
<context id="default" targetRuntime="MyBatis3">
<plugin type="org.mybatis.generator.plugins.MyLombokPlugin">
<property name="hasLombok" value="true"/>
</plugin>
<!--自定义注释插件-->
<plugin type="org.mybatis.generator.plugins.MyCommentPlugin">
<!--开启根据注释生成常量,需把常量字段定义为json-->
<!--模板规则-->
<!--注释{'常量后缀1':'值#描述','常量后缀2':'值#描述’}-->
<property name="makeConstant" value="true"/>
<!--作者-->
<property name="author" value="author"/>
</plugin>
<commentGenerator>
<property name="suppressDate" value="true"/>
<property name="suppressAllComments" value="true"/>
</commentGenerator>
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://ip:3306/库名"
userId="username"
password="密码">
</jdbcConnection>
<javaModelGenerator targetPackage="com.xxx.entity"
targetProject="./src/main/java">
<property name="trimStrings" value="true"/>
<property name="immutable" value="false"/>
</javaModelGenerator>
<sqlMapGenerator targetPackage="dao"
targetProject="./src/main/resources">
</sqlMapGenerator>
<javaClientGenerator type="XMLMAPPER"
targetPackage="com.xxx.dao"
targetProject="./src/main/java">
</javaClientGenerator>
<table tableName="表名" domainObjectName="XxxEntity"
enableSelectByPrimaryKey="true" enableUpdateByPrimaryKey="true"
enableDeleteByPrimaryKey="true">
</table>
</context>
</generatorConfiguration>
pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.wl.mybatis</groupId>
<artifactId>mybatis-generator</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>war</packaging>
<name>mybatis-generator Maven Webapp</name>
<!-- FIXME change it to the project's website -->
<url>http://www.example.com</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.7</version>
</dependency>
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.8.6</version>
</dependency>
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.3.5</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.5</version>
</dependency>
</dependencies>
<build>
<finalName>mybatis-generator</finalName>
<pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
<plugins>
<!-- mybatis-generator -->
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.7</version>
<configuration>
<!-- mybatis-generator的配置文件，根据情况调整位置 -->
<configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
<verbose>true</verbose>
<overwrite>true</overwrite>
</configuration>
<dependencies>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.7</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</pluginManagement>
</build>
</project>
GsonUtil.java
package util;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
/**
* @author author
* @date 2020/7/30 17:25
*/
public class GsonUtil {
private static final GsonBuilder gsonBuilder = new GsonBuilder();
private static final Gson gson = new Gson();
public static String toJson(Object obj) {
return gsonBuilder.serializeNulls().create().toJson(obj);
}
public static <T> T fromJson(String str,Class<T> clazz){
return gson.fromJson(str ,clazz);
}
}
最后编译MyCommentPlugin.java, MyLombokPlugin.java 建生成 class 文件
将这两个文件 copy 到
mybatis-generator-core-1.3.7.jar 的 org.mybatis.generator.plugins 目录下
最后执行：
最后在工程中就会生成对应的实体类：
最后说明：
以上两个插件功能也是网上参考大牛写的 再整理优化的。大牛的文档找不到了所以没法贴出对应大牛的文档链接，请见谅！
扫一扫
9153
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
