快捷導(dǎo)航

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

更新時(shí)間：2021年07月27日 11:37:53 作者：BUG記錄機(jī)

這篇文章主要介紹了解決mybatis-generator生成器添加類注釋方法無效的問題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

遇到的問題！

注：自定義CommentGenerator的都知道

通過實(shí)現(xiàn)CommentGenerator接口的一些不足，畢竟只是實(shí)現(xiàn)了CommentGenerator接口，在里面的方法再怎么改，有效的也只是針對(duì)model類，并且使用的人大概也發(fā)現(xiàn)了，里面的addClassComment方法都知道是在類文件上面生成注釋，但是無論我們?cè)谶@個(gè)方法實(shí)現(xiàn)里寫什么都沒有效果，其實(shí)因?yàn)镸GB默認(rèn)是沒有調(diào)用這個(gè)方法的，這個(gè)時(shí)候如果有需求希望生成的類文件自動(dòng)加了類文檔說明就辦不到了，而如果在源代碼的基礎(chǔ)上修改，就好辦多了，看了好久的源碼和網(wǎng)站上的經(jīng)驗(yàn)

解決辦法如下

先看效果

import org.springframework.stereotype.Component;
/**
  *我這里需求是自動(dòng)添加注解，也可以看下方生成注釋，導(dǎo)包等操作
  */
@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);
        /**
         * 導(dǎo)包
         */
        interfaze.addImportedType(imp);
        interfaze.addImportedType(imp2);
        /**
         * 清楚原有方法
         */
        interfaze.getMethods().clear();
        //interfaze.getAnnotations().clear();
        // 根據(jù)業(yè)務(wù)自己靈活發(fā)揮，本次需要spring注入
        interfaze.addAnnotation("@Component(\"" + introspectedTable.getFullyQualifiedTable() + "\")");
        return true;
    }
}

com.github.abel533.mapper.Mapper是一個(gè)通用的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">
    <!-- 是否去除自動(dòng)生成的注釋 true：是 ： false:否 -->
    <property name="suppressAllComments" value="true"/>
    <property name="suppressDate" value="true"/>
</commentGenerator>
</context>

3、啟動(dòng)(請(qǐng)使用此種方式運(yùn)行逆向工程)

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需要導(dǎo)包

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

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: