Mybatis代码生成器学习：从入门到实践

本文介绍了Mybatis代码生成器的学习，包括代码生成器的作用、优势、选择方法以及如何进行基本配置和进阶使用，旨在提高开发效率和代码质量。通过Mybatis代码生成器，开发者可以自动生成POJO类、Mapper接口、XML映射文件和测试代码，减少手动编写代码的时间和错误。文章还详细讲解了常用的代码生成器工具及其配置方法，帮助读者更好地理解和应用Mybatis代码生成器。

Mybatis简介

Mybatis 是一个优秀的持久层框架，它支持定制化 SQL 查询，存储过程以及高级映射。与 JPA、Hibernate 等框架相比，Mybatis 是一个半自动化的框架，需要手动编写 SQL 语句，但同时也提供了更灵活的查询策略。Mybatis 的设计旨在简化数据库操作，使得 Java 开发者能够更加专注于业务逻辑的实现，而不是数据库底层细节。

Mybatis的基本概念

Mybatis 的基本概念包括以下几点：

1. SqlSessionFactory：Mybatis 的核心是 SqlSessionFactory，它是线程安全的工厂，通常我们通过配置文件创建 SqlSessionFactory 对象。
2. SqlSession：SqlSession 是执行数据库操作的核心接口，它可以从 SqlSessionFactory 中获取，用于执行查询、更新、删除和插入操作。
3. Mapper：在 Mybatis 中，Mapper 接口和 XML 映射文件是用于定义 SQL 语句的地方。Mapper 接口定义了 CRUD 操作的签名，而 XML 文件中定义了具体的 SQL 语句。
4. Configuration：配置对象，配置 Mybatis 的各种设置和属性，如数据源、缓存、类型处理器等。

Mybatis的优势与应用场景

Mybatis 具有以下主要优势：

1. 灵活性：Mybatis 允许使用原始的 SQL 语句，使得在复杂查询和存储过程中具有很高的灵活性。
2. 性能：因为 Mybatis 不需要反射来执行 SQL，所以性能相对较高。
3. 轻量级：与 Hibernate 等框架相比，Mybatis 体积较小，配置简单，易于使用。
4. 易于维护：Mybatis 的 XML 文件和 Mapper 接口可以独立维护，使得代码更加清晰和易于维护。

应用场景包括：

• 需要频繁进行复杂的 SQL 查询和存储过程的项目。
• 涉及大量数据库操作的系统。
• 性能要求较高的场景，如互联网应用、大数据分析等。

代码生成器的作用与优势

代码生成器是一种工具，用来自动生成代码，减少手动编写代码的时间和错误。在 Mybatis 项目中，代码生成器可以生成 POJO 类（JavaBean）、Mapper 接口、XML 映射文件和测试代码等。通过使用代码生成器，开发人员可以减少重复劳动，提高开发效率。

代码生成器的定义

代码生成器是一种自动化工具，根据数据库表结构和配置生成相应的代码。这些代码通常包括：

• POJO 类：包含表中所有字段的 JavaBean 类，用于封装数据。
• Mapper 接口：定义 CRUD 操作的接口。
• XML 映射文件：包含 SQL 语句的 XML 文件。
• 测试代码：用于测试生成的代码是否正确。

使用代码生成器的好处

1. 减少开发时间：代码生成器可以快速生成代码，减少人工编写的时间。
2. 提高代码质量：自动生成的代码遵循一致的代码风格和规范，减少人工错误。
3. 易于维护：生成的代码结构清晰，易于维护和扩展。
4. 提升开发效率：开发者可以专注于业务逻辑，而不是数据库操作的细节。

Mybatis代码生成器选择

常用的Mybatis代码生成器工具介绍

在 Mybatis 中，有许多常用的代码生成器工具，包括：

1. Mybatis Generator：一个常用的开源工具，支持自定义模板和输出目录。
2. mybatis-plus：虽然主要是对 Mybatis 的扩展，但提供了代码生成器功能。
3. Quick Start：简单的代码生成器，适用于快速搭建项目。
4. Fast Mybatis Generator：一个轻量级的代码生成器。

这些工具各有特点和适用场景，具体选择可以根据项目的实际情况来决定。

如何根据项目需求选择合适的代码生成器

选择合适的代码生成器需要考虑以下几点：

1. 项目规模：小型项目可以选择简单的代码生成器，如 Quick Start。
2. 功能需求：如果需要自定义模板和高级功能，可以选择 Mybatis Generator 或 Fast Mybatis Generator。
3. 团队熟悉度：选择团队熟悉或支持的工具，能够更快上手。
4. 社区支持：选择有活跃社区和良好文档支持的工具，便于解决问题。

Mybatis代码生成器的基本配置

下载与安装代码生成器

以 Mybatis Generator 为例，下载和安装步骤如下：

1. 下载最新版本：可以从 Mybatis Generator 的 GitHub 仓库下载最新版本的 jar 包。
2. 添加依赖：如果使用 Maven 项目，可以在 pom.xml 文件中添加 Mybatis Generator 的依赖：

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

核心配置文件解析

配置文件通常以 XML 格式编写，包含数据库连接信息和生成代码的设置。下面是一个简单的配置文件示例：

<generatorConfiguration>
    <classPathEntry location="lib/mysql-connector-java-5.1.38.jar" />

    <context id="DB2Tables" targetRuntime="MyBatis3Simple">
        <commentGenerator>
            <property name="suppressDate" value="true" />
        </commentGenerator>

        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
            connectionURL="jdbc:mysql://localhost:3306/mybatis_generator"
            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="users" domainObjectName="User" enableCountByExample="false"
            enableUpdateByExample="false" enableDeleteByExample="false"
            enableSelectByExample="false" selectByExampleQueryId="false">
        </table>
    </context>
</generatorConfiguration>

配置文件中主要包含以下几个部分：

• commentGenerator：配置代码注释生成器。
• jdbcConnection：配置数据库连接信息。
• javaModelGenerator：生成 Java 模型对象的配置。
• sqlMapGenerator：生成 SQL 映射文件的配置。
• javaClientGenerator：生成 Mapper 接口的配置。
• table：指定要生成代码的数据库表。

使用Mybatis代码生成器生成代码

生成POJO类

生成 POJO 类的配置如上所示，通过 javaModelGenerator 标签来指定生成 Java 模型对象的配置。以下是一个完整的 POJO 类生成示例：

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

生成的 POJO 类示例如下：

package com.example.model;

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

    // getters and setters
}

生成Mapper接口和XML映射文件

生成 Mapper 接口和 XML 映射文件的配置如上所示，通过 javaClientGenerator 和 sqlMapGenerator 标签来指定生成 Mapper 接口和 XML 映射文件的配置。以下是一个完整的 Mapper 接口和 XML 映射文件生成示例：

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

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

生成的 Mapper 接口示例如下：

package com.example.mapper;

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

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);
}

生成的 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">
    <resultMap id="BaseResultMap" type="com.example.model.User">
        <id column="id" property="id" />
        <result column="username" property="username" />
        <result column="password" property="password" />
        <result column="email" property="email" />
    </resultMap>

    <sql id="Base_Column_List">
        id, username, password, email
    </sql>

    <select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="java.lang.Integer">
        select
        <if test="_parameter != null">
            <include refid="Base_Column_List" />
        </if>
        from users
        where id = #{id,jdbcType=INTEGER}
    </select>

    <insert id="insert" parameterType="com.example.model.User">
        insert into users (id, username, password, email)
        values (#{id,jdbcType=INTEGER}, #{username,jdbcType=VARCHAR}, #{password,jdbcType=VARCHAR}, #{email,jdbcType=VARCHAR})
    </insert>

    <update id="updateByPrimaryKeySelective" parameterType="com.example.model.User">
        update users
        <set>
            <if test="username != null">
                username = #{username,jdbcType=VARCHAR},
            </if>
            <if test="password != null">
                password = #{password,jdbcType=VARCHAR},
            </if>
            <if test="email != null">
                email = #{email,jdbcType=VARCHAR}
            </if>
        </set>
        where id = #{id,jdbcType=INTEGER}
    </update>
</mapper>

生成测试代码

生成测试代码的配置通常需要手动编写，以下是一个完整的测试代码示例：

package com.example.test;

import com.example.model.User;
import com.example.mapper.UserMapper;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

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

public class UserMapperTest {
    public static void main(String[] args) {
        // 读取 Mybatis 配置文件
        InputStream resourceAsStream = UserMapperTest.class.getClassLoader().getResourceAsStream("mybatis-config.xml");
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
        SqlSession sqlSession = sqlSessionFactory.openSession();

        // 使用 Mapper 接口
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);

        // 插入一条数据
        User user = new User();
        user.setUsername("testUser");
        user.setPassword("testPassword");
        user.setEmail("testEmail");
        int rows = userMapper.insert(user);
        System.out.println("Rows inserted: " + rows);

        // 更新一条数据
        user.setPassword("newPassword");
        rows = userMapper.updateByPrimaryKey(user);
        System.out.println("Rows updated: " + rows);

        // 查询所有数据
        List<User> users = userMapper.selectAll();
        for (User u : users) {
            System.out.println("User: " + u.getUsername());
        }

        // 删除一条数据
        rows = userMapper.deleteByPrimaryKey(user.getId());
        System.out.println("Rows deleted: " + rows);

        sqlSession.close();
    }
}

Mybatis代码生成器的进阶使用

自定义模板与输出目录

Mybatis Generator 支持自定义模板，通过 templateLocation 属性来指定模板文件的位置。模板文件可以扩展各种自定义功能，如生成特定的注解或代码结构。自定义模板的配置如下：

<templateLocation implementation="org.mybatis.generator.config.DefaultShellCallback">
    <property name="templateLocation" value="src/main/resources/mybatis-generator/templates" />
</templateLocation>

自定义模板文件可以放在指定目录下，例如：

<template file="src/main/resources/mybatis-generator/templates/UserMapper.java.vm">
    package com.example.mapper;

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

    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);

        List<User> selectAll();
    }
</template>

代码生成器的参数配置与优化

代码生成器的参数配置可以优化生成代码的质量和性能。以下是一些常用的参数配置示例：

<generatorConfiguration>
    <context id="DB2Tables" targetRuntime="MyBatis3Simple">
        <commentGenerator>
            <property name="suppressDate" value="true" />
        </commentGenerator>

        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
            connectionURL="jdbc:mysql://localhost:3306/mybatis_generator"
            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="users" domainObjectName="User" enableCountByExample="false"
            enableUpdateByExample="false" enableDeleteByExample="false"
            enableSelectByExample="false" selectByExampleQueryId="false">
            <columnOverride column="id" property="userId" />
        </table>
    </context>
</generatorConfiguration>

配置文件中可以使用各种参数来自定义生成代码的行为。例如，通过 columnOverride 标签可以重定义字段名称：

<columnOverride column="id" property="userId" />

这些参数配置可以帮助优化生成代码的结构和性能，使得生成的代码更加符合项目需求。

通过本文的介绍，读者可以了解到 Mybatis 代码生成器的作用、优势、选择方法以及如何进行基本配置和进阶使用。希望读者能够在实际项目中充分利用代码生成器，提高开发效率和代码质量。