【亲测免费】 MyBatis Generator 插件使用指南

项目介绍

MyBatis Generator (MBG) 是一个用于自动生成 MyBatis 相关代码的工具，可以大大减少开发人员的工作量。itfsw/mybatis-generator-plugin 是一个增强版的 MyBatis Generator 插件，提供了更多的功能和灵活性。

项目快速启动

安装

首先，确保你已经安装了 Java 和 Maven。然后，将以下依赖添加到你的 pom.xml 文件中：

<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.4.0</version>
</dependency>
<dependency>
    <groupId>com.itfsw</groupId>
    <artifactId>mybatis-generator-plugin</artifactId>
    <version>1.3.8</version>
</dependency>

配置

创建一个 generatorConfig.xml 文件，配置 MyBatis Generator 的生成规则。以下是一个简单的示例：

<?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>
    <context id="mysql" targetRuntime="MyBatis3">
        <plugin type="com.itfsw.mybatis.generator.plugins.ExampleTargetPlugin">
            <property name="targetPackage" value="com.example.mybatis.example"/>
        </plugin>

        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/mydb"
                        userId="root"
                        password="root">
        </jdbcConnection>

        <javaModelGenerator targetPackage="com.example.mybatis.model" targetProject="src/main/java"/>
        <sqlMapGenerator targetPackage="com.example.mybatis.mapper" targetProject="src/main/resources"/>
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mybatis.mapper" targetProject="src/main/java"/>

        <table tableName="user" domainObjectName="User"/>
    </context>
</generatorConfiguration>

运行

在命令行中运行以下命令来生成代码：

mvn mybatis-generator:generate

应用案例和最佳实践

案例一：简单的用户管理系统

假设我们有一个简单的用户管理系统，包含用户表 user，我们可以使用 MyBatis Generator 插件生成对应的 Model、Mapper 和 Example 类。

最佳实践

1. 分包管理：使用 ExampleTargetPlugin 将 Example 类独立到一个新包下，方便管理和查看。
2. 自定义插件：根据项目需求，开发和使用自定义插件，增强 MyBatis Generator 的功能。
3. 代码生成策略：合理配置 generatorConfig.xml，避免生成冗余代码。

典型生态项目

MyBatis Generator 插件可以与以下项目结合使用，提升开发效率：

1. Spring Boot：结合 Spring Boot 快速搭建项目框架。
2. MyBatis Plus：提供更多的 MyBatis 增强功能。
3. Lombok：减少样板代码，提升开发效率。

通过以上步骤，你可以快速上手并使用 itfsw/mybatis-generator-plugin 插件，提升 MyBatis 项目的开发效率。