MyBatisX插件介绍

mystery007

已于 2023-08-07 13:15:41 修改

阅读量3.5k

点赞数 3

文章标签： mybatis

于 2023-08-07 13:14:03 首次发布

原文链接：https://lilinchao.com/archives/2718.html

版权

一、介绍

MybatisX是一款基于 IDEA 的快速开发插件，方便在使用mybatis以及mybatis-plus开始时简化繁琐的重复操作，提高开发速率。

使用MybatisX的好处：
节省大量持久层代码开发时间
强大的功能为业务编写提供各类支持
配置简单，告别各类复杂的配置文件
MyBatisX插件用法：官网

二、安装方法

打开 IDEA，进入 File -> Settings -> Plugins -> Marketplace，输入 mybatisx 搜索并安装。
在这里插入图片描述
注意：使用的IDEA版本要适应MyBatisX插件版本。

三、生成代码功能

3.1 在idea配置Database数据源

（1）连接MySQL数据源

选择IDEA右侧导航栏的Database
点击【+】添加 Data Source数据源连接
选择要连接的数据库类型，本次使用的是MySQL数据库
在这里插入图片描述
（2）填入MySQL数据库连接信息，然后进行测试连接

注意：本次使用的是MySQL 5.7版本，在URL中需要增加上characterEncoding=utf-8&useSSL=false，不然测试连接会报错。

3.2 生成代码

（1）在idea中配置好数据源，右键需要生成代码的表名，点击MybatisX-Generator选项，弹出如下界面
在这里插入图片描述
部分参数说明

根据自身项目填写相应信息

在这里插入图片描述
（2）点击next后，下一步为生成mapper、service等

在这里插入图片描述
参数说明

annotation：生成的代码中是否加上注解（例如，@TableName等注解）。None为没有注解，其他为字面意思。

options各选项作用大致如下

comment：可能和生成java doc comments有关，但试了下，好像没有效果。

toString/hashCode/equals：是否生成相应的方法；建议勾选。

Lombok：勾选后实体类自动添加Lombok的@Data注解；建议勾选（建议安装Lombok）

Actual Column：勾选后，生成的实体类属性名和表中字段名大小写会保持一致。例如，表中有字段classID，勾选该选项后生成的属性名也为classID，未勾选则为classid。建议根据实际需要勾选。

Actual Column Annotation：是否对所有属性名都加上注解标明对应字段，例如@TableName。建议勾选。

JSR310:Data API：是否使用新标准的时间日期API，包括 Instant、Clock、LocalDateTime、DateTimeFormatter、ZonedDateTime 以及替换 Calendar 的 Chronology 等类。建议勾选（新标准的时间日期API比老版本友好多了，强烈建议使用新版时间日期API）。

template：生成mapper、service等相关代码所使用的模板。template可以修改，默认位于草稿和控制台——扩展——MybatisX 。对应文件夹内即为相关模板的具体配置文件。如果需要重置，右键template文件夹点击重置默认扩展即可。

如果没有使用MybatisPlus，可以选择default-empty模板。或自定义其他模板。

Model：是否生成实体类，如果不勾选则不会生成相应的实体类；建议勾选。

最底下的表：显示所要生成文件的类型、模块路径、基本路径、生成后位于哪个包。

后面三个列都可以修改值以符合项目需要。这些也可以在对应的template的文件夹内的.meta.xml中进行修改。

（3）点击Finish即完成对应代码的生成。