个人中心
文章发布
退出
作者热门文章
- Java锁的逻辑（结合对象头和ObjectMonitor）
- 还在用饼状图？来瞧瞧这些炫酷的百分比可视化新图形（附代码实现）⛵
- 自动注册实体类到EntityFrameworkCore上下文，并适配ABP及ABPVNext
- 基于Sklearn机器学习代码实战
26
4
在日常开发工作中，我们经常用Mybatis Generator根据表结构生成对应的实体类和Mapper文件。但是Mybatis Generator默认生成的代码中，注释并不是我们想要的，所以一般在Generator配置文件中，会设置不自动生成注释。带来的问题就是自动生成代码之后，我们还要自己去类文件中把注释加上，如果生成的类较少还好，如果有生成很多类文件，自己加注释是一件繁琐的工作.
通过重写Mybatis Generator的CommentGenerator接口，可以方便地生成自己想要的注释，减少重复工作.
pom.xml中引入jar包 。
<?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>org.example</groupId>
<artifactId>MyGenerator</artifactId>
<version>
1.0
-SNAPSHOT</version>
<properties>
<maven.compiler.source>
8
</maven.compiler.source>
<maven.compiler.target>
8
</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>
8.0
.
16
</version>
</dependency>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>
1.3
.
7
</version>
</dependency>
</dependencies>
</project>
。
随便找个目录放，我放在src/main/resources目录下 。
<?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>
<context id=
"
mysql
"
defaultModelType=
"
hierarchical
"
targetRuntime=
"
MyBatis3Simple
"
>
<!-- 生成的 Java 文件的编码 -->
<property name=
"
javaFileEncoding
"
value=
"
UTF-8
"
/>
<!-- 格式化 Java 代码 -->
<property name=
"
javaFormatter
"
value=
"
org.mybatis.generator.api.dom.DefaultJavaFormatter
"
/>
<!-- 格式化 XML 代码 -->
<property name=
"
xmlFormatter
"
value=
"
org.mybatis.generator.api.dom.DefaultXmlFormatter
"
/>
<commentGenerator>
<property name=
"
suppressAllComments
"
value=
"
false
"
/>
</commentGenerator>
<!-- 配置数据库连接 -->
<jdbcConnection driverClass=
"
com.mysql.cj.jdbc.Driver
"
connectionURL
=
"
URL
"
userId
=
"
user
"
password=
"
password
"
>
<!-- 设置 useInformationSchema 属性为
true
-->
<property name=
"
useInformationSchema
"
value=
"
true
"
/>
</jdbcConnection>
<!-- 生成实体的位置 -->
<javaModelGenerator targetPackage=
"
com.jd.bulk
"
targetProject
=
"
src/main/java
"
>
<property name=
"
enableSubPackages
"
value=
"
true
"
/>
</javaModelGenerator>
<!-- 生成 Mapper XML 的位置 -->
<sqlMapGenerator targetPackage=
"
com.jd.bulk
"
targetProject
=
"
src/main/resources
"
>
<property name=
"
enableSubPackages
"
value=
"
true
"
/>
</sqlMapGenerator>
<!-- 生成 Mapper 接口的位置 -->
<javaClientGenerator type=
"
XMLMAPPER
"
targetPackage
=
"
com.jd.bulk
"
targetProject
=
"
src/main/java
"
>
<property name=
"
enableSubPackages
"
value=
"
true
"
/>
</javaClientGenerator>
<!-- 设置数据库的表名和实体类名 -->
<table tableName=
"
worker
"
domainObjectName=
"
Worker
"
/>
</context>
</generatorConfiguration>
。
public
class
Generator {
public
static
void
main(String[] args) throws Exception {
List
<String> warnings =
new
ArrayList<>(
2
);
ConfigurationParser cp
=
new
ConfigurationParser(warnings);
File configFile
=
new
File(
"
src/main/resources/generatorConfig.xml
"
);
Configuration config
=
cp.parseConfiguration(configFile);
DefaultShellCallback callback
=
new
DefaultShellCallback(
true
);
MyBatisGenerator
=
new
MyBatisGenerator(config, callback, warnings);
myBatisGenerator.generate(
null
);
}
}
。
运行main方法，生成默认注释如下，并不是我们想要的注释，所以一般会配置为注释不生成:
重写以下方法，自定义注释 。
public
class
MySQLCommentGenerator implements CommentGenerator {
private
final Properties properties;
public
MySQLCommentGenerator() {
properties
=
new
Properties();
}
@Override
public
void
addConfigurationProperties(Properties properties) {
//
获取自定义的 properties
this
.properties.putAll(properties);
}
/*
*
* 重写给实体类加的注释
*/
@Override
public
void
addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
String author
= properties.getProperty(
"
author
"
);
String dateFormat
= properties.getProperty(
"
dateFormat
"
,
"
yyyy-MM-dd
"
);
SimpleDateFormat dateFormatter
=
new
SimpleDateFormat(dateFormat);
//
获取表注释
String remarks =
introspectedTable.getRemarks();
topLevelClass.addJavaDocLine(
"
/**
"
);
topLevelClass.addJavaDocLine(
"
*
"
+
remarks);
topLevelClass.addJavaDocLine(
"
*
"
);
topLevelClass.addJavaDocLine(
"
* @author
"
+
author);
topLevelClass.addJavaDocLine(
"
* @date
"
+ dateFormatter.format(
new
Date()));
topLevelClass.addJavaDocLine(
"
*/
"
);
}
/*
*
* 重写给实体类字段加的注释
*/
@Override
public
void
addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
//
获取列注释
String remarks =
introspectedColumn.getRemarks();
field.addJavaDocLine(
"
/**
"
);
field.addJavaDocLine(
"
*
"
+
remarks);
field.addJavaDocLine(
"
*/
"
);
}
/*
*
* 重写给实体类get方法加的注释
*/
@Override
public
void
addGetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
//
获取表注释
String remarks =
introspectedColumn.getRemarks();
method.addJavaDocLine(
"
/**
"
);
method.addJavaDocLine(
"
*
"
+
method.getName());
method.addJavaDocLine(
"
*/
"
);
}
。
将generatorConfig.xml文件中的commentGenerator做如下修改，type属性选择自己的实现类 。
<commentGenerator type=
"
com.generator.MySQLCommentGenerator
"
>
<property name=
"
author
"
value=
"
Your Name
"
/>
<property name=
"
dateFormat
"
value=
"
yyyy/MM/dd
"
/>
</commentGenerator>
。
运行main方法，生成注释如下:
Pom.xml文件中增加以下配置，需要引入generator插件时，依赖实现CommentGenerator接口的jar包，要先把自己的jar包install到本地仓库.
否则会报com.generator.MySQLCommentGenerator找不到，其他配置同上.
<build>
<defaultGoal>compile</defaultGoal>
<plugins>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>
1.4
.
0
</version>
<configuration>
<configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
<verbose>
true
</verbose>
<overwrite>
true
</overwrite>
</configuration>
<dependencies>
<!-- 其他的数据库，需要修改依赖 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>
8.0
.
16
</version>
</dependency>
<!-- 引用实现CommentGenerator接口的jar包 -->
<dependency>
<groupId>org.example</groupId>
<artifactId>MyGenerator</artifactId>
<version>
1.0
-SNAPSHOT</version>
</dependency>
</dependencies>
</plugin>
</plugins>
。
查看执行Mybatis Generator的main方法，主要分为两部分，解析指定的配置文件与调用生成java文件和Mapper文件的方法 。
跟踪解析xml文件的方法cp.parseConfiguration(configFile)发现，底层以Document形式读取xml文件，根据标签名解析各标签属性，保存到Configuration实例中.
其中解析commentGenerator标签的方法parseCommentGenerator(context, childNode)中，会获取commentGenerator标签的type属性值，也就是自定义的”com.generator.MySQLCommentGenerator”类，放到Context实例中.
xml配置文件解析完成，得到Configuration实例，后面生成文件的工作都会从Configuration实例中获取所需数据。生成文件的方法主要步骤为：1.连接数据库,查询表信息与列信息，2.生成文件内容，3.写入生成文件.
其中生成文件内容时，会根据Context的type属性反射创建MySQLCommentGenerator实例，然后调用自定义的生成注释方法.
如：生成实体类文件的注释，调用addModelClassComment方法 。
生成字段注释，调用addFieldComment方法 。
生成Get方法注释，调用addGetterComment方法 。
在调用addModelClassComment，addFieldComment，addGetterComment等生成注释的方法时，执行的都是MySQLCommentGenerator类的方法，这样就实现了生成自定义注释的功能.
通过使用自定义实现CommentGenerator接口，让自动生成的代码加上我们想要的注释，可以省去自己加注释的麻烦.
与一般使用Mybatis Generator生成代码的方式一样，多实现个接口即可。 使用Maven方式运行时，需要在pom.xml引入插件时，依赖自己jar包.
最后此篇关于把MybatisGenerator生成的代码加上想要的注释的文章就讲到这里了,如果你想了解更多关于把MybatisGenerator生成的代码加上想要的注释的内容请搜索CFSDN的文章或继续浏览相关文章，希望大家以后支持我的博客！ 。
26
4
0
我尝试理解[c代码 -> 汇编]代码 void node::Check( data & _data1, vector& _data2) { -> push ebp -> mov ebp,esp ->
我需要在当前表单(代码)的上下文中运行文本文件中的代码。其中一项要求是让代码创建新控件并将其添加到当前窗体。 例如，在Form1.cs中: using System.Windows.Forms; ..
我有此 C++ 代码并将其转换为 C# (.net Framework 4) 代码。有没有人给我一些关于 malloc、free 和 sprintf 方法的提示？ int monate = ee; d
我的网络服务器代码有问题 #include #include #include #include #include #include #include int
给定以下 html 代码，将列表中的第三个元素(即“美丽”一词)以斜体显示的 CSS 代码是什么？当然，我可以给这个元素一个 id 或一个 class，但 html 代码必须保持不变。谢谢
关闭。这个问题不符合Stack Overflow guidelines .它目前不接受答案。 我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题，以便用事实和引用来回答。 关闭 7 年前。
我试图制作一个宏来避免重复代码和注释。 我试过这个: #define GrowOnPage(any Page, any Component) Component.Width := Page.Surfa
我正在尝试将我的旧 C++ 代码“翻译”成头条新闻所暗示的 C# 代码。问题是我是 C# 中的新手，并不是所有的东西都像 C++ 中那样。在 C++ 中这些解决方案运行良好，但在 C# 中只是不能。我
在 Windows 10 上工作，R 语言的格式化程序似乎没有在 Visual Studio Code 中完成它的工作。我试过R support for Visual Studio Code和 R-T
我正在处理一些报告(计数)，我必须获取不同参数的计数。非常简单但乏味。 一个参数的示例查询: qCountsEmployee = ( "select count(*) from %s wher
最近几天我尝试从 d00m 调试网络错误。我开始用尽想法/线索，我希望其他 SO 用户拥有可能有用的宝贵经验。我希望能够提供所有相关信息，但我个人无法控制服务器环境。 整个事情始于用户注意到我们应用程
我有一个 app.js 文件，其中包含如下 dojo amd 模式代码: require(["dojo/dom", ..], function(dom){ dom.byId('someId').i
我对“-gencode”语句中的“code=sm_X”选项有点困惑。 一个例子:NVCC 编译器选项有什么作用 -gencode arch=compute_13,code=sm_13 嵌入库中？ 只有
我为我的表格使用 X-editable 框架。 但是我有一些问题。 $(document).ready(function() { $('.access').editable({
我一直在通过本教程学习 flask/python http://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-i-hello-wo
我想将 Vim 和 EMACS 用于 CNC、G 代码和 M 代码。 Vim 或 EMACS 是否有任何语法或模式来处理这种类型的代码？ 最佳答案 一些快速搜索使我找到了 this vim 和 thi
关闭。这个问题不符合Stack Overflow guidelines .它目前不接受答案。 想改进这个问题？更新问题，使其成为 on-topic对于堆栈溢出。 7年前关闭。 Improve this
这个问题在这里已经有了答案: Enabling markdown highlighting in Vim (5 个回答) 6年前关闭。 当我在 Vim 中编辑包含 Markdown 代码的 READM
我正在 Swift3 iOS 中开发视频应用程序。基本上我必须将视频 Assets 和音频与淡入淡出效果合并为一个并将其保存到 iPhone 画廊。为此，我使用以下方法: private func d
pipeline { agent any stages { stage('Build') { steps { e
我是一名优秀的程序员,十分优秀！