为了账号安全，请及时绑定邮箱和手机立即绑定
首页 手记 Mybatis官方生成器学习指南

Mybatis官方生成器学习指南

标签：
Java SSM 数据库
概述

本文全面介绍了Mybatis官方生成器的学习指南，包括其作用、特点及安装配置方法。通过详细的步骤和示例，帮助开发者快速理解和使用生成器来自动生成代码，减少手动编写代码的工作量。文章还涵盖了常见配置和实际应用案例，帮助读者更好地掌握Mybatis官方生成器学习。

Mybatis官方生成器学习指南
MyBatis简介

MyBatis是什么

MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解进行配置和原始映射，将接口和 Java 的 POJOs(Plain Old Java Objects，普通的 Java 对象)映射成数据库中的记录。

MyBatis的优势

  1. 简化SQL操作: MyBatis允许开发者直接编写原生SQL语句，同时通过XML映射文件或注解来映射SQL到Java对象，这使得开发者可以更灵活地控制数据库操作。
  2. 更灵活的数据库交互: MyBatis中的SQL语句可以动态地组装，这意味着可以很容易地根据应用的需要调整数据库交互行为。
  3. 支持自定义映射: MyBatis允许开发者自定义复杂对象之间的映射，这对于某些复杂的数据库操作尤其有用。
  4. 与数据库无关: MyBatis可以很好地支持多种数据库，如MySQL、Oracle、SQL Server等，而无需更改应用代码。
  5. 性能优化: MyBatis允许开发者优化SQL语句，这对于提高应用性能非常有帮助。

MyBatis的基本概念

  • 配置文件: MyBatis使用XML配置文件来指定数据库连接信息、映射文件位置等。以下是一个基本的MyBatis配置文件示例：
<configuration>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mydb"/>
                <property name="username" value="root"/>
                <property name="password" value="password"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/mybatis/example/UserMapper.xml"/>
    </mappers>
</configuration>
  • 映射文件: 映射文件定义了SQL语句以及结果集如何映射到Java对象。例如，一个简单的User映射文件可能包含以下内容：
<mapper namespace="com.example.mapper.UserMapper">
    <select id="selectUser" resultType="com.example.entity.User">
        SELECT * FROM users WHERE id = #{id}
    </select>
</mapper>

  • SqlSession: SqlSession是MyBatis的执行器，它负责获取Mapper对象并执行SQL语句。SqlSession对象包含所有执行数据库操作的方法，如select、insert、update等。

  • Mapper接口: Mapper接口定义了数据库操作的方法，这些方法通常对应于映射文件中的SQL语句。例如：
public interface UserMapper {
    User selectUser(int id);
}
MyBatis官方生成器简介

官方生成器的作用

MyBatis官方生成器旨在通过自动生成代码来减轻开发者的工作负担，尤其是在处理数据库操作时。它能够自动生成Mapper接口、映射文件以及一些基础的Java对象，从而帮助开发者快速搭建项目基础。

官方生成器的特点

  • 自动化: 生成器能够自动生成数据库操作所需的大部分代码，大大减少了手动编写代码的工作量。
  • 灵活性: 生成器提供多种配置选项，使得生成的代码可以适应不同的项目需求。
  • 易用性: 通过简单的配置文件，可以轻松地定制生成的代码，满足项目特定需求。

安装与配置

安装步骤

  1. 下载并导入依赖: 要使用MyBatis Generator，首先需要在项目中添加MyBatis Generator的依赖。对于Maven项目，可以在pom.xml文件中添加以下依赖：
<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.3.7</version>
</dependency>
  1. 配置Generator Configuration文件: 生成器需要一个配置文件来指定数据库连接信息、表名、生成代码的位置等。以下是一个简单的配置文件示例：
<generatorConfiguration>
    <context id="DB2Tables" targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/mydb"
                        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="users"/>
    </context>
</generatorConfiguration>

配置文件详解

  • <context>: 定义生成器的上下文，包括生成的目标运行时环境。
  • <commentGenerator>: 配置生成器的注释生成器，这里关闭了所有注释。
  • <jdbcConnection>: 配置数据库连接信息。
  • <javaModelGenerator>: 配置Java模型的生成器，指定生成的Java类的位置和包名。
  • <sqlMapGenerator>: 配置SQL映射文件的生成器，指定生成的SQL映射文件的位置和包名。
  • <javaClientGenerator>: 配置Java客户端的生成器，指定生成的Mapper接口的位置和包名。
  • <table>: 指定要生成代码的表名。
生成器的使用步骤

生成器的初始化

初始化生成器通常在项目的构建阶段执行，确保项目中包含所有必要的代码。以下是一个简单的生成器初始化的步骤：

  1. 编写配置文件：根据项目需求编写generatorConfig.xml配置文件。
  2. 编写启动脚本：在项目的构建脚本（如Maven的pom.xml中的<build>节点）中添加生成器的执行命令。
  3. 执行生成器：运行构建脚本，生成器将根据配置文件生成代码。

配置生成器

生成器的配置文件generatorConfig.xml包含了所有必要的配置信息，如数据库连接信息、表名等。以下是配置文件的一个基本框架：

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

生成代码

一旦配置文件准备好，可以通过执行生成器来生成代码。以下是一个例子，如何在Maven项目中执行生成器:

<build>
    <plugins>
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.7</version>
            <configuration>
                <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
                <overwrite>true</overwrite>
            </configuration>
            <dependencies>
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>8.0.22</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

执行mvn mybatis-generator:generate命令，生成器将根据配置文件生成代码。

常见配置详解

数据库连接配置

数据库连接配置是生成器配置文件中的关键部分，它指定了数据库的连接信息。以下是数据库连接配置的一个示例：

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

表与字段映射配置

表与字段映射配置用于指定哪些表需要生成代码，以及如何映射字段。例如：

<table tableName="users"
       autoRuntimeMapping="true"
       autoDelombok="false">
    <generatedKey column="id" sqlType="INTEGER" identity="true"/>
</table>
  • tableName: 指定要生成代码的表名。
  • autoRuntimeMapping: 是否启用自动运行时映射。
  • autoDelombok: 是否启用自动去Lombok注解。
  • generatedKey: 指定主键字段的配置。

生成策略配置

生成策略配置用于控制生成的代码的行为，例如是否生成构造函数、是否生成JavaBeans规范等。例如：

<javaModelGenerator targetPackage="com.example.model"
                    targetProject="src/main/java">
    <property name="enableSpringBeanUtilize" value="true"/>
    <property name="trimStrings" value="true"/>
</javaModelGenerator>
  • targetPackage: 生成的Java模型类的目标包名。
  • targetProject: 生成的Java模型类的目标项目目录。
  • enableSpringBeanUtilize: 是否启用Spring Bean Utilize特性。
  • trimStrings: 是否启用字符串截断。
实际应用案例

生成器生成的代码结构

使用MyBatis Generator生成代码后，会生成以下几类文件：

  1. Java模型类：例如，对于表users，生成器会生成一个User类。
  2. Mapper接口：例如，生成器会生成一个UserMapper接口。
  3. XML映射文件：例如，生成器会生成一个UserMapper.xml文件，其中包含SQL语句的定义。

以下是生成的代码示例：

Java模型类

package com.example.model;

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

    // Getters and Setters
    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;
    }
}

Mapper接口

package com.example.mapper;

import com.example.model.User;

public interface UserMapper {
    User selectUser(int id);
}

XML映射文件

<mapper namespace="com.example.mapper.UserMapper">
    <select id="selectUser" resultType="com.example.model.User">
        SELECT * FROM users WHERE id = #{id}
    </select>
</mapper>

代码自定义与调整

生成的代码可能需要根据实际需求进行调整。例如，可以通过修改配置文件中的属性来更改生成代码的行为。以下是一个自定义生成器配置文件的例子：

<generatorConfiguration>
    <context id="DB2Tables" targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/mydb"
                        userId="root"
                        password="password">
        </jdbcConnection>
        <javaModelGenerator targetPackage="com.example.model"
                            targetProject="src/main/java">
            <property name="enableSpringBeanUtilize" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <sqlMapGenerator targetPackage="com.example.mapper"
                         targetProject="src/main/resources"/>
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.example.mapper"
                             targetProject="src/main/java"/>
        <table tableName="users">
            <generatedKey column="id" sqlType="INTEGER" identity="true"/>
        </table>
    </context>
</generatorConfiguration>

在实际应用中，可能需要修改生成器的配置文件来适应项目需求，例如调整生成的Java类的属性：

<javaModelGenerator targetPackage="com.example.model"
                    targetProject="src/main/java">
    <property name="enableSpringBeanUtilize" value="true"/>
    <property name="trimStrings" value="true"/>
    <property name="immutable" value="false"/>
</javaModelGenerator>
常见问题与解答

生成器报错排查

生成器运行时可能会遇到各种错误，常见的错误包括：

  • 数据库连接失败：检查数据库连接信息是否正确。
  • 表名或字段名错误：检查配置文件中的表名和字段名是否正确。
  • 代码生成失败：检查生成器配置文件是否正确，确保所有必要的依赖项都已添加。

生成器配置修改

修改生成器配置文件通常需要重启生成器。例如，如果修改了表名或字段名，需要重新生成代码。

生成器优化技巧

  1. 缓存配置文件：对于大型项目，可以将配置文件缓存起来，避免每次生成时都重新解析。
  2. 使用模板：可以定义模板来生成特定的代码结构，例如使用Velocity模板。
  3. 脚本生成：可以编写脚本来生成特定的数据库操作代码，例如批量插入脚本。
  4. 自动化测试：可以集成自动化测试框架，确保生成的代码符合预期的要求。

示例代码

以下是一个简单的生成器配置文件示例，用于生成users表的代码：


<generatorConfiguration>
    <context id="DB2Tables" targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/mydb"
                        userId="root"
                        password="password">
        </jdbcConnection>
        <javaModelGenerator targetPackage="com.example.model"
                            targetProject="src/main/java">
            <property name="enableSpringBeanUtilize" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <sqlMapGenerator targetPackage="com.example.mapper"
                         targetProject="src/main/resources"/>
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.example.mapper"
                             targetProject="src/main/java"/>
        <table tableName="users">
            <generatedKey column="id" sqlType="INTEGER" identity="true"/>
        </table>
    </context>
</generatorConfiguration>
``

以上是使用MyBatis官方生成器的详细指南，希望对您有所帮助。
点击查看更多内容
发表于 2024.11.22 23:57， 共 55 人浏览

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

举报
为 TA 点赞

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

评论

作者其他优质文章

正在加载中

函数式编程

手记
篇
粉丝
14
获赞与收藏
30

关注作者，订阅最新文章

阅读免费教程

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

100积分直接送

付费专栏免费学

大额优惠券免费领

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

举报

0/150
提交
取消