一、研究问题本文分享使用Mybatis的逆向工程generator的时候，将生成的实体改为lombok形式，并且在成员变量上添加数据库中的字段描述（中文的描述哦）。本次环境是基于SpringBoot和MySQL，阅读前提是你先会使用原生的generator工具，如果你的环境是普通maven或其它环境也可以阅读，换汤不换药的。这里先看下图效果：一张数据库表，student库下的class，如果是原生的generator工具生成的实体中会有很多set，get方法，而且成员变量上没有描述或是英文描述，而下面是已经修改过的效果。二、整合lombok逆向工程是通过使用工具生成的代码，所以我们就修改他的工具源码，先解决第一个问题，将生成的实体类换成lombok形式。首先需要准备两个工程一个是原生的generator工程，测试使用它可以生成原来有set，get的实体，没有问题。下文称它为大工程，如何搭建原生generator的就不介绍了。另一个是一个辅助工程，使用它来修改源码，不会添加在项目中。下方称它为小工程。Gitee 地址，不需要做任何改动，拉取就可以直接使用：https://gitee.com/guaidonggua/generator_lombok若你还想自定义生成其它内容，继续往下看原理，先准备两个工程：大工程：https://gitee.com/guaidonggua/generator_lombok小工程：https://gitee.com/guaidonggua/generator_build2.1 创建小工程并修改源码2.1.1 maven依赖依赖如下，必要引入的有注释说明，其它不用较劲，这个小工程修改完源码就可以删除了的。<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
<!-- 必须引入
生成的.class插件文件需放入里面-->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.7</version>
</dependency>
</dependencies>
2.1.2 修改插件Plugin在小工程中，创建包org.mybatis.generator，然后在包下新建类继承PluginAdapter。包名不可以修改，类名可以修改。下面我自己定义的是LombokPlugin，可以直接复制以下代码。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.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;
public class LombokPlugin extends PluginAdapter {
public LombokPlugin() {
}
public boolean validate(List<String> list) {
return true;
}
public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
topLevelClass.addImportedType("lombok.Data");
topLevelClass.addAnnotation("@Data");
//topLevelClass.addImportedType("lombok.Getter");
//topLevelClass.addImportedType("lombok.Setter");
//topLevelClass.addImportedType("lombok.ToString");
//topLevelClass.addAnnotation("@Getter");
//topLevelClass.addAnnotation("@Setter");
//topLevelClass.addAnnotation("@ToString");
topLevelClass.addJavaDocLine("/**");
topLevelClass.addJavaDocLine("* Created by Mybatis Generator " + this.date2Str(new Date()));
topLevelClass.addJavaDocLine("*/");
return true;
}
public boolean clientGenerated(Interface interfaze, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
interfaze.addJavaDocLine("/**");
interfaze.addJavaDocLine("* Created by Mybatis Generator " + this.date2Str(new Date()));
interfaze.addJavaDocLine("*/");
return true;
}
public boolean modelSetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
return false;
}
public boolean modelGetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
return false;
}
private String date2Str(Date date) {
SimpleDateFormat sdf = new SimpleDateFormat("yyyy/MM/dd");
return sdf.format(date);
}
}
2.1.3 将修改完的插件编译成.class文件先clean一下，清除缓存。然后点一下小工程修改的代码，让光标在修改了插件的那个类里闪烁。进行下一步。2.2 大工程修改maven中必须引入mybatis-generator-core，因为你一会需要把这个.class替换。下面pom文件不用全复制，只需要在你的原生generator，也就是大工程中复制mybatis-generator-core和lombok即可，注意自己的mybatis-generator-core版本，我的是1.3.7。<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
<!-- 必须引入
生成的.class插件文件需放入里面-->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.7</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.7</version>
<executions>
<execution>
<id>mybatis-generator</id>
<phase>deploy</phase>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
<configuration>
<!-- generatorConfig.xml文件的位置，这个填写你自己的 -->
<configurationFile>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile>
<verbose>true</verbose>
<overwrite>true</overwrite>
</configuration>
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.17</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
2.3 将2.1.3生成的.class替换将自己生成的.class替换maven仓库中的插件。在本地找到你生成的.class文件，ctrl+c复制找到maven仓库的mybatis-generator-core，如下2.4 最后修改一下大工程的generatorConfig.xmlcontext标签中添加你复制过来的插件<plugin type="org.mybatis.generator.plugins.LombokPlugin" > <property name="hasLombok" value="true"/> </plugin>
2.5 测试然后启动逆向生成，查看实体三、添加中文注释3.1 小工程修改源代码又回到小工程中修改源注释的源代码。在org.mybatis.generator.internal包下新建DefaultCommentGenerator实现CommentGenerator接口，包和类都不可以修改，可以直接复制以下代码。package org.mybatis.generator.internal;
import org.mybatis.generator.api.CommentGenerator;
import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.dom.java.*;
import org.mybatis.generator.api.dom.xml.XmlElement;
import org.mybatis.generator.config.MergeConstants;
import org.mybatis.generator.config.PropertyRegistry;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Properties;
import java.util.Set;
import static org.mybatis.generator.internal.util.StringUtility.isTrue;
public class DefaultCommentGenerator implements CommentGenerator {
private Properties properties;
private Properties systemPro;
private boolean suppressDate;
private boolean suppressAllComments;
private String currentDateStr;
public DefaultCommentGenerator() {
super();
properties = new Properties();
systemPro = System.getProperties();
suppressDate = false;
suppressAllComments = false;
currentDateStr = (new SimpleDateFormat("yyyy-MM-dd")).format(new Date());
}
@Override
public void addJavaFileComment(CompilationUnit compilationUnit) {
// add no file level comments by default
return;
}
/**
* Adds a suitable comment to warn users that the element was generated, and
* when it was generated.
*/
@Override
public void addComment(XmlElement xmlElement) {
return;
}
@Override
public void addRootComment(XmlElement rootElement) {
// add no document level comments by default
return;
}
@Override
public void addGeneralMethodAnnotation(Method method, IntrospectedTable introspectedTable,
Set<FullyQualifiedJavaType> set) {
}
@Override
public void addGeneralMethodAnnotation(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn, Set<FullyQualifiedJavaType> set) {
}
@Override
public void addFieldAnnotation(Field field, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) {
}
@Override
public void addFieldAnnotation(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn, Set<FullyQualifiedJavaType> set) {
}
@Override
public void addClassAnnotation(InnerClass innerClass, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) {
}
@Override
public void addConfigurationProperties(Properties properties) {
this.properties.putAll(properties);
suppressDate = isTrue(properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_DATE));
suppressAllComments = isTrue(properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_ALL_COMMENTS));
}
/**
* This method adds the custom javadoc tag for. You may do nothing if you do
* not wish to include the Javadoc tag - however, if you do not include the
* Javadoc tag then the Java merge capability of the eclipse plugin will
* break.
*
* @param javaElement the java element
*/
protected void addJavadocTag(JavaElement javaElement, boolean markAsDoNotDelete) {
javaElement.addJavaDocLine(" *");
StringBuilder sb = new StringBuilder();
sb.append(" * ");
sb.append(MergeConstants.NEW_ELEMENT_TAG);
if (markAsDoNotDelete) {
sb.append(" do_not_delete_during_merge");
}
String s = getDateString();
if (s != null) {
sb.append(' ');
sb.append(s);
}
javaElement.addJavaDocLine(sb.toString());
}
/**
* This method returns a formated date string to include in the Javadoc tag
* and XML comments. You may return null if you do not want the date in
* these documentation elements.
*
* @return a string representing the current timestamp, or null
*/
protected String getDateString() {
String result = null;
if (!suppressDate) {
result = currentDateStr;
}
return result;
}
@Override
public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {
if (suppressAllComments) {
return;
}
StringBuilder sb = new StringBuilder();
innerClass.addJavaDocLine("/**");
sb.append(" * ");
sb.append(introspectedTable.getFullyQualifiedTable());
sb.append(" ");
sb.append(getDateString());
innerClass.addJavaDocLine(sb.toString());
innerClass.addJavaDocLine(" */");
}
@Override
public void addEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable) {
if (suppressAllComments) {
return;
}
StringBuilder sb = new StringBuilder();
innerEnum.addJavaDocLine("/**");
//
addJavadocTag(innerEnum, false);
sb.append(" * ");
sb.append(introspectedTable.getFullyQualifiedTable());
innerEnum.addJavaDocLine(sb.toString());
innerEnum.addJavaDocLine(" */");
}
@Override
public void addFieldComment(Field field, IntrospectedTable introspectedTable,
IntrospectedColumn introspectedColumn) {
if (suppressAllComments) {
return;
}
if (introspectedColumn.getRemarks() != null && !introspectedColumn.getRemarks().trim().isEmpty()) {
StringBuilder sb = new StringBuilder();
field.addJavaDocLine("/**");
sb.append(" * ");
sb.append(introspectedColumn.getRemarks());
field.addJavaDocLine(sb.toString());
//
addJavadocTag(field, false);
field.addJavaDocLine(" */");
}
}
@Override
public void addFieldComment(Field field, IntrospectedTable introspectedTable) {
if (suppressAllComments) {
return;
}
StringBuilder sb = new StringBuilder();
field.addJavaDocLine("/**");
sb.append(" * ");
sb.append(introspectedTable.getFullyQualifiedTable());
field.addJavaDocLine(sb.toString());
field.addJavaDocLine(" */");
}
@Override
public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
}
@Override
public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
if (suppressAllComments) {
return;
}
//
method.addJavaDocLine("/**");
//
addJavadocTag(method, false);
//
method.addJavaDocLine(" */");
}
@Override
public void addGetterComment(Method method, IntrospectedTable introspectedTable,
IntrospectedColumn introspectedColumn) {
if (suppressAllComments) {
return;
}
method.addJavaDocLine("/**");
StringBuilder sb = new StringBuilder();
sb.append(" * ");
sb.append(introspectedColumn.getRemarks());
method.addJavaDocLine(sb.toString());
sb.setLength(0);
sb.append(" * @return ");
sb.append(introspectedColumn.getActualColumnName());
sb.append(" ");
sb.append(introspectedColumn.getRemarks());
method.addJavaDocLine(sb.toString());
//
addJavadocTag(method, false);
method.addJavaDocLine(" */");
}
@Override
public void addSetterComment(Method method, IntrospectedTable introspectedTable,
IntrospectedColumn introspectedColumn) {
if (suppressAllComments) {
return;
}
method.addJavaDocLine("/**");
StringBuilder sb = new StringBuilder();
sb.append(" * ");
sb.append(introspectedColumn.getRemarks());
method.addJavaDocLine(sb.toString());
Parameter parm = method.getParameters().get(0);
sb.setLength(0);
sb.append(" * @param ");
sb.append(parm.getName());
sb.append(" ");
sb.append(introspectedColumn.getRemarks());
method.addJavaDocLine(sb.toString());
//
addJavadocTag(method, false);
method.addJavaDocLine(" */");
}
@Override
public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean markAsDoNotDelete) {
if (suppressAllComments) {
return;
}
StringBuilder sb = new StringBuilder();
innerClass.addJavaDocLine("/**");
sb.append(" * ");
sb.append(introspectedTable.getFullyQualifiedTable());
innerClass.addJavaDocLine(sb.toString());
sb.setLength(0);
sb.append(" * @author ");
sb.append(systemPro.getProperty("user.name"));
sb.append(" ");
sb.append(currentDateStr);
//
addJavadocTag(innerClass, markAsDoNotDelete);
innerClass.addJavaDocLine(" */");
}
}
3.2 同样将它编译成.class文件先clean，清空target。3.3 替换掉maven仓库中的.class同样找到你编译的.class文件，ctrl+c复制找到maven的位置使用压缩文件打开，ctrl+v粘贴，如果提示是否要替换，点击确定，全部替换。3.4 确保大工程中开启注释generatorConfig.xml配置文件开启注释3.5 启动逆向工程测试生成实体类作者微信公众号“怪東瓜”，有问题私聊，我们共同探讨实用技术，练出最美身材。

简介SpringBoot和Vue，前后端分离，我们开源一套漂亮的代码和一套整洁的代码规范，让大家在这浮躁的代码世界里感受到一股把代码写好的清流！同时又让开发者节省大量的时间，减少加班，快乐工作，热爱生活。SmartAdmin 让你从认识到忘不了，绝对是你最想要的！技术体系前端：Vue + Vue-Router + Vuex + ViewUI + vue-enum后端：SpringBoot2 + Mybatis-plus + jwt + druid + mysql前端代码规范smart-front-standard -guide基于阿里规范之上的后端规范smart-backend-standard-guide演示图登录页面：首页：人员管理：前端特点高质量的代码、代码结构、和代码注释漂亮的UI，菜单栏、标签页，体验、交互更好用的员工、部门、角色、菜单管理等等优化基于Keepalive的标签页，做到标签页该缓存的时候缓存，比如左右切换等，不该缓存的时候不缓存，比如新建，表单提交结束等前端常量维护: vue-enum，拒绝出现魔法数字，代码不可维护的现象全新的基于前端的权限设计(忘掉传统的权限设计吧，已经不适合这个前端时代)基于websocket的在线人数支持一级、二级、三级菜单，四级菜单以及搜索功能其他功能：邮件、富文本、消息、系统配置等等写不完了，太多好的细节需要你的发现......后端特点高质量的Java代码、分包结构、和代码注释业内独创的请求返回码维护，非常值得一看基于一个注解和controller的权限设计放弃更复杂的shiro，以及一套数据权限支持四层架构(controller, service, manager, dao)代码阅读性强、扩展性极高的员工、部门、角色、菜单管理基于LRU策略的内存级权限缓存配合前端vue-enum的swagger文档注解心跳服务，让你发现有哪些机器再跑，哪些人在偷偷的跑你的Job自定义的quartz job添加和修改，方便测试人员测试smart-reload，为系统预留钩子，动态加载，在不重启程序前提下执行一些代码，你懂的以上只是一些举例，更多灿若繁星的惊喜和细节，等待着你的发现！前端代码规范文件、文件夹、目录结构、组建、变量等等怎么命名html、css、less等如何规范vue项目目录结构如何划分router和store该怎么划分扩展性更好vue组件规范该选择哪些以及更多，数不胜数让你觉得实用，同时身心愉悦的规范后端代码规范四层架构(controller, service, manager, dao) 是什么，为什么要有四层各个层的代码该怎么写才能让团队配合默契，高度一致vo, bo, dto, entity ，各种javabean 怎么区分和使用spring的 @Transactional 你用对了吗方法参数个数、注释、todo这些也要有规范，你遵守过吗以上举例，只是沧海一粟，更多的细节等待你的发现！源码有需要源码的朋友麻烦转发后关注@JAVA梦想口服液私信回复【源码】即可获取！小结刚刚入驻头条，有什么理解不对的地方可以在评论区留言，觉得不错的朋友希望能得到您的转发支持，同时可以持续关注我，每周定期会分享3到4篇精选干货！您的关注是对我最大的支持谢谢.
您愿意向朋友推荐“博客详情页”吗？
强烈不推荐
不推荐
一般般
推荐
强烈推荐