把Mybatis Generator生成的程式碼加上想要的註釋

京東雲開發者發表於2022-11-23

作者：王建樂

1 前言

在日常開發工作中，我們經常用Mybatis Generator根據表結構生成對應的實體類和Mapper檔案。但是Mybatis Generator預設生成的程式碼中，註釋並不是我們想要的，所以一般在Generator配置檔案中，會設定不自動生成註釋。帶來的問題就是自動生成程式碼之後，我們還要自己去類檔案中把註釋加上，如果生成的類較少還好，如果有生成很多類檔案，自己加註釋是一件繁瑣的工作。

透過重寫Mybatis Generator的CommentGenerator介面，可以方便地生成自己想要的註釋，減少重複工作。

2 使用Java方式執行Mybatis Generator

2.1 IDEA中新建Maven專案

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>

2.2 建立generatorConfig.xml

隨便找個目錄放，我放在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>

2.3 建立main方法，執行Generator

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方法，生成預設註釋如下，並不是我們想要的註釋，所以一般會配置為註釋不生成：

2.4 實現CommentGenerator介面

重寫以下方法，自定義註釋

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(" */");
}

2.5 修改generatorConfig.xml配置

將generatorConfig.xml檔案中的commentGenerator做如下修改，type屬性選擇自己的實現類

<commentGenerator type="com.generator.MySQLCommentGenerator">
<property name="author" value="Your Name"/>
<property name="dateFormat" value="yyyy/MM/dd"/>
</commentGenerator>

執行main方法，生成註釋如下：

3 使用Maven方式執行Mybatis Generator

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>

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例項中。