MyBatis Generator Plugin 使用教程

MyBatis Generator Plugin 使用教程

1. 项目目录结构及介绍

本部分将概述kimichen13/mybatis-generator-plugin的项目布局，不过需注意，实际的链接指向了一个不存在的仓库地址，因此以下信息是基于常规MyBatis Generator插件的一般结构进行假设性的描述。若要获取具体项目的目录结构，请参考实际项目的Git仓库。

实际示例目录结构（假定）

mybatis-generator-plugin/
├── src
│   ├── main
│   │   └── java
│   │       └── com.example
│   │           ├── generator  // 自定义插件实现类存放处
│   │           └── config     // 配置相关类，如自定义配置处理器
│   └── resources
│       └── generatorConfig.xml  // MyBatis Generator配置文件
├── pom.xml                        // Maven项目配置文件
├── README.md                      // 项目说明文档
├── LICENSE                       // 许可证文件
└── ...

• src/main/java：包含项目的Java源码，其中generator目录下通常存放自定义的插件实现。
• src/resources/generatorConfig.xml：核心配置文件，用于指定数据库连接、表映射规则以及插件使用等关键设置。
• pom.xml：Maven项目的构建配置文件，包括依赖管理、编译指令等。
• README.md：项目简介、安装步骤、快速入门等重要指导信息。

2. 项目的启动文件介绍

由于这是一个插件而非独立运行的应用，没有传统意义上的“启动文件”。启动过程实际上是通过Maven或Gradle的任务来调用MyBatis Generator，生成对应的Java代码。在Maven中，这通常涉及到配置mybatis-generator-maven-plugin并在命令行执行mvn mybatis-generator:generate命令。以下是简化的Maven配置示例：

<!-- pom.xml 中的插件配置 -->
<build>
    <plugins>
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.x.x</version>
            <!-- 这里应添加相应版本 -->
            <executions>
                <execution>
                    <goals>
                        <goal>generate</goal>
                    </goals>
                </execution>
            </executions>
            <dependencies>
                <!-- 添加你的插件依赖 -->
            </dependencies>
        </plugin>
    </plugins>
</build>

3. 项目的配置文件介绍

generatorConfig.xml 示例结构

generatorConfig.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>

    <!-- 数据库连接 -->
    <databaseIdProvider type="DB_VENDOR">
        <property name="MySQL" value="mysql"/>
    </databaseIdProvider>
    
    <context id="DatabaseContext" targetRuntime="MyBatis3">
        <commentGenerator>
            <!-- 自定义注释生成器 -->
        </commentGenerator>
        
        <!-- JDBC连接 -->
        <jdbcConnection driverClass="${driver}" connectionURL="${url}"
                       userId="${username}" password="${password}"/>
        
        <!-- 生成模型的类 -->
        <javaModelGenerator targetPackage="your.package.name.model" targetProject="src/main/java">
            <!-- 配置策略 -->
        </javaModelGenerator>
        
        <!-- SQL映射文件 -->
        <sqlMapGenerator targetPackage="your.package.name.mapper" targetProject="src/main/resources">
            <!-- 配置 -->
        </sqlMapGenerator>
        
        <!-- 映射接口 -->
        <javaClientGenerator targetPackage="your.package.name.mapper" targetProject="src/main/java"
                            type="XMLMAPPER">
            <!-- 特殊配置 -->
        </javaClientGenerator>
        
        <!-- 表配置 -->
        <table tableName="example_table" domainObjectName="ExampleEntity">
            <!-- 可以指定自定义插件 -->
            <generatedKey column="id" sqlStatement="SELECT LAST_INSERT_ID()"/>
        </table>
    </context>

</generatorConfiguration>

• 数据库ID提供商：允许不同数据库有不同处理方式。
• JDBC连接：定义如何连接到数据库。
• 模型、SQL映射、接口生成器：指定生成的对象存储位置和命名空间。
• 表配置：指定需要处理的表及其细节，可以在此基础上应用特定的插件来定制行为。

请注意，上述内容中的具体细节需要依据实际项目需求调整。