MyBatisX 是一款针对 MyBatis 的 IntelliJ IDEA 插件，旨在提高开发效率，帮助开发者快速生成 MyBatis 相关的代码，包括实体类、Mapper 接口和 XML 配置文件。
一、前置条件
• 开发环境：已安装 IntelliJ IDEA。
• 插件安装：在 IntelliJ IDEA 中安装 MyBatisX 插件。
• 打开 Settings/Preferences，导航到 Plugins。
• 搜索 MyBatisX，点击 Install 安装并重启 IDEA。
1、找到MybatisX 模板存放位置
路径: Project->Scratches and Consoles->Extensions->MyBatisX
2、模板文件介绍：
ftl文件： 使用的FreeMark模板语言
| 名称 | 含义 |
| tableClass.fullClassName | 类的全称(包括包名) |
| tableClass.shortClassName | 类的简称 |
| tableClass.tableName | 表名 |
| tableClass.pkFields | 表的所有主键字段 |
| tableClass.allFields | 表的所有字段 |
| tableClass.baseFields | 排除主键和 blob 的所有字段 |
| tableClass.baseBlobFields | 排除主键的所有字段 |
| tableClass.remark | 表注释 |
| 名称 | 含义 |
| field.fieldName | 字段名称 |
| field.columnName | 列名称 |
| field.jdbcType | jdbc 类型 |
| field.columnLength | 列段长度 |
| field.columnScale | 列的精度 |
| field.columnIsArray | 字段类型是不是数组类型 |
| field.shortTypeName | java 类型短名称, 通常用于定义字段 |
| field.fullTypeName | java 类型的长名称, 通常用于导入 |
| field.remark | 字段注释 |
| field.autoIncrement | 是否自增 |
| field.nullable | 是否允许为空 |
| 名称 | 含义 |
|---|---|
| baseInfo.shortClassName | 配置名称 |
| baseInfo.tableName | 配置文件名称 |
| baseInfo.pkFields | 配置名称 |
| baseInfo.allFields | 后缀 |
| baseInfo.baseFields | 包名 |
| baseInfo.baseBlobFields | 模板内容 |
| baseInfo.remark | 相对模块的资源文件路径 |
3、使用MybatisX进行生成
步骤一：配置数据库连接
1. 打开数据库工具窗口：
在 IntelliJ IDEA 界面的右侧，找到并打开 Database 工具窗口。如果没有看到，可以通过菜单 View > Tool Windows > Database 打开。
2. 添加数据源：
点击工具窗口左上角的 “+” 按钮，选择 Data Source，然后选择你的数据库类型（例如，MySQL、PostgreSQL 等）。
3. 填写连接信息：
在弹出的窗口中，填写数据库的连接信息，包括主机名、端口、数据库名、用户名和密码。
点击 Test Connection，确保连接成功。
4. 保存配置：
连接成功后，点击 OK 保存数据库连接。
步骤二：使用 MyBatisX 生成代码
1. 选择目标表：
在 Database 工具窗口中，展开刚刚配置的数据库连接，找到需要生成代码的表。
2. 开始生成：
右键点击目标表，选择 MyBatisX，然后点击 Generate Code。
步骤三：配置代码生成选项
在弹出的 Generate Code 配置窗口中，进行以下设置：
1. 选择生成内容：
Model：生成实体类。
Mapper Interface：生成 Mapper 接口。
Mapper XML：生成 Mapper XML 配置文件。
2. 指定包名和路径：
Model Package：设置实体类的包名，例如 com.example.model。
Mapper Package：设置 Mapper 接口的包名，例如 com.example.mapper。
XML Directory：设置 XML 配置文件的生成目录，一般位于 resources 文件夹下。
3. 命名策略：
Class Naming：设置实体类的命名规则，通常使用表名转大写驼峰。
Field Naming：设置字段的命名规则，通常使用列名转小写驼峰。
4. 类型映射：
检查数据库类型与 Java 类型的映射关系，确保数据类型正确转换。
5. 其他设置：
Use Lombok：是否使用 Lombok 注解简化代码。
Generate Comments：是否生成字段和方法的注释。
Override Existing Files：是否覆盖已存在的文件。
步骤四：生成代码
1. 确认配置：
检查所有设置，确保无误。
2. 执行生成：
点击 OK 按钮，MyBatisX 将开始生成代码。
3. 查看结果：
在项目中找到生成的实体类、Mapper 接口和 XML 配置文件，检查代码是否符合预期。
步骤五：调整和优化
1. 手动调整：
根据项目需求，对生成的代码进行必要的修改和优化。
2. 配置文件注册：
将生成的 Mapper 接口和 XML 配置文件在 MyBatis 的主配置文件（如 mybatis-config.xml）或框架配置中注册。
3. 测试运行：
编写单元测试或运行项目，确保生成的代码正常工作。
注意事项
Lombok 支持：如果选择使用 Lombok，需在项目中添加 Lombok 依赖，并在 IDEA 中安装 Lombok 插件。
多表生成：MyBatisX 支持同时为多个表生成代码，可在 Database 工具窗口中选中多个表后一起生成。
自定义模板：
MyBatisX 提供了模板功能，允许自定义代码生成的模板，以满足特殊的编码规范。
可以在插件设置中修改模板。
六、总结
使用 MyBatisX 可以大大简化 MyBatis 开发过程中繁琐的代码编写工作。通过上述流程，您可以快速生成符合项目需求的实体类、Mapper 接口和 XML 配置文件，提高开发效率。
最后.我定义好的模版
