5.6 Mybatis代码生成器Mybatis Generator (MBG)实战详解

Mybatis Generator（MBG）是一个强大的工具，可以帮助开发者快速生成MyBatis的映射文件和相应的Java代码。通过MBG，我们可以大幅度减少手动编写重复代码的工作，提高开发效率。在这篇文章中，我们将探讨MBG的使用，并提供一些代码示例，以帮助大家快速上手。

1. MBG简介

Mybatis Generator是MyBatis官方提供的代码生成工具，它能够根据数据库表的结构自动生成相应的Java模型、Mapper接口、XML映射文件等。MBG支持多种数据库，并且可以通过配置文件灵活地定制生成的代码。

2. Maven依赖

在使用MBG之前，我们需要在项目中引入MBG的相关依赖。如果您使用Maven进行项目管理，可以在pom.xml中添加以下依赖：

<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.4.0</version>
</dependency>

3. 配置文件

MBG的配置主要在generatorConfig.xml文件中，该文件用于描述数据库连接、需要生成的表、各类生成策略等。以下是一个示例配置文件：

<!DOCTYPE generatorConfiguration SYSTEM "http://mybatis.org/dtd/mybatis-generator-config_1_0_0.dtd">
<generatorConfiguration>
    <context id="myContext" targetRuntime="MyBatis3">
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/your_database"
                        userId="your_username"
                        password="your_password"/>

        <javaModelGenerator targetPackage="com.example.model" 
                            targetProject="src/main/java"/>

        <sqlMapGenerator targetPackage="com.example.mapper" 
                         targetProject="src/main/resources"/>

        <javaClientGenerator type="XMLMAPPER" 
                             targetPackage="com.example.mapper" 
                             targetProject="src/main/java"/>

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

在上面的配置中，我们指定了数据库的连接信息，Java模型、Mapper和XML映射文件生成的目标包和项目路径，以及要生成的表。

4. 执行代码生成

配置完成后，我们需要编写Java代码来执行MBG的生成流程。可以创建一个简单的Java类来执行：

import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.DefaultShellCallback;
import org.mybatis.generator.internal.DefaultMyBatisGenerator;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

public class Generator {
    public static void main(String[] args) {
        try {
            List<String> warnings = new ArrayList<>();
            boolean overwrite = true;
            File configFile = new File("src/main/resources/generatorConfig.xml");
            Configuration config = new ConfigurationParser(warnings).parseConfiguration(configFile);
            MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, new DefaultShellCallback(overwrite), warnings);
            myBatisGenerator.generate(null);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

在这个Generator类中，我们加载了配置文件并执行了代码生成。执行此程序后，所有配置的Java类和XML文件将自动生成在指定的目录中。

5. 生成后的代码示例

例如，生成的User模型类可能如下所示：

package com.example.model;

public class User {
    private Long id;
    private String username;
    private String password;

    // getters and setters
}

同时，生成的Mapper接口会类似于：

package com.example.mapper;

import com.example.model.User;
import java.util.List;

public interface UserMapper {
    int insert(User record);
    User selectByPrimaryKey(Long id);
    List<User> selectAll();
}

总结

Mybatis Generator是一个非常实用的工具，可以帮助开发者快速生成MyBatis所需的代码，大大提高开发效率。通过简单的配置文件和运行代码，开发者能够将繁琐的手动编码转化为自动化处理，使得数据库表的CRUD操作变得更加高效便捷。希望本文能帮助您快速上手MBG的使用。