李林超博客
首页
归档
留言
友链
动态
关于
归档
留言
友链
动态
关于
首页
Java
正文
09.MyBatisX插件介绍
Leefs
2022-12-24 PM
1265℃
0条
[TOC] ### 一、介绍 MybatisX是一款基于 IDEA 的快速开发插件，方便在使用mybatis以及mybatis-plus开始时简化繁琐的重复操作，提高开发速率。 **使用MybatisX的好处** - 节省大量持久层代码开发时间 - 强大的功能为业务编写提供各类支持 - 配置简单，告别各类复杂的配置文件 MyBatisX插件用法：https://baomidou.com/pages/ba5b24/ ### 二、安装方法 > 打开 IDEA，进入 File -> Settings -> Plugins -> Marketplace，输入 `mybatisx` 搜索并安装。  注意：本人使用的IDEA版本是2022.3版本，搜索对应的MyBatisX插件也是最新版的1.5.5。 #### 安装遇到的坑 因为本人之间使用的IDEA是2018.3版本，该版本对应的MyBatisX插件为v 0.1.0版本，此版本的MyBatisX除了跳转功能外，其他功能都不太好使。  本人尝试了通过官网下载MyBatisX插件，然后手动本地导入到IDEA中，但是因为IDEA版本太低，高版本的MyBatisX插件无法和IDEA兼容，导入失败。 无奈之下为了演示MyBatisX插件所具备的完整功能，将IDEA更新到了2022.3版。 最后在多说一句，2022.3版IDEA真香！！！ ### 三、生成代码功能 #### 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选项，弹出如下界面**  **部分参数说明** | 参数 | 说明 | | ------------------ | ------------------------------------------------------------ | | module path | 模块路径，此处填写项目所在路径，生成的代码会在相应位置 | | base package | 填写项目的包 | | encoding | 编码，使用UTF-8即可 | | base path | 代码所在路径 | | relative package | 决定实体类会被生成在哪里，默认生成在domain包中，可以修改为其他包但不要为空 | | extra class suffix | 生成的实体类后面会加上里面的内容。举例：图中如果这里写入Test，最后生成实体类会叫FilesTest | | ignore xxx | 生成实体类相应字段中忽略指定的前缀/后缀 | | superClass | 生成实体类继承的父类 | 根据自身项目填写相应信息  **（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即完成对应代码的生成。** ### 四、其他基础功能 #### 4.1 xml跳转 添加插件后在DAO层会多一只戴红色头巾的小鸟，同样在对应xml文件方法前也会对应一只戴蓝色头巾的小鸟，点击即可在dao和xml文件之间跳转  #### 4.2 自动生成映射方法 在DAO中写好对应方法后,按**Alt+Enter**选择自动生成就能自动在xml中生成对应的映射方法  **UserMapper.xml中**  剩下的直接写SQL就好了。 #### 4.3 重置模板 > IDEA左下角，选择Scratches and Consoles -> Extensions -> MyBatisX 右键选择【Restore ...】即可重置所有的模版  ### 五、JPA 提示 代码自动补全，同时在xml中生成对应的SQL语句 > 本次只以新增为例进行演示 > > 详细操作可以直接查看官方文档：https://baomidou.com/pages/ba5b24/#%E5%8A%9F%E8%83%BD #### 生成新增 + 在相应的Mapper接口中写入MyBatisX提示的新增方法，比如`insertSelective` + 然后右键，选择【Show Context Actions】。或者直接使用快捷键【Alt + Enter】  + 选择【Generate MyBatis Sql】  **会自动生成相应代码** + **UserMapper接口**  + **UserMapper.xml**  *附参考文章链接* *https://baomidou.com/pages/ba5b24* *https://blog.csdn.net/qq_56393773/article/details/125706384*
标签:
MyBatis
,
MyBatis-Plus
,
MyBatisX
非特殊说明，本博所有文章均为博主原创。
如若转载，请注明出处：
https://lilinchao.com/archives/2718.html
上一篇
08.MyBatis-Plus多数据源
下一篇
01.Nacos介绍
取消回复
评论啦~
提交评论
栏目分类
随笔
2
Java
326
大数据
229
工具
31
其它
25
GO
40
标签云
NIO
JVM
数学
排序
Map
前端
Spring
容器深入研究
递归
Spark Core
稀疏数组
持有对象
并发编程
Thymeleaf
Hadoop
序列化和反序列化
RSA加解密
并发线程
设计模式
哈希表
DataWarehouse
Http
Kafka
数据结构和算法
DataX
国产数据库改造
MyBatis-Plus
nginx
Elasticsearch
Ubuntu
友情链接
申请
范明明
庄严博客
Mx
陶小桃Blog
虫洞