Mybatis中通过XML文件配置SQL语句实战教程

于 2025-07-05 13:16:18 发布
阅读量608 收藏 27
点赞数 10
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_35879493/article/details/149151698

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

简介：本文将详细介绍如何在Mybatis框架中通过XML文件配置SQL语句，实现数据的插入操作。内容包括Mybatis XML配置文件结构、如何在映射器接口中使用这些配置，以及动态SQL的使用方法。通过具体的代码示例，说明如何将Java对象的属性值映射到SQL语句中的占位符，并执行数据插入操作。
XML文件配置SQL语句

1. Mybatis框架概述

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

1.1 Mybatis的定位

Mybatis的核心是使用动态SQL和高级映射来解决开发者在使用JDBC时面临的一系列繁琐问题。它不是直接提供数据访问对象（DAO）的实现，而是提供了操作数据库的API，开发者只需要关注SQL本身，其它的如数据源配置、数据库连接创建和关闭等复杂操作都由Mybatis来处理。

1.2 Mybatis的工作原理

在Mybatis中，开发者会写一个Mapper接口和一个对应的XML文件（或者使用注解），Mybatis会根据这些信息生成代理对象。当代理对象的方法被调用时，Mybatis框架根据提供的信息，动态生成SQL语句，并且处理数据库的执行结果，映射成相应的Java对象返回。Mybatis通过这种方式，实现了SQL与Java代码的解耦，提高了代码的可读性和可维护性。

2. XML配置文件结构

2.1 Mybatis配置文件基础

2.1.1 配置文件的组成元素

Mybatis配置文件是Mybatis框架的基石，它的主要作用是初始化Mybatis并构建与数据库交互的环境。配置文件中包含了一系列的元素，每个元素都有其特定的作用和配置方式，使得开发者能够灵活地配置和优化Mybatis行为。

配置文件主要由以下几个部分组成：

  • configuration ：这是配置文件的根元素，所有的配置内容都是它的子元素。
  • properties ：用于定义配置文件中使用的属性值。
  • settings ：用于配置Mybatis的核心设置。
  • typeAliases ：为Java类型设置别名，简化了类的全限定名。
  • typeHandlers ：用于指定Java类型与数据库类型之间的映射关系。
  • objectFactory ：用于创建结果集中的对象。
  • plugins ：配置Mybatis插件，可以对Mybatis行为进行拦截。
  • environments ：配置数据库环境，可以配置多个环境（通常是开发、测试和生产环境）。
  • databaseIdProvider ：用于配置支持不同数据库厂商的SQL语句。
  • mappers ：映射器的位置，它告诉Mybatis去哪里找映射的文件或接口。

2.1.2 环境配置和属性设置

在 environments 元素下配置不同的数据库环境是Mybatis应用中非常常见的需求。这些环境配置项允许开发者在同一配置文件中设置多个环境，如开发环境（dev），测试环境（test）和生产环境（prod）。每个环境配置通常包括 transactionManager （事务管理器）和 dataSource （数据源）的配置。

properties 元素则用于从外部文件加载属性值，例如数据库连接信息。通过定义属性并在配置文件中引用这些属性，可以提高配置文件的可维护性和可配置性。 

<configuration>
    <!-- 加载外部属性文件 -->
    <properties resource="db.properties" />

    <settings>
        <!-- 开启驼峰命名转换 -->
        <setting name="mapUnderscoreToCamelCase" value="true" />
    </settings>

    <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>
        <mapper resource="org/mybatis/example/BlogMapper.xml" />
    </mappers>
</configuration>

在上述配置文件片段中，可以看到Mybatis如何配置连接属性和环境。 <properties> 标签从 db.properties 文件中加载了数据库连接的属性，这样配置的好处是可以在多个文件之间共享和重用数据库配置。 <environments> 标签定义了名为 development 的环境，并设置了事务管理器和数据源的类型。

这种配置方式允许开发者在不同的环境之间切换而不需要修改代码，只需更改配置文件即可。

2.2 XML映射文件解析

2.2.1 映射文件的作用与结构

XML映射文件是Mybatis实现SQL映射的核心。它将SQL语句和Java方法进行映射，使得在Java代码中只需要调用接口方法就能执行对应的SQL语句。映射文件的扩展名为.xml，通常与Mapper接口同名，并存放在同一个包下。

映射文件主要由以下几个部分组成：

  • mapper ：映射器的根元素，具有namespace属性，通常与接口的全限定名相同。
  • parameterMap ：用于定义输入参数的类型和属性。
  • resultMap ：用于定义查询结果集的映射关系。
  • sql ：用于定义SQL片段，可以被多个地方复用。
  • select ：用于定义查询操作的SQL语句。
  • insert ：用于定义插入数据的SQL语句。
  • update ：用于定义更新数据的SQL语句。
  • delete ：用于定义删除数据的SQL语句。

2.2.2 映射文件中的SQL片段复用

在Mybatis中，为了减少代码的冗余并提高代码的复用性，允许定义SQL片段，并在其他SQL语句中引用。这一功能极大地简化了复杂SQL的维护工作。

复用主要通过 <sql> 标签来实现。开发者可以在 <sql> 标签中定义一个SQL片段，并通过 include 标签来引用它。 

<mapper namespace="com.example.mapper.UserMapper">
    <sql id="Base_Column_List">
        id, name, age, email
    </sql>
    <select id="selectUsers" resultType="com.example.model.User">
        SELECT
        <include refid="Base_Column_List"/>
        FROM users
    </select>
</mapper>

上述映射文件中，我们定义了一个SQL片段 Base_Column_List ，该片段包含了查询 users 表时常用的列。在 selectUsers 查询中，我们通过 <include> 标签引用了这个片段。当需要修改查询中要选择的列时，只需修改 Base_Column_List 即可，无需修改每个查询语句。

这种机制极大地提高了SQL的维护效率，并使得配置文件更加清晰。无论项目多大，使用SQL片段都能保持代码的整洁和一致性。

在接下来的章节中，我们将深入讨论Mapper接口与XML文件的关联方式，探索如何通过这些配置将接口方法与SQL语句精确映射，并利用动态SQL来应对复杂的查询需求。

3. Mapper接口与XML文件关联方式

3.1 映射器接口定义

3.1.1 接口与XML映射的关系

在Mybatis中，Mapper接口与XML映射文件之间存在一种密切的联系。Mapper接口可以被视作SQL操作的契约，它定义了一系列可以进行数据库操作的方法，而具体的SQL语句实现则被放置在XML映射文件中。这种分离的设计既可以让开发者集中精力编写接口的业务逻辑，又能灵活地修改底层的SQL实现，从而实现业务逻辑与数据访问逻辑的解耦。

为了建立两者之间的关联，通常需要在接口定义的上方使用特定的注解或者在Mybatis的配置文件中进行映射。例如，使用 @Mapper 注解可以标示一个接口为Mybatis的Mapper接口，而对于XML映射文件，需要在Mybatis的配置文件中通过 <mappers> 标签来引入。 

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

在XML文件中，通常需要使用命名空间（namespace）与接口的完全限定名（fully-qualified name）相同来建立映射关系。如： 

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

3.1.2 接口方法与SQL语句的映射

每个Mapper接口中的方法都需要有一个对应的SQL语句与之对应，这种映射关系是通过接口方法的名称与XML中的SQL语句的id属性来实现的。例如，接口中定义了一个 selectUserById 方法，那么在XML文件中需要有一个 <select> 标签，并且其id属性值为 selectUserById 。 

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

在XML中，对应的SQL语句映射如下： 

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

在上述例子中， <select> 标签定义了要执行的SQL查询， id 属性值 selectUserById 对应接口中定义的方法名， resultType 指定了返回结果的类型。

3.2 动态SQL支持

3.2.1 动态SQL的概念与优势

动态SQL是Mybatis中的一个高级特性，它允许开发者编写在运行时可以根据条件动态变化的SQL语句。这种技术极大地提高了SQL语句的灵活性，允许我们构建复杂的查询而不需要编写大量的样板代码。

使用动态SQL的优点包括：

  • 减少代码重复 ：动态SQL可以复用代码片段，避免了在多个地方编写相同的SQL代码。
  • 提高维护性 ：当业务逻辑变化时，只需要修改动态SQL片段，而不需要修改多个SQL语句。
  • 灵活处理数据 ：可以很容易地根据不同的条件构建不同的查询语句。

3.2.2 动态SQL标签的使用案例

Mybatis提供了一系列的动态SQL标签来支持构建复杂的SQL语句，例如： <if> , <choose> , <when> , <otherwise> , <where> , <foreach> 等。这些标签可以在运行时根据不同的条件动态地包含或排除SQL片段。

例如，我们需要构建一个动态查询的SQL语句，根据传入的参数来决定是否包含某个查询条件。 

<select id="selectUsers" resultType="com.example.domain.User">
  SELECT * FROM users
  <where>
    <if test="name != null">
      AND name LIKE CONCAT('%', #{name}, '%')
    </if>
    <if test="age != null">
      AND age = #{age}
    </if>
  </where>
</select>

在上述 <select> 标签中， <where> 标签会智能地插入 WHERE 关键字，并且会剔除其中条件为空的情况。这样，如果参数 name 为空，则 AND name LIKE ... 部分不会出现在生成的SQL语句中。如果传入的参数都为空，则最终执行的SQL语句简化为 SELECT * FROM users 。

使用动态SQL标签可以极大地提高SQL语句的灵活性，并且简化了代码的复杂度。通过Mybatis的动态SQL特性，开发者可以构建出既强大又易于维护的SQL语句。

4. 使用 标签配置插入数据的SQL语句

4.1 标签的基本使用

4.1.1 标签的属性介绍

在Mybatis中， <insert> 标签用于配置插入数据的SQL语句，它有以下几个属性可供使用：

  • id : 唯一标识符，用于在Mapper接口中引用该语句。
  • parameterType : 指定输入参数的类型，通常用于指定接口方法参数的类型。
  • flushCache : 是否清空本地缓存。默认为false。
  • statementType : 指定Mybatis执行该语句时使用的是哪种Statement对象。可选值为 PREPARED （预编译）、 Callable （调用存储过程），默认为 PREPARED 。
  • useGeneratedKeys : 是否允许JDBC支持自动生成主键。默认为false。
  • keyProperty : 当 useGeneratedKeys 为true时，指定将自动生成的主键赋值给哪个属性。
  • keyColumn : 当 useGeneratedKeys 为true时，指定将自动生成的主键赋值给哪个数据库列。
  • databaseId : 指定数据库厂商标识，用于支持多种数据库兼容。

下面是一个简单的 <insert> 标签使用示例： 

<insert id="insertUser" parameterType="com.example.User" useGeneratedKeys="true" keyProperty="id">
  INSERT INTO users (name, email)
  VALUES (#{name}, #{email})
</insert>

在此示例中， id 属性为插入操作的唯一标识符， parameterType 指定了参数类型为 com.example.User ， useGeneratedKeys 和 keyProperty 表明插入成功后，生成的主键将被设置到用户对象的 id 属性中。

4.1.2 插入操作的参数处理

在Mybatis中， <insert> 标签可以接受简单的参数或复杂的参数对象。简单参数包括基本数据类型、基本数据类型的包装类以及String类型。复杂的参数对象可以是自定义的JavaBean或Map等。

当使用简单参数时，可以直接在SQL语句中使用 #{} 占位符进行参数传递。例如： 

<insert id="insertProduct" parameterType="String">
  INSERT INTO products (name, description)
  VALUES (#{name}, #{description})
</insert>

如果插入操作使用的是复杂参数对象，则可以利用对象属性名作为占位符。例如，一个名为 Product 的JavaBean对象有 name 和 description 属性： 

<insert id="insertProduct" parameterType="com.example.Product">
  INSERT INTO products (name, description)
  VALUES (#{name}, #{description})
</insert>

在这个例子中， #{name} 和 #{description} 将被Mybatis替换为传入的 Product 对象的同名属性值。

4.2 插入操作的事务管理

4.2.1 事务的基本概念

事务是数据库操作的最小工作单元，它保证了一系列的操作要么全部成功，要么全部失败，避免了部分成功带来的数据不一致性问题。事务具备四个基本特性，通常称为ACID：

  • 原子性（Atomicity）：事务中的所有操作必须全部完成，如果任何操作失败，则事务中的所有操作都将被回滚。
  • 一致性（Consistency）：事务必须使数据库从一个一致性状态转换到另一个一致性状态。
  • 隔离性（Isolation）：事务的执行不能被其他事务干扰，即一个事务内部的操作及使用的数据对并发执行的其他事务是隔离的。
  • 持久性（Durability）：一旦事务提交，则其所做的修改就会永久保存在数据库中。

4.2.2 Mybatis事务隔离级别的配置与应用

Mybatis允许开发者通过数据库连接池或者数据源来配置事务隔离级别。在使用Spring框架时，通常会通过配置数据源的属性来设置事务隔离级别。

例如，如果你使用的是HikariCP作为连接池，可以在配置文件中设置： 

# application.properties
spring.datasource.hikari.transaction-isolation=TRANSACTION_READ_COMMITTED

在Mybatis的配置文件中，你可以通过 <environments> 标签配置事务管理器： 

<environments default="development">
    <environment id="development">
        <transactionManager type="JDBC"/>
        <dataSource type="POOLED">
            <!-- 数据库连接属性 -->
        </dataSource>
    </environment>
</environments>

事务管理器的类型可以是 JDBC 或 MANAGED 。当类型为 JDBC 时，Mybatis会使用JDBC的事务管理功能，包括设置事务隔离级别。

设置事务隔离级别的目的是为了提高数据库并发性能，同时保持数据的一致性。以下是常见的事务隔离级别：

  • READ_UNCOMMITTED : 允许读取尚未提交的数据变更。可能导致脏读、不可重复读和幻读。
  • READ_COMMITTED : 允许读取并发事务已经提交的数据。避免了脏读，但不可重复读和幻读仍可能发生。
  • REPEATABLE_READ : 对同一字段的多次读取结果都是一致的，除非数据是被本事务自己所修改。避免了脏读和不可重复读，但幻读可能发生。
  • SERIALIZABLE : 完全串行化的读，避免脏读、不可重复读和幻读。

开发者应根据应用的实际情况选择合适的事务隔离级别。不同的隔离级别需要在性能和数据一致性之间做出权衡。

通过以上内容，我们可以看到 <insert> 标签在Mybatis中的具体使用方法以及事务的基本概念和隔离级别的相关应用。在后续内容中，我们将深入探讨如何通过Mybatis进行SQL操作的解耦和维护扩展性，以提高项目的可维护性和可扩展性。

5. Mybatis SQL操作的解耦及维护扩展性

5.1 SQL映射解耦策略

在处理复杂的应用程序时，SQL操作的紧密耦合会使得代码难以维护和扩展。Mybatis作为一个持久层框架，提供了解耦SQL操作的策略，以便让开发人员可以更专注于业务逻辑的实现，同时减少硬编码SQL语句对系统的干扰。

5.1.1 解耦的重要性与方法

解耦的重要性

解耦意味着减少模块之间的直接依赖，这样做的好处是可以在不影响其他模块的情况下修改、替换甚至扩展某个模块的功能。在Mybatis中，通过将SQL语句与业务代码解耦，可以更容易地管理SQL语句，减少因需求变更带来的影响范围。

解耦的方法

Mybatis通过映射器（Mapper）接口与XML文件的关联，实现了SQL的解耦。开发者只需要在接口中定义方法，然后在XML中编写对应的SQL语句。当需求变更需要修改SQL时，只需修改XML中的SQL语句，而无需修改接口或业务代码，从而实现了两者的解耦。 

// 定义Mapper接口
public interface UserMapper {
    User selectUserById(int id);
}

// XML映射文件中的SQL映射
<select id="selectUserById" resultType="User">
    SELECT * FROM users WHERE id = #{id}
</select>

5.1.2 解耦后SQL维护的优势

集中管理

所有的SQL语句都集中在一个或多个XML文件中，便于维护和管理。开发者可以更快速地找到特定的SQL语句，并进行更新或优化。

版本控制

由于SQL语句与业务代码解耦，它们可以被添加到版本控制系统中。这样，每一次SQL的变更都会有明确的记录，便于追溯历史变更和进行代码审查。

测试易于进行

解耦后的SQL语句可以单独进行测试，减少了测试的整体复杂度。可以通过单元测试直接调用Mapper接口的方法，检验SQL语句的正确性。

更好的团队协作

团队成员可以分工协作，有的负责编写业务代码，有的负责编写和维护SQL语句。这样的分工可以提高开发效率，减少冲突。

5.2 扩展性增强技巧

Mybatis除了提供SQL操作的解耦外，还提供了许多扩展点，以便开发者可以在框架中添加自定义行为，实现更强大的功能。

5.2.1 SQL标签复用与模块化

Mybatis的XML映射文件支持使用各种SQL标签来构建复杂的SQL语句。利用这些标签可以实现SQL代码的复用，进而提高开发效率，维护代码的模块化。

SQL片段复用

SQL片段是Mybatis的一个强大的特性，允许开发者将常用的SQL代码片段定义在 <sql> 标签中，然后在需要的地方通过 <include> 标签引用。 

<!-- 定义SQL片段 -->
<sql id="Base_Column_List">
    id, name, email, phone
</sql>

<!-- 在其他SQL语句中复用 -->
<select id="selectUser" resultType="User">
    SELECT <include refid="Base_Column_List"/> FROM users WHERE active = 1
</select>

模块化设计

在Mybatis的映射文件中，可以通过 <resultMap> 来定义复杂的映射规则。通过这种方式，可以将数据库列和Java对象的属性映射关系模块化，使得映射关系清晰，易于管理。 

<resultMap id="userResultMap" type="User">
    <id column="id" property="id"/>
    <result column="name" property="name"/>
    <result column="email" property="email"/>
    <!-- 其他映射规则 -->
</resultMap>

5.2.2 Mybatis插件的应用与扩展点

Mybatis允许开发者实现插件来拦截核心对象（Executor、StatementHandler、ParameterHandler 和 ResultSetHandler）的执行方法，从而在运行时进行自定义的操作。

插件的应用

插件可以用于执行SQL语句的性能优化、日志记录、分页处理、事务控制等。编写插件通常需要使用Java的动态代理机制。 

@Intercepts({
    @Signature(method = "prepare", type = StatementHandler.class, args = {Connection.class, Integer.class}),
})
public class CustomPlugin implements Interceptor {
    // 实现Interceptor接口的方法
}

通过配置插件，可以在Mybatis启动时自动加载，从而在整个应用程序中生效。

扩展点

Mybatis提供了多个扩展点，允许开发者在不同的生命周期阶段插入自定义的逻辑。例如，可以在SQL语句执行前进行参数的修改，在结果集处理前进行预处理等。

扩展点增强了Mybatis的灵活性，使得开发者可以根据实际业务需要，对框架进行定制和优化。

通过上述方法，开发者可以有效地解耦SQL操作，并通过各种插件和扩展点来增强Mybatis的维护性和可扩展性，从而提高整体开发效率和代码质量。

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

简介：本文将详细介绍如何在Mybatis框架中通过XML文件配置SQL语句，实现数据的插入操作。内容包括Mybatis XML配置文件结构、如何在映射器接口中使用这些配置，以及动态SQL的使用方法。通过具体的代码示例，说明如何将Java对象的属性值映射到SQL语句中的占位符，并执行数据插入操作。


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

晁好刚
关注
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值