解決mybatis-generator生成器添加類註釋方法無效的問題

Posted on by

遇到的問題！

註：自定義CommentGenerator的都知道

通過實現CommentGenerator接口的一些不足，畢竟隻是實現瞭CommentGenerator接口，在裡面的方法再怎麼改，有效的也隻是針對model類，並且使用的人大概也發現瞭，裡面的addClassComment方法都知道是在類文件上面生成註釋，但是無論我們在這個方法實現裡寫什麼都沒有效果，其實因為MGB默認是沒有調用這個方法的，這個時候如果有需求希望生成的類文件自動加瞭類文檔說明就辦不到瞭，而如果在源代碼的基礎上修改，就好辦多瞭，看瞭好久的源碼和網站上的經驗

解決辦法如下

先看效果

import org.springframework.stereotype.Component;
/**
  *我這裡需求是自動添加註解，也可以看下方生成註釋，導包等操作
  */
@Component("tableName")
public interface tableNameMapper {
 ...
}

1、繼承PluginAdapter

package com.**.***.generate;
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.Interface;
import org.mybatis.generator.api.dom.java.TopLevelClass;
import java.util.List;
/**
 * Created by JGMa on 2019-07-17
 **/
public class BaseMapperGeneratorPlugin extends PluginAdapter {
    @Override
    public boolean validate(List<String> warnings) {
        return true;
    }
    /**
     * 生成mapper接口
     */
    @Override
    public boolean clientGenerated(Interface interfaze,
                                   TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
        FullyQualifiedJavaType fqjt = new FullyQualifiedJavaType("Mapper<"
                + introspectedTable.getBaseRecordType() + ">");
        FullyQualifiedJavaType imp = new FullyQualifiedJavaType(
                "com.github.abel533.mapper.Mapper");
        FullyQualifiedJavaType imp2 = new FullyQualifiedJavaType(
                "org.springframework.stereotype.Component");
        /**
         * extends MybatisBaseMapper
         */
        interfaze.addSuperInterface(fqjt);
        /**
         * 導包
         */
        interfaze.addImportedType(imp);
        interfaze.addImportedType(imp2);
        /**
         * 清楚原有方法
         */
        interfaze.getMethods().clear();
        //interfaze.getAnnotations().clear();
        // 根據業務自己靈活發揮，本次需要spring註入
        interfaze.addAnnotation("@Component(\"" + introspectedTable.getFullyQualifiedTable() + "\")");
        return true;
    }
}

com.github.abel533.mapper.Mapper是一個通用的mapper有興趣的也可以去看，下面給出pom

<!-- 通用mapper -->
<dependency>
    <groupId>com.github.abel533</groupId>
    <artifactId>mapper</artifactId>
    <version>2.3.4</version>
</dependency>

2、xml中配置插件

<context>
<!--自定義的mapper接口-->
<plugin type="com.**.***.generate.BaseMapperGeneratorPlugin"/>
<commentGenerator type="com.hzqsy.cebdis.config.MyCommentGenerator">
    <!-- 是否去除自動生成的註釋 true：是 ： false:否 -->
    <property name="suppressAllComments" value="true"/>
    <property name="suppressDate" value="true"/>
</commentGenerator>
</context>

3、啟動(請使用此種方式運行逆向工程)

import org.mybatis.generator.api.ShellRunner;
/**
 * Created by JGMa on 2019-07-15
 **/
public class StartUp {
    public static void main(String[] args) {
        args = new String[] { "-configfile", "D:\\mybatis-generator-config.xml", "-overwrite" };
        ShellRunner.main(args);
    }
}

如果找不到shellRunner需要導包

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

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：