Mybatis-generator生成字段注释

2024-05-15 07:48
文章标签 生成 注释 mybatis generator

本文主要是介绍Mybatis-generator生成字段注释，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

Mybatis自动生成工具能够根据数据库表/视图等自动生成相应的bean和mapper，大大的简化了开发工作。
但默认的生成bean并没有将数据库表中的字段注释也放到生成的bean的属性上。
本文记录如何让mybatis-generator根据数据库表字段注释生成bean的属性注释。

零.写在前边

评论区有些朋友在使用过程中可能出现了某些类找不的问题，那我再补充一些前置操作。
1.maven项目加上插件

    <build><finalName>目标包名</finalName><plugins><plugin><groupId>org.mybatis.generator</groupId><artifactId>mybatis-generator-maven-plugin</artifactId><version>1.3.2</version><configuration><verbose>true</verbose><overwrite>true</overwrite></configuration><dependencies><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>${mysqlDriver.version}</version></dependency><dependency><groupId>本项目groupId</groupId><artifactId>本项目artifactId</artifactId><version>1.0</version><scope>system</scope><systemPath>${basedir}/target/目标包名.jar</systemPath></dependency><dependency><groupId>org.postgresql</groupId><artifactId>postgresql</artifactId><version>42.2.5</version></dependency></dependencies></plugin></plugins></build>

2.按照下边的方案写好之后要记得maven install或package,生成目标jar包
3.使用maven插件mybatis-generator:generate -f pom.xml
4.【或者】推荐，使用idea的右侧maven快捷操作，直接鼠标点两下maven install和mybatis-genneator就行了。

一.编写自定义注释生成工具

首先我们要实现CommentGenerator这个接口，编写一个自定义注释生成工具
当然也可以继承DefaultCommentGenerator这个类，直接重写getter、setter、字段等生成注释的方法即可。

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;/*** @author HelSing* @date 2019/3/18*/
public class MybatisCommentGenerator implements CommentGenerator {private Properties properties;private Properties systemPro;private boolean suppressDate;private boolean suppressAllComments;private String nowTime;public MybatisCommentGenerator() {super();properties = new Properties();systemPro = System.getProperties();suppressDate = false;suppressAllComments = false;nowTime = (new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")).format(new Date());}/*** 类的注释* @param innerClass* @param introspectedTable* @param markAsDoNotDelete*/@Overridepublic 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().replace("\n", " "));sb.setLength(0);sb.append(" * @author ");sb.append(systemPro.getProperty("user.name"));sb.append(" ");sb.append(nowTime);innerClass.addJavaDocLine(" */");}@Overridepublic 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().replace("\n", " "));innerClass.addJavaDocLine(" */");}/*** 设置字段注释*/@Overridepublic void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {if (suppressAllComments) {return;}StringBuilder sb = new StringBuilder();field.addJavaDocLine("/**");sb.append(" * ");sb.append(introspectedColumn.getRemarks() + " " + introspectedColumn.getActualColumnName());field.addJavaDocLine(sb.toString().replace("\n", " "));field.addJavaDocLine(" */");}@Overridepublic 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().replace("\n", " "));field.addJavaDocLine(" */");}/*** 设置setter方法注释*/@Overridepublic 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().replace("\n", " "));sb.setLength(0);sb.append(" * @author ");sb.append(systemPro.getProperty("user.name"));method.addJavaDocLine(sb.toString().replace("\n", " "));sb.setLength(0);if(suppressDate){sb.append(" * @date " + nowTime);method.addJavaDocLine(sb.toString().replace("\n", " "));sb.setLength(0);}Parameter parm = method.getParameters().get(0);sb.append(" * @param ");sb.append(parm.getName());sb.append(" ");sb.append(introspectedColumn.getRemarks());method.addJavaDocLine(sb.toString().replace("\n", " "));method.addJavaDocLine(" */");}/*** 设置getter方法注释*/@Overridepublic 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().replace("\n", " "));sb.setLength(0);sb.append(" * @author ");sb.append(systemPro.getProperty("user.name"));method.addJavaDocLine(sb.toString().replace("\n", " "));sb.setLength(0);if(suppressDate){sb.append(" * @date " + nowTime);method.addJavaDocLine(sb.toString().replace("\n", " "));sb.setLength(0);}sb.append(" * @return ");sb.append(introspectedColumn.getActualColumnName());sb.append(" ");sb.append(introspectedColumn.getRemarks());method.addJavaDocLine(sb.toString().replace("\n", " "));method.addJavaDocLine(" */");}@Overridepublic void addJavaFileComment(CompilationUnit compilationUnit) {if (suppressAllComments) {return;}return;}@Overridepublic void addComment(XmlElement xmlElement) {return;}@Overridepublic void addRootComment(XmlElement rootElement) {return;}@Overridepublic void addConfigurationProperties(Properties properties) {this.properties.putAll(properties);suppressDate = Boolean.valueOf(properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_DATE));suppressAllComments = Boolean.valueOf(properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_ALL_COMMENTS));}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());}protected String getDateString() {String result = null;if (!suppressDate) {result = nowTime;}return result;}@Overridepublic void addEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable) {if (suppressAllComments) {return;}StringBuilder sb = new StringBuilder();innerEnum.addJavaDocLine("/**");sb.append(" * ");sb.append(introspectedTable.getFullyQualifiedTable());innerEnum.addJavaDocLine(sb.toString().replace("\n", " "));innerEnum.addJavaDocLine(" */");}@Overridepublic void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {if (suppressAllComments) {return;}method.addJavaDocLine("/**");addJavadocTag(method, false);method.addJavaDocLine(" */");}
}

二.使用第一步编写的自定义注释生成工具

在mybatis-generator的配置文件generatorConfig.xml中配置好自定义的注释生成工具

<generatorConfiguration>
<context id="default" targetRuntime="MyBatis3"><!-- optional，旨在创建class时，对注释进行控制 --><commentGenerator type="com.xxx.generator.MybatisCommentGenerator"><!--<property name="suppressDate" value="true"/>--><!--<property name="suppressAllComments" value="true" />--><!-- 是否生成注释代时间戳--><property name="suppressDate" value="true"/></commentGenerator></context>
</generatorConfiguration>

三.还是按照以前的生成操作执行即可

public class Organization extends BaseBean {/*** 主键ID id*/private Integer id;/*** 父级ID pid*/private Integer pid;/*** 机构名称 name*/private String name;/*** 主键ID* @author Helsing* @date 2019-04-06 15:48:47* @return id 主键ID*/public Integer getId() {return id;}/*** 主键ID* @author Helsing* @date 2019-04-06 15:48:47* @param id 主键ID*/public void setId(Integer id) {this.id = id;}/*** 父级ID* @author Helsing* @date 2019-04-06 15:48:47* @return pid 父级ID*/public Integer getPid() {return pid;}/*** 父级ID* @author Helsing* @date 2019-04-06 15:48:47* @param pid 父级ID*/public void setPid(Integer pid) {this.pid = pid;}
}

四.参考

Mybatis自动生成字段注释

这篇关于Mybatis-generator生成字段注释的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/991236。

相关文章

持久层 技术选型如何决策？JPA，Hibernate，ibatis(mybatis)

持久层 技术选型如何决策？JPA，Hibernate，ibatis(mybatis)

转自：http://t.51jdy.cn/thread-259-1-1.html 持久层 是一个项目 后台 最重要的部分。他直接 决定了 数据读写的性能，业务编写的复杂度，数据结构(对象结构)等问题。 因此 架构师在考虑 使用那个持久层框架的时候 要考虑清楚。 选择的 标准： 1，项目的场景。 2，团队的技能掌握情况。 3，开发周期(开发效率)。 传统的 业务系统，通常业
阅读更多...
android 带与不带logo的二维码生成

android 带与不带logo的二维码生成

该代码基于ZXing项目，这个网上能下载得到。 定义的控件以及属性： public static final int SCAN_CODE = 1;private ImageView iv;private EditText et;private Button qr_btn,add_logo;private Bitmap logo,bitmap,bmp; //logo图标private st
阅读更多...
FastAdmin/bootstrapTable 表格中生成的按钮设置成文字

FastAdmin/bootstrapTable 表格中生成的按钮设置成文字

公司有个系统后台框架用的是FastAdmin，后台表格的操作栏按钮只有图标，想要设置成文字。 查资料后发现其实很简单，主需要新增“text”属性即可，如下 buttons: [{name: 'acceptcompany',title: '复核企业',text:'复核企业',classname: 'btn btn-xs btn-primary btn-dialog',icon: 'fa fa-pe
阅读更多...
MyBatis-Plus常用注解详解与实战应用

MyBatis-Plus常用注解详解与实战应用

MyBatis-Plus 是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。它提供了大量的常用注解，使得开发者能够更方便地进行数据库操作。 MyBatis-Plus 提供的注解可以帮我们解决一些数据库与实体之间相互映射的问题。 @TableName @TableName 用来指定表名 在使用 MyBatis-Plus 实现基本的 C
阅读更多...
PHP生成csv格式Excel，秒级别实现excel导出功能

PHP生成csv格式Excel，秒级别实现excel导出功能

防止报超内存，兼容中文，兼容科学技术法。 爽。。。。很爽。。。。 /*** 告诉浏览器下载csv文件* @param string $filename*/public static function downloadCsv($data, $filename, $encoding = 'utf-8'){header("Content-type: text/csv");header("Conten
阅读更多...
PHP 读取或生成大的Excel

PHP 读取或生成大的Excel

场景，在很多情况下，需要读取Excel文件。 常用的有PHPExcel包或者使用 maatwebsite/excel 包 但是使用这个包读取或生成excel，如果excel文件过大，很容易出现超内存情况。 解决方法： 上传：要求上传者使用.csv 文件上传。然后使用php自带的 fgetcsv()函数来读取文件。http://php.net/manual/zh/function.fgetc
阅读更多...
MyBatis系列之分页插件及问题

MyBatis系列之分页插件及问题

概述 无论是C端产品页面，还是后台系统页面，不可能一次性将全部数据加载出来。后台系统一般都是PC端登录，用Table组件（如Ant Design Table）渲染展示数据，可点击列表的下一页（或指定某一页）查看数据。C端产品如App，在下滑时可查看更多数据，看起来像是一次性加载数据，实际上也是分批请求后台系统获取数据。而这，就是分页功能。 如果没有使用Hibernate或MyBatis这样的O
阅读更多...
3D模型相关生成

3D模型相关生成

3D模型相关生成 1. DreamFusion Model DreamFusion Model 是一种将文本描述转化为三维模型的技术。你可以想象它是一个“魔法翻译器”，你告诉它一个场景或物体的描述，比如“一个飞翔的龙”，它就能生成一个相应的 3D 模型。 原理： 文本到图像生成：DreamFusion 首先将文本描述转化为一系列可能的 2D 图像。这部分利用了预训练的扩散模型（如 DALL
阅读更多...
【MyBatis学习8】MyBatis中的二级缓存

【MyBatis学习8】MyBatis中的二级缓存

1. 二级缓存的原理 　　前面介绍了，mybatis中的二级缓存是mapper级别的缓存，值得注意的是，不同的mapper都有一个二级缓存，也就是说，不同的mapper之间的二级缓存是互不影响的。为了更加清楚的描述二级缓存，先来看一个示意图：    　　从图中可以看出： sqlSession1去查询用户id为1的用户信息，查询到用户信息会将查询数据存储到该UserMapper的二级缓存中
阅读更多...
【MyBatis学习7】MyBatis中的一级缓存

【MyBatis学习7】MyBatis中的一级缓存

缓存的作用是减轻数据库的压力，提高数据库的性能的。mybatis中提供了一级缓存和二级缓存，先来看一下两个缓存的示意图：  　　从图中可以看出： 一级缓存是SqlSession级别的缓存。在操作数据库时需要构造sqlSession对象，在对象中有一个数据结构（HashMap）用于存储缓存数据。不同的sqlSession之间的缓存数据区域（HashMap）是互相不影响的。二级缓存是mappe
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2