使用mybatis generator生成简单的CRUD代码

# 1. 介绍MyBatis Generator

## 1.1 MyBatis Generator的概述

MyBatis Generator（简称MBG）是一个可以根据数据库表自动生成对应的实体类、DAO接口以及映射文件的代码生成工具。它能够将数据库表结构映射成为实体类，并生成相应的CRUD（Create, Retrieve, Update, Delete）操作的DAO接口和映射文件，极大地提高了开发人员的效率。

## 1.2 为什么选择MyBatis Generator

在传统的开发模式中，开发人员需要手动编写实体类、DAO接口以及映射文件，这往往是一项繁琐且容易出错的工作。而MyBatis Generator可以自动帮助开发人员完成这部分工作，从而大大减轻了开发人员的负担，提高了开发效率。

## 1.3 MyBatis Generator的特点和优势

MyBatis Generator的特点和优势主要包括：
- 自动生成代码：根据数据库表结构自动生成对应的实体类、DAO接口和映射文件，省去了手动编写的繁琐过程。
- 可定制性强：可以通过配置文件对生成的代码进行定制，满足不同项目的需求。
- 提高开发效率：避免了重复性的开发工作，减少了人为出错的可能性，提高了开发效率。

### 2. 准备工作

在使用MyBatis Generator之前，我们需要进行一些准备工作，包括环境搭建、项目结构和依赖的配置以及数据库的准备。

#### 2.1 环境搭建

首先，确保你已经安装了Java开发环境（JDK）。然后，我们需要下载MyBatis Generator工具（通常是一个独立的JAR文件），并将其放置在合适的位置，比如项目的根目录或者专门的工具目录。

#### 2.2 项目结构和依赖

在你的项目中，需要引入MyBatis以及对应的数据库驱动，以及MyBatis Generator所需的相关依赖。如果你是使用Maven进行项目管理，可以在`pom.xml`文件中配置相关的依赖项。

<dependencies>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.23</version>
    </dependency>
    <!-- MyBatis Generator 相关依赖 -->
    <dependency>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-core</artifactId>
        <version>1.4.0</version>
    </dependency>
</dependencies>

#### 2.3 数据库准备

在开始之前，你需要准备好要生成代码的数据库。确保你已经创建了相应的数据库和表结构，以便MyBatis Generator可以根据表结构生成相应的代码。

### 3. 配置MyBatis Generator

在使用MyBatis Generator之前，我们需要进行相应的配置，以便生成符合我们需求的代码。

#### 3.1 GeneratorConfig.xml详解

MyBatis Generator的配置文件是一个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>
    <context id="default" targetRuntime="MyBatis3">
        <!-- 生成代码的目标路径 -->
        <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"/>

        <!-- 数据库连接配置 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/mybatis_example"
            userId="root" password="root"/>

        <!-- 数据库表结构映射配置 -->
        <table tableName="user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false"
            enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/>
    </context>
</generatorConfiguration>

以上是一个典型的`generatorConfig.xml`文件的示例，下面我们逐个解析其中的配置项。

首先是配置生成代码的目标路径，分别对应生成的Java模型(`javaModelGenerator`)、数据库映射文件(`sqlMapGenerator`)和Java接口文件(`javaClientGenerator`)。我们需要根据项目的结构来设置正确的目标路径。比如上述示例中的示意图，Java模型生成的包名是`com.example.model`，生成文件的目标路径在`src/main/java`下。

然后是配置数据库连接信息，包括数据库驱动类(`driverClass`)、连接URL(`connectionURL`)、用户名(`userId`)和密码(`password`)。

最后是配置具体的数据库表结构映射，我们需要指定要生成代码的表名(`tableName`)和对应的Java模型类名(`domainObjectName`)。除此之外，还可以根据需要启用或禁用一些生成的方法，比如根据条件查询、更新等。

#### 3.2 数据库连接配置

MyBatis Generator需要连接数据库来获取表结构信息，并根据配置生成相应的代码。在`generatorConfig.xml`文件中，我们需要配置相应的数据库连接信息。

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

在上述示例中，我们使用了MySQL数据库，并指定了相应的驱动类(`driverClass`)、连接URL(`connectionURL`)、用户名(`userId`)和密码(`password`)。根据实际情况来修改这些信息，确保能够成功连接到数据库。

#### 3.3 数据库表结构映射配置

在`generatorConfig.xml`文件中，我们还需要配置要生成的数据库表结构映射。

<table tableName="user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false"
    enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/>

在上述示例中，我们配置了一张表的映射信息。`tableName`是表名，`domainObjectName`是生成的Java模型类名。除此之外，还可以根据需要启用或禁用一些生成的方法，比如根据条件查询、更新等。

根据实际需求，可以在`generatorConfig.xml`中配置多个表的映射信息。

### 4. 生成简单的CRUD代码

MyBatis Generator 可以帮助我们自动生成简单的 CRUD 代码，包括单表的增删改查操作，多表关联查询以及自定义查询语句。在这一章节中，我们将详细介绍如何使用 MyBatis Generator 生成各种类型的代码。

#### 4.1 生成单表的CRUD代码

首先，我们需要配置 MyBatis Generator，指定需要生成代码的数据库表和对应的实体类。然后我们可以使用 MyBatis Generator 自动生成基本的增删改查代码。

// 示例代码：生成单表的CRUD代码
public interface UserMapper {
    int deleteByPrimaryKey(Integer id);

    int insert(User record);

    int insertSelective(User record);

    User selectByPrimaryKey(Integer id);

    int updateByPrimaryKeySelective(User record);

    int updateByPrimaryKey(User record);
}

在上面的示例中，我们可以看到通过 MyBatis Generator 自动生成了 `UserMapper` 接口，其中包含了基本的增删改查方法。

#### 4.2 生成多表关联查询代码

除了生成单表的CRUD代码，MyBatis Generator 还可以根据数据库表之间的关联关系，生成多表关联查询的代码。我们可以在配置文件中定义表的关联关系，然后生成对应的查询代码。

// 示例代码：生成多表关联查询代码
public interface OrderMapper {
    List<Order> selectOrderWithUser();
}

在上面的示例中，`OrderMapper` 接口中的 `selectOrderWithUser` 方法就是通过 MyBatis Generator 自动生成的多表关联查询代码。

#### 4.3 生成自定义查询语句代码

有时候，我们需要执行一些复杂的自定义查询语句，比如统计某个条件下的记录数量，分页查询等等。MyBatis Generator 也能够帮助我们生成这样的自定义查询代码。

// 示例代码：生成自定义查询语句代码
public interface UserMapper {
    int countByAgeGreaterThan(Integer age);

    List<User> selectByPage(int offset, int limit);
}

在上面的示例中，`UserMapper` 接口中的 `countByAgeGreaterThan` 和 `selectByPage` 方法就是通过 MyBatis Generator 自动生成的自定义查询语句代码。

### 5. 使用生成的代码

在前面我们已经介绍了如何配置和生成MyBatis Generator的代码，接下来我们将详细讨论如何使用生成的代码。

#### 5.1 DAO层的使用

在生成的代码中，DAO层是与数据库交互的层，我们可以直接使用自动生成的DAO接口和实体类来进行数据库的CRUD操作。

// 示例代码，使用自动生成的UserDAO进行数据库操作
User user = new User();
user.setUsername("Alice");
user.setPassword("123456");
userDAO.insert(user);  // 插入数据

User userById = userDAO.selectByPrimaryKey(1);  // 根据主键查询数据

userById.setUsername("Bob");
userDAO.updateByPrimaryKey(userById);  // 更新数据

userDAO.deleteByPrimaryKey(1);  // 删除数据

#### 5.2 Service层的使用

Service层是业务逻辑的处理层，我们可以在Service层进行一些复杂的业务逻辑处理，然后调用DAO层的方法来操作数据库。

// 示例代码，使用自动生成的UserService进行业务逻辑处理
public void updateUserPassword(int userId, String newPassword) {
    User user = userDAO.selectByPrimaryKey(userId);
    user.setPassword(newPassword);
    userDAO.updateByPrimaryKey(user);
    
    // 其他业务逻辑处理...
}

#### 5.3 Controller层的使用

Controller层接受前端的请求，并调用Service层的方法来处理业务逻辑，然后返回结果给前端。

// 示例代码，使用自动生成的UserController处理前端请求
@RestController
@RequestMapping("/user")
public class UserController {
    
    @Autowired
    private UserService userService;
    
    @PostMapping("/updatePassword")
    public String updatePassword(@RequestParam("userId") int userId, @RequestParam("newPassword") String newPassword) {
        userService.updateUserPassword(userId, newPassword);
        return "Password updated successfully";
    }

    // 其他接口处理...
}

通过以上示例代码，可以看到我们可以直接使用MyBatis Generator生成的DAO接口和实体类进行数据库操作，同时在Service和Controller层进行业务逻辑的处理和接口的实现。这样可以大大减少重复的CRUD代码，提高开发效率。

在实际使用过程中，我们可以根据业务需求对自动生成的代码进行修改和扩展，但 MyBatis Generator生成的代码为我们提供了一个很好的基础。
## 6. 总结和扩展

在本文中，我们介绍了MyBatis Generator的概述，并讨论了为什么选择使用它以及其特点和优势。接着，我们进行了准备工作，包括环境搭建、项目结构和依赖、数据库准备。

然后，我们详细讲解了如何配置MyBatis Generator，包括GeneratorConfig.xml的详解、数据库连接配置和数据库表结构映射配置。

接下来，我们展示了如何使用MyBatis Generator生成简单的CRUD代码。首先，我们生成了单表的CRUD代码，包括插入、查询、更新和删除操作。接着，我们学习了如何生成多表关联查询代码，通过一些配置示例展示了不同的关联查询方式。最后，我们还演示了生成自定义查询语句代码的方法，让我们可以根据自己的需求编写复杂的查询语句。

在生成了代码之后，我们学习了如何使用生成的代码。我们介绍了DAO层的使用，通过调用自动生成的DAO类中的方法来实现对数据库的操作。然后，我们讨论了Service层的使用，包括如何封装业务逻辑和事务管理等。最后，我们探讨了Controller层的使用，展示了如何接收请求、调用Service层方法并返回响应。

总体来说，MyBatis Generator是一个非常强大和方便的工具，可以大大提高我们的开发效率。然而，它也存在一些局限性。比如，生成的代码可能不够灵活，难以满足某些特殊需求；而且对于复杂的数据库表结构映射和关联查询，可能需要手动编写SQL语句。

建议在以下场景使用MyBatis Generator：
- 数据库表结构相对简单且不频繁变更的项目；
- 需要快速生成基本的CRUD代码的项目；
- 需要自动生成部分SQL语句的项目。

在使用MyBatis Generator时，需要注意以下事项：
- 配置文件的编写要准确无误，特别是数据库连接配置和表结构映射配置；
- 生成的代码需要进行适当的修改和扩展，以满足具体的业务需求；
- 当数据库表结构发生变化时，需要及时更新相关的配置。

尽管MyBatis Generator已经非常好用，但仍有一些扩展和改进的空间。比如，可以增加更多的配置选项，支持更灵活的代码生成方式；还可以提供更好的集成和扩展机制，方便与其他框架和工具的集成。

希望本文能帮助你理解和使用MyBatis Generator，提高开发效率并提升项目质量。如果有任何疑问或建议，请随时与我们联系。

谢谢阅读！