Mybatis-generator/通用Mapper/Mybatis-Plus对比

你的名字 2022-03-14 17:20 325阅读 0赞

# 1. Mybatis-generator #

MyBatis Generator（MBG）是MyBatis MyBatis 和iBATIS的代码生成器。它为所有版本的MyBatis以及版本2.2.0之后的iBATIS版本生成代码。它将根据数据库表生成可用于访问表的文件。

Mybatis-generator主要完成的工作是依据数据库表创建对应的model、dao、mapping文件，可以通过Maven插件或者mybatis-generator的jar包生成。

这里介绍Maven插件使用方法：

1.  在pom.xml文件中加入mybatis-generator系列插件；
2.  创建generatorConfig.xml文件，在配置文件中指定数据库连接地址、生成类的存放地址、生成对应表的类名等信息；![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTI0NTg2_size_16_color_FFFFFF_t_70][]
3.  执行mybatis-generator插件，即可生成相应文件；
4.  此外，mybatis-generator自动生成了example类用于构造复杂的筛选条件，详细用法可以参考 [http://www.mybatis.org/generator/generatedobjects/exampleClassUsage.html][http_www.mybatis.org_generator_generatedobjects_exampleClassUsage.html] 。

Mybatis-generator使用较为简单，生成的DAO类及映射文件中包含基本的CRUD操作。需要注意的是，在一次项目中避免多次执行mybatis-generator，即应当尽量在数据库表建立完整并且确定不会修改之后执行mabatis-generator，否则再次执行会覆盖原本的Model、DAO和映射文件的文件夹（踩过的坑）。

插件使用参考 [https://blog.csdn.net/pucao\_cug/article/details/64499355][https_blog.csdn.net_pucao_cug_article_details_64499355] 。

# 2. 通用Mapper #

首先我们来看一下通用Mapper官方给出的用途

![201903081514000.png][]

正如之前提到的，当数据库字段变化频繁时，使用MBG（mybatis-generator）会带来大量的重构工作，对此，通用Mapper给出的解决办法是：给予开发者一个具备丰富的单表方法并且容易扩展的通用的Mapper。

通用Mapper是对单表的CRUD操作进行了较为详细的实现，使得开发人员可以随意的按照自己的需求选择通用的方法，同时允许开发人员便捷地对通用Mapper进行扩展。

先看一下通用Mapper在Maven项目中的配置：

1. 在pom.xml中添加插件配置

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTI0NTg2_size_16_color_FFFFFF_t_70 1][]

可以看到，通用Mapper的代码生成实际上是使用了MGB，因此通用Mapper的代码生成器只是调用了MGB，然后在这个基础上加入了一些元素来方便开发。

2. 来看一下配置文件generatorConfig.xml

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTI0NTg2_size_16_color_FFFFFF_t_70 2][]

与MGB原有的配置文件相比，这里只是多了一个插件的配置，这个插件的作用是：配置生成的Mapper接口都会自动继承这个接口，也就是说，使用通用Mapper生成的mapper接口即使看上去空空如也，但已经具备了大量的对数据库的操作方法。此外，通用 Mapper 专用代码生成器生成的 Model 会在原有基础上增加 @Table,@Id,@Column 等注解，方便自动与数据库字段进行映射。

3. 在 pom.xml 这一级目录的命令行窗口执行 mvn mybatis-generator:generate或者直接在执行mvn插件即可。

4. 通用Mapper同样有Example的设计，与MGB不同的是，MDB会对每一个表生成对应的Example类，而通用Mapper提供了一个统一的Example类，这个类和 MBG 生成的相比，需要自己设置属性名，这个类还额外提供了更多的方法。

通用Mapper可以看作是MGB的改进和扩展，一定程度上解决了使用MGB重构的问题。

更多详细的使用可以参考官方文档：[https://github.com/abel533/Mapper/wiki][https_github.com_abel533_Mapper_wiki] 。

# 3. Mybatis-Plus #

Mybatis-Plus（以下简称MP）是Mybatis的增强工具（MBG和通用Mapper可看成插件），在Mybatis的基础上增加了很多功能，简化开发，提高效率。

先看看MB在Spring Boot中的引入：

1. 在maven中添加MP启动器

![20190308151818496.png][]

2. 要使用代码生成器还需要添加模板引擎依赖

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTI0NTg2_size_16_color_FFFFFF_t_70 3][]

3. pom.xml到这里已经配置完成了，下面进行代码的自动生成。AutoGenerator是MP的代码生成器，通过调用AutoGenerator，进行相应的模板、策略配置可以快速生成Entity、Mapper、Mapper XML、Service、Controller各个模块的代码。

AutoGenerator的使用参考 [https://mybatis.plus/guide/generator.html][https_mybatis.plus_guide_generator.html] 。

4. MP将通用的CRUD操作封装进BaseMapper接口，而自动生成的Mapper接口便自动继承了BaseMapper接口。复杂的Sql操作，则可以使用QueryWrapper(LambdaQueryWrapper) 和 UpdateWrapper(LambdaUpdateWrapper)进行动态Sql拼接。

5. 此外，MP还支持分页、逻辑删除、通用枚举、Sql注入等功能，在博客

[https://blog.csdn.net/qq\_32867467/article/details/82944674][https_blog.csdn.net_qq_32867467_article_details_82944674]中说的较为详细。

6. 值得一提的是，MP提供了性能分析插件，能够输出每条SQL语句及其执行时间，使用它需要在xml中添加相应的插件信息

![20190308151921116.png][]

然后在config文件中添加插件

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTI0NTg2_size_16_color_FFFFFF_t_70 4][]

与MBG不同，使用Mybatis-Plus自动生成代码需要编写代码，通过调用AutoAutoGenerator类实现代码生成，从这方面来说不如使用插件方便。但是它丰富的功能以及只是相对复杂的配置还是使它领先于MBG以及通用Mapper。

# 三款框架的功能对比 #

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:88.7pt;"> &nbsp; </td> 
 <td style="vertical-align:top;width:110.7pt;"> Mybatis-generator </td> 
 <td style="vertical-align:top;width:107pt;"> 通用Mapper </td> 
 <td style="vertical-align:top;width:108.4pt;"> Mybatis-Plus </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:88.7pt;"> 代码生成器 </td> 
 <td style="vertical-align:top;width:110.7pt;"> 支持自动生成Model,Mapper,Mapper XML文件 生成方式不够灵活； 生成代码功能较为简单 </td> 
 <td style="vertical-align:top;width:107pt;"> 支持自动生成Entity,Mapper,Mapper XML文件； 提供通用的Mapper模板，生成方式较灵活； 生成的Model文件包含注释能够很好地与数据库表完成映射 </td> 
 <td style="vertical-align:top;width:108.4pt;"> 支持自动生成Entity,Mapper,Mapper XML,Service,Controller文件； 提供BaseMapper接口 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:88.7pt;"> CRUD操作 </td> 
 <td style="vertical-align:top;width:110.7pt;"> 代码生成后每个Mapper有固定的CRUD方法； 在每个Mapper上分别扩展 </td> 
 <td style="vertical-align:top;width:107pt;"> 提供通用Mapper接口； 可以扩展通用接口 </td> 
 <td style="vertical-align:top;width:108.4pt;"> 提供BaseMapper接口； 可以扩展通用接口 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:88.7pt;"> 条件构造器 </td> 
 <td style="vertical-align:top;width:110.7pt;"> 每个实体类自己的Example构造条件 </td> 
 <td style="vertical-align:top;width:107pt;"> 提供通用Example </td> 
 <td style="vertical-align:top;width:108.4pt;"> 提供Wrapper进行复杂条件构造 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:88.7pt;"> 乐观锁 </td> 
 <td style="vertical-align:top;width:110.7pt;"> &nbsp; </td> 
 <td style="vertical-align:top;width:107pt;"> 支持 </td> 
 <td style="vertical-align:top;width:108.4pt;"> 支持 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:88.7pt;"> 主键策略 </td> 
 <td style="vertical-align:top;width:110.7pt;"> &nbsp; </td> 
 <td style="vertical-align:top;width:107pt;"> 支持 </td> 
 <td style="vertical-align:top;width:108.4pt;"> 支持 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:88.7pt;"> 分页 </td> 
 <td style="vertical-align:top;width:110.7pt;"> &nbsp; </td> 
 <td style="vertical-align:top;width:107pt;"> &nbsp; </td> 
 <td style="vertical-align:top;width:108.4pt;"> 支持 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:88.7pt;"> 逻辑删除 </td> 
 <td style="vertical-align:top;width:110.7pt;"> &nbsp; </td> 
 <td style="vertical-align:top;width:107pt;"> &nbsp; </td> 
 <td style="vertical-align:top;width:108.4pt;"> 支持 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:88.7pt;"> 通用枚举 </td> 
 <td style="vertical-align:top;width:110.7pt;"> &nbsp; </td> 
 <td style="vertical-align:top;width:107pt;"> &nbsp; </td> 
 <td style="vertical-align:top;width:108.4pt;"> 支持 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:88.7pt;"> 攻击Sql阻断 </td> 
 <td style="vertical-align:top;width:110.7pt;"> &nbsp; </td> 
 <td style="vertical-align:top;width:107pt;"> &nbsp; </td> 
 <td style="vertical-align:top;width:108.4pt;"> 支持 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;width:88.7pt;"> 性能分析 </td> 
 <td style="vertical-align:top;width:110.7pt;"> &nbsp; </td> 
 <td style="vertical-align:top;width:107pt;"> &nbsp; </td> 
 <td style="vertical-align:top;width:108.4pt;"> 支持 </td> 
 </tr> 
 </tbody> 
</table>

总结一下，通用Mapper是对Mybatis-generator的升级改造，解决了使用Mybatis-generator可能需要大量重构的问题，并且在这个基础上加入了一些新的功能。Mybatis-Plus可以看作是在另一个方向上对Mybatis的升级改造，不仅能够根据数据库表快速生成pojo实体类，还封装了大量CRUD方法，使用Wrapper解决了复杂条件构造等问题，更是根据开发中常见的问题给出了一系列解决方案。

在拥有Maven和Spring boot的开发框架下，MBG、通用Mapper和MP都可以快速地完成安装，相比于MBG和通用Mapper仅需要执行插件就可以完成基本的开发工作，MP可能需要更多的开发工作量。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTI0NTg2_size_16_color_FFFFFF_t_70]: /images/20220311/e1b6f2c7cb40403888dd615247196833.png
[http_www.mybatis.org_generator_generatedobjects_exampleClassUsage.html]: http://www.mybatis.org/generator/generatedobjects/exampleClassUsage.html
[https_blog.csdn.net_pucao_cug_article_details_64499355]: https://blog.csdn.net/pucao_cug/article/details/64499355
[201903081514000.png]: /images/20220311/9f952a0e2810490cae0f955f06a47a09.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTI0NTg2_size_16_color_FFFFFF_t_70 1]: /images/20220311/b4ed5a83334847e6b264b61069c272c1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTI0NTg2_size_16_color_FFFFFF_t_70 2]: /images/20220311/df3fc413a9f147a79b89465637f7635c.png
[https_github.com_abel533_Mapper_wiki]: https://github.com/abel533/Mapper/wiki
[20190308151818496.png]: /images/20220311/06525870eab64101b4a29a6f7eb447d9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTI0NTg2_size_16_color_FFFFFF_t_70 3]: /images/20220311/55ae9f5faeba432a9f6511ff9ad40c16.png
[https_mybatis.plus_guide_generator.html]: https://mybatis.plus/guide/generator.html
[https_blog.csdn.net_qq_32867467_article_details_82944674]: https://blog.csdn.net/qq_32867467/article/details/82944674
[20190308151921116.png]: /images/20220311/5477717bf29b4185a49021a1998af98b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTI0NTg2_size_16_color_FFFFFF_t_70 4]: /images/20220311/a32dacca9815499f98a0c7588e525349.png