自定义MyBatis Generator 注释配置教程

"MyBatis Generator 自定义生成注释的方法" 在开发过程中，MyBatis Generator (MBG) 是一个非常实用的工具，它能够自动生成数据库表对应的实体类、Mapper接口和XML配置文件，极大地提高了开发效率。然而，MBG默认生成的代码可能无法满足所有开发团队的规范和需求，比如注释的格式和内容。本篇文章将介绍如何自定义MBG生成的注释，以适应特定的项目风格。 首先，我们需要了解MBG的基本配置。在MBG的配置文件（通常为`mybatis-generator-config.xml`）中，我们可以指定数据库驱动、目标编程语言、生成的代码风格等。例如： ```xml <?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> <!-- 指定数据库驱动的jdbc驱动jar包的位置 --> <classPathEntry location="./mysql-connector-java-5.1.40.jar"/> <!-- 配置上下文 --> <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"/> <!-- 配置数据库连接 --> <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost/your_database" userId="your_username" password="your_password"/> ... </context> </generatorConfiguration> ``` 在MBG的配置中，我们并没有直接设置注释的选项。但是，MBG允许我们通过插件（plugins）机制来自定义生成的代码。要自定义注释，我们需要创建一个实现了`org.mybatis.generator.api.Plugin`接口的类，并在配置文件中启用它。 例如，我们创建一个名为`CustomCommentPlugin`的插件，它会在生成的类和方法上添加自定义的注释： ```java 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.FullyQualifiedJavaType; import org.mybatis.generator.api.dom.java InnerClass; import org.mybatis.generator.api.dom.java.JavaVisibility; import org.mybatis.generator.api.dom.java.Method; import org.mybatis.generator.api.dom.java.TopLevelClass; public class CustomCommentPlugin extends PluginAdapter { @Override public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) { // 在生成的基类中添加注释 topLevelClass.addJavaDocLine("/"); topLevelClass.addJavaDocLine(" * 自定义基类注释"); topLevelClass.addJavaDocLine(" * @author YourName"); topLevelClass.addJavaDocLine(" */"); return true; } @Override public boolean modelExampleClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) { // 在Example类中添加注释 ... return true; } @Override public boolean modelFieldGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) { // 在字段上添加注释 method.addJavaDocLine("/"); method.addJavaDocLine(" * " + introspectedColumn.getRemarks()); method.addJavaDocLine(" */"); return true; } // 其他需要自定义注释的地方... } ``` 接下来，在MBG配置文件中启用这个插件： ```xml <plugins> <plugin type="com.yourpackage.CustomCommentPlugin"/> </plugins> ``` 通过这种方式，我们就可以在MBG生成的代码中插入自定义的注释了。这不仅可以帮助团队遵循统一的代码规范，还可以在注释中包含更多的元数据信息，如字段的描述、作者信息等。 总结来说，MyBatis Generator 提供了强大的自定义能力，允许开发者通过插件机制来定制生成代码的各个细节，包括注释。通过创建自定义插件并覆盖必要的方法，我们可以根据项目需求添加丰富的注释，提高代码的可读性和维护性。在实际项目中，可以根据具体需求调整`CustomCommentPlugin`中的逻辑，以实现更复杂的注释生成规则。