Mybatis代码生成器入门教程

概述

Mybatis代码生成器是一个用于自动生成Mybatis框架所需代码的工具，能够根据数据库表自动生成Mapper接口、XML映射文件和实体类，从而大大提高开发效率。使用该工具可以减少开发人员的手动编写代码的工作量，降低错误率，并且易于维护。Mybatis代码生成器支持多种数据库，适应不同的开发环境。

Mybatis代码生成器简介 什么是Mybatis代码生成器

Mybatis代码生成器是一个用于自动生成Mybatis框架所需代码的工具，它能够根据数据库表自动生成Mybatis的Mapper接口、对应的XML映射文件以及实体类。这使得开发人员可以大大减少重复的手动编写代码的工作量，从而提高开发效率。

Mybatis代码生成器的作用

Mybatis代码生成器的主要作用是提高开发效率。通过自动生成Mapper接口、XML映射文件和实体类，开发人员可以快速地构建数据库访问层，而无需手动编写这些基础代码。这不仅减少了重复劳动，还降低了代码出错的可能性。

Mybatis代码生成器的优势

Mybatis代码生成器的优势主要体现在以下几个方面：

1. 提高开发效率：自动生成的代码减少了开发人员的手动编写工作，使得开发更加高效。
2. 减少错误：自动生成的代码避免了人工编写可能引入的错误，提高了代码质量。
3. 易于维护：通过代码生成器生成的代码结构一致，易于理解和维护。
4. 支持多种数据库：代码生成器支持多种数据库，包括MySQL、Oracle、SQL Server等，可以适应不同的开发环境。

安装与环境搭建 准备开发环境

在开始使用Mybatis代码生成器之前，需要确保开发环境已经搭建好。以下是推荐的开发环境配置：

• 操作系统：Windows、Linux或macOS
• Java版本：JDK 1.8及以上版本
• IDE：Eclipse、IntelliJ IDEA或其他Java开发工具
• Mybatis版本：3.x.x及以上版本
• 数据库：MySQL、Oracle、SQL Server等

安装Java环境和选择合适的IDE，确保IDE已经配置好Java环境。安装Mybatis框架，可以通过Maven或Gradle依赖管理工具来引入Mybatis依赖。

Maven引入Mybatis依赖

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.6</version>
</dependency>

安装Mybatis代码生成器插件

Mybatis代码生成器插件可以通过多种方式安装，例如安装插件到IDE中，或者在项目中引入相关的依赖。以下是几种常见的安装方式：

安装到IDE

对于Eclipse、IntelliJ IDEA等IDE，可以下载Mybatis代码生成器插件的安装包，根据插件的安装指南进行安装。

引入Maven依赖

在项目中通过Maven引入Mybatis代码生成器依赖，示例如下：

<dependency>
    <groupId>tk.mybatis</groupId>
    <artifactId>mapper-generator</artifactId>
    <version>1.3.7</version>
</dependency>

Mybatis代码生成器的基本配置 配置文件详解

Mybatis代码生成器的配置文件通常是一个XML文件，位于项目的资源目录中。配置文件中定义了数据库连接、生成代码的输出目录、生成的代码模板等信息。以下是一个简单的配置文件示例：

<generatorConfiguration>
    <context id="DB2Tables" targetRuntime="MyBatis3Simple" defaultTableType="平铺策略">
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/test"
                        userId="root"
                        password="password">
        </jdbcConnection>
        <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"/>
    </context>
</generatorConfiguration>

数据库连接配置

数据库连接配置是配置文件中最为关键的部分之一。需要提供数据库驱动类、连接URL、用户名和密码等信息。示例如下：

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

生成代码的参数配置

生成代码的参数配置主要包括生成的代码目标包和输出路径等。通过配置这些参数，可以灵活地控制生成代码的位置和结构。示例如下：

<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"/>

使用Mybatis代码生成器生成代码 生成Mapper接口

Mapper接口是Mybatis中用于映射SQL语句的Java接口。使用Mybatis代码生成器可以自动生成Mapper接口，示例如下：

public interface UserMapper {
    User selectUser(int id);
    int insertUser(User user);
    int updateUser(User user);
    int deleteUser(int id);
}

生成对应的XML映射文件

生成的XML映射文件包含了SQL语句的映射。示例如下：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.mapper.UserMapper">
    <select id="selectUser" resultType="User">
        SELECT * FROM users WHERE id = #{id}
    </select>
    <insert id="insertUser" parameterType="User">
        INSERT INTO users (id, name, email) VALUES (#{id}, #{name}, #{email})
    </insert>
    <update id="updateUser" parameterType="User">
        UPDATE users SET name = #{name}, email = #{email} WHERE id = #{id}
    </update>
    <delete id="deleteUser" parameterType="int">
        DELETE FROM users WHERE id = #{id}
    </delete>
</mapper>

生成实体类

生成的实体类是数据库表对应的Java类。示例如下：

public class User {
    private int id;
    private String name;
    private String email;

    public int getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getEmail() {
        return email;
    }

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

自定义生成的代码 修改模板来自定义生成的代码结构

Mybatis代码生成器提供了丰富的模板配置选项，可以通过修改模板来自定义生成的代码结构。例如，可以通过修改模板来控制生成的Mapper接口的命名规则，或者自定义生成的XML映射文件的内容。

自定义Mapper接口模板

可以在配置文件中指定Mapper接口的模板文件路径，示例如下：

<javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java" mapperTemplate="templates/UserMapper.java">
    <property name="enableCache" value="false"/>
    <property name="enableResultMap" value="false"/>
    <property name="enableConstructor" value="false"/>
    <property name="enableUseGeneratedKeys" value="false"/>
</javaClientGenerator>

自定义XML映射文件模板

同样，可以通过配置XML映射文件的模板来控制生成的内容，示例如下：

<sqlMapGenerator targetPackage="com.example.mapper" targetProject="src/main/resources" sqlMapTemplate="templates/UserMapper.xml">
</sqlMapGenerator>

自定义生成的代码内容

除了修改模板来自定义生成的代码结构，还可以通过配置生成代码的内容来满足特定的需求。例如，可以通过配置生成的实体类是否包含特定的字段，或者是否生成特定的SQL语句。

配置实体类字段

可以在配置文件中指定生成的实体类包含哪些字段，示例如下：

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

配置生成的SQL语句

可以通过配置生成的XML映射文件来控制生成的SQL语句的内容，示例如下：

<sqlMapGenerator targetPackage="com.example.mapper" targetProject="src/main/resources">
    <property name="enableSubPackages" value="true"/>
    <property name="trimStrings" value="true"/>
    <property name="sqlMapPackage" value="com.example.mapper"/>
    <property name="sqlMapType" value="XML"/>
</sqlMapGenerator>

实例分析 项目实例

为了更好地理解Mybatis代码生成器的使用，我们可以通过一个简单的实例来演示其配置和使用过程。假设我们有一个名为users的数据库表，包含id、name、email三个字段。以下是配置文件和生成代码的示例。

配置文件

<generatorConfiguration>
    <context id="DB2Tables" targetRuntime="MyBatis3Simple" defaultTableType="平铺策略">
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/test"
                        userId="root"
                        password="password">
        </jdbcConnection>
        <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"/>
    </context>
</generatorConfiguration>

生成的Mapper接口

public interface UserMapper {
    User selectUser(int id);
    int insertUser(User user);
    int updateUser(User user);
    int deleteUser(int id);
}

生成的XML映射文件

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.mapper.UserMapper">
    <select id="selectUser" resultType="User">
        SELECT * FROM users WHERE id = #{id}
    </select>
    <insert id="insertUser" parameterType="User">
        INSERT INTO users (id, name, email) VALUES (#{id}, #{name}, #{email})
    </insert>
    <update id="updateUser" parameterType="User">
        UPDATE users SET name = #{name}, email = #{email} WHERE id = #{id}
    </update>
    <delete id="deleteUser" parameterType="int">
        DELETE FROM users WHERE id = #{id}
    </delete>
</mapper>

生成的实体类

public class User {
    private int id;
    private String name;
    private String email;

    public int getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getEmail() {
        return email;
    }

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

常见问题与解决方法 代码生成失败的原因分析

代码生成失败的原因可能包括配置文件错误、数据库连接失败、生成代码的输出路径不存在等。以下是一些常见的错误原因及解决方法：

配置文件错误

检查配置文件中的数据库连接信息是否正确，包括驱动类、连接URL、用户名和密码等。确保所有配置项都正确无误。

数据库连接失败

确保数据库服务已经启动，并且可以通过提供的连接信息成功连接到数据库。检查数据库连接URL、用户名和密码是否正确。

输出路径不存在

确保生成代码的输出路径存在，并且具有写权限。可以在IDE中手动创建输出路径，或者在配置文件中指定正确的输出路径。

解决生成代码中常见的问题

生成代码中常见的问题包括Mapper接口中没有定义某些方法、生成的实体类缺少某些字段等。可以通过修改配置文件中的参数来解决这些问题。

缺少Mapper接口方法

如果生成的Mapper接口缺少某些方法，可以在配置文件中指定生成的Mapper接口的方法模板，示例如下：

<javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java" mapperTemplate="templates/UserMapper.java">
    <property name="enableCache" value="false"/>
    <property name="enableResultMap" value="false"/>
    <property name="enableConstructor" value="false"/>
    <property name="enableUseGeneratedKeys" value="false"/>
</javaClientGenerator>

缺少实体类字段

如果生成的实体类缺少某些字段，可以在配置文件中指定生成的实体类的模板文件路径，示例如下：

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