MyBatis 学习笔记

原创已于 2024-11-02 22:54:21 修改 · 1.2k 阅读

33 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot

于 2024-11-02 22:46:56 首次发布

一、引言

MyBatis 是一款优秀的持久层框架，它简化了数据库操作，提高了开发效率。在学习和使用 MyBatis 的过程中，我积累了不少知识和经验，以下是我对其中一些重点内容的记录。

二、学习过程

（一）基础知识理解

持久层概念
在开始学习 MyBatis 之前，首先要理解持久层在整个软件架构中的作用。持久层主要负责将数据在内存和数据库之间进行转换和存储。例如，当我们在应用程序中创建了一个用户对象，持久层要负责将这个用户对象的信息准确无误地存储到数据库中，并且在需要的时候能够从数据库中检索出用户信息并重新构建成内存中的用户对象。

MyBatis 架构
了解 MyBatis 的架构是深入学习的关键。它由多个核心组件构成，其中包括 SqlSessionFactory、SqlSession、Mapper 接口和 Mapper XML 文件等。SqlSessionFactory 是创建 SqlSession 的工厂，它负责读取配置文件，构建出整个 MyBatis 运行的环境。SqlSession 则是用于执行 SQL 语句的会话对象，通过它可以与数据库进行交互。Mapper 接口定义了数据库操作的方法签名，而 Mapper XML 文件则是实现这些方法对应的 SQL 语句。以下是一个简单的代码示例展示如何获取 SqlSession：

// 加载MyBatis配置文件
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
// 创建SqlSessionFactory
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 获取SqlSession
SqlSession sqlSession = sqlSessionFactory.openSession();

（二）配置文件学习

主配置文件（mybatis - config.xml）

MyBatis 的主配置文件是整个框架的核心配置部分。在学习过程中，我首先关注了数据源的配置。例如，配置连接数据库的驱动、URL、用户名和密码等信息。

<configuration>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mydb?useSSL=false&amp;serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="password"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <!-- 配置Mapper XML文件或Mapper接口 -->
    </mappers>
</configuration>

这里需要注意的是，不同的数据库驱动和连接字符串的格式是不同的，要根据实际使用的数据库进行正确配置。同时，在配置<mappers>部分时，可以选择使用 XML 映射器或者基于接口的映射器。如果使用 XML 映射器，需要指定 Mapper XML 文件的路径；如果使用接口映射器，则需要遵循一定的命名规则和配置方式。

Mapper XML 文件
Mapper XML 文件用于编写具体的 SQL 语句。学习过程中，我重点掌握了 SQL 语句的编写方式以及参数传递和结果映射。例如，对于一个简单的查询用户信息的 SQL 语句：

<select id="selectUserById" resultMap="userResultMap">
    SELECT * FROM users WHERE id = #{id}
</select>
<resultMap id="userResultMap" type="com.example.User">
    <id property="id" column="id"/>
    <result property="username" column="username"/>
    <result property="password" column="password"/>
</resultMap>

在这个例子中，<select>标签中的 id 属性要与 Mapper 接口中的方法名相对应，通过 #{id} 这种方式可以接收参数。而<resultMap>则用于将查询结果的列与 Java 对象的属性进行映射。这部分需要仔细处理数据类型的匹配和属性与列名的对应关系，以确保数据的准确转换。以下是一个 Java 用户类的代码示例：

public class User {
    private int id;
    private String username;
    private String password;

    // 构造函数、Getter和Setter方法省略
}

（三）动态 SQL 学习

动态 SQL 是 MyBatis 的一个强大功能。在实际开发中，经常会遇到根据不同条件生成不同 SQL 语句的情况。例如，在查询用户列表时，可能需要根据用户名、年龄等多个条件进行筛选，而且这些条件可能是可选的。

<select id="selectUsers" resultMap="userResultMap">
    SELECT * FROM users
    <where>
        <if test="username!= null">
            AND username LIKE '%${username}%'
        </if>
        <if test="age!= null">
            AND age = #{age}
        </if>
    </where>
</select>

在这个例子中，<where>标签用于自动处理 SQL 语句中的 WHERE 关键字和多余的 AND 关键字。<if>标签则根据条件判断是否添加相应的查询条件。这里需要注意的是，和#的区别，#是预编译处理，可以防止注入，而{} 是直接替换，在某些特定情况下使用，但要注意安全性。

三、安装步骤

（一）添加依赖（以 Maven 项目为例）

在 Maven 项目的 pom.xml 文件中添加 MyBatis 的依赖：

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

同时，如果使用的是 MySQL 数据库，还需要添加 MySQL 数据库驱动的依赖：

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.28</version>
</dependency>

（二）创建配置文件

创建 mybatis - config.xml
按照上述配置文件学习部分的内容，创建主配置文件，并将其放置在项目的资源目录下（一般是 src/main/resources）。
创建 Mapper XML 文件
根据业务需求，创建相应的 Mapper XML 文件，同样放置在资源目录下，可以根据功能模块进行分类，例如将用户相关的 Mapper XML 文件放在一个名为 “user” 的目录下。

（三）创建 Mapper 接口

在 Java 代码中，创建与 Mapper XML 文件对应的接口。接口中的方法签名要与 Mapper XML 文件中的 SQL 语句的 id 属性相对应。例如：

public interface UserMapper {
    User selectUserById(int id);
    List<User> selectUsers(String username, Integer age);
}

（四）初始化 MyBatis

在 Java 代码中，通过读取配置文件来初始化 MyBatis：

String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

这样就完成了 MyBatis 的基本安装和初始化，可以开始使用它进行数据库操作了。

四、遇到的问题及解决过程

（一）数据库连接问题

问题描述
在配置数据源后，启动应用程序时，出现了数据库连接失败的错误。错误信息提示无法加载数据库驱动。
解决过程
首先检查了数据库驱动的依赖是否添加正确，发现依赖版本没有问题。然后检查了驱动名称是否正确，发现原来是在配置文件中，驱动名称写错了，应该是 “com.mysql.cj.jdbc.Driver”，而我写成了 “com.mysql.jdbc.Driver”。修改后，问题得到解决。

（二）Mapper 接口与 XML 文件绑定问题

问题描述
在运行程序时，出现了找不到 Mapper 方法对应的 SQL 语句的错误。
解决过程
检查了 Mapper 接口和 XML 文件的命名和路径。发现是由于没有遵循 MyBatis 的命名约定，MyBatis 默认要求 Mapper 接口和 XML 文件的名称要相同（除了扩展名），并且要在同一目录下或者在配置文件中正确指定 Mapper XML 文件的路径。我将 Mapper 接口和 XML 文件的名称修改一致，并将 XML 文件放置在与接口相同的包路径下（通过在主配置文件中配置<package>标签来实现 Mapper 接口和 XML 文件的自动扫描），问题得到解决。

（三）动态 SQL 中参数类型问题

问题描述
在使用动态 SQL 的<if>标签时，出现了参数类型不匹配的错误。例如，当传递一个字符串类型的参数时，在 SQL 语句中判断条件总是不成立。
解决过程
仔细检查了参数传递和 SQL 语句中的条件判断。发现是由于在<if>标签的 test 属性中，对于字符串类型的参数没有正确处理。在 MyBatis 中，对于字符串类型的参数判断应该使用单引号，例如：<if test="'${username}'!= null">。修改后，动态 SQL 的参数判断问题得到解决。

五、总结

通过对 MyBatis 的学习和实践，我深刻体会到它在数据库操作方面的便捷性和灵活性。在学习过程中，掌握配置文件的编写、Mapper 接口与 XML 文件的配合以及动态 SQL 的使用是关键。同时，在安装和使用过程中，要注意数据库连接的正确配置、依赖的添加以及各种命名和路径的规范。遇到问题时，要仔细分析错误信息，从配置、代码逻辑等多个角度去排查问题。MyBatis 为开发人员提供了一种高效的数据库访问方式，能够大大提高开发效率，尤其是在处理复杂的数据库操作和业务逻辑时，其优势更加明显。通过不断地实践和总结，能够更好地运用 MyBatis 来构建高质量的持久层代码。