首页手记 Mybatis代码生成器资料详解与实战教程

Mybatis代码生成器资料详解与实战教程

标签：

Java SSM 数据库

概述

Mybatis代码生成器是一种能够自动生成与数据库表结构对应的Java实体类、Mapper接口及XML映射文件的工具，显著提高开发效率。本文详细介绍了Mybatis代码生成器的作用、优势、配置方法以及生成代码的结构，并提供了实战案例和使用技巧。通过学习本文，读者可以快速入门并熟练使用Mybatis代码生成器，提升开发效率。mybatis代码生成器资料在此文章中得到了全面的讲解。

Mybatis代码生成器简介

什么是Mybatis代码生成器

Mybatis代码生成器是一种工具，它可以自动生成与数据库表结构对应的Java实体类、Mapper接口以及对应的XML映射文件。通过这种方式，开发者可以快速地构建出与数据库交互的代码，而不需要手动编写这些代码。Mybatis代码生成器通常与Mybatis框架一起使用，可以显著提高开发效率。

Mybatis代码生成器的作用和优势

节省时间：自动化的代码生成可以节省开发人员大量时间，因为手动编写这些代码是相当繁琐和耗时的。例如，手动创建一个包含多个字段的实体类可能需要十几分钟，而使用Mybatis代码生成器可以在几秒钟内完成。
降低错误率：自动化的代码生成减少了人为错误的可能性，确保生成的代码结构一致且符合项目规范。例如，手动编写SQL语句时可能会有拼写错误或语法错误，而使用代码生成器可以避免这些问题。
提高代码质量：生成的代码通常遵循最佳实践，确保了代码的可读性和可维护性。例如，生成的代码会自动遵守项目的命名规则，确保代码风格一致。
易于维护：当数据库表结构发生变化时，只需重新运行代码生成器即可更新相关代码，无需手动修改所有相关代码。例如，如果数据库表增加了新的字段，只需重新运行代码生成器，生成的实体类和Mapper接口会自动包含新的字段。
标准化开发流程：通过统一的代码生成模板，可以确保项目中所有相关的代码风格和结构一致。例如，生成的代码会自动遵循预定义的命名规则和结构，保持代码风格的统一。

快速入门Mybatis代码生成器

准备工作

在开始使用Mybatis代码生成器之前，需要准备以下内容：

数据库连接信息：确保数据库已经创建好，并且你有相应的连接信息（如数据库地址、用户名和密码）。
Maven项目：推荐使用Maven项目管理，方便依赖管理和构建。
数据库表结构：确保数据库中已经创建好表结构，并且这些表结构将作为代码生成的依据。

下载和配置Mybatis代码生成器

添加依赖：在Maven项目的pom.xml文件中添加Mybatis代码生成器的依赖。

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

配置生成器配置文件：创建一个名为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="DB2Tables" targetRuntime="MyBatis3">
        <!-- 数据库驱动 -->
        <jdbcConnection driverType="MySQL">
            <property name="connectionURL" value="jdbc:mysql://localhost:3306/test_db"/>
            <property name="driverClass" value="com.mysql.jdbc.Driver"/>
            <property name="username" value="root"/>
            <property name="password" value="password"/>
        </jdbcConnection>

        <!-- 实体类生成配置 -->
        <javaTypeResolver>
            <property name="unambiguousTypeMappings" value="true"/>
            <property name="forceNoTypeBuffer" value="false"/>
            <property name="typeExclusions" value=""/>
        </javaTypeResolver>

        <!-- 输出路径 -->
        <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"/>
        <table tableName="order" domainObjectName="Order" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/>
    </context>
</generatorConfiguration>

运行生成器：在Maven项目中，可以通过执行命令来运行Mybatis代码生成器。

mvn mybatis-generator:generate

Mybatis代码生成器的使用步骤详解

导入数据库表结构

创建数据库表：首先在数据库中创建好需要生成代码的表结构。

CREATE TABLE `user` (
  `id` INT(11) NOT NULL AUTO_INCREMENT,
  `name` VARCHAR(255) DEFAULT NULL,
  `email` VARCHAR(255) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

配置表信息：在generatorConfig.xml文件中，按照实际需求配置需要生成代码的表信息。

<generatorConfiguration>
    <context id="DB2Tables" targetRuntime="MyBatis3">
        <jdbcConnection driverType="MySQL">
            <property name="connectionURL" value="jdbc:mysql://localhost:3306/test_db"/>
            <property name="driverClass" value="com.mysql.jdbc.Driver"/>
            <property name="username" value="root"/>
            <property name="password" value="password"/>
        </jdbcConnection>

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

代码生成过程解析

数据库连接：Mybatis代码生成器通过配置文件中的jdbcConnection标签连接到数据库。
解析表结构：代码生成器会读取数据库中的表结构信息，包括表名、字段名、数据类型等。
生成Java实体类：根据读取的表结构信息，生成对应的Java实体类。
生成Mapper接口：生成一个接口，该接口定义了对数据库表的基本操作方法。
生成XML映射文件：为每个生成的Mapper接口生成一个对应的XML映射文件，该文件定义了SQL语句。
输出文件：生成的文件会被输出到配置文件中指定的路径。

生成的代码结构与说明

Java实体类：每一个表都会生成一个对应的Java实体类。例如，对于user表，会生成一个名为User.java的类。

package com.example.model;

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

    public Integer getId() {
        return id;
    }

    public void setId(Integer 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;
    }
}

Mapper接口：为每个表生成一个Mapper接口，该接口定义了基本的CRUD操作。

package com.example.mapper;

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映射文件：每个Mapper接口对应的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">
    <resultMap id="BaseResultMap" type="com.example.model.User">
        <id column="id" property="id" jdbcType="INTEGER"/>
        <result column="name" property="name" jdbcType="VARCHAR"/>
        <result column="email" property="email" jdbcType="VARCHAR"/>
    </resultMap>

    <select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="java.lang.Integer">
        SELECT
        `id`,
        `name`,
        `email`
        FROM `user`
        WHERE `id` = #{id}
    </select>

    <insert id="insert" parameterType="com.example.model.User">
        INSERT INTO `user` (`name`, `email`)
        VALUES (#{name}, #{email})
    </insert>
</mapper>

常见问题解答

常见错误及解决方法

配置文件错误：确保配置文件中的数据库连接信息正确。常见的错误包括数据库地址、用户名、密码等信息错误。
数据库连接失败：检查数据库是否正常运行，并确保数据库连接信息正确。
生成代码不一致：确保配置文件中的生成器配置正确，特别是在目标包名和输出路径上。
生成代码无效：检查生成的代码是否符合项目要求，必要时可以手动调整生成的代码。

代码生成器的自定义配置

自定义实体类命名规则：可以通过修改domainObjectName属性来自定义生成的实体类名称。

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

选择需要生成的表：通过配置table标签来选择需要生成代码的表。

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

生成特定的映射方法：可以通过配置enableCountByExample等属性来控制是否生成某些特定的映射方法。

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

实战案例分享

使用Mybatis代码生成器的完整流程

准备工作：确保数据库已经创建好，并且已经配置好Maven项目。
配置生成器配置文件：创建并配置generatorConfig.xml文件。
运行生成器：通过Maven命令运行代码生成器。
生成代码：查看生成的Java实体类、Mapper接口和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="DB2Tables" targetRuntime="MyBatis3">
        <jdbcConnection driverType="MySQL">
            <property name="connectionURL" value="jdbc:mysql://localhost:3306/test_db"/>
            <property name="driverClass" value="com.mysql.jdbc.Driver"/>
            <property name="username" value="root"/>
            <property name="password" value="password"/>
        </jdbcConnection>

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

生成的Java实体类示例

package com.example.model;

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

    public Integer getId() {
        return id;
    }

    public void setId(Integer 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;
    }
}

生成的Mapper接口示例

package com.example.mapper;

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" jdbcType="INTEGER"/>
        <result column="name" property="name" jdbcType="VARCHAR"/>
        <result column="email" property="email" jdbcType="VARCHAR"/>
    </resultMap>

    <select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="java.lang.Integer">
        SELECT
        `id`,
        `name`,
        `email`
        FROM `user`
        WHERE `id` = #{id}
    </select>

    <insert id="insert" parameterType="com.example.model.User">
        INSERT INTO `user` (`name`, `email`)
        VALUES (#{name}, #{email})
    </insert>
</mapper>

小结与技巧分享

Mybatis代码生成器的优点总结

节省时间：自动化的代码生成可以显著缩短开发周期，开发人员可以将更多时间用于业务逻辑实现。
降低错误率：减少了手动编写代码带来的错误，确保生成的代码结构一致和符合项目规范。
提高代码质量：生成的代码结构清晰，遵循最佳实践，提高了代码的可读性和可维护性。
易于维护：数据库表结构变化时，只需重新运行生成器即可更新代码，减轻了维护工作量。
标准化开发流程：确保项目中的代码风格和结构一致，提高了项目的一致性和规范性。

提高使用效率的小技巧

生成代码后手动调整：生成的代码可能并不完全符合项目需求，手动调整可以提高代码的适用性。例如，可以在生成的Mapper接口中添加一些业务逻辑相关的自定义方法。
配置自定义模板：在generatorConfig.xml文件中配置自定义模板，可以生成更符合项目需求的代码。例如，可以配置生成特定的映射方法，如selectByCondition等。
使用IDE集成：某些IDE插件（如Mybatis Generator for IntelliJ IDEA）可以直接在IDE中运行生成器，提高开发效率。
定期生成代码：数据库表结构变化时，定期运行生成器更新代码，确保代码始终与数据库表结构同步。
参考官方文档：Mybatis Generator提供了详尽的官方文档，可以参考官方文档了解更多的配置选项和最佳实践。

通过以上内容的详细介绍，希望能帮助开发者更好地理解和使用Mybatis代码生成器，提高开发效率。

点击查看更多内容

为 TA 点赞

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

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

莫回无

手记
篇

粉丝

3

获赞与收藏

2

关注作者，订阅最新文章

阅读免费教程

Java并发工具

23个小节 19187 313

Java 并发原理入门教程

26个小节 38860 566

Java 入门教程

50个小节 340924 3155

推荐

评论

收藏

共同学习，写下你的评论



感谢您的支持，我会继续努力的～

扫码打赏，你说多少就多少

赞赏金额会直接到老师账户

支付方式

打开微信扫一扫，即可进行扫码打赏哦

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

恭喜你，你的运气太好了，居然抽中了 100个积分！

恭喜你，抽中了价值元的专栏！

太棒了，直接落到你账户里！

积分商城里的罗技鼠标、机械键盘、
Kindle 阅读器、小米平衡车
Apple iPad （10.2英寸）、大额优惠券
在等着你去兑换了噢

作者：

免费赠送

兑换码：1111222211 复制

优惠券可用于购买实战课、体系课
无门槛使用

先去看看，有什么好东西马上兑换我爱学习，选课去


热搜

最近搜索清空