把 Mybatis Generator 生成的代码加上想要的注释

1 前言

在日常开发工作中，我们经常用 Mybatis Generator 根据表结构生成对应的实体类和 Mapper 文件。但是 Mybatis Generator 默认生成的代码中，注释并不是我们想要的，所以一般在 Generator 配置文件中，会设置不自动生成注释。带来的问题就是自动生成代码之后，我们还要自己去类文件中把注释加上，如果生成的类较少还好，如果有生成很多类文件，自己加注释是一件繁琐的工作。

通过重写 Mybatis Generator 的 CommentGenerator 接口，可以方便地生成自己想要的注释，减少重复工作。

2 使用 Java 方式执行 Mybatis Generator

2.1 IDEA 中新建 Maven 项目

pom.xml 中引入 jar 包

1. <?xml version="1.0" encoding="UTF-8"?>
   

2. <project xmlns="http://maven.apache.org/POM/4.0.0"
   

3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   

4. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   

5. <modelVersion>4.0.0</modelVersion>
   

6. <groupId>org.example</groupId>
   

7. <artifactId>MyGenerator</artifactId>
   

8. <version>1.0-SNAPSHOT</version>
   

9. <properties>
   

10. <maven.compiler.source>8</maven.compiler.source>
    

11. <maven.compiler.target>8</maven.compiler.target>
    

12. </properties>
    

13. <dependencies>
    

14. <dependency>
    

15. <groupId>mysql</groupId>
    

16. <artifactId>mysql-connector-java</artifactId>
    

17. <version>8.0.16</version>
    

18. </dependency>
    

19. <dependency>
    

20. <groupId>org.mybatis.generator</groupId>
    

21. <artifactId>mybatis-generator-core</artifactId>
    

22. <version>1.3.7</version>
    

23. </dependency>
    

24. </dependencies>
    

25. </project>
    

2.2 创建 generatorConfig.xml

随便找个目录放，我放在 src/main/resources 目录下

1. <?xml version="1.0" encoding="UTF-8"?>
   

2. <!DOCTYPE generatorConfiguration PUBLIC
   

3. "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
   

4. "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
   

5. <generatorConfiguration>
   

6. <context id="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple" >
   

7. 
   

8. <property name="javaFileEncoding" value="UTF-8"/>
   

9. 
   

10. <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
    

11. 
    

12. <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
    

13. <commentGenerator>
    

14. <property name="suppressAllComments" value="false" />
    

15. </commentGenerator>
    

16. 
    

17. <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
    

18. connectionURL="URL"
    

19. userId="user" password="password">
    

20. 
    

21. <property name="useInformationSchema" value="true" />
    

22. </jdbcConnection>
    

23. 
    

24. <javaModelGenerator targetPackage="com.jd.bulk"
    

25. targetProject="src/main/java">
    

26. <property name="enableSubPackages" value="true"/>
    

27. </javaModelGenerator>
    

28. 
    

29. <sqlMapGenerator targetPackage="com.jd.bulk"
    

30. targetProject="src/main/resources">
    

31. <property name="enableSubPackages" value="true"/>
    

32. </sqlMapGenerator>
    

33. 
    

34. <javaClientGenerator type="XMLMAPPER"
    

35. targetPackage="com.jd.bulk"
    

36. targetProject="src/main/java">
    

37. <property name="enableSubPackages" value="true"/>
    

38. </javaClientGenerator>
    

39. 
    

40. <table tableName="worker" domainObjectName="Worker"/>
    

41. </context>
    

42. </generatorConfiguration>
    

2.3 创建 main 方法，运行 Generator

1. public class Generator {
   

2. public static void main(String[] args) throws Exception {
   

3. List<String> warnings = new ArrayList<>(2);
   

4. ConfigurationParser cp = new ConfigurationParser(warnings);
   

5. File configFile = new File("src/main/resources/generatorConfig.xml");
   

6. Configuration config = cp.parseConfiguration(configFile);
   

7. DefaultShellCallback callback = new DefaultShellCallback(true);
   

8. MyBatisGenerator = new MyBatisGenerator(config, callback, warnings);
   

9. myBatisGenerator.generate(null);
   

10. }
    

11. }
    

运行 main 方法，生成默认注释如下，并不是我们想要的注释，所以一般会配置为注释不生成：

2.4 实现 CommentGenerator 接口

重写以下方法，自定义注释

1. public class MySQLCommentGenerator implements CommentGenerator {
   

2. private final Properties properties;
   

3. public MySQLCommentGenerator() {
   

4. properties = new Properties();
   

5. }
   

6. @Override
   

7. public void addConfigurationProperties(Properties properties) {
   

8. // 获取自定义的 properties
   

9. this.properties.putAll(properties);
   

10. }
    

11. /**
    

12. * 重写给实体类加的注释
    

13. */
    

14. @Override
    

15. public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
    

16. String author = properties.getProperty("author");
    

17. String dateFormat = properties.getProperty("dateFormat", "yyyy-MM-dd");
    

18. SimpleDateFormat dateFormatter = new SimpleDateFormat(dateFormat);
    

19. // 获取表注释
    

20. String remarks = introspectedTable.getRemarks();
    

21. topLevelClass.addJavaDocLine("/**");
    

22. topLevelClass.addJavaDocLine(" * " + remarks);
    

23. topLevelClass.addJavaDocLine(" *");
    

24. topLevelClass.addJavaDocLine(" * @author " + author);
    

25. topLevelClass.addJavaDocLine(" * @date " + dateFormatter.format(new Date()));
    

26. topLevelClass.addJavaDocLine(" */");
    

27. }
    

28. /**
    

29. * 重写给实体类字段加的注释
    

30. */
    

31. @Override
    

32. public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
    

33. // 获取列注释
    

34. String remarks = introspectedColumn.getRemarks();
    

35. field.addJavaDocLine("/**");
    

36. field.addJavaDocLine(" * " + remarks);
    

37. field.addJavaDocLine(" */");
    

38. }
    

39. /**
    

40. * 重写给实体类get方法加的注释
    

41. */
    

42. @Override
    

43. public void addGetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
    

44. // 获取表注释
    

45. String remarks = introspectedColumn.getRemarks();
    

46. method.addJavaDocLine("/**");
    

47. method.addJavaDocLine(" * " + method.getName());
    

48. method.addJavaDocLine(" */");
    

49. }
    

2.5 修改 generatorConfig.xml 配置

将 generatorConfig.xml 文件中的 commentGenerator 做如下修改，type 属性选择自己的实现类

1. <commentGenerator type="com.generator.MySQLCommentGenerator">
   

2. <property name="author" value="Your Name"/>
   

3. <property name="dateFormat" value="yyyy/MM/dd"/>
   

4. </commentGenerator>
   

运行 main 方法，生成注释如下：

3 使用 Maven 方式执行 Mybatis Generator

Pom.xml 文件中增加以下配置，需要引入 generator 插件时，依赖实现 CommentGenerator 接口的 jar 包，要先把自己的 jar 包 install 到本地仓库。

否则会报 com.generator.MySQLCommentGenerator 找不到，其他配置同上。

1. <build>
   

2. <defaultGoal>compile</defaultGoal>
   

3. <plugins>
   

4. <plugin>
   

5. <groupId>org.mybatis.generator</groupId>
   

6. <artifactId>mybatis-generator-maven-plugin</artifactId>
   

7. <version>1.4.0</version>
   

8. <configuration>
   

9. <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
   

10. <verbose>true</verbose>
    

11. <overwrite>true</overwrite>
    

12. </configuration>
    

13. <dependencies>
    

14. 
    

15. <dependency>
    

16. <groupId>mysql</groupId>
    

17. <artifactId>mysql-connector-java</artifactId>
    

18. <version>8.0.16</version>
    

19. </dependency>
    

20. 
    

21. <dependency>
    

22. <groupId>org.example</groupId>
    

23. <artifactId>MyGenerator</artifactId>
    

24. <version>1.0-SNAPSHOT</version>
    

25. </dependency>
    

26. </dependencies>
    

27. </plugin>
    

28. </plugins>
    

4 源码分析

查看执行 Mybatis Generator 的 main 方法，主要分为两部分，解析指定的配置文件与调用生成 java 文件和 Mapper 文件的方法

4.1 解析指定的 xml 配置文件

跟踪解析 xml 文件的方法 cp.parseConfiguration(configFile)发现，底层以 Document 形式读取 xml 文件，根据标签名解析各标签属性，保存到 Configuration 实例中。

其中解析 commentGenerator 标签的方法 parseCommentGenerator(context, childNode)中，会获取 commentGenerator 标签的 type 属性值，也就是自定义的”com.generator.MySQLCommentGenerator”类，放到 Context 实例中。

4.2 调用生成 java 文件和 Mapper 文件的方法

xml 配置文件解析完成，得到 Configuration 实例，后面生成文件的工作都会从 Configuration 实例中获取所需数据。生成文件的方法主要步骤为：1.连接数据库,查询表信息与列信息，2.生成文件内容，3.写入生成文件。

其中生成文件内容时，会根据 Context 的 type 属性反射创建 MySQLCommentGenerator 实例，然后调用自定义的生成注释方法。

如：生成实体类文件的注释，调用 addModelClassComment 方法

生成字段注释，调用 addFieldComment 方法

生成 Get 方法注释，调用 addGetterComment 方法

在调用 addModelClassComment，addFieldComment，addGetterComment 等生成注释的方法时，执行的都是 MySQLCommentGenerator 类的方法，这样就实现了生成自定义注释的功能。

5 总结

通过使用自定义实现 CommentGenerator 接口，让自动生成的代码加上我们想要的注释，可以省去自己加注释的麻烦。

与一般使用 Mybatis Generator 生成代码的方式一样，多实现个接口即可。

使用 Maven 方式运行时，需要在 pom.xml 引入插件时，依赖自己 jar 包。

作者：京东物流 王建乐

来源：京东云开发者社区 自猿其说 Tech 转载请注明来源