mybatisx-generator lombok

### 集成 MyBatisX-Generator 和 Lombok MyBatisX 是基于 IntelliJ IDEA 的插件，用于简化 MyBatis 开发流程。它支持通过图形化界面快速生成 Mapper 文件、DAO 层代码以及对应的实体类。当与 Lombok 结合时，可以进一步减少样板代码的编写量。 #### Maven 或 Gradle 中引入依赖项 要实现 MyBatisX Generator 和 Lombok 的集成，首先需要确保项目中已经正确引入了必要的依赖项。以下是 Maven `pom.xml` 的配置示例： ```xml <dependencies> <!-- MyBatis Core --> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.5.9</version> </dependency> <!-- Lombok --> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.24</version> <scope>provided</scope> </dependency> <!-- MyBatis Generator Core --> <dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-core</artifactId> <version>1.4.0</version> </dependency> <!-- MyBatis Generator Lombok Plugin --> <dependency> <groupId>com.github.GuoGuiRong</groupId> <artifactId>mybatis-generator-lombok-plugin</artifactId> <version>1.0.0</version> </dependency> </dependencies> ``` 上述配置中的 `mybatis-generator-lombok-plugin` 提供了对 Lombok 注解的支持[^1]。 --- #### generatorConfig.xml 配置文件设置 在 `generatorConfig.xml` 文件中，需要显式声明启用 Lombok 插件并指定其路径。以下是一个完整的 XML 配置示例： ```xml <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"> <generatorConfiguration> <!-- 数据库驱动 --> <classPathEntry location="mysql-connector-java.jar"/> <context id="DB2Tables" targetRuntime="MyBatis3"> <!-- 添加 Lombok 插件 --> <plugin type="org.mybatis.generator.plugins.LombokPlugin"> <property name="hasLombok" value="true"/> </plugin> <!-- 自定义插件 (可选) --> <plugin type="com.github.GuoGuiRong.mybatismapper.plugin.MybatisMapperAnnotationPlugin"/> <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/testdb" userId="root" password="password"/> <javaModelGenerator targetPackage="com.example.model" targetProject="src/main/java"/> <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources"/> <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java"/> <table tableName="users" domainObjectName="User"/> </context> </generatorConfiguration> ``` 在此配置中，`<plugin>` 标签指定了 Lombok 插件及其参数[^4]。 --- #### 使用 MyBatisX 运行代码生成器 完成以上配置后，在 IntelliJ IDEA 中可以通过 MyBatisX 插件运行代码生成工具： 1. 打开菜单栏 **Tools -> MyBatisX -> Generate Code**。 2. 在弹出窗口中选择已配置好的 `generatorConfig.xml` 文件。 3. 单击执行按钮即可生成带有 Lombok 注解的 Java 实体类和其他相关代码。 --- #### 自动生成的结果样例 假设数据库表名为 `users`，字段包括 `id`, `name`, 和 `age`，则生成的 User 类可能如下所示： ```java import lombok.Data; @Data public class User { private Long id; private String name; private Integer age; } ``` 此代码片段展示了如何利用 Lombok 的 `@Data` 注解来替代手动编写的 getter 和 setter 方法[^2]。 --- #### 常见问题排查 如果遇到无法正常生成带 Lombok 注解的代码的情况，请检查以下几点： 1. 是否正确导入了 `mybatis-generator-lombok-plugin` 依赖。 2. `generatorConfig.xml` 文件中 `<plugin>` 标签的路径是否匹配实际使用的插件包名。 3. 确认 IDE 已经启用了 Lombok 支持（IntelliJ IDEA 设置路径为：Preferences -> Plugins -> Search "Lombok" 并安装）。 ---