关于mybatis生成插件Generator配置文件中自定义注释

最新推荐文章于 2025-03-11 18:37:53 发布

原创最新推荐文章于 2025-03-11 18:37:53 发布 · 2.4k 阅读

0 ·

CC 4.0 BY-SA版权

maven 同时被 2 个专栏收录

4 篇文章

订阅专栏

mybatis

2 篇文章

订阅专栏

1.编写一个实现org.mybatis.generator.api.CommentGenerator接口的类。这个类有默认的实现，不会写可以参考默认实现
org.mybatis.generator.internal.DefaultCommentGenerator

2.在maven插件中添加依赖
<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.3</version>
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.37</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.5</version>
        </dependency>
        <dependency>
            <groupId>com.demo.aaa</groupId>
            <artifactId>bbb</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>
</plugin>

如上将驱动也添加到以来中，就可以不用在配置文件中增加classPathEntry元素。
bbb是项目本身，需要先在本地安装方可引用。


如上配置完成后在插件的配置文件中
<commentGenerator type="com.zhaolu.tian.MyComment">
    <property name="suppressAllComments" value="true"/>
    <property name="suppressDate" value="true"/>
</commentGenerator>
如此指定实现类即可。
最后提醒一下：有个坑，mysql的java驱动对于generator插件高版本的不适用，还是用低版本的吧。5.1.37就挺好的不是嘛
最后贴一个完整的配置，好以后拿来就用。
<?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>

    <properties resource="generatorConfig.properties"/>

    <context id="mysql" defaultModelType="flat" targetRuntime="MyBatis3Simple">

        <property name="autoDelimitKeywords" value="true"/>
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <property name="javaFileEncoding" value="UTF-8"/>


        <commentGenerator type="com.m2m.mybatis.MyCommentGenerator">
            <property name="suppressAllComments" value="true"/>
            <property name="suppressDate" value="true"/>
        </commentGenerator>

        <jdbcConnection driverClass="${jdbc.driver}" connectionURL="${jdbc.url}" userId="${jdbc.username}"
                        password="${jdbc.password}"/>

        <javaModelGenerator targetPackage="${modelPackage}" targetProject="${targetPackage}">
            
        </javaModelGenerator>

        <sqlMapGenerator targetPackage="${sqlPackage}" targetProject="${targetPackage}"/>
        
        <javaClientGenerator type="XMLMAPPER" targetPackage="${clientPackage}" targetProject="${targetPackage}">
            <!--继承通用mapper接口-->
            <property name="rootInterface" value="tk.mybatis.mapper.common.Mapper"/>
        </javaClientGenerator>

        
        <table tableName="%">
            <generatedKey column="id" sqlStatement="Mysql"/>
        </table>
    </context>
</generatorConfiguration>