Mybatis官方生成器入门教程

Mybatis官方生成器(Mybatis Generator, 简称MBG)是一个基于Apache Maven的开源代码生成工具，能够自动生成Java实体类、Mapper接口和XML映射文件，简化数据持久化开发工作。MBG广泛应用于Java Web开发，特别是在使用Mybatis时，其高效性和灵活性显著提高了开发效率。通过MBG，开发者可以快速生成符合项目需求的代码，同时保持代码的高度可维护性和可扩展性。

Mybatis官方生成器简介

什么是Mybatis官方生成器

Mybatis官方生成器(Mybatis Generator, 简称MBG)是一个开源的代码生成工具，它基于Apache Maven构建，能够根据数据库表自动生成对应的Java实体类、Mapper接口、XML映射文件等。MBG广泛应用于Java Web开发中，特别是在使用Mybatis进行数据持久化开发时。

MBG的作用和优势

Mybatis官方生成器的主要作用是自动化代码生成，这极大地简化了数据持久化层的开发工作。通过MBG，开发者可以快速地生成符合项目需求的Java类和映射文件，节省大量手动编写代码的时间，提高开发效率。MBG生成的代码具有高度的可维护性和可扩展性，方便开发者在后续维护中进行修改和扩展。

MBG的优势在于：

• 高效性：自动化生成代码，减少手动编码的时间和错误。
• 一致性：生成的代码遵循一致的命名规范和结构。
• 灵活性：支持自定义生成规则和配置选项，满足不同项目的需求。
• 可维护性：生成的代码易于理解和维护。
• 扩展性：可以方便地扩展和修改生成的代码。

MBG适用于所有使用Mybatis进行数据访问的项目，特别适用于那些需要频繁与数据库交互的系统，例如企业级应用、在线商城、社交平台等。

安装和配置Mybatis官方生成器

为了使用Mybatis官方生成器，首先需要在项目中引入MBG的依赖。以下是配置步骤：

1. 引入Maven依赖：在项目的pom.xml文件中添加mybatis-generator-core的依赖。示例如下：

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

1. 编写生成器配置文件：创建一个配置文件，通常是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.dtd">
<generatorConfiguration>
    <context id="DB2Tables" targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="true" />
        </commentGenerator>
        <jdbcConnection driverType="Derby">
            <property name="connectionURL" value="jdbc:derby://localhost:1527/sample" />
            <property name="driverClass" value="org.apache.derby.jdbc.ClientDriver" />
            <property name="password" value="app" />
            <property name="userId" value="app" />
        </jdbcConnection>
        <javaModelGenerator targetPackage="com.example.model" targetProject="/Users/example/workspace/mybatis-example/src/main/java">
            <property name="enableSubPackages" value="true" />
            <property name="trimStrings" value="true" />
            <property name="suppressAllComments" value="true" />
        </javaModelGenerator>
        <sqlMapGenerator targetPackage="com.example.mapper" targetProject="/Users/example/workspace/mybatis-example/src/main/resources">
            <property name="enableSubPackages" value="true" />
            <property name="suppressAllComments" value="true" />
        </sqlMapGenerator>
        <javaClientGenerator type="ANNOTATEDMAPPER" targetPackage="com.example.mapper" targetProject="/Users/example/workspace/mybatis-example/src/main/java">
            <property name="enableSubPackages" value="true" />
            <property name="suppressAllComments" value="true" />
        </javaClientGenerator>
    </context>
</generatorConfiguration>

1. 执行生成器：通过Maven命令执行MBG。在命令行中执行以下命令：

mvn mybatis-generator:generate

执行后，MBG将根据配置文件生成相应的Java类和映射文件。

生成基本的数据库实体类

使用Mybatis官方生成器生成实体类

在配置好MBG后，可以使用它生成数据库表对应的Java实体类。这些实体类用于映射数据库中的表结构，使得Java代码可以方便地与数据库进行交互。

例如，假设有一个名为User的数据库表，包含id、username、email等字段。MBG将根据这些字段，生成对应的User实体类。生成的实体类通常包含一些默认或自定义的方法，如getId()、setId()等。

MBG生成的实体类示例如下：

public class User {
    private Integer id;
    private String username;
    private String email;

    // Getters and Setters
    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }
}

查看和修改生成的实体类

生成器生成的实体类位于指定的包路径下，例如com.example.model。可以通过IDE直接访问这些类，进行查看和修改。例如，可以在生成的User类中添加自定义的方法或属性。以下是一个修改示例：

public class User {
    private Integer id;
    private String username;
    private String email;

    // Getters and Setters
    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    // 自定义方法
    public String getFullName() {
        return username + " (" + email + ")";
    }
}

生成Mapper接口和XML映射文件

介绍Mapper接口和XML映射文件

在Mybatis中，Mapper接口用于定义一系列CRUD操作，而XML映射文件则定义了这些操作的具体SQL语句。两者结合使用，可以实现灵活高效的数据访问。

Mapper接口示例如下：

public interface UserMapper {
    User selectUserById(Integer id);
    void insertUser(User user);
    void updateUser(User user);
    void deleteUser(Integer id);
}

对应的XML映射文件示例如下：

<mapper namespace="com.example.mapper.UserMapper">
    <select id="selectUserById" resultType="com.example.model.User">
        SELECT * FROM User WHERE id = #{id}
    </select>
    <insert id="insertUser">
        INSERT INTO User (id, username, email) VALUES (#{id}, #{username}, #{email})
    </insert>
    <update id="updateUser">
        UPDATE User SET username=#{username}, email=#{email} WHERE id=#{id}
    </update>
    <delete id="deleteUser">
        DELETE FROM User WHERE id=#{id}
    </delete>
</mapper>

使用Mybatis官方生成器生成Mapper接口和XML映射文件

在配置文件中，通过javaClientGenerator和sqlMapGenerator标签来指定生成Mapper接口和XML映射文件。以下是配置文件中相关配置的示例：

<javaClientGenerator type="ANNOTATEDMAPPER" targetPackage="com.example.mapper" targetProject="/Users/example/workspace/mybatis-example/src/main/java">
    <property name="enableSubPackages" value="true" />
    <property name="suppressAllComments" value="true" />
</javaClientGenerator>
<sqlMapGenerator targetPackage="com.example.mapper" targetProject="/Users/example/workspace/mybatis-example/src/main/resources">
    <property name="enableSubPackages" value="true" />
    <property name="suppressAllComments" value="true" />
</sqlMapGenerator>

MBG会生成如上述所示的Mapper接口和XML映射文件。生成的Mapper接口通常会包含一些基本的CRUD方法，例如selectUserById、insertUser、updateUser和deleteUser。

自定义Mapper接口和XML文件的生成规则

MBG允许自定义生成器的配置，以满足不同项目的需求。可以通过配置文件中的属性来控制生成的Mapper接口和XML文件的具体规则。以下是一些常用的配置选项及其说明：

<javaClientGenerator type="ANNOTATEDMAPPER" targetPackage="com.example.mapper" targetProject="/Users/example/workspace/mybatis-example/src/main/java">
    <property name="enableSubPackages" value="true" />
    <property name="suppressAllComments" value="true" />
</javaClientGenerator>
<sqlMapGenerator targetPackage="com.example.mapper" targetProject="/Users/example/workspace/mybatis-example/src/main/resources">
    <property name="enableSubPackages" value="true" />
    <property name="suppressAllComments" value="true" />
</sqlMapGenerator>

以上配置指定了Mapper接口和XML映射文件的位置、是否启用子包、是否生成注释等。可以根据项目需求，自定义生成器的行为。

使用Mybatis官方生成器生成CRUD操作代码

生成CRUD操作的概述

CRUD（Create、Read、Update、Delete）操作是数据持久化中的基本功能。Mybatis官方生成器可以自动生成这些操作的代码，从而简化开发工作。

MBG生成的CRUD操作代码通常包括：

• 创建（Create）：插入新记录
• 读取（Read）：查询记录
• 更新（Update）：修改记录
• 删除（Delete）：删除记录

这些操作分别对应于insertUser、selectUserById、updateUser和deleteUser等方法。

自动生成增删改查方法

MBG在生成Mapper接口时，会根据数据库表的字段自动生成一系列CRUD方法。例如，对于User表，生成的Mapper接口可能包含以下方法：

public interface UserMapper {
    User selectUserById(Integer id);
    List<User> selectAllUsers();
    void insertUser(User user);
    void updateUser(User user);
    void deleteUser(Integer id);
}

这些方法的实现会生成在对应的XML映射文件中，例如：

<mapper namespace="com.example.mapper.UserMapper">
    <select id="selectAllUsers" resultType="com.example.model.User">
        SELECT * FROM User
    </select>
    <select id="selectUserById" resultType="com.example.model.User">
        SELECT * FROM User WHERE id = #{id}
    </select>
    <insert id="insertUser">
        INSERT INTO User (id, username, email) VALUES (#{id}, #{username}, #{email})
    </insert>
    <update id="updateUser">
        UPDATE User SET username=#{username}, email=#{email} WHERE id=#{id}
    </update>
    <delete id="deleteUser">
        DELETE FROM User WHERE id=#{id}
    </delete>
</mapper>

了解生成的CRUD操作代码的工作原理

生成的CRUD操作代码遵循Mybatis的编程模型。例如，selectUserById方法通过调用<select>标签定义的SQL语句查询数据库，并返回一个User对象。以下是selectUserById方法的实现细节：

public User selectUserById(Integer id) {
    User user = new User();
    SqlSession session = sqlSessionFactory.openSession();
    try {
        user = session.selectOne("com.example.mapper.UserMapper.selectUserById", id);
    } finally {
        session.close();
    }
    return user;
}

selectOne方法通过传入的SQL语句ID（即<select>标签的id属性）和参数（如id）来执行查询操作。生成的Mapper接口和XML文件自动处理了SQL语句的执行和结果的映射，简化了开发工作。

Mybatis官方生成器的高级配置

介绍Mybatis官方生成器的配置选项

Mybatis官方生成器提供了丰富的配置选项，用于定制生成的代码。以下是一些常用的配置选项：

• enableSubPackages：是否启用子包。例如，可以根据数据库表的命名空间生成子包。
• trimStrings：是否启用字符串截断。这会影响生成的实体类中字符串字段的处理方式。
• suppressAllComments：是否关闭注释生成。注释通常包含表描述、字段描述等信息。
• javaModelGenerator：定义实体类生成的配置，包括目标包、项目路径等。
• javaClientGenerator：定义Mapper接口生成的配置，包括目标包、项目路径、生成类型等。
• sqlMapGenerator：定义XML映射文件生成的配置，包括目标包、项目路径等。

如何自定义生成器的配置文件

MBG的配置文件generatorConfig.xml定义了所有生成器的行为。可以在配置文件中添加或修改这些配置选项。例如，修改实体类的生成规则：

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

这样的配置使生成的实体类符合项目特定的要求。

生成器配置的高级技巧和最佳实践

1. 子包的使用：通过设置enableSubPackages属性，可以将生成的类根据数据库命名空间进行分类。例如，可以将不同的数据库表生成到不同的子包中，提高代码的组织性。

2. 注释的管理：通过设置suppressAllComments属性，可以控制是否生成注释。注释可以提供额外的元数据信息，但在某些情况下，生成的注释可能会影响代码的整洁性。

3. 类型和字段映射：可以通过自定义配置，控制生成器如何处理数据库字段类型和Java类型之间的映射。例如，可以自动将数据库中的VARCHAR类型映射为Java的String类型。

4. 自定义命名规则：通过<property>标签定义自定义的命名规则，以生成符合项目规范的类名和方法名。例如，可以将数据库字段名从first_name映射为firstName。

5. 扩展插件：MBG支持通过插件机制进行扩展，允许开发者编写自定义的插件来增强生成器的功能。例如，可以编写插件自定义生成器的行为，使其更好地适应项目需求。

这些高级配置技巧有助于提高生成器的灵活性和适应性，使生成的代码更加符合项目的需求。

常见问题与解答

常见的配置错误及解决办法

1. 数据库连接失败：

   • 确保配置文件中的数据库连接信息（如连接URL、驱动类、用户名和密码）正确无误。
   • 检查数据库服务是否正常运行。

2. 生成的代码不符合预期：

   • 检查配置文件中的生成器配置选项，确保它们符合项目的需求。
   • 确保生成器版本与Mybatis版本兼容。
3. 生成的代码存在编译错误：
   • 检查生成的代码的包名、文件路径是否正确。
   • 确保项目的依赖库完整，特别是Mybatis和MBG的依赖库。

生成代码时遇到的问题及解决方法

1. 生成的类名冲突：

   • 通过配置<property>标签中的命名规则，自定义生成的类名，避免冲突。
   • 使用子包技术，将不同的数据库表生成到不同的子包中。

2. 生成的映射文件错误：

   • 检查配置文件中的sqlMapGenerator部分的配置。
   • 确保生成器生成的XML文件路径正确，并且与Mapper接口对应。
3. 生成的Mapper接口方法缺失：
   • 检查配置文件中的javaClientGenerator部分的配置。
   • 确保生成器生成的Mapper接口方法符合预期的操作。

如何获取更多的帮助和资源

1. 官方文档和社区：

   • 官方文档提供了详细的配置指南和示例，帮助解决常见问题。
   • Mybatis和MBG的社区论坛提供丰富的讨论和解决方案，可以获取更多帮助。

2. 在线学习资源：

   • 慕课网 提供了丰富的Mybatis和MBG相关的在线课程，帮助开发者深入学习和掌握这些工具。
3. 代码示例和实战项目：
   • 参考开源项目中的MBG配置和使用，可以更好地理解其应用和最佳实践。