注释生成器

为了生成db里面的注释，必须自定义注释生成器

EmptyCommentGenerator：

import org.mybatis.generator.api.CommentGenerator;

import org.mybatis.generator.api.IntrospectedColumn;

import org.mybatis.generator.api.IntrospectedTable;

import org.mybatis.generator.api.dom.java.*;

import org.mybatis.generator.api.dom.xml.XmlElement;

import java.util.Properties;

import java.util.Set;

public class EmptyCommentGenerator implements CommentGenerator {

	@Override

	public void addConfigurationProperties(Properties properties) {

	}

	@Override

	public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {

	}

	@Override

	public void addFieldComment(Field field, IntrospectedTable introspectedTable) {

	}

	@Override

	public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {

	}

	@Override

	public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {

	}

	@Override

	public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean b) {

	}

	@Override

	public void addEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable) {

	}

	@Override

	public void addGetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {

	}

	@Override

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

	}

	@Override

	public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {

	}

	@Override

	public void addJavaFileComment(CompilationUnit compilationUnit) {

	}

	@Override

	public void addComment(XmlElement xmlElement) {

	}

	@Override

	public void addRootComment(XmlElement xmlElement) {

	}

	@Override

	public void addGeneralMethodAnnotation(Method method, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) {

	}

	@Override

	public void addGeneralMethodAnnotation(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn, Set<FullyQualifiedJavaType> set) {

	}

	@Override

	public void addFieldAnnotation(Field field, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) {

	}

	@Override

	public void addFieldAnnotation(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn, Set<FullyQualifiedJavaType> set) {

	}

	@Override

	public void addClassAnnotation(InnerClass innerClass, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) {

	}

}

MySQLCommentGenerator：

import java.util.Properties;

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.TopLevelClass;

/**

 * Created by qhong on 2019/3/22 14:10

 **/

public class MySQLCommentGenerator extends EmptyCommentGenerator {

   private Properties properties;

   public MySQLCommentGenerator() {

      properties = new Properties();

   }

   @Override

   public void addConfigurationProperties(Properties properties) {

      // 获取自定义的 properties

      this.properties.putAll(properties);

   }

   @Override

   public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {

      // 获取表注释

      String remarks = introspectedTable.getRemarks();

      topLevelClass.addJavaDocLine("/**");

      topLevelClass.addJavaDocLine(" * " + remarks);

      topLevelClass.addJavaDocLine(" */");

   }

   @Override

   public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {

      // 获取列注释

      String remarks = introspectedColumn.getRemarks();

      field.addJavaDocLine("/**");

      field.addJavaDocLine(" * " + remarks);

      field.addJavaDocLine(" */");

   }

}

代码生成配置

mybatis-generator.xml

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

<!-- 第一种mybatis逆向生成xml配置 -->

<generatorConfiguration>

  <context id="sqlserverTables" defaultModelType="flat"  targetRuntime="MyBatis3">

    <!-- 生成的 Java 文件的编码 -->

    <property name="javaFileEncoding" value="UTF-8"/>

    <!-- 格式化 Java 代码 -->

    <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>

    <!-- 格式化 XML 代码 -->

    <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>

    <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>

    <!-- 生成的pojo，将implements Serializable-->

    <plugin type="org.mybatis.generator.plugins.SerializablePlugin"></plugin>

    <!-- 自定义注释生成器 -->

    <commentGenerator type="com.jsy.order.config.mybatis.MySQLCommentGenerator">

    </commentGenerator>

    <!-- 数据库链接URL、用户名、密码 -->

    <jdbcConnection driverClass="com.mysql.jdbc.Driver"

      connectionURL="jdbc:mysql://18.16.200.42:3306/personnel-dev"

      userId="root"

      password="shitou$root">

      <!-- 设置 useInformationSchema 属性为 true -->

      <property name="useInformationSchema" value="true" />

    </jdbcConnection>

    <!--

    默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer

        true，把JDBC DECIMAL 和 NUMERIC 类型解析为java.math.BigDecimal

    -->

    <javaTypeResolver>

      <property name="forceBigDecimals" value="false"/>

    </javaTypeResolver>

    <!--

    生成model模型，对应的包路径，以及文件存放路径(targetProject)，targetProject可以指定具体的路径,如./src/main/java，

    也可以使用“MAVEN”来自动生成，这样生成的代码会在target/generatord-source目录下

    -->

    <!--<javaModelGenerator targetPackage="com.joey.mybaties.test.pojo" targetProject="MAVEN">-->

    <javaModelGenerator targetPackage="com.jsy.order.mybatis.entity" targetProject="./src/main/java">

      <property name="enableSubPackages" value="true"/>

      <!-- 从数据库返回的值被清理前后的空格  -->

      <property name="trimStrings" value="true"/>

    </javaModelGenerator>

    <!--对应的mapper.xml文件  -->

    <sqlMapGenerator targetPackage="mappers" targetProject="./src/main/resources">

      <property name="enableSubPackages" value="true"/>

    </sqlMapGenerator>

    <!-- 对应的Mapper接口类文件 -->

    <javaClientGenerator type="XMLMAPPER" targetPackage="com.jsy.order.mybatis.dao" targetProject="./src/main/java">

      <property name="enableSubPackages" value="true"/>

    </javaClientGenerator>

    <!--生成对应表及类名-->

    <!--<table tableName="stocktradeinfo" domainObjectName="StockTradeInfo" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>-->

    <table tableName="tb_order" domainObjectName="Order" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>

    <table tableName="tb_resident_customer_info" domainObjectName="ResidentCustomerInfo" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>

  </context>

</generatorConfiguration>

注意其中的commentGenerator节点，引用的是自定义的类

上面的网上都有，但是网上一般都是自己写main方法调用

我这边不想写main方法，还是用maven插件命令进行调用

pom.xml插件配置：

<build>

    <pluginManagement>

        <plugins>

            <plugin>

                <groupId>org.mybatis.generator</groupId>

                <artifactId>mybatis-generator-maven-plugin</artifactId>

                <version>1.3.7</version>

                <dependencies>

                    <dependency>

                        <groupId> mysql</groupId>

                        <artifactId> mysql-connector-java</artifactId>

                        <version> 5.1.39</version>

                    </dependency>

                    <dependency>

                        <groupId>org.mybatis.generator</groupId>

                        <artifactId>mybatis-generator-core</artifactId>

                        <version>1.3.7</version>

                    </dependency>

                    <dependency>

                        <groupId>com.jsy</groupId>

                        <artifactId>order-persistence</artifactId>

                        <version>1.0.0-SNAPSHOT</version>

                    </dependency>

                </dependencies>

                <executions>

                    <execution>

                        <id>Generate MyBatis Artifacts</id>

                        <!--<phase>package</phase>-->

                        <!--<goals>-->

                            <!--<goal>generate</goal>-->

                        <!--</goals>-->

                    </execution>

                </executions>

                <configuration>

                    <!--允许移动生成的文件 -->

                    <verbose>true</verbose>

                    <!-- 是否覆盖 -->

                    <overwrite>true</overwrite>

                    <!-- 自动生成的配置 -->

                    <configurationFile>

                        src/main/resources/mybatis-generator.xml</configurationFile>

                </configuration>

            </plugin>

        </plugins>

    </pluginManagement>

</build>

goal：

其中goals注释，是因为mybatis-generator.xml中，如果没有table标签，那么package就会报错

[ERROR] Failed to execute goal org.mybatis.generator:mybatis-generator-maven-plugin:1.3.7:generate (Generate MyBatis Artifacts) on project order-persistence: XML Parser Error on line 70: 元素类型为 "context" 的内

容不完整, 它必须匹配 "(property*,plugin*,commentGenerator?,(connectionFactory|jdbcConnection),javaTypeReso

lver?,javaModelGenerator,sqlMapGenerator?,javaClientGenerator?,table+)"。 -> [Help 1]

插件配置的引用

注意插件配置中的引用依赖

<dependency>

                    <groupId>com.jsy</groupId>

                    <artifactId>order-persistence</artifactId>

                    <version>1.0.0-SNAPSHOT</version>

                </dependency>

这是我项目中的一个模块，就是上面自定义注释生成器所在项目的模块，而且这个模块还要引用

   <!-- MyBatis Generator -->

    <dependency>

      <groupId>org.mybatis.generator</groupId>

      <artifactId>mybatis-generator-core</artifactId>

      <version>1.3.7</version>

    </dependency>

mybatis-generator 的plugin有自己的classpath，我们在项目中直接继承的类和plugin不属于同一个classpath

这其实是不同的两个维度。

命令生成代码

全都配置好以后，还需要将注释生成器所在模块使用maven命令install到本地，

这样就可以使用下面命令生成代码

mvn mybatis-generator:generate

如果本地并没有注释生成器所在模块，那么就会报异常：

[ERROR] Failed to execute goal org.mybatis.generator:mybatis-generator-maven-plugin:1.3.7:generate (default-cli) on project order-persistence: Execution default-cli of goal org.mybatis.generator:mybatis-generator-maven-plugin:1.3.7:generate failed: Cannot instantiate object of type com.jsy.order.config.mybatis.MySQLCommentGenerator -> [Help 1]

参考

MyBatis Generator 自定义生成注释

mybatis-generator自定义注释生成

mybatis插件--(1)--mybatis generator自定义插件或者扩展报Cannot instantiate object of type XXX

MyBatis Generator 自定义生成注释的更多相关文章

  1. 使用Mybatis Generator自动生成Mybatis相关代码

    本文将简要介绍怎样利用Mybatis Generator自动生成Mybatis的相关代码: 一.构建一个环境: 1. 首先创建一个表: CREATE TABLE pet (name VARCHAR(2 ...

  2. SpringBoot 添加mybatis generator 自动生成代码插件

    自动生成数据层代码,提高开发效率 1.pom添加插件,并指定配置文件路径 <!-- mybatis generator 自动生成代码插件 --> <plugin> <gr ...

  3. idea中mybatis generator自动生成代码配置 数据库是sqlserver

    好长时间没有写博客了,最近公司要用java语言,开始学习java,属于初学者,今天主要记录一下mybatis generator自动生成代码,首先在如下图的目录中新建两个文件,如下图 generato ...

  4. SpringBoot入门篇--整合mybatis+generator自动生成代码+druid连接池+PageHelper分页插件

    原文链接 我们这一篇博客讲的是如何整合Springboot和Mybatis框架,然后使用generator自动生成mapper,pojo等文件.然后再使用阿里巴巴提供的开源连接池druid,这个连接池 ...

  5. IDEA Maven Mybatis generator 自动生成代码

    IDEA Maven Mybatis generator 自动生成代码 一.安装配置maven以及在Idea中配置maven 安装过程步骤可以看上面的博文,里面介绍得很详细. 二.建数据表 DROP ...

  6. IDEA Maven Mybatis generator 自动生成代码(实例讲解)(转)

    IDEA Maven Mybatis generator 自动生成代码(实例讲解) MyBatis Generator • 简称MBG,是一个专门为MyBatis框架使用者定制的代码生成器,可以快速的 ...

  7. Mybatis generator 逆向生成代码

    Mybatis generator 逆向生成代码 简单介绍 本文介绍用mybatis逆向生成javaben dao接口 1.创建maven项目 创建相应的包 附上项目创建完成的图片 然后在pom.xm ...

  8. MyBatis Generator 自动生成的POJO对象的使用（一）

    MyBatis Generator 会自动生成以下几种类型的对象(除非你使用MyBatis3DynamicSql 的运行环境): Java Model Objects(总是生成) SQL Map Fi ...

  9. 记一次 IDEA mybatis.generator 自定义扩展插件

    在使用 idea mybatis.generator 生成的代码,遇到 生成的代码很多重复的地方, 虽然代码是生成的,我们也不应该允许重复的代码出现,因为这些代码后期都要来手动维护. 对于生成时间戳注 ...

随机推荐

  1. [译]《Sphinx权威指南》 - Sphinx入门

    本章中,我们会讨论到Sphinx基础的安装.配置和维护.不要被“基础”这形容词糊弄而跳过这个章节.对于“基础”,我不是指简单到显而易见的东西,而是指所有人都会用到的功能. 一般来说,Sphinx会使用 ...

  2. struct ifreq学习和实例

    一.struct ifreq结构体 这个结构定义在/usr/include/net/if.h,用来配置和获取ip地址,掩码,MTU等接口信息的. /* Interface request struct ...

  3. 数据库设计入门及ERMaster的安装和使用

    数据库的设计步骤 1.标识表  (根据需求创建表) 2.标识表的字段 3.标识表与表之间的关系 注意事项: 三大范式: 1.确保标识的字段的原子性,字段的概念分的不能再分 2.确保字段与表有依赖的关系 ...

  4. lnmp 切换PHP版本，并且安装swoole

    lnmp 切换php版本 进入 lnmp 安装的目录,进入install.sh 的目录执行: sudo ./install.sh mphp 备注: find / -name install.sh 备注 ...

  5. ValueError: Variable rnn/basic_lstm_cell/kernel already exists, disallowed. Did you mean to set reuse=True or reuse=tf.AUTO_REUSE in VarScope? Originally defined at:

    问题 ValueError: Variable rnn/basic_lstm_cell/kernel already exists, disallowed. Did you mean to set r ...

  6. git备注

    下拉仓库 git clone ""建立本地分支 git checkout -b "分支名字" 修改代码以后切换到主分支 git checkout master更 ...

  7. pycharm的断点调试与TODO标记

    断点调试的方法: 断点调试在程序比较大的时候调试运用的比较多 点击Pycharm软件右上角绿色三角形右边的小甲鱼图标,点击之后会弹出断点调试的界面 Debug是用来调试bug的 terminal 是终 ...

  8. Python实现图像直方图均衡化算法

    title: "Python实现图像直方图均衡化算法" date: 2018-06-12T17:10:48+08:00 tags: [""] categorie ...

  9. Blender学习

    学习顺序(下面为引用他人的视频或博客) 51个必须知道的blender操作 https://www.bilibili.com/video/av4619930/ Blender常用快捷键一览表 http ...

  10. laravel blog edit

    模板复制create的模板 主要修改的地方 <form action="{{ url('admin/article/'.$article->id) }}" method ...