Intellij IDEA 2016学习系列之（三）修改mybatis-generator源码生成中文注释

最新推荐文章于 2023-04-27 17:20:24 发布
最新推荐文章于 2023-04-27 17:20:24 发布
阅读量1w 收藏 14
点赞数 2
分类专栏： Mybatis IntelliJ IDEA 工具技巧 文章标签： idea mybatis generator 中文注释 jar下载
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/liudongdong0909/article/details/52427967
版权

如果你进入本文，说明你也是想在mybatis generator 自动生成mapper xml model的时候，自动生成数据库字段的备注为注释信息。那么只要你阅读完本文，就可以帮助你实现你想要的。文章末尾会有源码的地址和jar.

下载mybatis-generator-core源码

其中下载过程各位可以自行Google，我这里有已经测试通过的maven工程，各位可以直接下载下来，导入自己的IDE中就可以了。
maven mybatis-generator-core 源码

导入成功之后的格式：

这里写图片描述
如果是直接下载的官方的源码，要修改pom.xml中的好多东西，各位有兴趣自己玩。我这里是解决好了之后的。
pom.xml

<?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>

  <parent>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator</artifactId>
    <version>1.3.2</version>
  </parent>

  <groupId>org.mybatis.generator</groupId>
  <artifactId>mybatis-generator-core</artifactId>
  <!--1.3.2-fix 是我自己命名的，也是最后jar的名称-->
  <version>1.3.2-fix</version>
  <packaging>jar</packaging>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <build>
    <!-- this build creates and installs an instrumented JAR file
         for use by the systests projects - so we can gather
         consolidated coverage information
    -->
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <source>1.7</source>
          <target>1.7</target>
          <encoding>UTF-8</encoding>
        </configuration>
      </plugin>
      <!--<plugin>-->
        <!--<groupId>org.apache.maven.plugins</groupId>-->
        <!--<artifactId>maven-site-plugin</artifactId>-->
        <!--<executions>-->
          <!--<execution>-->
            <!--<phase>prepare-package</phase>-->
            <!--<goals>-->
              <!--<goal>site</goal>-->
            <!--</goals>-->
          <!--</execution>-->
        <!--</executions>-->
      <!--</plugin>-->
      <!--<plugin>-->
        <!--<groupId>org.apache.maven.plugins</groupId>-->
        <!--<artifactId>maven-source-plugin</artifactId>-->
        <!--<executions>-->
          <!--<execution>-->
            <!--<phase>prepare-package</phase>-->
            <!--<goals>-->
              <!--<goal>jar-no-fork</goal>-->
            <!--</goals>-->
          <!--</execution>-->
        <!--</executions>-->
      <!--</plugin>-->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <executions>
          <execution>
            <phase>prepare-package</phase>
            <goals>
              <goal>jar</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <!--<plugin>-->
        <!--<groupId>org.apache.maven.plugins</groupId>-->
        <!--<artifactId>maven-jar-plugin</artifactId>-->
        <!--<configuration>-->
          <!--<archive>-->
            <!--<manifest>-->
              <!--<mainClass>org.mybatis.generator.api.ShellRunner</mainClass>-->
            <!--</manifest>-->
          <!--</archive>-->
        <!--</configuration>-->
      <!--</plugin>-->
      <!--<plugin>-->
        <!--<groupId>org.apache.maven.plugins</groupId>-->
        <!--<artifactId>maven-assembly-plugin</artifactId>-->
        <!--<configuration>-->
          <!--<descriptors>-->
            <!--<descriptor>${project.basedir}/src/main/assembly/src.xml</descriptor>-->
          <!--</descriptors>-->
        <!--</configuration>-->
        <!--<executions>-->
          <!--<execution>-->
            <!--<id>bundle</id>-->
            <!--<goals>-->
              <!--<goal>single</goal>-->
            <!--</goals>-->
            <!--<phase>package</phase>-->
          <!--</execution>-->
        <!--</executions>-->
      <!--</plugin>-->
      <!--<plugin>-->
        <!--<groupId>org.apache.maven.plugins</groupId>-->
        <!--<artifactId>maven-release-plugin</artifactId>-->
        <!--<configuration>-->
          <!--<arguments>-Prelease</arguments>-->
        <!--</configuration>-->
      <!--</plugin>-->
    </plugins>
  </build>

  <reporting>
    <plugins>
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>jdepend-maven-plugin</artifactId>
        <version>2.0</version>
      </plugin>
    </plugins>
  </reporting>

  <dependencies>
    <dependency>
      <groupId>log4j</groupId>
      <artifactId>log4j</artifactId>
      <scope>provided</scope>
      <optional>true</optional>
    </dependency>
    <dependency>
      <groupId>org.apache.ant</groupId>
      <artifactId>ant</artifactId>
      <scope>provided</scope>
      <optional>true</optional>
    </dependency>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.hsqldb</groupId>
      <artifactId>hsqldb</artifactId>
      <scope>test</scope>
    </dependency>
  </dependencies>

</project>

源码的修改

这里写图片描述

我这里不修改默认的类DefaultCommentGenerator，而是新建一个自己的类 DG2CommentGenerator。按照自己的需求重写一些方法，主要有生成mapper接口的备注信息，生成model对象的注释。

package org.mybatis.generator.internal;

import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.api.dom.java.InnerClass;
import org.mybatis.generator.api.dom.java.Method;
import org.mybatis.generator.api.dom.java.Parameter;
import org.mybatis.generator.api.dom.xml.TextElement;
import org.mybatis.generator.api.dom.xml.XmlElement;
import org.mybatis.generator.config.MergeConstants;

import java.util.List;

/**
 * 自定义注解生成
 *
 * @author IT_donggua
 * @version V1.0
 * @create 2016-09-02 下午 06:28
        */
public class DG2CommentGenerator extends  DefaultCommentGenerator{

    public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
        StringBuilder sb = new StringBuilder();
        method.addJavaDocLine("/**"); //$NON-NLS-1$
//        method.addJavaDocLine(" * This method was generated by MyBatis Generator."); //$NON-NLS-1$

//        sb.append(" * This method corresponds to the database table "); //$NON-NLS-1$
        sb.append(" * ");
        if (method.isConstructor()) {
            sb.append(" 构造查询条件");
        }
        String method_name = method.getName();
        if ("setOrderByClause".equals(method_name)) {
            sb.append(" 设置排序字段");
        } else if ("setDistinct".equals(method_name)) {
            sb.append(" 设置过滤重复数据");
        } else if ("getOredCriteria".equals(method_name)) {
            sb.append(" 获取当前的查询条件实例");
        } else if ("isDistinct".equals(method_name)) {
            sb.append(" 是否过滤重复数据");
        } else if ("getOrderByClause".equals(method_name)) {
            sb.append(" 获取排序字段");
        } else if ("createCriteria".equals(method_name)) {
            sb.append(" 创建一个查询条件");
        } else if ("createCriteriaInternal".equals(method_name)) {
            sb.append(" 内部构建查询条件对象");
        } else if ("clear".equals(method_name)) {
            sb.append(" 清除查询条件");
        } else if ("countByExample".equals(method_name)) {
            sb.append(" 根据指定的条件获取数据库记录数");
        } else if ("deleteByExample".equals(method_name)) {
            sb.append(" 根据指定的条件删除数据库符合条件的记录");
        } else if ("deleteByPrimaryKey".equals(method_name)) {
            sb.append(" 根据主键删除数据库的记录");
        } else if ("insert".equals(method_name)) {
            sb.append(" 新写入数据库记录");
        } else if ("insertSelective".equals(method_name)) {
            sb.append(" 动态字段,写入数据库记录");
        } else if ("selectByExample".equals(method_name)) {
            sb.append(" 根据指定的条件查询符合条件的数据库记录");
        } else if ("selectByPrimaryKey".equals(method_name)) {
            sb.append(" 根据指定主键获取一条数据库记录");
        } else if ("updateByExampleSelective".equals(method_name)) {
            sb.append(" 动态根据指定的条件来更新符合条件的数据库记录");
        } else if ("updateByExample".equals(method_name)) {
            sb.append(" 根据指定的条件来更新符合条件的数据库记录");
        } else if ("updateByPrimaryKeySelective".equals(method_name)) {
            sb.append(" 动态字段,根据主键来更新符合条件的数据库记录");
        } else if ("updateByPrimaryKey".equals(method_name)) {
            sb.append(" 根据主键来更新符合条件的数据库记录");
        }
        sb.append(",");
        sb.append(introspectedTable.getFullyQualifiedTable());
        method.addJavaDocLine(sb.toString());

        final List<Parameter> parameterList = method.getParameters();
        if (!parameterList.isEmpty()) {
            method.addJavaDocLine(" *");
            if ("or".equals(method_name)) {
                sb.append(" 增加或者的查询条件,用于构建或者查询");
            }
        } else {
            if ("or".equals(method_name)) {
                sb.append(" 创建一个新的或者查询条件");
            }
        }
        String paramterName;
        for (Parameter parameter : parameterList) {
            sb.setLength(0);
            sb.append(" * @param "); //$NON-NLS-1$
            paramterName = parameter.getName();
            sb.append(paramterName);
            if ("orderByClause".equals(paramterName)) {
                sb.append(" 排序字段"); //$NON-NLS-1$
            } else if ("distinct".equals(paramterName)) {
                sb.append(" 是否过滤重复数据");
            } else if ("criteria".equals(paramterName)) {
                sb.append(" 过滤条件实例");
            }
            method.addJavaDocLine(sb.toString());
        }


        //        addJavadocTag(method, false);

        method.addJavaDocLine(" */"); //$NON-NLS-1$
    }

    @Override
    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {
        // 类注释，不管用
        String shortName = innerClass.getType().getShortName();
        innerClass.addJavaDocLine("/**");
        //innerClass.addJavaDocLine(" * 类注释");
        innerClass.addJavaDocLine(" * " + introspectedTable.getFullyQualifiedTable().getRemark());
        innerClass.addJavaDocLine(" * " + shortName);
        innerClass.addJavaDocLine(" * 数据库表：" + introspectedTable.getFullyQualifiedTable());
        // addJavadocTag(innerClass, false);
        innerClass.addJavaDocLine(" */");
    }

    @Override
    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean markAsDoNotDelete) {
        // 类注释，不管用
        String shortName = innerClass.getType().getShortName();
        innerClass.addJavaDocLine("/**");
        innerClass.addJavaDocLine(" * 类注释");
        innerClass.addJavaDocLine(" * " + shortName);
        innerClass.addJavaDocLine(" * 数据库表：" + introspectedTable.getFullyQualifiedTable());
        // addJavadocTag(innerClass, false);
        innerClass.addJavaDocLine(" */");
    }

    @Override
    public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
        // 添加字段注释
        StringBuffer sb = new StringBuffer();
        field.addJavaDocLine("/**");
        if (introspectedColumn.getRemarks() != null)
            field.addJavaDocLine(" * " + introspectedColumn.getRemarks());
        sb.append(" * 表字段 : ");
        sb.append(introspectedTable.getFullyQualifiedTable());
        sb.append('.');
        sb.append(introspectedColumn.getActualColumnName());
        field.addJavaDocLine(sb.toString());
        // addJavadocTag(field, false);
        field.addJavaDocLine(" */");
    }

    @Override
    public void addGetterComment(Method method,
                                 IntrospectedTable introspectedTable,
                                 IntrospectedColumn introspectedColumn) {
        StringBuilder sb = new StringBuilder();

        method.addJavaDocLine("/**"); //$NON-NLS-1$
//        method.addJavaDocLine(" * This method was generated by MyBatis Generator."); //$NON-NLS-1$

        sb.append(" * 获取 "); //$NON-NLS-1$
        sb.append(introspectedColumn.getRemarks()).append(" 字段:");
        sb.append(introspectedTable.getFullyQualifiedTable());
        sb.append('.');
        sb.append(introspectedColumn.getActualColumnName());
        method.addJavaDocLine(sb.toString());

        method.addJavaDocLine(" *"); //$NON-NLS-1$

        sb.setLength(0);
        sb.append(" * @return "); //$NON-NLS-1$
        sb.append(introspectedTable.getFullyQualifiedTable());
        sb.append('.');
        sb.append(introspectedColumn.getActualColumnName());
        sb.append(", ");
        sb.append(introspectedColumn.getRemarks());
        method.addJavaDocLine(sb.toString());

//        addJavadocTag(method, false);

        method.addJavaDocLine(" */"); //$NON-NLS-1$
    }

    @Override
    public void addSetterComment(Method method,
                                 IntrospectedTable introspectedTable,
                                 IntrospectedColumn introspectedColumn) {

        StringBuilder sb = new StringBuilder();

        method.addJavaDocLine("/**"); //$NON-NLS-1$
//        method.addJavaDocLine(" * This method was generated by MyBatis Generator."); //$NON-NLS-1$

        sb.append(" * 设置 ");  //$NON-NLS-1$
        sb.append(introspectedColumn.getRemarks()).append(" 字段:");
        sb.append(introspectedTable.getFullyQualifiedTable());
        sb.append('.');
        sb.append(introspectedColumn.getActualColumnName());
        method.addJavaDocLine(sb.toString());

        method.addJavaDocLine(" *"); //$NON-NLS-1$

        Parameter parm = method.getParameters().get(0);
        sb.setLength(0);
        sb.append(" * @param "); //$NON-NLS-1$
        sb.append(parm.getName());
        sb.append(" the value for "); //$NON-NLS-1$
        sb.append(introspectedTable.getFullyQualifiedTable());
        sb.append('.');
        sb.append(introspectedColumn.getActualColumnName());
        sb.append(", ");
        sb.append(introspectedColumn.getRemarks());
        method.addJavaDocLine(sb.toString());

//        addJavadocTag(method, false);

        method.addJavaDocLine(" */"); //$NON-NLS-1$
    }

    @Override
    public void addComment(XmlElement xmlElement) {
        xmlElement.addElement(new TextElement("<!--")); //$NON-NLS-1$

        StringBuilder sb = new StringBuilder();
        sb.append(MergeConstants.NEW_ELEMENT_TAG);
        xmlElement.addElement(new TextElement(sb.toString()));
//        xmlElement
//                .addElement(new TextElement(
//                        "  This element is automatically generated by MyBatis Generator, do not modify.")); //$NON-NLS-1$

//        String s = getDateString();
//        if (s != null) {
//            sb.setLength(0);
//            sb.append("  This element was generated on "); //$NON-NLS-1$
//            sb.append(s);
//            sb.append('.');
//            xmlElement.addElement(new TextElement(sb.toString()));
//        }

        xmlElement.addElement(new TextElement("-->")); //$NON-NLS-1$
    }
}

修改生成model对象类的注释

在FullyQualifiedTable中添加remark字段，用于保存数据库表的备注信息

这里写图片描述

修改DatabaseIntrospector的calculateIntrospectedTables方法，添加一段获取数据库备注的代码

这里写图片描述

 //设置数据库表的备注信息
 //start
   Statement stmt = this.databaseMetaData.getConnection().createStatement();
            ResultSet rs = stmt.executeQuery(new StringBuilder().append("SHOW TABLE STATUS LIKE '").append(atn.getTableName()).append("'").toString());
            while (rs.next())
            //将数据库表得备注信息设置到remark字段
                table.setRemark(rs.getString("COMMENT"));

 closeResultSet(rs);
  stmt.close();
 //end
修改DG2CommentGenerator中的 addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) 方法

这里写图片描述

具体样式可以按自己的爱好设置。

//生成model对象的注释信息
    @Override
    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {
        // 类注释，不管用
        String shortName = innerClass.getType().getShortName();
        innerClass.addJavaDocLine("/**");
        //innerClass.addJavaDocLine(" * 类注释");
        //获取数据库表的备注信息
        innerClass.addJavaDocLine(" * " + introspectedTable.getFullyQualifiedTable().getRemark());
        //model对象的名称
        innerClass.addJavaDocLine(" * " + shortName);
        //获取数据库表
        innerClass.addJavaDocLine(" * 数据库表：" + introspectedTable.getFullyQualifiedTable());
        // addJavadocTag(innerClass, false);
        innerClass.addJavaDocLine(" */");
    }

修改model对象中字段的注释

在IntrospectedColumn中添加remarks属性,用于保存数据库对应表中字段的备注信息，需要setter/getter

这里写图片描述

修改DG2CommentGenerator中的 addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) 方法

这里写图片描述

 //model对象中字段的注释
    @Override
    public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
        // 添加字段注释
        StringBuffer sb = new StringBuffer();
        field.addJavaDocLine("/**");
        //对应表中字段的备注(数据库中自己写的备注信息)
        if (introspectedColumn.getRemarks() != null)
            field.addJavaDocLine(" * " + introspectedColumn.getRemarks());
        sb.append(" * 表字段 : ");
        //对应表名称
        sb.append(introspectedTable.getFullyQualifiedTable());
        sb.append('.');
        //对应表中字段的名称
        sb.append(introspectedColumn.getActualColumnName());
        field.addJavaDocLine(sb.toString());
        // addJavadocTag(field, false);
        field.addJavaDocLine(" */");
    }

修改model对象中setter/getter的注释

这个就直接上代码，没有源码修改。

getter方法
@Override
    public void addGetterComment(Method method,
                                 IntrospectedTable introspectedTable,
                                 IntrospectedColumn introspectedColumn) {
        StringBuilder sb = new StringBuilder();

        method.addJavaDocLine("/**"); //$NON-NLS-1$
//        method.addJavaDocLine(" * This method was generated by MyBatis Generator."); //$NON-NLS-1$

        sb.append(" * 获取 "); //$NON-NLS-1$
        sb.append(introspectedColumn.getRemarks()).append(" 字段:");
        sb.append(introspectedTable.getFullyQualifiedTable());
        sb.append('.');
        sb.append(introspectedColumn.getActualColumnName());
        method.addJavaDocLine(sb.toString());

        method.addJavaDocLine(" *"); //$NON-NLS-1$

        sb.setLength(0);
        sb.append(" * @return "); //$NON-NLS-1$
        sb.append(introspectedTable.getFullyQualifiedTable());
        sb.append('.');
        sb.append(introspectedColumn.getActualColumnName());
        sb.append(", ");
        sb.append(introspectedColumn.getRemarks());
        method.addJavaDocLine(sb.toString());

//        addJavadocTag(method, false);

        method.addJavaDocLine(" */"); //$NON-NLS-1$
    }
setter方法
@Override
    public void addSetterComment(Method method,
                                 IntrospectedTable introspectedTable,
                                 IntrospectedColumn introspectedColumn) {

        StringBuilder sb = new StringBuilder();

        method.addJavaDocLine("/**"); //$NON-NLS-1$
//        method.addJavaDocLine(" * This method was generated by MyBatis Generator."); //$NON-NLS-1$

        sb.append(" * 设置 ");  //$NON-NLS-1$
        sb.append(introspectedColumn.getRemarks()).append(" 字段:");
        sb.append(introspectedTable.getFullyQualifiedTable());
        sb.append('.');
        sb.append(introspectedColumn.getActualColumnName());
        method.addJavaDocLine(sb.toString());

        method.addJavaDocLine(" *"); //$NON-NLS-1$

        Parameter parm = method.getParameters().get(0);
        sb.setLength(0);
        sb.append(" * @param "); //$NON-NLS-1$
        sb.append(parm.getName());
        sb.append(" the value for "); //$NON-NLS-1$
        sb.append(introspectedTable.getFullyQualifiedTable());
        sb.append('.');
        sb.append(introspectedColumn.getActualColumnName());
        sb.append(", ");
        sb.append(introspectedColumn.getRemarks());
        method.addJavaDocLine(sb.toString());

//        addJavadocTag(method, false);

        method.addJavaDocLine(" */"); //$NON-NLS-1$
    }

修改生成mapper中的注释

修改mapper接口中的注释
public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
        StringBuilder sb = new StringBuilder();
        method.addJavaDocLine("/**"); //$NON-NLS-1$
//        method.addJavaDocLine(" * This method was generated by MyBatis Generator."); //$NON-NLS-1$

//        sb.append(" * This method corresponds to the database table "); //$NON-NLS-1$
        sb.append(" * ");
        if (method.isConstructor()) {
            sb.append(" 构造查询条件");
        }
        String method_name = method.getName();
        if ("setOrderByClause".equals(method_name)) {
            sb.append(" 设置排序字段");
        } else if ("setDistinct".equals(method_name)) {
            sb.append(" 设置过滤重复数据");
        } else if ("getOredCriteria".equals(method_name)) {
            sb.append(" 获取当前的查询条件实例");
        } else if ("isDistinct".equals(method_name)) {
            sb.append(" 是否过滤重复数据");
        } else if ("getOrderByClause".equals(method_name)) {
            sb.append(" 获取排序字段");
        } else if ("createCriteria".equals(method_name)) {
            sb.append(" 创建一个查询条件");
        } else if ("createCriteriaInternal".equals(method_name)) {
            sb.append(" 内部构建查询条件对象");
        } else if ("clear".equals(method_name)) {
            sb.append(" 清除查询条件");
        } else if ("countByExample".equals(method_name)) {
            sb.append(" 根据指定的条件获取数据库记录数");
        } else if ("deleteByExample".equals(method_name)) {
            sb.append(" 根据指定的条件删除数据库符合条件的记录");
        } else if ("deleteByPrimaryKey".equals(method_name)) {
            sb.append(" 根据主键删除数据库的记录");
        } else if ("insert".equals(method_name)) {
            sb.append(" 新写入数据库记录");
        } else if ("insertSelective".equals(method_name)) {
            sb.append(" 动态字段,写入数据库记录");
        } else if ("selectByExample".equals(method_name)) {
            sb.append(" 根据指定的条件查询符合条件的数据库记录");
        } else if ("selectByPrimaryKey".equals(method_name)) {
            sb.append(" 根据指定主键获取一条数据库记录");
        } else if ("updateByExampleSelective".equals(method_name)) {
            sb.append(" 动态根据指定的条件来更新符合条件的数据库记录");
        } else if ("updateByExample".equals(method_name)) {
            sb.append(" 根据指定的条件来更新符合条件的数据库记录");
        } else if ("updateByPrimaryKeySelective".equals(method_name)) {
            sb.append(" 动态字段,根据主键来更新符合条件的数据库记录");
        } else if ("updateByPrimaryKey".equals(method_name)) {
            sb.append(" 根据主键来更新符合条件的数据库记录");
        }
        sb.append(",");
        sb.append(introspectedTable.getFullyQualifiedTable());
        method.addJavaDocLine(sb.toString());

        final List<Parameter> parameterList = method.getParameters();
        if (!parameterList.isEmpty()) {
            method.addJavaDocLine(" *");
            if ("or".equals(method_name)) {
                sb.append(" 增加或者的查询条件,用于构建或者查询");
            }
        } else {
            if ("or".equals(method_name)) {
                sb.append(" 创建一个新的或者查询条件");
            }
        }
        String paramterName;
        for (Parameter parameter : parameterList) {
            sb.setLength(0);
            sb.append(" * @param "); //$NON-NLS-1$
            paramterName = parameter.getName();
            sb.append(paramterName);
            if ("orderByClause".equals(paramterName)) {
                sb.append(" 排序字段"); //$NON-NLS-1$
            } else if ("distinct".equals(paramterName)) {
                sb.append(" 是否过滤重复数据");
            } else if ("criteria".equals(paramterName)) {
                sb.append(" 过滤条件实例");
            }
            method.addJavaDocLine(sb.toString());
        }


        //        addJavadocTag(method, false);

        method.addJavaDocLine(" */"); //$NON-NLS-1$
    }
删除mapper.xml中的注释
 @Override
    public void addComment(XmlElement xmlElement) {
        xmlElement.addElement(new TextElement("<!--")); //$NON-NLS-1$

        StringBuilder sb = new StringBuilder();
        sb.append(MergeConstants.NEW_ELEMENT_TAG);
        xmlElement.addElement(new TextElement(sb.toString()));
//        xmlElement
//                .addElement(new TextElement(
//                        "  This element is automatically generated by MyBatis Generator, do not modify.")); //$NON-NLS-1$

//        String s = getDateString();
//        if (s != null) {
//            sb.setLength(0);
//            sb.append("  This element was generated on "); //$NON-NLS-1$
//            sb.append(s);
//            sb.append('.');
//            xmlElement.addElement(new TextElement(sb.toString()));
//        }

        xmlElement.addElement(new TextElement("-->")); //$NON-NLS-1$
    }

maven工程的打包

clean install -Dmaven.test.skip=true

这里写图片描述

生成之后我的maven仓库中的jar如下：

这里写图片描述
这里写图片描述

如何在工程中引用

参照Intellij IDEA 2016学习系列之（二）mybatis-generator生成

需要修改generatorConfig.xml

将

 <context id="testTables" targetRuntime="MyBatis3">
      <commentGenerator>
         <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
         <property name="suppressAllComments" value="true" />
      </commentGenerator>

替换为

<!--使用自定义的类DG2CommentGenerator-->
<commentGenerator type="org.mybatis.generator.internal.DG2CommentGenerator">
            <property name="javaFileEncoding" value="UTF-8"/>
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="false" />
            <property name="suppressDate" value="true" />
        </commentGenerator>
需要修改pom.xml

将插件中的依赖

<dependencies>
                <dependency>
                    <groupId>org.mybatis.generator</groupId>
                    <artifactId>mybatis-generator-core</artifactId>
                    <version>1.3.2</version>
                </dependency>
            </dependencies>

修改为

<dependencies>
                    <dependency>
                        <groupId>org.mybatis.generator</groupId>
                        <artifactId>mybatis-generator-core</artifactId>
                        <!--使用自己的版本-->
                        <version>1.3.2-fix</version>
                    </dependency>
                </dependencies>

至此，大功告成。请看生成之后的代码样式。
这里写图片描述
这里写图片描述
这里写图片描述
这里写图片描述

源码和jar下载

1.3.2-fix.jar:http://download.csdn.net/detail/liudongdong0909/9621144
1.3.2-fix源码：https://github.com/liudongdong0909/mybatis-generator-core-fix.git

幸运的天才小驴
关注
  • 2
    点赞
  • 踩
  • 14
    收藏
    觉得还不错? 一键收藏
  • 16
    评论
专栏目录
mybatis-generator生成带中文注释POJO类的超详细教程含代码和图解
小沐的博客
04-12 1591
mybatis-generator生成带中文注释POJO类的超详细教程含代码和图解 mybatis-generator自动生成带中文注释POJO类和增删改查,idea和eclipes都可以使用 MyCommentGenerator.java package yao.demo.common.generator; import org.mybatis.generator.api.CommentGenerator; import org.mybatis.generator.api.Introspec
idea配置mybatis-generator.docx
07-09
### Idea配置MyBatis-Generator详解 #### 一、引言 在Java开发过程中，尤其在涉及数据库操作的应用中，代码生成工具可以帮助开发者快速构建出基础的DAO层接口及其实现类，极大地提高了开发效率。其中，MyBatis-...
IDEA中源码注释自动翻译，并设置快捷键方便查看
superLearner的博客
09-30 7111
1、实现注释自动翻译 1）安装插件：Translation，安装完需要重启IDEA生效 （已安装过的在Installed下能搜索到，没安装过的切换到Marketplace下搜索安装） 2）Translation配置 2、快捷方式配置，快速查看 至此，就可以按照自己喜欢的快捷方式，轻松查看已翻译过的源码注释了，源码路更轻盈，哈哈 ...
mybatis generator自定义model的代码注释
a20100997的博客
04-27 1337
1、生成的model虽然可以根据数据库字段的comment生成注释，但这些注释仅对后端开发人员可见，如果想让前端人员通过swagger查看，仍需要手动添加注解，比如@ApiModelProperty；2、手动添加@ApiModelProperty注解之后，如果数据库表有修改，当使用mbg重新生成之后，之前手工添加的@ApiModelProperty会被覆盖，又得重新添加。B处的代码是为数据库中的Date格式的字段添加一行@JsonFormat代码，指定统一的格式。具体代码请移步gitee。
MyBatis积累(2)：Mybatis Generator 自定义注释
mingyuli的博客
02-17 699
`
Mybatis一站式新手入门（IDEA）
weixin_47268883的博客
02-04 89
Mybatis一站式新手入门（IDEA）
IntelliJ IDEA中使用mybatis-generator的示例
08-27
主要介绍了IntelliJ IDEA中使用mybatis-generator,小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
mybatis-generator-gui自动生成工具
11-22
相比于IntelliJ IDEA中的Mybatis-Plugins，Mybatis-Generator-GUI在用户体验和功能上可能更具优势，尤其对于那些不习惯使用IDE插件或者寻求更直观操作方式的开发者而言。 首先，我们来详细了解一下Mybatis ...
mybatis-plus-generator.zip
09-13
首先，`mybatis-plus-generator.iml`是IntelliJ IDEA项目的配置文件，它包含了项目结构和依赖等信息，便于在IDEA环境中导入和管理项目。 `pom.xml`是Maven项目的配置文件，它定义了项目的基本信息、依赖关系以及...
mybatis-generator-yml-maven-plugin：MyBatis Generator yml配置，lombok插件，swagger插件支持
02-04
支持方便地配置常用插件，例如注释生成，Lombok，招摇等。 介绍使用某些配置或插件的好处 尝试找到适合不同情况的最佳配置 内容 环境要求 确保已安装Java8和IDE（例如Intellij Idea和Eclipse） 项目中使用了Maven ...
mybatis-generator中文注释
10-11
生成代码时携带中文注释 generatorConfig.xml中<context>标签下 添加 <property name="javaFileEncoding" value="UTF-8"/> <commentGenerator type="org.mybatis.generator.internal.DG2CommentGenerator"> <property name="suppressDate" value="true"/> <property name="suppressAllComments" value="false" /> </commentGenerator>
mybatis-generator自动生成代码(含中文注释)
12-28
mybatis-generator自动生成代码(含中文注释) 这是一个maven项目，下载后直接导入到eclipse或者idea中即可。 修改对应的generatorConfig.xml 改成自己的数据库配置，然后运行App.java即可生成
intellij idea 利用generatorConfig反向生成java类
04-19
intellij idea 利用generatorConfig反向生成java类以及mapper等操作简单。 src/main/resources/generatorConfig.xml <generatorConfiguration>下面，不加这个不好使 <classPathEntry location="E:\\\\Apache\\\\Maven\\\\mavenStore\\\\mysql\\\\mysql-connector-java\\\\5.1.46\\\\mysql-connector-java-5.1.46.jar" /> 代码中需要加入
JDK8源码 注释附带中文翻译
04-27
压缩包中为JDK8的源码，在源码的注释下方附带的中文翻译，是本压缩包的亮点，下方为局部代码，示范给大家： * Sole constructor. Programmers cannot invoke this constructor. * It is for use by code emitted by the compiler in response to * enum type declarations. * * *  唯一构造函数。程序员不能调用此构造函数。它由编译器响应枚举类型声明时发出的代码使用。
mybatis generator插件中文注释解决方案
09-26
mybatis generator默认生成的注释不包含英文，这个是修复过的。详情使用请参考我的博客。https://my.oschina.net/kkrgwbj/blog/748591
关于mybatis generator生成中文注释
diana0405的博客
01-17 361
1、创建MyCommentGenerator类实现CommentGenerator接口 package gengrator; import org.mybatis.generator.api.CommentGenerator; import org.mybatis.generator.api.IntrospectedColumn; import org.mybatis...
MyBatis Generator系列(二)----自定义CommentGenerator实现中文注释
热门推荐
fendo
10-05 2万+
一、简介 由于MyBatis Generator自带了生成注释的功能,但是,是英文的而且生成的根本无法理解,所以可以通过,修改他的源码来实现生成中文的注释,具体方式有以下几种: 1) 自定义CommentGenerator 2) 修改源码 3) PluginAdapter插件的形式 二、自定义CommentGenerator实现中文注释 2.1、先创建M
MyBatis Generator 自定义CommentGenerator实现中文注释
u010686811的专栏
12-09 3370
MyBatis Generator自定义CommentGenerator实现中文注释(oracle) 目录 MyBatis Generator自定义CommentGenerator实现中文注释 第一步：pom.xml文件 oracle驱动依赖 <dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-core&lt..
逆向工程之实现CommentGenerator接口来实现生成自定义注解的实体类等
weixin_45650737的博客
02-20 837
转自：https://blog.csdn.net/qq_39693263/article/details/105650307 作者：起个不重复的名字真难 一、使用背景 项目操作数据库层使用的并不是mybatis，而是Spring的JdbcTemple,因此对底层的SQL创建是使用的自定义注解来动态生成。自定义注解对字段多时，手动生成实体类过于繁琐，就想使用逆向工程来生成。网上找的基本都是mybatis的，对自定义注解的比较少。参考了许多人博客后，转载的那个是比较接近的了。 二、步骤说明 1、pom文件dep
,idea插件idea-mybatis-generator怎么用
最新发布
05-20
idea-mybatis-generator 是一个 IntelliJ IDEA 的插件，用于生成 MyBatis 的 Mapper、Model 和 XML 配置文件。下面是使用该插件的步骤： 1. 打开 IntelliJ IDEA，点击菜单栏中的 "File" -> "Settings" 打开设置窗口...
评论 16
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值