为了账号安全，请及时绑定邮箱和手机立即绑定
首页 手记 Mybatis代码生成器入门：快速开始指南

Mybatis代码生成器入门：快速开始指南

标签：
SSM
概述

Mybatis代码生成器是一种自动化工具，用于根据数据库表结构自动生成Mybatis相关的代码，包括实体类、Mapper接口和Mapper XML配置文件等。这些代码可以极大地方便开发人员进行数据库操作，同时避免手动编写重复性代码，节省开发时间。本文将详细介绍Mybatis代码生成器入门的相关内容，包括常用工具介绍、环境搭建、配置文件详解、生成代码流程以及实战演练。Mybatis代码生成器入门涵盖了从环境搭建到代码生成的全过程，帮助开发者快速上手。

Mybatis代码生成器简介
Mybatis代码生成器的作用

Mybatis代码生成器是一种自动化工具，用于根据数据库表结构自动生成Mybatis相关的代码。通常包括实体类（POJO）、Mapper接口、Mapper XML配置文件等。这些代码遵循Mybatis的设计模式，可以极大地方便开发人员进行数据库操作。此外，使用代码生成器可以避免手动编写这些重复性代码，节省开发时间，提高开发效率。

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

Mybatis自定义代码生成器是官方推荐的一种生成方式，它可以根据工程需要生成相应的代码。此外，还有一些第三方开源工具，例如Mybatis-Plus，Mybatis Generator等，这些工具同样可以实现代码的自动化生成。

  • Mybatis Generator：这是一个非常成熟且具有广泛应用的工具，可以直接通过配置文件生成代码。适用于自定义生成代码场景。
  • Mybatis-Plus：虽然主要是一个增强工具，但它也集成了代码生成的功能。它使用简单的注解来实现代码的自动生成，除了生成代码外，还提供了一系列增强功能。
  • 其他的开源项目：还有一些其他的开源项目，如 FastGenerator、MybatisCodeGenerator等，这些项目也支持自定义代码生成。
环境搭建
开发环境准备

在开始使用Mybatis代码生成器之前，我们需要准备一个标准的Java开发环境。这包括安装Java开发工具包（JDK）、IDE（如IntelliJ IDEA、Eclipse），以及搭建数据库环境（如MySQL、Oracle）。

  • JDK安装：下载并安装JDK。版本应至少为JDK8。
  • IDE选择：选择一款适合Java开发的IDE。这里推荐使用IntelliJ IDEA，它支持多种编程语言，具有强大的代码编辑和调试功能。
  • 数据库安装：选择合适的数据库，安装并配置数据库环境。例如，对于MySQL，可以到官网下载并安装稳定版的MySQL。初始化数据库环境时，包括创建数据库和配置连接信息等。
下载并集成代码生成器工具

以Mybatis Generator为例，介绍其使用方法。

下载Mybatis Generator

Mybatis Generator的最新版本可以从其GitHub仓库获取。访问其主页并下载最新版本的jar包。

集成到项目中

在IDE中新建一个Java项目，添加Mybatis Generator jar包到项目的类路径下。具体步骤如下：

  1. 在IDE中创建一个新项目。
  2. 创建一个pom.xml文件，并在其中配置maven依赖，加入Mybatis Generator jar包。
  3. 确保项目中包含数据库连接信息和Mybatis配置文件。
<dependencies>
    <dependency>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-core</artifactId>
        <version>1.3.7</version>
    </dependency>
</dependencies>

完整的pom.xml配置文件示例如下：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>mybatis-generator-example</artifactId>
    <version>1.0-SNAPSHOT</version>
    <dependencies>
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.7</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.18</version>
        </dependency>
    </dependencies>
</project>
  1. 配置数据库连接信息。

创建配置文件

创建一个配置文件，例如generatorConfig.xml，用于配置数据库连接信息和生成代码的配置。

<generatorConfiguration>
    <context id="testTables" targetRuntime="mybatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/testdb"
                        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>

使用命令行生成代码：

mvn mybatis-generator:generate

在IDE中运行生成代码：

  1. 在IDE中，右键点击pom.xml文件。
  2. 选择运行Mybatis Generator插件，通常在"Maven"或"Run Maven Goal"菜单中选择mybatis-generator:generate。
配置文件详解
配置文件的基本结构

Mybatis Generator配置文件的基本结构如下：

<generatorConfiguration>
    <context id="testTables" targetRuntime="mybatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/testdb"
                        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"/>
        <table tableName="user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/>
    </context>
</generatorConfiguration>
关键配置项说明
  • context：定义配置文件的上下文，里面可以包含多个表的生成器配置。
  • commentGenerator：配置生成的代码是否添加注释，例如，suppressAllComments属性设置为true表示不生成注释。
  • jdbcConnection：数据库的JDBC连接配置，包括数据库驱动类名、连接URL、用户名、密码。
  • javaModelGenerator：Java模型（实体类）生成配置。
  • sqlMapGenerator：SQL映射文件生成配置。
  • javaClientGenerator：Java客户端（Mapper接口和XML配置文件）生成配置。
  • table：指定要生成代码的表的配置，包括表名、领域对象名称等。

例如，<table>标签的具体配置：

<table tableName="user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/>
生成代码流程
数据库表结构分析

将数据库表结构转化为代码前，首先需要查看表的字段以及其类型。例如，有一个名为user的数据库表，包含以下字段：

字段名 类型 示例值
id INT 1
name VARCHAR 张三
age INT 22
gender ENUM '男', '女'
email VARCHAR zhangsan@example.com
自动生成Mybatis相关代码

使用Mybatis Generator工具，根据generatorConfig.xml配置文件，自动生成相应的代码。

  • 实体类（POJO）：每个数据库表生成一个对应的实体类。例如，User实体类：
public class User {
    private Integer id;
    private String name;
    private Integer age;
    private String gender;
    private String email;

    // Getter和Setter方法
}
  • Mapper接口：定义数据库操作的接口。例如，UserMapper接口：
public interface UserMapper {
    List<User> selectAllUsers();
    User selectUserById(Integer id);
    void insertUser(User user);
    void updateUser(User user);
    void deleteUserById(Integer id);
}
  • Mapper XML文件：定义SQL语句的具体实现。例如，UserMapper.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" parameterType="com.example.model.User">
        INSERT INTO user (name, age, gender, email) VALUES (#{name}, #{age}, #{gender}, #{email})
    </insert>
    <update id="updateUser" parameterType="com.example.model.User">
        UPDATE user SET name = #{name}, age = #{age}, gender = #{gender}, email = #{email} WHERE id = #{id}
    </update>
    <delete id="deleteUserById" parameterType="Integer">
        DELETE FROM user WHERE id = #{id}
    </delete>
</mapper>
代码自检与调整

根据生成的代码，进行自检和调整。检查生成的代码是否符合预期的功能需求，例如，是否正确实现了数据库的增删改查操作。如果生成的代码不符合实际需求，可以通过修改generatorConfig.xml配置文件来调整。

实战演练
设计一个简单的数据库表

创建一个简单的用户表user，包含以下字段：

字段名 类型 示例值
id INT 1
name VARCHAR 张三
age INT 22
gender ENUM '男', '女'
email VARCHAR zhangsan@example.com
使用生成器自动生成代码

根据上述表结构，使用Mybatis Generator工具生成代码。首先，确保数据库中存在user表。

CREATE TABLE `user` (
    `id` INT PRIMARY KEY,
    `name` VARCHAR(50),
    `age` INT,
    `gender` ENUM('男', '女'),
    `email` VARCHAR(100)
);

然后，配置generatorConfig.xml文件以指定生成器应该为user表生成代码。

<generatorConfiguration>
    <context id="testTables" targetRuntime="mybatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/testdb"
                        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"/>
        <table tableName="user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/>
    </context>
</generatorConfiguration>

使用命令行生成代码：

mvn mybatis-generator:generate

在IDE中运行生成代码：

  1. 在IDE中，右键点击pom.xml文件。
  2. 选择运行Mybatis Generator插件，通常在"Maven"或"Run Maven Goal"菜单中选择mybatis-generator:generate。
调试生成的代码样例

调试生成的代码，确保它能够正确地实现预期的功能。例如，可以通过编写单元测试来验证生成的代码是否能够正确地执行查询、插入、更新和删除操作。

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

import java.io.InputStream;

public class UserTest {

    private SqlSessionFactory sqlSessionFactory;

    @Before
    public void setUp() {
        // 读取Mybatis配置文件
        String resource = "mybatis-config.xml";
        InputStream inputStream = UserTest.class.getClassLoader().getResourceAsStream(resource);
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    }

    @Test
    public void testInsertUser() {
        try (SqlSession session = sqlSessionFactory.openSession()) {
            UserMapper mapper = session.getMapper(UserMapper.class);

            User user = new User();
            user.setName("张三");
            user.setAge(22);
            user.setGender("男");
            user.setEmail("zhangsan@example.com");
            mapper.insertUser(user);
            session.commit();
        }
    }

    @Test
    public void testSelectUserById() {
        try (SqlSession session = sqlSessionFactory.openSession()) {
            UserMapper mapper = session.getMapper(UserMapper.class);
            User user = mapper.selectUserById(1);
            System.out.println(user.getName()); // 输出结果为"张三"
        }
    }

    @Test
    public void testUpdateUser() {
        try (SqlSession session = sqlSessionFactory.openSession()) {
            UserMapper mapper = session.getMapper(UserMapper.class);
            User user = mapper.selectUserById(1);
            user.setName("李四");
            mapper.updateUser(user);
            session.commit();
        }
    }

    @Test
    public void testDeleteUserById() {
        try (SqlSession session = sqlSessionFactory.openSession()) {
            UserMapper mapper = session.getMapper(UserMapper.class);
            mapper.deleteUserById(1);
            session.commit();
        }
    }
}
常见问题及解决方法
常见错误及解决办法

在使用Mybatis代码生成器过程中，可能会遇到以下常见的问题及解决办法：

  • 配置文件无法解析：检查配置文件的语法是否正确、数据库连接信息是否正确。
  • 数据库连接失败：确保数据库服务已经启动，并且配置的连接信息（URL、用户名、密码等）是正确的。
  • 生成代码不完整：检查配置文件中的表名等信息是否正确，并且数据库表结构是否正确。
  • 生成的代码不符合预期：可以通过修改配置文件中的相应设置来调整生成的代码。
代码生成器的优化建议
  • 定义模板文件：除了直接使用配置文件自动生成代码，还可以定义模板文件，以更灵活地定制生成的代码。
  • 结合IDE：将Mybatis代码生成器集成到IDE（如IntelliJ IDEA）中，实现一键生成代码功能。
  • 持续集成：设置持续集成（CI）系统，在每次数据库结构发生变化时自动生成相应的代码。

通过上述方法，可以进一步提高代码生成器的灵活性和适用性，从而更好地满足项目开发的需求。

点击查看更多内容
发表于 2024.10.15 13:47， 共 66 人浏览

本文原创发布于慕课网 ，转载请注明出处，谢谢合作

举报
为 TA 点赞

若觉得本文不错，就分享一下吧！

评论

作者其他优质文章

正在加载中

倚天杖

手记
篇
粉丝
47
获赞与收藏
187

关注作者，订阅最新文章

阅读免费教程

  • 推荐
  • 评论
  • 收藏
  • 共同学习，写下你的评论
感谢您的支持，我会继续努力的～
扫码打赏，你说多少就多少
赞赏金额会直接到老师账户
支付方式
打开微信扫一扫，即可进行扫码打赏哦
今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与 放弃机会
意见反馈 帮助中心 APP下载
官方微信

举报

0/150
提交
取消