mybatis generator代码生成器的安装与配置

# 1. 简介

## 1.1 MyBatis Generator 是什么？

MyBatis Generator（简称 MBG）是一个基于Java的代码生成器，可以根据数据库表结构自动生成对应的Java Model类、SQL Map文件和DAO接口。通过简单的配置，可以提高开发效率，减少重复劳动。

## 1.2 为什么选择MyBatis Generator？

MyBatis Generator具有以下优点：
- 自动生成代码，减少开发人员的重复工作
- 与MyBatis框架无缝整合，提供了精确的SQL控制
- 支持定制化配置，适应不同项目需求
- 易于学习和上手，减少学习成本，提高项目开发速度

## 环境准备

MyBatis Generator 代码生成器的安装与配置需要进行一些环境准备工作，主要包括JDK的安装与配置以及MyBatis Generator的下载与安装。

### 2.1 JDK的安装与配置

在安装 MyBatis Generator 之前，首先需要安装并配置好 Java Development Kit（JDK）。可以按照以下步骤进行安装与配置：

1. 访问 Oracle 官网（https://www.oracle.com/java/technologies/javase-jdk11-downloads.html）下载适用于您操作系统的 JDK 安装包；
2. 安装 JDK，并配置环境变量，设置JAVA_HOME为JDK的安装路径；
3. 确保 JDK 安装成功，打开命令行窗口，输入 java -version 和 javac -version 命令，查看是否能输出相应的版本信息。

### 2.2 MyBatis Generator的下载与安装

MyBatis Generator 是一个独立的工具，它并不依赖于 MyBatis 或者其他任何的类库，因此可以非常方便地集成到 Java 项目中。在开始使用 MyBatis Generator 之前，需要进行下载并安装：

1. 访问 MyBatis Generator 官方网站（https://mybatis.org/generator/）下载最新版本的 MyBatis Generator；
2. 解压下载的压缩包到您选择的安装目录；
3. 配置环境变量，将 MyBatis Generator 的 bin 目录添加到系统的 PATH 环境变量中，这样在命令行中就可以直接执行 MyBatis Generator 相关的命令。

完成了环境准备工作后，就可以开始配置数据库连接信息并进行代码生成了。
**3. 数据库连接配置**

在使用MyBatis Generator之前，我们需要先配置数据库连接信息，以便生成器能够正确读取数据库的结构信息。

---
#### 3.1 配置数据库连接信息

在MyBatis Generator中，可以通过在`generatorConfig.xml`文件中配置数据库连接信息，示例如下：

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

在上述示例中，我们使用了MySQL数据库，数据库连接URL为`jdbc:mysql://localhost:3306/mydatabase`，用户名为`root`，密码为`123456`。其中，`driverClass`指定了数据库驱动的类名，这里使用的是MySQL的驱动类。

除了MySQL数据库，MyBatis Generator还支持多种数据库，如Oracle、PostgreSQL等，只需将`driverClass`和`connectionURL`修改为对应的数据库驱动和连接信息即可。

---
#### 3.2 配置数据库驱动

在配置数据库连接信息的同时，我们还需要将相应的数据库驱动添加到我们的项目中。以MySQL数据库为例，我们可以在`pom.xml`文件中添加以下依赖：

<!-- MySQL数据库驱动 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.15</version>
</dependency>

上述示例中使用的是MySQL Connector/J驱动，版本为8.0.15。根据自己使用的数据库类型和版本，可以选择对应的数据库驱动。

完成了数据库连接信息的配置和数据库驱动的添加后，我们就可以开始配置生成器的参数，以便根据数据库结构生成相应的代码。

---

### 4. 生成器的配置

MyBatis Generator 可以通过配置文件进行生成器参数配置，包括 Java Model 类的生成配置、SQL Map 文件的生成配置、DAO 接口的生成配置等。在这一章节中，我们将详细介绍如何进行生成器的配置。

#### 4.1 通过XML配置文件进行生成器参数配置

在 MyBatis Generator 中，通过创建一个 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="DB2Tables" targetRuntime="MyBatis3">
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/mybatis"
                        userId="root"
                        password="password">
        </jdbcConnection>

        <!-- 定义生成的实体类的包名和存储路径 -->
        <javaModelGenerator targetPackage="com.example.model"
                            targetProject="src/main/java">
        </javaModelGenerator>

        <!-- 定义生成的映射文件的包名和存储路径 -->
        <sqlMapGenerator targetPackage="mapper"
                         targetProject="src/main/resources">
        </sqlMapGenerator>

        <!-- 定义生成的DAO接口的包名和存储路径 -->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.example.dao"
                             targetProject="src/main/java">
        </javaClientGenerator>

        <!-- 定义要生成的表 -->
        <table tableName="user" domainObjectName="User">
        </table>
    </context>
</generatorConfiguration>

在这个示例中，我们定义了一个名为 "DB2Tables" 的上下文，指定了数据库连接信息、生成的实体类、映射文件和DAO接口的包名和存储路径，以及要生成的表信息。通过这样的配置文件，我们可以灵活地配置生成器的参数。

#### 4.2 Java Model 类的生成配置

通过 MyBatis Generator 的配置，可以定制生成的 Java Model 类的规则，包括类的注释、成员变量名的转换规则、是否使用序列化等。例如，可以通过以下配置设置生成的 Java Model 类：

<javaModelGenerator targetPackage="com.example.model"
                    targetProject="src/main/java">
    <property name="enableSubPackages" value="true"/>
    <property name="trimStrings" value="true"/>
</javaModelGenerator>

#### 4.3 SQL Map 文件的生成配置

SQL Map 文件是 MyBatis 中的映射文件，也可以通过配置定制生成规则。例如，可以配置生成的 SQL Map 文件：

<sqlMapGenerator targetPackage="mapper"
                 targetProject="src/main/resources">
    <property name="enableSubPackages" value="true"/>
</sqlMapGenerator>

#### 4.4 DAO 接口的生成配置

最后，我们可以通过配置生成的 DAO 接口。可以定制生成的接口类型、包名和存储路径，例如：

<javaClientGenerator type="XMLMAPPER"
                     targetPackage="com.example.dao"
                     targetProject="src/main/java">
    <property name="enableSubPackages" value="true"/>
</javaClientGenerator>

## 5. 生成器的使用

在前面的章节中，我们已经完成了MyBatis Generator的安装和配置。现在我们将介绍如何使用生成器来生成代码。

### 5.1 命令行使用 MyBatis Generator

MyBatis Generator提供了一个命令行工具，可以通过命令行来生成代码。首先，打开命令行工具进入MyBatis Generator的安装目录。

#### 5.1.1 生成器配置文件

在命令行工具中，我们需要通过指定一个配置文件来告诉生成器需要生成哪些内容以及生成的参数配置。生成器配置文件是一个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>
    <context id="default" targetRuntime="MyBatis3Simple">
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/test?useSSL=false" userId="root" password="root" />

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

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

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

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

在上面的配置文件中，我们指定了数据库连接信息、生成的Java Model类、SQL Map文件、DAO接口的包名和路径等信息。此外，我们还指定了要生成的表名和对应的实体类名。

#### 5.1.2 执行生成命令

在命令行中，我们可以使用以下命令来执行生成器：

java -jar mybatis-generator-core-x.x.x.jar -configfile generatorConfig.xml

其中，`mybatis-generator-core-x.x.x.jar`是MyBatis Generator的JAR文件，`generatorConfig.xml`是生成器配置文件。

执行上述命令后，生成器就会根据配置文件进行代码的生成。生成的代码将会按照配置文件中的路径和包名结构生成在指定的目录中。

### 5.2 在Java项目中使用 MyBatis Generator

除了命令行工具，MyBatis Generator还提供了一个Java API，可以在Java项目中通过代码来调用生成器。

以下是一个简单的Java代码示例：

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

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

public class MyBatisGeneratorApplication {

    public static void main(String[] args) throws Exception {
        List<String> warnings = new ArrayList<>();
        boolean overwrite = true;
        InputStream configFile = MyBatisGeneratorApplication.class.getResourceAsStream("/generatorConfig.xml");
        ConfigurationParser cp = new ConfigurationParser(warnings);
        Configuration config = cp.parseConfiguration(configFile);
        DefaultShellCallback callback = new DefaultShellCallback(overwrite);
        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        myBatisGenerator.generate(null);
    }
}

在上面的代码中，我们通过解析配置文件生成了一个`Configuration`对象，然后使用`DefaultShellCallback`对象来指定是否覆盖已存在的文件。最后，通过`MyBatisGenerator`对象的`generate`方法来执行生成操作。

运行上述代码后，生成器将会根据配置文件进行代码的生成。

到此为止，我们已经介绍了如何使用命令行工具和Java API来使用MyBatis Generator生成代码。

## 6. 实战案例

在本章节中，我们将通过一个实际案例来演示如何使用MyBatis Generator进行代码生成，并介绍如何优化配置和生成结果的调整。

### 6.1 通过实际案例演示MyBatis Generator的使用

假设我们有一个名为"User"的数据库表，表结构如下：

CREATE TABLE User (
  id INT(11) PRIMARY KEY AUTO_INCREMENT,
  username VARCHAR(50) NOT NULL,
  password VARCHAR(50) NOT NULL,
  email VARCHAR(100),
  created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
  updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
);

我们希望使用MyBatis Generator生成对应的Java Model类、SQL Map文件和DAO接口。

首先，我们需要在Generator配置文件中进行相应的配置。打开"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>
  <context id="DB2Tables" targetRuntime="MyBatis3">
    <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                    connectionURL="jdbc:mysql://localhost:3306/db_example"
                    userId="root"
                    password="password">
    </jdbcConnection>

    <javaModelGenerator targetPackage="com.example.model"
                        targetProject="src/main/java">
        <property name="enableSubPackages" value="true"/>
        <property name="trimStrings" value="true"/>
    </javaModelGenerator>

    <sqlMapGenerator targetPackage="com.example.mapper"
                     targetProject="src/main/resources">
        <property name="enableSubPackages" value="true"/>
    </sqlMapGenerator>
  
    <javaClientGenerator type="XMLMAPPER"
                         targetPackage="com.example.mapper"
                         targetProject="src/main/java">
        <property name="enableSubPackages" value="true"/>
    </javaClientGenerator>
  
    <table tableName="User"
           domainObjectName="User"
           mapperName="UserMapper"
           sqlProviderName="UserSqlProvider">
    </table>
  </context>
</generatorConfiguration>

注意，上述配置需要根据实际情况进行调整，比如数据库连接信息、Java包名等。

保存配置文件后，我们可以通过执行以下命令来生成代码：

java -jar mybatis-generator-core-x.x.x.jar -configfile generatorConfig.xml -overwrite

其中，"mybatis-generator-core-x.x.x.jar"为MyBatis Generator的执行文件的路径，可以根据实际情况进行调整。

生成的代码将会被输出到指定的目录下，我们可以在相应的目录中找到生成的Java Model类、SQL Map文件和DAO接口。

### 6.2 优化配置和生成结果的调整

在使用MyBatis Generator时，我们可以通过调整配置来优化生成的结果。下面是一些常见的优化配置和调整方式：

- 使用外部配置文件：将Generator的配置项放在外部的XML或properties文件中，方便管理和修改。
- 定制模板：通过修改模板文件，可以根据自己的需求生成更符合项目规范的代码。
- 选择生成的内容：根据需求，可以只生成部分表的代码，避免不必要的代码生成和文件生成。
- 配置生成文件的编码：根据项目需要，我们可以配置生成的代码文件的编码格式，确保文件的正确编码。
- 添加注释和文档：在生成的代码中添加注释和文档，方便维护和理解代码。

通过不断优化配置和调整，我们可以使用MyBatis Generator生成更符合项目需求的代码，并提高开发效率。

## 结论