Mybatis之Mybatis Generator vs IDEA插件 自动生成代码

最新推荐文章于 2023-07-03 23:21:16 发布
置顶 最新推荐文章于 2023-07-03 23:21:16 发布
阅读量800 收藏 6
点赞数 2
分类专栏： Spring Boot Mybatis 笔记 文章标签： spring java mybatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/NestorBian/article/details/106604194
版权
Spring Boot 同时被 3 个专栏收录
9 篇文章 0 订阅
订阅专栏
笔记
9 篇文章 0 订阅
订阅专栏
Mybatis
6 篇文章 0 订阅
订阅专栏

Mybatis之Mybatis Generator vs IDEA插件 自动生成代码

Mybatis系列文章
Mybatis之配置详解
Mybatis之XML 映射器详解
Mybatis之动态 SQL详解
Mybatis之缓存详解
Mybatis之映射器注解详解
Mybatis之Mybatis Generator vs IDEA插件 自动生成代码

前言

为了给大家对比Mybatis Generator和IDEA插件MyBatisCodeHelper-Pro究竟哪一个更好用，接下来会分别介绍怎么使用Mybatis Generator自动生成代码以及如何使用MyBatisCodeHelper-Pro插件生成代码。

Mybatis Generator xml配置文件

接下来主要讲解以下xml配置文件该如何配置，因为Mybatis Generator官网已经详细罗列出所有标签的用法以及解释，下面只详细介绍一些常用标签。下文中MyBatis Generator 用MBG来替代。样例如下：

<?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="mybatis-generator.properties" />
    <classPathEntry location="${driverLocation}"/>

    <context id="default" targetRuntime="MyBatis3" defaultModelType="conditional">
        <property name="autoDelimitKeywords" value="true"/>
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="false"/>
            <property name="addRemarkComments" value="true"/>
        </commentGenerator>
        
        <jdbcConnection driverClass="${driverClass}"
                        connectionURL="${connectionURL}"
                        userId="${userId}"
                        password="${password}">
            <property name="nullCatalogMeansCurrent" value="true"/>
        </jdbcConnection>

        <javaTypeResolver>
            <property name="forceBigDecimals" value="true"/>
            <property name="useJSR310Types" value="true"/>
        </javaTypeResolver>

        <javaModelGenerator targetPackage="com.nestor.mybatisgeneratordemo.po"
                            targetProject="${baseTargetProject}/src/main/java">
            <property name="enableSubPackages" value="false"/>
            <property name="constructorBased" value="false"/>
            <property name="trimStrings" value="true"/>
            <property name="immutable" value="false"/>
            <property name="rootClass" value="com.nestor.mybatisgeneratordemo.po.BaseModel"/>
        </javaModelGenerator>
  
        <sqlMapGenerator targetPackage="mapper"
                         targetProject="${baseTargetProject}/src/main/resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.nestor.mybatisgeneratordemo.mapper"
                             targetProject="${baseTargetProject}/src/main/java">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <table tableName="%" schema="root">
            <generatedKey column="id" sqlStatement="MySql" identity="true" type="post"/>
        </table>
    </context>
</generatorConfiguration>

1. 配置文件头

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

2. 根节点generatorConfiguration

generatorConfiguration节点没有任何属性，直接写节点即可，如下：

<generatorConfiguration>
    <!-- 具体配置内容 -->
</generatorConfiguration>

3. generatorConfiguration子元素

从这段开始，就是配置的主要内容，这些配置都是generatorConfiguration元素的子元素。

包含以下子元素（有严格的顺序）：

<properties> (0个或1个)

<classPathEntry> (0个或多个)

<context> (1个或多个)

3.1 properties 元素

这个元素用来指定外部的属性元素，不是必须的元素。

元素用于指定一个需要在配置中解析使用的外部属性文件，引入属性文件后，可以在配置中使用 ${property}这种形式的引用，通过这种方式引用属性文件中的属性值。

<properties resource="mybatis-generator.properties" />

这个属性可以通过resource或者url来指定属性文件的位置，这两个属性只能使用其中一个来指定，同时出现会报错。
resource：指定classpath下的属性文件，使用类似com/myproject/generatorConfig.properties这样的属性值。
url：可以指定文件系统上的特定位置，例如file:///C:/myfolder/generatorConfig.properties

3.2 classPathEntry 元素

这个元素可以0或多个，不受限制。

最常见的用法是通过这个属性指定驱动的路径，例如：

<classPathEntry location="D:/maven/repository/mysql/mysql-connector-java/8.0.20/mysql-connector-java-8.0.20.jar"/>

注意，classPathEntry只在下面这两种情况下才有效：

  • 当加载 JDBC 驱动内数据库时,常用场景：使用命令行进行Mybatis代码自动生成时,下文中会详细介绍。
  • 当加载根类中的 JavaModelGenerator 检查重写的方法时。

3.3 context 元素

在MBG的配置中，至少需要有一个<context>元素。

<context>元素用于指定生成一组对象的环境。例如指定要连接的数据库，要生成对象的类型和要处理的数据库中的表。运行MBG的时候还可以指定要运行的<context>。

该元素只有一个必选属性id，用来唯一确定一个<context>元素，该id属性可以在运行MBG的使用。

此外还有几个可选属性：
defaultModelType:这个属性很重要，这个属性定义了MBG如何生成实体类。
这个属性有以下可选值：

  • conditional:这是默认值,这个模型和下面的hierarchical类似，除了如果那个单独的类将只包含一个字段，将不会生成一个单独的类。 因此,如果一个表的主键只有一个字段,那么不会为该字段生成单独的实体类,会将该字段合并到基本实体类中。
  • flat:该模型为每一张表只生成一个实体类。这个实体类包含表中的所有字段。这种模型最简单，推荐使用。
  • hierarchical:如果表有主键,那么该模型会产生一个单独的主键实体类,如果表还有BLOB字段， 则会为表生成一个包含所有BLOB字段的单独的实体类,然后为所有其他的字段生成一个单独的实体类。 MBG会在所有生成的实体类之间维护一个继承关系。

targetRuntime:此属性用于指定生成的代码的运行时环境。该属性支持以下可选值：

  • MyBatis3:默认值
  • MyBatis3Simple:不生成和Example查询有关的内容
  • Ibatis2Java2:基于Ibatis2生成
  • Ibatis2Java5:基于Ibatis2生成

一般情况下，我们使用如下的配置即可：

<context id="default" targetRuntime="MyBatis3" defaultModelType="conditional">

<context>的子元素，这些子元素（有严格的配置顺序）包括：

  • <property> (0个或多个)
  • <plugin> (0个或多个)
  • <commentGenerator> (0个或1个)
  • <jdbcConnection> (1个)
  • <javaTypeResolver> (0个或1个)
  • <javaModelGenerator> (1个)
  • <sqlMapGenerator> (0个或1个)
  • <javaClientGenerator> (0个或1个)
  • <table> (1个或多个)
3.3.1 property 元素

下面看看支持的属性：autoDelimitKeywords、beginningDelimiter、endingDelimiter、javaFileEncoding
、javaFormatter、xmlFormatter

首先是autoDelimitKeywords，当表名或者字段名为SQL关键字的时候，可以设置该属性为true，MBG会自动给表名或字段名添加分隔符。

beginningDelimiter和endingDelimiter的默认值为双引号(")，在Mysql中不能这么写，所以还要将这两个默认值改为反单引号(`)，配置如下：

<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>

属性javaFileEncoding设置要使用的Java文件的编码，默认使用当前平台的编码，只有当生产的编码需要特殊指定时才需要使用，一般用不到。

最后两个javaFormatter和xmlFormatter属性可能会很有用，如果你想使用模板来定制生成的java文件和xml文件的样式，你可以通过指定这两个属性的值来实现。

3.3.2 plugin 元素

该元素可以配置0个或者多个，不受限制。

<plugin>元素用来定义一个插件。插件用于扩展或修改通过MyBatis Generator (MBG)代码生成器生成的代码。

<plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
3.3.3 commentGenerator 元素

该元素最多可以配置1个。

这个元素非常有用，相信很多人都有过这样的需求，就是希望MBG生成的代码中可以包含注释信息，具体就是生成表或字段的备注信息。

该元素有一个可选属性type,可以指定用户的实现类，该类需要实现org.mybatis.generator.api.CommentGenerator接口。而且必有一个默认的构造方法。这个属性默认值是使用实现类org.mybatis.generator.internal.DefaultCommentGenerator。

默认的实现类中提供了两个可选属性，需要通过属性进行配置。suppressAllComments:阻止生成注释，默认为false。suppressDate:阻止生成的注释包含时间戳，默认为false。

一般情况下由于MBG生成的注释信息没有任何价值，而且有时间戳的情况下每次生成的注释都不一样，使用版本控制的时候每次都会提交，因而一般情况下我们都会屏蔽日期注释信息，可以如下配置：

<commentGenerator>
    <property name="suppressAllComments" value="false"/>
    <property name="suppressDate" value="true"/>
</commentGenerator>

可以自己实现个类名为MyCommentGenerator，在你自己的实现类中，你可以选择是否继续支持上面的两个属性，你还可以增加对其他属性的支持。

<commentGenerator type="com.nestor.mybatisgeneratordemo.common.MyCommentGenerator">
3.3.4 jdbcConnection 元素

<jdbcConnection>用于指定数据库连接信息，该元素必选，并且只能有一个。

配置该元素只需要注意如果JDBC驱动不在classpath下，就需要通过<classPathEntry>元素引入jar包，这里推荐将jar包放到classpath下。

该元素有两个必选属性:driverClass:访问数据库的JDBC驱动程序的完全限定类名。connectionURL:访问数据库的JDBC连接URL。
该元素还有两个可选属性:userId:访问数据库的用户ID。password:访问数据库的密码。

这个元素配置起来最容易，这里举个简单例子：

<jdbcConnection driverClass="com.mysql.jdbc.Driver"
                connectionURL="jdbc:mysql://localhost:3306/test"
                userId="root"
                password="">
</jdbcConnection>
3.3.5 javaTypeResolver 元素

该元素最多可以配置一个。这个元素的配置用来指定JDBC类型和Java类型如何转换。

该元素提供了一个可选的属性type，和比较类型，提供了默认的实现DEFAULT，一般情况下使用默认即可，需要特殊处理的情况可以通过其他元素配置来解决，不建议修改该属性。

<property>可以配置的属性为forceBigDecimals，该属性可以控制是否强制DECIMAL和NUMERIC类型的字段转换为Java类型的java.math.BigDecimal,默认值为false，一般不需要配置。

默认情况下的转换规则为：

  • 如果精度>0或者长度>18，就会使用java.math.BigDecimal
  • 如果精度=0并且10<=长度<=18，就会使用java.lang.Long
  • 如果精度=0并且5<=长度<=9，就会使用java.lang.Integer
  • 如果精度=0并且长度<5，就会使用java.lang.Short
  • 如果设置为true，那么一定会使用java.math.BigDecimal

可以配置的属性为useJSR310Types，该属性可以控制是否强制DATE和DATETIME类型的字段转换为Java8的LocalDate和LocalDateTime,默认值为false。

配置示例如下：

<javaTypeResolver>
    <property name="forceBigDecimals" value="true"/>
    <property name="useJSR310Types" value="true"/>
</javaTypeResolver>
3.3.6 javaModelGenerator 元素

该元素必须配置一个，并且最多一个。该元素用来控制生成的实体类，根据中配置的defaultModelType，一个表可能会对应生成多个不同的实体类。一个表对应多个类实际上并不方便，所以前面也推荐使用flat，这种情况下一个表对应一个实体类。

该元素只有两个属性，都是必选的。targetPackage:生成实体类存放的包名。targetProject:指定目标项目路径，可以是绝对路径或相对路径（如 targetProject=“src/main/java”）。

该元素支持以下几个<property>子元素属性：

  • constructorBased:该属性只对MyBatis3有效，如果true就会使用构造方法入参，如果false就会使用setter方式。默认为false。
  • enableSubPackages:如果true，MBG会根据catalog和schema来生成子包。如果false就会直接用targetPackage属性。默认为false。
  • immutable:该属性用来配置实体类属性是否可变，如果设置为true，那么constructorBased不管设置成什么，都会使用构造方法入参，并且不会生成setter方法。如果为false，实体类属性就可以改变。默认为false。
  • rootClass:设置所有实体类的基类。如果设置，需要使用类的全限定名称。并且如果MBG能够加载rootClass，那么MBG不会覆盖和父类中完全匹配的属性。匹配规则：属性名完全相同 属性类型相同 属性有getter方法 属性有setter方法
  • trimStrings:是否对数据库查询结果进行trim操作，如果设置为true就会生成类似这样public void setUsername(String username) {this.username = username == null ? null : username.trim();}的setter方法。默认值为false。

配置示例如下：

<javaModelGenerator targetPackage="com.nestor.mybatisgeneratordemo.po"
                    targetProject="${baseTargetProject}/src/main/java">
    <property name="enableSubPackages" value="false"/>
    <property name="constructorBased" value="false"/>
    <property name="trimStrings" value="true"/>
    <property name="immutable" value="false"/>
    <property name="rootClass" value="com.nestor.mybatisgeneratordemo.po.BaseModel"/>
</javaModelGenerator>
3.3.7 sqlMapGenerator 元素

该元素可选，最多配置一个。但是有如下两种必选的特殊情况：
如果targetRuntime目标是iBATIS2，该元素必须配置一个。
如果targetRuntime目标是MyBatis3，只有当<javaClientGenerator>需要XML时，该元素必须配置一个。 如果没有配置<javaClientGenerator>，则使用以下的规则：如果指定了一个<sqlMapGenerator>，那么MBG将只生成XML的SQL映射文件和实体类。如果没有指定<sqlMapGenerator>，那么MBG将只生成实体类。
该元素只有两个属性都是必选的。targetPackage:生成实体类存放的包名，一般就是放在该包下。targetProject:指定目标项目路径，可以是绝对路径或相对路径（如 targetProject=“src/main/resources”）。

该元素支持<property>子元素，只有一个可以配置的属性：
enableSubPackages:如果true，MBG会根据catalog和schema来生成子包。如果false就会直接用targetPackage属性。默认为false。

配置示例：

<sqlMapGenerator targetPackage="mapper"
                 targetProject="${baseTargetProject}/src/main/resources">
    <property name="enableSubPackages" value="false"/>
</sqlMapGenerator>
3.3.8 javaClientGenerator 元素

该元素可选，最多配置一个。如果不配置该元素，就不会生成Mapper接口。

该元素有3个必选属性：
type:该属性用于选择一个预定义的客户端代码（可以理解为Mapper接口）生成器，用户可以自定义实现，需要继承org.mybatis.generator.codegen.AbstractJavaClientGenerator类，必选有一个默认的构造方法。 该属性提供了以下预定的代码生成器，首先根据的targetRuntime分成三类：
MyBatis3:
ANNOTATEDMAPPER:基于注解的Mapper接口，不会有对应的XML映射文件
MIXEDMAPPER:XML和注解的混合形式，(上面这种情况中的)SqlProvider注解方法会被XML替代。
XMLMAPPER:所有的方法都在XML中，接口调用依赖XML文件。

MyBatis3Simple:
ANNOTATEDMAPPER:基于注解的Mapper接口，不会有对应的XML映射文件
XMLMAPPER:所有的方法都在XML中，接口调用依赖XML文件。

Ibatis2Java2或Ibatis2Java5:
IBATIS:生成的对象符合iBATIS的DAO框架（不建议使用）。
GENERIC-CI:生成的对象将只依赖于SqlMapClient，通过构造方法注入。
GENERIC-SI:生成的对象将只依赖于SqlMapClient，通过setter方法注入。
SPRING:生成的对象符合Spring的DAO接口

targetPackage:生成实体类存放的包名，一般就是放在该包下。
targetProject:指定目标项目路径，可以是绝对路径或相对路径（如 targetProject=“src/main/java”）。
该元素还有一个可选属性：
implementationPackage:如果指定了该属性，实现类就会生成在这个包中。

该元素支持子元素设置的属性：enableSubPackages、exampleMethodVisibility、methodNameCalculator、rootInterface、useLegacyBuilder。
这几个属性不太常用，具体作用请看Mybatis Generator官网。

配置示例：

<javaClientGenerator type="XMLMAPPER"
                     targetPackage="com.nestor.mybatisgeneratordemo.mapper"
                     targetProject="${baseTargetProject}/src/main/java">
    <property name="enableSubPackages" value="false"/>
    <!--<property name="rootInterface" value="com.nestor.mybatisgeneratordemo.mapper.BaseMapper"/>-->
</javaClientGenerator>
3.3.9 table 元素

该元素至少要配置一个，可以配置多个。该元素用来配置要通过内省的表。只有配置的才会生成实体类和其他文件。

该元素有一个必选属性：
tableName：指定要生成的表名，可以使用SQL通配符匹配多个表。
例如要生成全部的表，可以按如下配置：

<table tableName="%" />

该元素包含多个可选属性：

  • schema:数据库的schema,可以使用SQL通配符匹配。如果设置了该值，生成SQL的表名会变成如schema.tableName的形式。
  • catalog:数据库的catalog，如果设置了该值，生成SQL的表名会变成如catalog.tableName的形式。
    alias:如果指定，这个值会用在生成的select查询SQL的表的别名和列名上。 列名会被别名为 alias_actualColumnName(别名_实际列名) 这种模式。
  • domainObjectName:生成对象的基本名称。如果没有指定，MBG会自动根据表名来生成名称。
  • enableXXX:XXX代表多种SQL方法，该属性用来指定是否生成对应的XXX语句。
  • selectByPrimaryKeyQueryId:DBA跟踪工具会用到，具体请看详细文档。
  • selectByExampleQueryId:DBA跟踪工具会用到，具体请看详细文档。
  • modelType:和的defaultModelType含义一样，这里可以针对表进行配置，这里的配置会覆盖的defaultModelType配置。
  • escapeWildcards:这个属性表示当查询列，是否对schema和表名中的SQL通配符 (’_’ and ‘%’) 进行转义。 对于某些驱动当schema或表名中包含SQL通配符时（例如，一个表名是MY_TABLE，有一些驱动需要将下划线进行转义）是必须的。默认值是false。
  • delimitIdentifiers:是否给标识符增加分隔符。默认false。当catalog,schema或tableName中包含空白时，默认为true。
  • delimitAllColumns:是否对所有列添加分隔符。默认false。

该元素包含多个可用的<property>子元素，可选属性为：
constructorBased:和中的属性含义一样。
ignoreQualifiersAtRuntime:生成的SQL中的表名将不会包含schema和catalog前缀。
immutable:和中的属性含义一样。
modelOnly:此属性用于配置是否为表只生成实体类。如果设置为true就不会有Mapper接口。如果配置了，并且modelOnly为true，那么XML映射文件中只有实体对象的映射元素()。如果为true还会覆盖属性中的enableXXX方法，将不会生成任何CRUD方法。
rootClass:和中的属性含义一样。
rootInterface:和中的属性含义一样。
runtimeCatalog:运行时的catalog，当生成表和运行环境的表的catalog不一样的时候可以使用该属性进行配置。
runtimeSchema:运行时的schema，当生成表和运行环境的表的schema不一样的时候可以使用该属性进行配置。
runtimeTableName:运行时的tableName，当生成表和运行环境的表的tableName不一样的时候可以使用该属性进行配置。
selectAllOrderByClause:该属性值会追加到selectAll方法后的SQL中，会直接跟order by拼接后添加到SQL末尾。
useActualColumnNames:如果设置为true,那么MBG会使用从数据库元数据获取的列名作为生成的实体对象的属性。 如果为false(默认值)，MGB将会尝试将返回的名称转换为驼峰形式。 在这两种情况下，可以通过 元素显示指定，在这种情况下将会忽略这个（useActualColumnNames）属性。
useColumnIndexes:如果是true,MBG生成resultMaps的时候会使用列的索引,而不是结果中列名的顺序。
useCompoundPropertyNames:如果是true,那么MBG生成属性名的时候会将列名和列备注接起来。

<table>还包含以下子元素：

  • <generatedKey> (0个或1个)，这个元素用来指定自动生成主键的属性。MBG在生成insert的SQL映射文件中插入一个元素。 这个元素非常重要。
  • <columnRenamingRule> (0个或1个)。使用该元素可以在生成列之前，对列进行重命名。这对那些存在同一前缀的字段想在生成属性名时去除前缀的表非常有用。
  • <columnOverride> (0个或多个)。该元素从将某些属性默认计算的值更改为指定的值。
  • <ignoreColumn> (0个或多个)。该元素可以用来屏蔽不需要生成的列。

Mybatis Generator 实战

引入maven依赖

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>
<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.4.0</version>
</dependency>

添加配置文件

在这里插入图片描述
generatorConfig.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">
<generatorConfiguration>

    <properties resource="mybatis-generator.properties" />
    <classPathEntry location="${driverLocation}"/>
    
    <context id="default" targetRuntime="MyBatis3" defaultModelType="conditional">

        <property name="autoDelimitKeywords" value="true"/>
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>

        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <!--不合并 mapper.xml，直接覆盖，不加的话多次执行会生成重复的xml语句-->
        <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />
        <!--自定义插件-->
        <plugin type="com.nestor.mybatisgeneratordemo.common.MyToStringPlugin" />
        <plugin type="com.nestor.mybatisgeneratordemo.common.BaseMapperGeneratorPlugin">
            <property name="baseMapper" value="com.nestor.mybatisgeneratordemo.mapper.BaseMapper" />
        </plugin>

        <commentGenerator type="com.nestor.mybatisgeneratordemo.common.MyCommentGenerator">
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="false"/>
            <property name="addRemarkComments" value="true"/>
        </commentGenerator>

        <jdbcConnection driverClass="${driverClass}"
                        connectionURL="${connectionURL}"
                        userId="${userId}"
                        password="${password}">
            <!--指定使用数据库连接里的库信息-->
            <property name="nullCatalogMeansCurrent" value="true"/>
        </jdbcConnection>

        <javaTypeResolver>
            <property name="forceBigDecimals" value="true"/>
            <property name="useJSR310Types" value="true"/>
        </javaTypeResolver>

        <javaModelGenerator targetPackage="com.nestor.mybatisgeneratordemo.po"
                            targetProject="${baseTargetProject}/src/main/java">
            <property name="enableSubPackages" value="false"/>
            <property name="constructorBased" value="false"/>
            <property name="trimStrings" value="true"/>
            <property name="immutable" value="false"/>
            <property name="rootClass" value="com.nestor.mybatisgeneratordemo.po.BaseModel"/>
        </javaModelGenerator>

        <sqlMapGenerator targetPackage="mapper"
                         targetProject="${baseTargetProject}/src/main/resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.nestor.mybatisgeneratordemo.mapper"
                             targetProject="${baseTargetProject}/src/main/java">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <table tableName="grade_param" domainObjectName="GradeParam">
            <generatedKey column="id" sqlStatement="MySql" identity="true" type="post"/>
            <columnOverride column="level" javaType="com.nestor.mybatisgeneratordemo.enums.GradeLevel"/>
        </table>
        <table tableName="student" domainObjectName="Student">
            <generatedKey column="id" sqlStatement="MySql" identity="true" type="post"/>
            <columnOverride column="sex" javaType="com.nestor.mybatisgeneratordemo.enums.Sex"/>
        </table>
        <table tableName="school" domainObjectName="School">
            <generatedKey column="id" sqlStatement="MySql" identity="true" type="post"/>
        </table>
    </context>
</generatorConfiguration>

在我的个性配置中可以看到，我使用了自定义插件，MyToStringPlugin主要是为我们的model类生成我们自定义toString方法。BaseMapperGeneratorPlugin主要是让自动生成的mapper接口都继承于我们自定义的BaseMapper接口，同时在自动生成代码时，保留接口中已定义方法。MyCommentGenerator帮助生成实体类注释的插件。具体源码就不贴出来了，有兴趣的小伙伴可以去github工程中查看。

mybatis-generator.properties

driverLocation=D:/maven/repository/mysql/mysql-connector-java/8.0.20/mysql-connector-java-8.0.20.jar
driverClass=com.mysql.cj.jdbc.Driver
connectionURL=jdbc:mysql://localhost:3306/mybatis-demo?useUnicode=true&characeterEncoding=utf-8&serverTimezone=UTC
userId=root
password=123456
baseTargetProject=D:/IdeaProjects/mybatis-demos/mybatis-generator-demo

运行Mybatis Generator的方式

这里主要介绍常用的三种方式：JAVA启动类，maven插件，命令行

JAVA启动类

添加MybatisJavaGenerator java类直接执行main方法即可。

public class MybatisJavaGenerator {

    public static void main(String[] args) throws Exception {
        List<String> warnings = new ArrayList<>();
        ConfigurationParser cp = new ConfigurationParser(warnings);
        Configuration config = cp.parseConfiguration(
                MybatisJavaGenerator.class.getResourceAsStream("/generatorConfig.xml"));
        DefaultShellCallback callback = new DefaultShellCallback(true);
        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        myBatisGenerator.generate(null);
    }

}

注意点：在使用JAVA启动类方式自动生成代码时，需要在generatorConfig.xml配置targetProject时需要指定磁盘路径（例：D:/IdeaProjects/mybatis-demos/mybatis-generator-demo/src/main/java）以及需要在generatorConfig.xml中指定classPathEntry，否则会找不到驱动的jar包。

maven插件

	<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.4.0</version>
                <configuration>
                    <!-- 在控制台打印执行日志 -->
                    <verbose>true</verbose>
                    <!-- 重复生成时会覆盖之前的文件-->
                    <overwrite>true</overwrite>
                    <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
                </configuration>
                <executions>
                    <execution>
                        <id>Generate MyBatis Artifacts</id>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                    </execution>
                </executions>
                <!-- 数据库连接选择8.0以上的，因为用的mysql8.0-->
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>8.0.20</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>

执行maven install就会自动生成model、mapper、xml。

注意点：使用maven插件时，使用自定义插件时就需要将对应引用的插件代码单独打包发布到maven，再在pom文件引用并在<build>中也配置，否者无法通过install方式自动生成代码。无需要在generatorConfig.xml中指定classPathEntry。

命令行

打开mybatis-generator-core-x.x.x.jar所在文件夹，在命令窗口执行下面命令，注意：与mybatis-generator-core-x.x.x.jar不在同一目录下，需要指定generatorConfig.xml的路径

java -jar mybatis-generator-core-x.x.x.jar -configfile generatorConfig.xml -overwrite

注意点：需要在generatorConfig.xml中指定classPathEntry，否则会找不到驱动的jar包。

IDEA插件

IDEA中有很多关于mybatis generator自动生成代码相关插件，可以通过搜索mybatis关键字来查找。这里主要介绍一下Free MyBatis plugin和MyBatisCodeHelper-Pro。

在这里插入图片描述

Free MyBatis plugin

免费的mybatis自动生成代码IDEA插件。

  1. 连接上IDEA自带的Database
    在这里插入图片描述
  2. 选中想要自动生成代码的表，然后右击选择mybatis-generator。点击确定出现以下窗口。
    在这里插入图片描述
  3. 选择对应需要存放model、mapper、xml的路径。点击确定就会自动生成。

MyBatisCodeHelper-Pro

收费的mybatis自动生成代码IDEA插件，但是功能强大而且收费也不贵几十块一年，具有mybatis的补全、检测、跳转、代码生成等功能，了解具体详情或者具体操作步骤可以看插件的文档

以下介绍两种比较常用的自动生成代码方式。

通过model生成

  1. 找到定义好的model，alt+insert组合键，弹出弹框选择generate mybatis files
    在这里插入图片描述
  2. 选择new myabtis file,出现以下弹框
    在这里插入图片描述
  3. 选择对应需要存放model、mapper、xml、sql的路径。点击确定就会自动生成。

通过数据库table生成

这种方式与上面Free MyBatis plugin插件生成的方式类似。

  1. 选择表，然后右击选择Mybatis generator或者Mybatis multiple table generate都可以，一个针对于单表，一个针对于多表。
    在这里插入图片描述
  2. 选择对应需要存放model、mapper、xml的路径。点击确定就会自动生成。

一个自动生成代码的规范

无论我们使用哪种方式，不管是通过代码还是IDEA插件，都要保证自动生成的代码与我们自定义的代码分离开，防止下次生成覆盖之前自己自定义的代码。建议分别创建如下目录。
在这里插入图片描述
从图中看出红框选中的editable包下的部分是我们自定义的一些sql放置的xml，而它的外层是代码自动生成的一些xml。同样mapper接口也可以建一个editable包，存放自定义接口，但是要保证editable的xml使用的是editable下mapper的namespace。

在我示例的github工程中因为不想单独定义editable mapper接口就写了BaseMapperGeneratorPlugin，把自动生成的方法都放在BaseMapper中，自定义的方法就可以放在对应的mapper中。
在这里插入图片描述
因为BaseMapperGeneratorPlugin插件支持保留自定义方法所以不用多次自动生成担心自定义方法丢失的问题。示例里面我也是给xml单独创建了一个editable包，不同的是外层的xml和editable包下的两个mapper.xml使用的是同一个namespace。

总结

针对Mybatis Generator通过代码实现自动生成和IDEA插件这两种方式体验下来看，针对快速构建项目，针对表结构修改不频繁或者不迭代的项目来说，使用IDEA插件来生成更方便，更迅速，无需引入依赖以及编写代码。但是如果是针对长久项目迭代，表结构经常变更的话，还是更建议Mybatis Generator代码实现。

github工程地址：https://github.com/nestorbian/spring-boot-examples/tree/master/mybatis-generator-demo

Mybatis系列文章
Mybatis之配置详解
Mybatis之XML 映射器详解
Mybatis之动态 SQL详解
Mybatis之缓存详解
Mybatis之映射器注解详解
Mybatis之Mybatis Generator vs IDEA插件 自动生成代码

参考：
MyBatis Generator官网
MyBatis Generator 详解
MyBatisCodeHelper-Pro官网

泽阳君
关注
  • 2
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
Mybatis Plus代码生成器 IDEA 插件版 （版本v0.0.6）
06-28
Mybatisplus 代码生成器提供 Windows Desktop 和 IDEA Plugin 两个版本。 我的IDEA是2019.2版本的，没有问题，如果你是其他版本，不知道有没有问题，有问题可以给我反馈。 Windows & Mac Desktop 桌面版下载地址：...
MybatisPlus学习之MyBatisX插件比代码生成器还好用的哦
m0_67393039的博客
08-29 445
MyBatis-Plus为我们提供了强大的mapper和service模板，能够大大的提高开发效率但是在真正开发过程中，MyBatis-Plus并不能为我们解决所有问题，例如一些复杂的SQL，多表联查，我们就需要自己去编写代码和SQL语句，我们该如何快速的解决这个问题呢，这个时候可以使用MyBatisX插件MyBatisX一款基于 IDEA 的快速开发插件，为效率而生。...
取代 Mybatis Generator，这款代码生成神器配置更简单，开发效率更高
沉默王二
02-14 3844
作为一名 Java 后端开发，日常工作中免不了要生成数据库表对应的持久化对象 PO，操作数据库的接口 DAO，以及 CRUD 的 XML，也就是 mapper。 Mybatis Generator 是 MyBatis 官方提供的一个代码生成工具，完全可以胜任这个工作，不过最近在开发“编程猫”开源网站的时候试用了一下 MyBatis-Plus 官方提供 AutoGenerator，发现配置更简单，开发效率更高！于是就来给小伙伴们安利一波。 来个 GIF 感受一下 AutoGenerator 生成代码的快感吧
idea mybatis generator插件_IDEA有了这款Maven插件，再次彰显牛逼，再也不用手动写代码了...
weixin_39831001的博客
11-22 178
点击蓝色字免费订阅，每天收到这样的好信息前言:最近有不少粉丝关注本公众号。并且我已经成功开通了流量主同时会赚一点点广告费,我打算每个月把这部分钱拿出来给大家买点书刊,算是给大家一点福利吧。大家想买什么书扫描下方的加他拉你加群。最后,非常感谢大家的关注。来源：cnblogs.com/homejim/p/9782403.html1，创建代码生成器1.1，创建Maven项目1.2，配置gene...
Mybatis-X插件自动生成代码的使用详解（小白专用）
wuyanwenyun的博客
05-28 9218
Mybatis-X插件自动生成代码的使用详解（小白专用）
MybatisX-Generator自动代码生成插件
Lou_Lan的博客
10-19 4万+
一、概述 MybatisX-Generator是mybatis-plus的代码自动生成插件，用在idea的开发工具上，我们可以idea上安装这个插件，然后通过idea自带的数据库进行使用，打开idea的数据库database，链接一个数据库，然后对你要进行代码生成的表进行右击，就可以看到这个插件。 点击该插件就可以使用代码自动生成，这里主要是对这个代码生成插件使用配置的讲解。 二、配置说明图 代码自动生成配置的页面总共有两个，配置完成之后就可以进行代码的自动生成了。 ....
IDEA Maven Mybatis generator 自动生成代码(实例讲解)
08-28
下面小编就为大家分享一篇IDEA Maven Mybatis generator 自动生成代码的实例讲解，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
IDEA mybatis-generator逆向工程生成代码
08-27
主要介绍了IDEA mybatis-generator逆向工程生成代码，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
MyBatis-plus+达梦数据库实现自动生成代码的示例
09-07
主要介绍了MyBatis-plus+达梦数据库实现自动生成代码的示例，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
Intellij下MyBatis代码生成器MybatisGenerator的使用
04-19
基于MySQL8、MyBatis3.5.4、MyBatisGenerator1.40 以Scott用户下的dept和emp表为例，有关这两个表的注释请参考：https://editor.csdn.net/md/?articleId=101469279 解决生成实体类注释不能正确读取数据库中注释的...
17代码生成器插件MyBatis Generator
本人主攻Java，希望自己能成为出色的程序员。
07-03 2000
Mybatis Generator简称 MBG，是一个专门为 MyBatis和 ibatis框架使用者提供的代码生成器。也可以快速的根据数据表生成对应的pojo类、Mapper接口、Mapper文件，甚至生成QBC风格的查询对象。一般在项目中，根据MyBatis Generator的XML配置文件设置生成简单的CRUD，但是复杂的查询或者有关关联的操作还是需要我们写SQL完成。pom.xml引出 mybatis-generator 坐标。
SpringBoot系列-- SpringBoot之Mybatis Generator生成器使用(多种方式)
Gang-bb的博客
01-28 8710
目录1. 项目环境2. 引入依赖3.生成基于.xml形式使用mybatis的各层文件3.1 用generatorConfig.xml配置插件生成3.1.1 编写generatorConfig.xml文件3.1.2 关于generatorConfig.xml配置文件的补充说明3.1.3 开始生成文件3.2 使用Idea插件生成3.2.1 better-mybatis-generator插件简介3.2.2 better-mybatis-generator使用3.2.3 功能更强大的MyBatisCodeHelp
Mybatis：通过插件生成代码
程序员无羡的博客
05-09 167
Mybatis：通过插件生成代码
Idea生成Builder代码-插件Builder Generator
你就像甜甜的益达
05-15 1万+
文章目录插件 插件 当时搜索builer,出来很多,好像是第一个吧,下载的比较多…
MybatisPlus 超好用的idea代码生成插件，及使用详解
热门推荐
beibei3321的博客
05-26 4万+
新需求来了，又添加了好几张表，总不能手写或者复制之前的代码，再一通修改吧？！ 一张表需要添加好几个新字段，往实体类里手动添加？有没有想过不是很优雅，费事费力可能还要加加班！ 这时候就要用到代码自动生成了。 MybatisPlus 代码自动生成网上有很多讲解，要手动添加各种依赖和模板引擎依赖，那到底有没有简单又好用，还能满足需求的代码生成插件呢？
IDEA中的建造者模式代码生成插件
杂货铺的少掌柜
06-08 1037
Mac 电脑按快捷键 Command + N 弹出如下弹窗。插件名称：Builder Generator。选 Builder 后弹出如下弹窗。作用：帮助生成建造者模式的代码。配置项不多，自己试试。
mybatis-generator代码生成插件
m0_61035392的博客
08-18 1164
一，背景 mybatis-generator是一款在使用mybatis框架时，自动生成model，dao和mapper的工具，很大程度上减少了业务开发人员的手动编码时间，今天自己研究了一下，也分享一下使用心得供大家简单使用。 二，配置 1，首先在build中导入mybatis-generator-maven-plugin的插件（前置最好导入mysql-connector-java和mybatis-spring-boot-starter两个依赖，否则有可能出异常） <build>
Idea-使用MybatisX生成代码
weixin_47137972的博客
04-25 1126
首先使用Idea连接数据库。
mybatis plus generator设置代码生成器分布式多模块
weixin_39052568的博客
05-26 1567
从mybatis plus官网可以找到代码生成器的demo,我这里是是从官网上抄过来做了一些修改, package com.kfl; import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException; import com.baomidou.mybatisplus.core.toolkit.StringUtils; import com.baomidou.mybatisplus.generator.AutoGenerator; imp
idea mybatis自动生成xml插件
最新发布
08-01
要在Intellij IDEA中使用MyBatis自动生成XML插件，你可以按照以下步骤进行配置： 1. 在项目的pom.xml文件中添加MyBatis Generator插件的配置。你可以在标签中添加以下代码： ``` <groupId>org.mybatis.generator ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值