tags: [mybatis, mybatis generator]
categories: [mybatis]

前言

实际开发之中，虽然有很多CRUD工具，但是使用最多的还是Mybatis，而Mybatis Gerator可以帮助你自动生成基本的单表CRUD代码，提高效率

但是生成的代码有些地方已经不符合当前的风格和标准，比如现在很多项目都是使用lombok，而不是在实体类里面添加get/set方法，默认生成的注释信息不友好，这个时候我们可以通过一些修改来生成我们想要的结果

本项目为SpringBoot项目，数据为MySQL

使用

引入依赖

后边的Plugn是以Maven生成的，若以代码形式来生成则无需配置

  1.         <!--mybatis-->
  2.         <dependency>
  3.             <groupId>org.mybatis.spring.boot</groupId>
  4.             <artifactId>mybatis-spring-boot-starter</artifactId>
  5.         </dependency>
  6.         <!-- https://mvnrepository.com/artifact/org.mybatis.generator/mybatis-generator-core -->
  7.         <dependency>
  8.             <groupId>org.mybatis.generator</groupId>
  9.             <artifactId>mybatis-generator-core</artifactId>
  10.             <version>1.3.7</version>
  11.         </dependency>
  13.             <plugin>
  14.                 <groupId>org.mybatis.generator</groupId>
  15.                 <artifactId>mybatis-generator-maven-plugin</artifactId>
  16.                 <version>1.3.7</version>
  17.                 <configuration>
  18.                     <!--自定义路径,否则会自动识别GeneratorConfig.xml文件-->
  19.                     <!-- <configurationFiile>${basedir}/src/main/resources/generatorConfig.xml</configurationFile>-->
  20.                     <!--是为了运行mvn mybatis-generator:generate -e时显示具体过程-->
  21.                     <verbose>true</verbose>
  22.                     <!--为了生成文件时后一次生成的文件覆盖前一次生成的同名文件-->
  23.                     <overwrite>true</overwrite>
  24.                 </configuration>
  25.                 <dependencies>
  26.                     <dependency>
  27.                         <groupId>mysql</groupId>
  28.                         <artifactId>mysql-connector-java</artifactId>
  29.                         <version>5.1.44</version>
  30.                     </dependency>
  31.                 </dependencies>
  32.             </plugin>

后边的Plugn是以Maven生成需要配置的，若以代码形式来生成则无需配置
我的存放目录如下
1.png

添加自定义插件

  1. package com.bwensun.common.mybatis;
  3. import org.mybatis.generator.api.IntrospectedColumn;
  4. import org.mybatis.generator.api.IntrospectedTable;
  5. import org.mybatis.generator.api.PluginAdapter;
  6. import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
  7. import org.mybatis.generator.api.dom.java.Interface;
  8. import org.mybatis.generator.api.dom.java.Method;
  9. import org.mybatis.generator.api.dom.java.TopLevelClass;
  11. import java.text.SimpleDateFormat;
  12. import java.util.Date;
  13. import java.util.List;
  15. /**
  16.  * lombok插件
  17.  *
  18.  * @author bwensun
  19.  * @date 2019/12/16
  20.  */
  21. public class LombokPlugin extends PluginAdapter {
  23.     @Override
  24.     public boolean validate(List<String> warnings) {
  25.         return true;
  26.     }
  28.     @Override
  29.     public boolean clientGenerated(Interface interfaze, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
  30.         SimpleDateFormat dateFormatter = new SimpleDateFormat(properties.getProperty("dateFormat", "yyyy-MM-dd"));
  31.         //接口添加注释
  32.         interfaze.addJavaDocLine("/**");
  33.                 interfaze.addJavaDocLine(" * " + introspectedTable.getRemarks());
  34.         interfaze.addJavaDocLine(" *");
  35.         interfaze.addJavaDocLine(" * @author " + properties.getProperty("author"));
  36.         interfaze.addJavaDocLine(" * @date " + dateFormatter.format(new Date()));
  37.         interfaze.addJavaDocLine(" */");
  38.         //dao添加注解
  39.         addAnnotations(interfaze, "org.springframework.stereotype.Repository", "@Repository");
  42.         return true;
  43.     }
  45.     @Override
  46.     public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
  47.         if (Boolean.parseBoolean(this.properties.getProperty("data"))) {
  48.             addAnnotations(topLevelClass, "lombok.Data", "@Data");
  49.         } else {
  50.             addAnnotations(topLevelClass, "lombok.Getter", "@Getter");
  51.             addAnnotations(topLevelClass, "lombok.Setter", "@Setter");
  52.             addAnnotations(topLevelClass, "lombok.ToString", "@ToString");
  53.         }
  54.         if (Boolean.parseBoolean(this.properties.getProperty("builder"))) {
  55.             addAnnotations(topLevelClass, "lombok.Builder", "@Builder");
  56.         }
  57.         return true;
  58.     }
  60.     /**
  61.      * 关闭get方法生成
  62.      */
  63.     @Override
  64.     public boolean modelGetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
  65.         return false;
  66.     }
  68.     /**
  69.      * 关闭set方法生成
  70.      */
  71.     @Override
  72.     public boolean modelSetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
  73.         return false;
  74.     }
  76.     public void addSwaggerAnnotation(){
  78.     }
  81.     /**
  82.      * 设置类注解
  83.      *
  84.      * @param importedType 导包类型
  85.      * @param annotation   注解
  86.      */
  87.     private void addAnnotations(TopLevelClass topLevelClass, String importedType, String annotation) {
  88.         topLevelClass.addImportedType(importedType);
  89.         topLevelClass.addAnnotation(annotation);
  90.     }
  92.     /**
  93.      * 设置接口注解
  94.      *
  95.      * @param importedType 导包类型
  96.      * @param annotation   注解
  97.      */
  98.     private void addAnnotations(Interface interfaze, String importedType, String annotation) {
  99.         interfaze.addImportedType(new FullyQualifiedJavaType(importedType));
  100.         interfaze.addAnnotation(annotation);
  101.     }
  103.     private String date2Str(Date date) {
  104.         SimpleDateFormat format = new SimpleDateFormat("yyyy/MM/dd");
  105.         return format.format(date);
  106.     }
  107. }

说明
Mybatis Generator的配置文件中包含了plugn标签，我们就可以通过手写插件来实现我们自己的功能，

重写注释部分注释方法

  1. package com.bwensun.common.mybatis;
  3. import org.mybatis.generator.api.IntrospectedColumn;
  4. import org.mybatis.generator.api.IntrospectedTable;
  5. import org.mybatis.generator.api.dom.java.*;
  7. import org.mybatis.generator.internal.DefaultCommentGenerator;
  8. import org.mybatis.generator.internal.util.StringUtility;
  10. import java.text.SimpleDateFormat;
  11. import java.util.Date;
  12. import java.util.List;
  13. import java.util.Properties;
  14. import java.util.Set;
  16. /**
  17.  * 增加 swagger 字段注释支持
  18.  *
  19.  * @author daiwenzh5
  20.  * @date 2019/9/8 18:56
  21.  */
  22. public class CustomCommentGenerator extends DefaultCommentGenerator {
  24.     private Properties properties;
  26.     public CustomCommentGenerator() {
  27.         properties = new Properties();
  28.     }
  30.     @Override
  31.     public void addConfigurationProperties(Properties properties) {
  32.         // 获取自定义的 properties
  33.         this.properties.putAll(properties);
  34.     }
  36.     /**
  37.      * 添加 swagger 字段注解
  38.      *
  39.      * @param field              字段
  40.      * @param introspectedTable  表
  41.      * @param introspectedColumn 列
  42.      * @param imports            导入类
  43.      */
  44.     @Override
  45.     public void addFieldAnnotation(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn, Set<FullyQualifiedJavaType> imports) {
  46.         imports.add(new FullyQualifiedJavaType("io.swagger.annotations.ApiModelProperty"));
  47.         String remarks = introspectedColumn.getRemarks();
  48.         field.addAnnotation(this.getSwaggerAnnotation(field.getName(), remarks));
  49.         super.addFieldAnnotation(field, introspectedTable, introspectedColumn, imports);
  50.     }
  52.     @Override
  53.     public void addFieldAnnotation(Field field, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) {
  54.         super.addFieldAnnotation(field, introspectedTable, set);
  55.     }
  57.     @Override
  58.     public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
  59.         // 获取字段注释
  60.         String remarks = introspectedColumn.getRemarks();
  61.         field.addJavaDocLine("/**");
  62.         field.addJavaDocLine(" * " + remarks);
  63.         field.addJavaDocLine(" */");
  64.     }
  66.     @Override
  67.     public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
  68. /*        if (suppressAllComments) {
  69.             return;
  70.         }*/
  71.         String methodDoc = getMethodDoc(method, introspectedTable);
  72.         method.addJavaDocLine("/**");
  73.         method.addJavaDocLine(" * " + methodDoc);
  74.         method.addJavaDocLine(" *");
  75.         setMethodParam(method);
  76.         setMethodReturn(method, introspectedTable);
  77.         method.addJavaDocLine(" */");
  78.     }
  80.     @Override
  81.     public void addClassAnnotation(InnerClass innerClass, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) {
  82.         super.addClassAnnotation(innerClass, introspectedTable, set);
  83.     }
  85.     @Override
  86.     public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
  87.         String author = properties.getProperty("author");
  88.         String dateFormat = properties.getProperty("dateFormat", "yyyy-MM-dd");
  89.         SimpleDateFormat dateFormatter = new SimpleDateFormat(dateFormat);
  91.         // 获取表注释
  92.         String remarks = introspectedTable.getRemarks();
  94.         topLevelClass.addJavaDocLine("/**");
  95.         topLevelClass.addJavaDocLine(" * " + remarks);
  96.         topLevelClass.addJavaDocLine(" *");
  97.         topLevelClass.addJavaDocLine(" * @author " + author);
  98.         topLevelClass.addJavaDocLine(" * @date " + dateFormatter.format(new Date()));
  99.         topLevelClass.addJavaDocLine(" */");
  100.     }
  102.     /**
  103.      * 获取 swagger 注解信息
  104.      *
  105.      * @param name    字段名
  106.      * @param remarks 注释信息
  107.      * @return 返回 swagger 注释字符串
  108.      */
  109.     private String getSwaggerAnnotation(String name, String remarks) {
  110.         StringBuffer buffer = new StringBuffer("@ApiModelProperty(");
  111.         buffer.append("name = \"");
  112.         buffer.append(name);
  113.         if (StringUtility.stringHasValue(remarks)) {
  114.             buffer.append("\", value = \"");
  115.             buffer.append(remarks);
  116.         }
  117.         buffer.append("\")");
  118.         return buffer.toString();
  119.     }
  121.     private String getMethodDoc(Method method, IntrospectedTable introspectedTable) {
  122.         String remarks = introspectedTable.getRemarks();
  123.         String methodDoc;
  124.         switch (method.getName()){
  125.             case "deleteByPrimaryKey":
  126.                 methodDoc = ("根据主键删除" + remarks + "记录");
  127.                 break;
  128.             case "selectByPrimaryKey":
  129.                 methodDoc = ("根据主键查询" + remarks + "记录");
  130.                 break;
  131.             case "insert":
  132.                 methodDoc = ("新增记录至" + remarks);
  133.                 break;
  134.             case "selectAll":
  135.                 methodDoc = ("查询" + remarks + "所有记录");
  136.                 break;
  137.             case "updateByPrimaryKey":
  138.                 methodDoc = ("根据主键更新" + remarks + "记录");
  139.                 break;
  140.             default:
  141.                 methodDoc = "description";
  142.                 break;
  143.         }
  144.         return methodDoc;
  145.     }
  147.     /**
  148.      * 设置参数注释
  149.      *
  150.      * @param method 方法
  151.      */
  152.     private void setMethodParam(Method method) {
  153.         List<Parameter> parameters = method.getParameters();
  154.         if (parameters.size() != 0){
  155.             parameters.forEach(x ->
  156.                 method.addJavaDocLine(" * @param " + x.getName() + ("ID".equalsIgnoreCase(x.getName())?" 主键":" 记录") )
  157.             );
  158.         }
  159.     }
  161.     /**
  162.      * 设置返回值注释
  163.      *
  164.      * @param method 方法
  165.      * @param introspectedTable 表对象
  166.      */
  167.     private void setMethodReturn(Method method, IntrospectedTable introspectedTable) {
  168.         String methodReturn;
  169.         String shortName = method.getReturnType().getShortName();
  170.         if ("int".equalsIgnoreCase(shortName)){
  171.             methodReturn = "受影响的记录数";
  172.         }else if (shortName.startsWith("java.util.List")){
  173.             methodReturn = introspectedTable.getRemarks() + "list";
  174.         }else {
  175.             methodReturn = introspectedTable.getRemarks() + "记录";
  176.         }
  177.         method.addJavaDocLine(" * @return " + methodReturn);
  178.     }
  180. }

配置文件配置

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE generatorConfiguration
  3.         PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
  4.         "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
  5. <generatorConfiguration>
  6.     <!-- 数据库驱动:选择你的本地硬盘上面的数据库驱动包-->
  7.     <classPathEntry  location="D:\ProgramFile\maven\maven_repository\mysql\mysql-connector-java\5.1.44\mysql-connector-java-5.1.44.jar"/>
  8.     <context id="CustomGenerator" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple">
  9.         <property name="autoDelimitKeywords" value="false"/>
  11.         <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
  12.         <!-- 插件 -->
  13.         <plugin type="com.bwensun.common.mybatis.LombokPlugin">
  14.             <property name="author" value="bwensun"/>
  15.             <property name="builder" value="false"/>
  16.             <property name="data" value="false"/>
  17.         </plugin>
  19.         <commentGenerator type = "com.bwensun.common.mybatis.CustomCommentGenerator">
  20.             <property name="javaFileEncoding" value="UTF-8"/>
  21.             <property name="suppressDate" value="true" />
  22.             <property name="suppressAllComments" value="false" />
  23.             <property name="author" value="郑建雄"/>
  24.             <property name="dateFormat" value="yyyy/MM/dd"/>
  25.         </commentGenerator>
  26.         <!--数据库链接URL，用户名、密码 -->
  27.         <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://127.0.0.1:3306/blog?useSSL=true"
  28.                         userId="root" password="285413">
  29.             <property name="useInformationSchema" value="true" />
  31.         </jdbcConnection>
  32.         <javaTypeResolver>
  33.             <property name="forceBigDecimals" value="false"/>
  34.         </javaTypeResolver>
  35.         <!-- 生成模型的包名和位置-->
  36.         <javaModelGenerator targetPackage="com.bwensun.blog.domain" targetProject="BLOG_API/src/main/java">
  37.             <!-- 是否允许子包，即targetPackage.schemaName.tableName -->
  38.             <property name="enableSubPackages" value="true"/>
  39.             <!-- 是否对model添加 构造函数 -->
  40.             <property name="constructorBased" value="false"/>
  41.             <!-- 是否对类CHAR类型的列的数据进行trim操作 -->
  42.             <property name="trimStrings" value="true"/>
  43.             <!-- 建立的Model对象是否 不可改变  即生成的Model对象不会有 setter方法，只有构造方法 -->
  44.             <!--<property name="immutable" value="false"/>-->
  45.         </javaModelGenerator>
  46.         <!-- 生成映射文件的包名和位置-->
  47.         <sqlMapGenerator targetPackage="mapper" targetProject="BLOG_USER_SERVICE/src/main/resources">
  48.             <property name="enableSubPackages" value="false"/>
  49.         </sqlMapGenerator>
  50.         <!-- 生成DAO的包名和位置-->
  51.         <javaClientGenerator type="XMLMAPPER" targetPackage="com.bwensun.repository"
  52.                              targetProject="BLOG_USER_SERVICE/src/main/java">
  53.             <property name="enableSubPackages" value="false"/>
  54.         </javaClientGenerator>
  55.         <!-->要生成的表 tableName是数据库中的表名或视图名 domainObjectName是实体类名<-->
  56.         <table tableName="USER" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false"
  57.                enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false">
  59.         </table>
  60.     </context>
  61. </generatorConfiguration>

执行生成代码

  1. /**
  2.  * @author bwensun
  3.  * @date 2019/12/17
  4.  */
  5. public class MybatisGenerator {
  6.     public static void main(String[] args) {
  7.         String path = "D:\\ProgramFile\\idea_workspace\\DUBBO_TEST\\BLOG\\BLOG_USER_SERVICE\\src\\main\\resources\\generatorConfig.xml";
  8.         args = new String[]{"-configfile", path, "-overwrite"};
  9.         ShellRunner.main(args);
  10.     }
  11. }