MyBatis自动生成注释配置

tpts

已于 2022-07-02 07:26:57 修改

阅读量977

点赞数

分类专栏： java 文章标签： mybatis java mysql

于 2022-06-20 17:16:27 首次发布

本文链接：https://blog.csdn.net/u013015681/article/details/125376260

版权

java 专栏收录该内容

13 篇文章 0 订阅

订阅专栏

项目中原来用的mybatis自动生成代码的配置，会生成很多无用的注释，希望通过自定义注释生成器的方式，来定制化注释的生成方式。

具体的配置方式如下：

<commentGenerator type="com.xxx.MyCommentGenerator">
            <!-- 是否去除自动生成日期的注释 true：是 ： false:否 -->
            <property name="suppressDate" value="true"/>
            <!-- 是否去除所有自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="false"/>
            <!-- 是否添加数据库内的注释 true：是 ： false:否 -->
            <property name="addRemarkComments" value="true"/>
        </commentGenerator>

这个类的定义就是直接实现的CommentGenerator接口，然后重新实现了相关的方法。然后在具体生成代码的时候，一直报以下的Exception：

Caused by: java.lang.ClassNotFoundException: com.xxx.MyCommentGenerator
    at org.codehaus.plexus.classworlds.strategy.SelfFirstStrategy.loadClass (SelfFirstStrategy.java:50)
    at org.codehaus.plexus.classworlds.realm.ClassRealm.unsynchronizedLoadClass (ClassRealm.java:271)
    at org.codehaus.plexus.classworlds.realm.ClassRealm.loadClass (ClassRealm.java:247)
    at org.codehaus.plexus.classworlds.realm.ClassRealm.loadClass (ClassRealm.java:239)
    at java.lang.Class.forName0 (Native Method)
    at java.lang.Class.forName (Class.java:348)
    at org.mybatis.generator.internal.ObjectFactory.internalClassForName (ObjectFactory.java:150)
    at org.mybatis.generator.internal.ObjectFactory.createInternalObject (ObjectFactory.java:180)
    at org.mybatis.generator.internal.ObjectFactory.createCommentGenerator (ObjectFactory.java:241)
    at org.mybatis.generator.config.Context.getCommentGenerator (Context.java:266)
    at org.mybatis.generator.codegen.mybatis3.model.BaseRecordGenerator.getCompilationUnits (BaseRecordGenerator.java:53)
    at org.mybatis.generator.codegen.mybatis3.IntrospectedTableMyBatis3Impl.getGeneratedJavaFiles (IntrospectedTableMyBatis3Impl.java:181)
    at org.mybatis.generator.config.Context.generateFiles (Context.java:460)
    at org.mybatis.generator.api.MyBatisGenerator.generate (MyBatisGenerator.java:262)
    at org.mybatis.generator.api.MyBatisGenerator.generate (MyBatisGenerator.java:182)
    at org.mybatis.generator.maven.MyBatisGeneratorMojo.execute (MyBatisGeneratorMojo.java:229)
    at org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo (DefaultBuildPluginManager.java:137)
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute (MojoExecutor.java:210)
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute (MojoExecutor.java:156)
    at org.apache.maven.lifecycle.internal.MojoExecutor.execute (MojoExecutor.java:148)
    at org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject (LifecycleModuleBuilder.java:117)
    at org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject (LifecycleModuleBuilder.java:81)
    at org.apache.maven.lifecycle.internal.builder.singlethreaded.SingleThreadedBuilder.build (SingleThreadedBuilder.java:56)
    at org.apache.maven.lifecycle.internal.LifecycleStarter.execute (LifecycleStarter.java:128)
    at org.apache.maven.DefaultMaven.doExecute (DefaultMaven.java:305)
    at org.apache.maven.DefaultMaven.doExecute (DefaultMaven.java:192)
    at org.apache.maven.DefaultMaven.execute (DefaultMaven.java:105)
    at org.apache.maven.cli.MavenCli.execute (MavenCli.java:957)
    at org.apache.maven.cli.MavenCli.doMain (MavenCli.java:289)
    at org.apache.maven.cli.MavenCli.main (MavenCli.java:193)
    at sun.reflect.NativeMethodAccessorImpl.invoke0 (Native Method)
    at sun.reflect.NativeMethodAccessorImpl.invoke (NativeMethodAccessorImpl.java:62)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke (DelegatingMethodAccessorImpl.java:43)
    at java.lang.reflect.Method.invoke (Method.java:498)
    at org.codehaus.plexus.classworlds.launcher.Launcher.launchEnhanced (Launcher.java:282)
    at org.codehaus.plexus.classworlds.launcher.Launcher.launch (Launcher.java:225)
    at org.codehaus.plexus.classworlds.launcher.Launcher.mainWithExitCode (Launcher.java:406)
    at org.codehaus.plexus.classworlds.launcher.Launcher.main (Launcher.java:347)
    at org.codehaus.classworlds.Launcher.main (Launcher.java:47)

但是明明是有这个类的定义的，所以就推断是该类不再maven plugin的classpath上，然后查看了官方文档 $[2]$ ，看见有这么一句叙述：

大概意思就是说maven plugin的classpath依赖很少，如果有特殊依赖的话，需要单独添加进行声明，虽然这个类是定义在当前模块中，但是自动生成插件默认并不依赖当前的模块，所以最后的解决方案就是把当前模块的jar包依赖，也加入到了上述截图中的<dependencies>标签里边，然后就可以正确生成代码了。

参考文章

1.MyBatis Generator 自定义生成注释 - SegmentFault 思否

2.MyBatis Generator Core – Running MyBatis Generator With Maven