MyBatis框架深度学习指南

于 2024-10-30 13:11:41 发布
阅读量858 收藏 13
点赞数 19
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/weixin_36282234/article/details/143378917
版权

本文还有配套的精品资源，点击获取 menu-r.4af5f7ec.gif

简介：“mybatis课堂笔记”是一份详尽的MyBatis框架学习资料，由IT培训机构传智播客提供，内容包括框架核心概念、配置、映射文件、动态SQL和与Spring整合等，旨在帮助开发者深入掌握MyBatis，优化数据库编程能力。 mybatis课堂笔记

1. MyBatis框架简介与历史

1.1 框架的起源与发展

MyBatis起源于Apache的一个开源项目iBatis，2010年iBatis项目被迁移到Google Code并更名为MyBatis。随着Java社区中ORM框架的流行，MyBatis逐渐发展成一个广泛使用的轻量级持久层框架。它主要通过XML或者注解的方式，将对象与数据库表进行映射，极大地简化了数据库编程。

1.2 框架特点与优势

MyBatis作为半自动ORM（对象关系映射）框架，拥有以下几个显著特点与优势： - 灵活性高 ：允许开发者编写原生的SQL，支持动态SQL，可以与各种数据库方言配合使用。 - SQL优化 ：因为可以手写SQL，所以对于SQL的优化更加灵活。 - 扩展性强 ：MyBatis支持自定义SQL、映射结果集、缓存等高级特性。

1.3 目标人群与适用场景

MyBatis主要面向那些对SQL优化有较高要求的项目，以及需要灵活控制SQL语句的开发者。它非常适合于那些已经有大量SQL语句的遗留项目，或者对于数据库性能要求非常高的应用。而对于需要快速开发且对数据库交互要求不高的轻量级应用，开发者可能会倾向于使用全自动ORM框架如Hibernate。

2. MyBatis设计理念与项目结构

2.1 MyBatis的设计理念

2.1.1 持久层框架的理解

在软件工程中，持久层（Persistence Layer）是指负责数据持久化的软件层次。数据持久化是将程序数据在瞬时状态和持久状态间转换的过程。在Java企业级应用中，MyBatis就是作为这一层的重要框架，专注于数据的存取操作。

MyBatis的设计思想主要在于简化数据访问层的代码，它通过XML或注解的方式将对象与数据库进行映射，从而允许用户使用简单的API进行数据库操作。与早期的JDBC相比，MyBatis大大减少了模板代码的编写，使得开发者能够更加专注于业务逻辑的实现。

具体来说，MyBatis将数据操作抽象为以下几个核心概念：

  • SQL Session ：一个SQL Session相当于一次数据库会话，它包含了执行SQL命令所需的所有方法。通过SQL Session对象，可以执行映射的SQL语句，获取映射生成的语句并处理结果。
  • Mapper ：Mapper是MyBatis中定义SQL语句的接口，每个接口都对应着SQL语句的标识，MyBatis会为这些接口生成代理对象。通过这些代理对象，开发者可以像调用方法一样执行SQL语句。
  • SQL ID ：每个Mapper中的方法都会有一个唯一的标识符（ID），这允许MyBatis定位到具体的SQL语句。
  • ResultMap ：MyBatis通过ResultMap来映射数据库查询结果集与Java对象的属性，极大地提高了SQL语句与Java对象的灵活性。

理解这些概念有助于深入掌握MyBatis框架的设计理念，并在实际应用中合理利用这些特性，提高开发效率与数据操作的性能。

2.1.2 接口绑定与SQL映射

MyBatis的核心设计理念之一是通过接口绑定将Java接口与SQL语句关联起来，这一过程被称为接口绑定或SQL映射。这种设计方式让开发者能够以编程的方式定义与数据库的交互，同时保持了Java代码的类型安全。

接口绑定机制

接口绑定是将MyBatis的Mapper接口中的方法与SQL语句对应起来的过程。可以通过XML文件或者注解的方式来实现。以下是通过XML文件实现接口绑定的基本步骤：

  1. 定义Mapper接口 ：首先定义一个Mapper接口，其中包含数据库操作的方法。
  2. 编写SQL映射文件 ：为每个Mapper接口编写一个对应的XML映射文件，文件中定义了接口方法与SQL语句的映射关系。
  3. 配置MyBatis ：在MyBatis的配置文件中注册映射文件，从而让MyBatis知道如何查找和加载它们。 
public interface UserMapper {
    User getUserById(int id);
}

<mapper namespace="com.example.mapper.UserMapper">
    <select id="getUserById" resultType="com.example.domain.User">
        SELECT * FROM users WHERE id = #{id}
    </select>
</mapper>
动态代理机制

MyBatis使用动态代理机制来创建Mapper接口的实例。当调用Mapper接口的方法时，MyBatis会拦截这个调用并将其转换为相应的SQL语句执行。这种方式让MyBatis的使用者可以像使用普通的Java接口一样调用数据库操作，而不必关心底层的SQL语句是如何执行的。 

SqlSession session = sqlSessionFactory.openSession();
try {
    UserMapper userMapper = session.getMapper(UserMapper.class);
    User user = userMapper.getUserById(1);
    // 使用user对象...
} finally {
    session.close();
}

接口绑定和动态代理机制使得MyBatis的使用变得更加灵活和强大，同时也保持了代码的可读性和可维护性。开发者可以轻松地将SQL语句与Java代码分离，使得数据库操作更加模块化。

2.2 MyBatis的项目结构

2.2.1 核心组件分析

MyBatis的项目结构由几个核心组件构成，这些组件共同构成了MyBatis的骨架，为应用程序提供持久化支持。以下是MyBatis主要的核心组件及其作用：

  • SqlSessionFactoryBuilder ：用于构建SqlSessionFactory实例。它通过读取配置文件或程序配置来创建SqlSessionFactory，是MyBatis初始化过程的关键组件。
  • SqlSessionFactory ：作为MyBatis的核心工厂，SqlSessionFactory负责创建SqlSession实例。SqlSessionFactory是线程安全的，通常在应用初始化时创建，之后整个应用生命周期中复用同一个实例。
  • SqlSession ：代表了与数据库的一次会话，是执行持久化操作的主接口。通过SqlSession，可以进行CRUD等数据库操作。
  • Executor ：负责SQL语句的生成和查询缓存的维护，是MyBatis的调度核心。
  • StatementHandler ：处理SQL语句的生成和执行，包括预编译、参数映射以及结果集的处理。
  • ParameterHandler ：处理SQL语句中的参数部分，将Java对象转换为数据库可接受的参数类型。
  • ResultSetHandler ：处理查询操作产生的结果集，将数据库返回的结果集映射成Java对象。

这些组件之间的相互作用构成了MyBatis操作数据库的基本流程。理解这些组件及其工作原理对于深入掌握MyBatis框架至关重要。

2.2.2 模块划分与依赖关系

MyBatis作为一个功能强大的持久层框架，其内部实现了模块化的划分，各模块之间具有清晰的依赖关系和职责分配。以下为MyBatis主要模块及其依赖关系的概述：

  • 核心模块 ：包含核心的执行逻辑和主要的接口定义。它负责维护整个框架的生命周期，包括SqlSessionFactory的创建和SqlSession的管理。

  • 绑定模块 ：负责将Mapper接口和XML映射文件中的SQL语句与相应的Java方法关联起来。该模块需要解析用户的输入（XML或注解），并提供接口动态代理机制。

  • 数据源模块 ：提供数据源的抽象和实现，是数据库连接池管理的关键部分。MyBatis支持多种数据源实现，如HikariCP、DBCP等。

  • 事务模块 ：封装了对数据库事务的管理，它提供了事务控制的相关接口。开发者可以自定义事务管理器，也可以使用默认的事务模块。

  • 解析模块 ：负责解析XML配置文件或注解，包括映射文件中的SQL语句解析、结果集映射规则等。这个模块提供了对复杂SQL语句和映射规则的强大支持。

  • 类型处理模块 ：用于处理Java数据类型和数据库数据类型之间的转换，保证数据在Java对象和数据库记录之间能够正确映射。

  • 日志模块 ：提供了一个统一的日志框架抽象，MyBatis可以集成多种日志框架如Log4j、SLF4J等。

这些模块之间通过良好的接口耦合和依赖注入，使得MyBatis能够灵活地扩展和维护。开发者可以根据自己的需求选择使用特定模块，或者替换现有模块以满足特定场景的需求。

通过本章节的介绍，我们了解了MyBatis的核心设计理念，包括接口绑定和SQL映射机制，以及其项目结构中核心组件的分析和模块划分。这些内容为理解MyBatis的底层工作原理和高级特性奠定了基础。在下一章节中，我们将继续深入探讨MyBatis环境搭建与XML配置的过程。

3. MyBatis环境搭建与XML配置

3.1 MyBatis环境搭建

3.1.1 环境需求与安装步骤

MyBatis的环境搭建对于任何想要开始使用这一流行的Java持久层框架的开发者来说，都是首要步骤。在详细探讨如何搭建环境之前，我们先了解下必要的环境需求：

  • JDK版本：MyBatis支持JDK 8及以上版本。
  • Maven或Gradle：用于依赖管理，推荐使用。
  • 一个IDE：例如IntelliJ IDEA、Eclipse等。
  • 数据库：虽然MyBatis与特定数据库无关，但你需要选择一个数据库进行操作，比如MySQL、PostgreSQL等。

搭建步骤如下：

  1. 创建Maven项目： 在IDE中选择创建一个新的Maven项目。根据向导填写相应的项目坐标、包名和版本等信息。
  2. 配置pom.xml： 在项目的pom.xml文件中添加MyBatis的依赖，以MySQL为例，你需要添加MySQL的JDBC驱动依赖以及MyBatis核心依赖。这里是一个配置示例： 
<dependencies>
    <!-- MySQL 驱动 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.23</version>
    </dependency>
    <!-- MyBatis -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version>
    </dependency>
    <!-- 其他依赖，如日志、测试等 -->
</dependencies>
  1. 配置数据库连接信息： 在 src/main/resources 目录下创建一个 db.properties 文件，并填入数据库连接信息： 
jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mydatabase?useSSL=false&serverTimezone=UTC
jdbc.username=root
jdbc.password=yourpassword
  1. 创建MyBatis配置文件： 在 src/main/resources 目录下创建一个 mybatis-config.xml 文件，这是MyBatis的核心配置文件，稍后会详细介绍。

3.1.2 环境配置与验证

配置完成后，我们需要验证环境是否搭建成功。这通常包括：

  1. 单元测试： 编写一个简单的单元测试来检查数据库连接是否正常。
  2. 启动应用： 编写一个应用程序来执行一个简单的数据库操作，如插入或查询，以验证MyBatis是否配置正确。

以下是单元测试的一个示例，假设你已经使用Junit和MyBatis-Spring库： 

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

public class MyBatisTest {

    private SqlSessionFactory sqlSessionFactory;

    @BeforeEach
    public void setUp() throws Exception {
        // 加载MyBatis配置文件并创建SqlSessionFactory
        sqlSessionFactory = new SqlSessionFactoryBuilder().build( /* mybatis-config.xml */ );
    }

    @Test
    public void testConnection() {
        // 获取SqlSession实例
        try (SqlSession session = sqlSessionFactory.openSession()) {
            // 执行查询操作
            User user = session.selectOne("com.example.mapper.UserMapper.selectUser", 1);
            // 确认查询结果
            System.out.println(user.getName());
        }
    }
}

确保 mybatis-config.xml 配置文件中定义了对应的Mapper文件路径，例如： 

<mappers>
    <mapper resource="com/example/mapper/UserMapper.xml" />
</mappers>

3.2 MyBatis的XML配置

3.2.1 配置文件结构与内容

MyBatis的XML配置文件是整个MyBatis应用的配置核心。该配置文件大致可以分为以下几个部分：

  1. properties ：外部化配置，用于引入数据库等外部配置信息。
  2. settings ：MyBatis的全局配置设置，如是否开启延迟加载等。
  3. typeAliases ：类型别名的定义，用于简化全限定类名的使用。
  4. environments ：环境配置，包括事务管理器和数据源的配置，通常支持多个环境配置以适应不同的部署环境。
  5. mapper ：Mapper接口的路径配置，MyBatis通过它来知道去哪里找到SQL映射文件。

一个典型的 mybatis-config.xml 配置文件如下： 

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
        PUBLIC "-//***//DTD Config 3.0//EN"
        "***">
<configuration>
    <properties resource="db.properties"/>
    <settings>
        <setting name="mapUnderscoreToCamelCase" value="true"/>
        <setting name="logImpl" value="STDOUT_LOGGING"/>
    </settings>
    <typeAliases>
        <package name="com.example.model"/>
    </typeAliases>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <package name="com.example.mapper"/>
    </mappers>
</configuration>

3.2.2 核心配置项详解

让我们进一步解读上述配置文件中的核心配置项：

  • properties ：这里我们引入了一个外部的配置文件 db.properties 。使用 ${} 语法可以在XML中直接引用这些属性值，使得配置更加灵活。
  • settings ：其中 mapUnderscoreToCamelCase 设置为 true 表示开启驼峰命名规则，会自动将数据库的下划线分隔字段转换为Java对象的驼峰命名字段。 logImpl 设置为 STDOUT_LOGGING 表示日志输出到控制台，有助于调试。
  • typeAliases ：这一部分简化了后续代码中需要使用到的类的全限定名，只需要使用别名即可。
  • environments ：定义了我们的数据源和事务管理器。通常会定义多个环境，例如开发、测试、生产等，但是这里只有一个开发环境。
  • mappers ：这里使用 <package> 标签自动扫描指定包下的所有Mapper接口，大大简化了配置工作。

理解和配置好上述各个部分后，MyBatis的环境搭建就完成了。接下来，我们就可以开始配置和使用Mapper接口和映射文件，以及进行具体的数据库操作了。

4. SqlSessionFactory和SqlSession对象使用

在MyBatis框架中，SqlSessionFactory和SqlSession对象是两个核心组件，它们在数据访问层中扮演着至关重要的角色。本章节将深入探讨这两个对象的使用方法，生命周期管理，以及如何通过它们执行CRUD（创建、读取、更新和删除）操作。

4.1 SqlSessionFactory对象构建

4.1.1 SqlSessionFactory的生命周期

SqlSessionFactory是一个线程安全的工厂类，用于创建SqlSession实例。在MyBatis中，SqlSessionFactory是一个重量级的资源，它负责加载MyBatis的配置文件，并创建SqlSession对象。它的生命周期应当是应用级别的，通常在应用启动时创建，而在应用关闭时销毁。因为SqlSessionFactory是重量级的，所以它的创建成本较高，一旦创建，就应当在整个应用中重用。为了确保线程安全，不同的线程不应该共享同一个SqlSessionFactory实例。

4.1.2 获取SqlSessionFactory实例方法

要获取SqlSessionFactory实例，通常有以下两种方法：

  1. 使用MyBatis提供的 SqlSessionFactoryBuilder 类，通过解析XML配置文件创建SqlSessionFactory实例。示例如下： 
String resource = "org/mybatis/example/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
  1. 在Spring框架中，可以使用MyBatis-Spring模块提供的 SqlSessionFactoryBean 类来配置SqlSessionFactory，并通过Spring IoC容器进行管理。示例如下： 
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource"/>
    <property name="configLocation" value="classpath:org/mybatis/example/mybatis-config.xml"/>
</bean>

在两种方法中， Resources.getResourceAsStream 用于读取XML配置文件， SqlSessionFactoryBuilder 解析XML并创建SqlSessionFactory实例。在Spring配置中， SqlSessionFactoryBean 配置了数据源和MyBatis配置文件的位置，由Spring容器创建和管理SqlSessionFactory实例。

4.2 SqlSession对象操作

4.2.1 SqlSession的作用域和生命周期

SqlSession是MyBatis操作数据库的核心对象，它是轻量级的，通常每次请求都会创建一个SqlSession实例，并在请求结束时关闭。SqlSession实例应当与请求或线程绑定，确保不会被其他线程访问。每个SqlSession实例都会关联一个数据库连接，并持有该连接直到关闭。

4.2.2 CRUD操作的实现

SqlSession提供了多种方法来执行数据库操作，包括insert、update、delete和select等方法。以下是使用SqlSession执行CRUD操作的示例代码： 

try (SqlSession session = sqlSessionFactory.openSession()) {
    BlogMapper mapper = session.getMapper(BlogMapper.class);
    // 插入操作
    Blog blog = new Blog();
    blog.setTitle("My First Blog Post");
    blog.setAuthor("John Doe");
    mapper.insertBlog(blog);
    // 更新操作
    blog.setBody("Body of my first blog post");
    mapper.updateBlog(blog);
    // 删除操作
    mapper.deleteBlog(blog);
    // 查询操作
    Blog selectedBlog = mapper.selectBlog(blog.getId());
}

在上述代码中，首先通过 sqlSessionFactory.openSession() 创建一个新的SqlSession实例。然后，使用 getMapper 方法获取对应的Mapper接口实例。通过该接口实例，可以直接调用相应的方法执行数据库的CRUD操作。注意，在使用try-with-resources语句时，SqlSession会在try代码块执行完毕后自动关闭。

CRUD操作的每个方法都会对应到SQL映射文件中定义的SQL语句。例如，insertBlog操作会对应到SQL映射文件中定义的insert语句，该语句与Mapper接口中的insertBlog方法绑定。

通过上述内容的介绍，我们可以看到SqlSessionFactory和SqlSession对象的构建和使用，它们是MyBatis操作数据库的基础。在下一章节中，我们将进一步深入理解MyBatis的高级特性，例如动态SQL的编写和应用。

5. Mapper接口和映射文件应用

5.1 Mapper接口的定义与绑定

5.1.1 接口绑定的原理

MyBatis的核心特性之一是支持对SQL语句与Java接口进行绑定。这一过程实际上是将接口方法与映射文件中定义的SQL语句关联起来。通过动态代理机制，MyBatis在运行时会自动为接口生成一个代理对象，当调用接口中的方法时，代理对象会将这些调用转换为对数据库的操作。

这种绑定机制的关键在于 Mapper XML 文件或者注解方式提供的映射关系。每一种方法对应着数据库中的一个操作，MyBatis 利用 Java 的动态代理来拦截接口方法的调用，并根据方法签名到映射文件中寻找对应的SQL语句来执行。

5.1.2 动态代理机制解析

为了理解动态代理机制，我们需要考虑MyBatis是如何使用Java的动态代理来创建Mapper接口的代理对象的。首先，MyBatis的SqlSession实例会根据Mapper接口的完全限定名找到对应的映射文件或者注解。

在映射文件中，每个 <select> , <insert> , <update> , <delete> 标签的 id 属性值应当与Mapper接口中的方法名相匹配。MyBatis会利用Java的动态代理机制来生成一个实现了Mapper接口的代理实例。

例如，定义一个简单的Mapper接口： 

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

对应的映射文件可能会是这样： 

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

当通过SqlSession获取UserMapper接口的代理实例，并调用selectUserById方法时，MyBatis会拦截该方法调用，并根据映射文件中的信息生成并执行相应的SQL语句。

5.2 映射文件的应用

5.2.1 映射文件的结构

映射文件通常遵循一个简单的XML结构。每个映射文件都与一个Mapper接口相对应，并且可以通过namespace属性来定义这个映射文件所对应的接口的全限定名。 

<mapper namespace="com.example.mapper.UserMapper">
    <!-- 映射语句 -->
</mapper>

映射文件中可以包含各种类型的SQL映射语句，包括 <insert> , <update> , <delete> , <select> 等。每个语句都具有一个唯一的标识符，即id属性。这个id与接口方法相对应，使得MyBatis能够通过接口方法找到相应的SQL语句。

5.2.2 SQL片段与resultMap配置

除了完整的SQL语句，映射文件中还可以定义SQL片段和resultMap。SQL片段可以将常用的SQL片段定义在一个地方，然后在需要的地方进行引用，这样可以避免SQL语句的重复。 

<sql id="Base_Column_List">
    id, name, email, age, create_time
</sql>

在需要的地方使用： 

<select id="selectUsers" resultType="User">
    SELECT <include refid="Base_Column_List" /> FROM users
</select>

resultMap是MyBatis中处理复杂结果映射的强大机制。它允许开发者自定义如何从数据库结果集中获取数据，并将其映射到Java对象的属性上。resultMap提供了丰富的配置项，如：

  • association：处理一对一关系。
  • collection：处理一对多关系。
  • discriminator：根据某列的值判断使用哪个resultMap。
  • 子resultMap：用于更复杂的映射配置。

例如，一个简单的resultMap配置可以是： 

<resultMap id="userResultMap" type="User">
    <id property="id" column="id" />
    <result property="name" column="name" />
    <result property="email" column="email" />
    <!-- 更多的result配置 -->
</resultMap>

在SQL语句中引用resultMap，以便MyBatis知道如何将查询结果映射到Java对象： 

<select id="selectUserById" resultMap="userResultMap">
    SELECT id, name, email FROM users WHERE id = #{id}
</select>

通过这些配置，MyBatis能够将SQL查询的结果集准确地映射到Java对象的属性上，极大地方便了开发者对数据的处理和操作。

本文还有配套的精品资源，点击获取 menu-r.4af5f7ec.gif

简介：“mybatis课堂笔记”是一份详尽的MyBatis框架学习资料，由IT培训机构传智播客提供，内容包括框架核心概念、配置、映射文件、动态SQL和与Spring整合等，旨在帮助开发者深入掌握MyBatis，优化数据库编程能力。

本文还有配套的精品资源，点击获取 menu-r.4af5f7ec.gif

EdTechIH
关注
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值