MyBatis 的好帮手-MybatisX-CSDN博客

本文链接：https://blog.csdn.net/weixin_41559503/article/details/132057690

你是否碰见过这样的情况：

MybatisX 能很好的解决这些问题。

MybatisX 是一款基于 IDEA 的快速开发插件，通过对 MyBatis 和 MyBatis-Plus 的适配，实现 DTO、Xml、SQL 等模式化代码的一键生成，并可以定制化模板，是 Java 开发工程师的好帮手。

Intellij IDEA → Settings → Plugins → Marketplace → MybatisX → 重启 IDEA

安装完插件需要重启，另外如果进入不了 Marketplace 可以尝试挂代理

在这里插入图片描述

Database → 点击➕号 → Data Source → MySQL → 填写数据库信息 → Apply → Make Global → OK

不要忘记点击 Make Global 按钮，不然每一个工程都要进行数据源配置，非常麻烦

在这里插入图片描述

选择数据源 → 点击 Data Source Properties（或者数据源后的 1 of xxx） → Schemas →选择数据源

这一步主要是为了查找方便，常用的数据库一般就几个，只勾选常用的利于操作

在这里插入图片描述

在 Mapper 层中点点击这个按钮可以直接跳转到对应的 Xml 或者 SQL 语句
在这里插入图片描述

在这里插入图片描述

可以生成 Mapper 层、Xml、DTO 代码，并可以指定生成的模板、路径、语句等，非常便捷，是核心功能
表 → 右键 → MybatisX-Generator
在这里插入图片描述

标签	解释
module path	模块路径。点击编辑框可以选择在哪个模块里生成代码。
base package	基础包名。在基础路径的基础上生成的包名。
base path	基础路径。在模块路径的基础上生成的包名。
relative package	相对包名。DTO 对象会在这里生成。
encoding	编码格式，默认 UTF-8。
extra class suffix	附加类后缀。DTO 的类名会在生成后添加指定的后缀。
ignore filed prefix	忽略字段前缀。DTO 的字段会在生成后删除指定的前缀。
ignore filed suffix	忽略字段后缀。DTO 的字段会在生成后删除指定的后缀。
class name strategy	类名生成策略。可选：camel（驼峰结构）和 same as tablename（与表名相同）
superClass	DTO 对象继承的父类。
ignore table prefix	忽略表前缀。DTO 的类名会在生成后删除指定的前缀。
ignore table suffix	忽略表后缀。DTO 的类名会在生成后删除指定的后缀。

在这里插入图片描述

点击 Next，进入 Mapper 和 Xml 的设置

标签	解释
annotation	注解类型。目前支持四种注解：None（无注解）、Mybatis-Plus 3、Mybatis-Plust 2、JPA，如果没有使用直接选 None 即可。
options	额外的一些选项。Comment（注释，建议勾选）；toString/hashCode/equals（重写这些方法，根据需要勾选）；Lombok（使用 Lombok 注解方式，如果使用了 Lombok 建议勾选）；Actual Column（实际列名，比如 user_name 列对应的属性也叫 user_name，不勾选就是；userName，不建议勾选）；Actual Column Annotation（添加列注解，建议勾选）；JSR310：Date API（是否选用新标准的时间 API，建议勾选）；Model（是否生成 DTO 模型，根据需要勾选）
template	生成模板。custom-model-swagger（属性上会自动增加 swagger 的相关注解）；default-all（生成所有常用的 curd 方法，包括 Mapper 和 Xml）；default-empty（生成的 Mapper 和 Xml 没有方法）；mybatis-plus2；mybatis-plus3

在这里插入图片描述

注意在生成过程中要保持数据源的连接状态，不然无法生成

重置模板功能可以自定义生成的 Xml 文件，或者刷新最新版本的模板格式
Project → Scratches and Consoles → Extensions → MyBatisX → templates
在这里插入图片描述

刷新默认的模板需要先删除模板文件，如删除 defalut-all，然后右键 templates → Restore Default Extensions
自定义模板内容

字段信息

配置信息