当前位置：首页 > article >正文

MyBatis-Mapper 接口与 XML 映射

article 2024/9/24 9:34:42

MyBatis 是一款流行的持久层框架，提供了对 SQL 语句的良好支持和灵活的配置方式。在 MyBatis 中，可以通过两种方式进行 SQL 映射：Mapper 接口 和 XML 映射。这两种方式各有优劣，灵活的使用能够满足不同的开发需求。

一、MyBatis 的核心概念

在讨论 Mapper 接口和 XML 映射之前，首先需要了解 MyBatis 的几个核心概念：

SqlSession：这是 MyBatis 的核心接口，用于执行 SQL 操作，包括插入、更新、删除和查询。
Mapper：Mapper 是一个接口或者 XML 文件，用于定义 SQL 语句与 Java 方法的映射关系。
XML 映射文件：这是 MyBatis 中一种配置 SQL 语句的方式，通常通过 XML 文件将 SQL 与 Java 对象进行映射。
动态 SQL：MyBatis 支持动态 SQL，通过 XML 中的标签（如 <if>、<choose>、<foreach>）来动态生成 SQL 语句。

二、Mapper 接口映射

1. 什么是 Mapper 接口

Mapper 接口是一种直接使用 Java 接口与 SQL 语句进行绑定的方式。Mapper 接口允许我们通过编写接口的方法名，来代替传统的手写 SQL 代码，使得开发更加简洁。MyBatis 会根据方法签名自动匹配 SQL 语句，并返回结果。

2. Mapper 接口示例

假设我们有一个 User 实体类，包含 id、name 和 email 属性。可以通过定义一个 UserMapper 接口来操作用户数据表。

public interface UserMapper {
    // 查询所有用户
    List<User> findAllUsers();

    // 根据 ID 查询用户
    User findUserById(int id);

    // 插入新用户
    void insertUser(User user);

    // 更新用户
    void updateUser(User user);

    // 删除用户
    void deleteUser(int id);
}

3. 使用注解实现 SQL 映射

在 Mapper 接口中，我们可以直接使用注解来实现 SQL 语句的映射，避免使用 XML 文件。MyBatis 提供了多种注解，如 @Select、@Insert、@Update 和 @Delete，用于声明 SQL 语句。

public interface UserMapper {

    @Select("SELECT * FROM users")
    List<User> findAllUsers();

    @Select("SELECT * FROM users WHERE id = #{id}")
    User findUserById(int id);

    @Insert("INSERT INTO users(name, email) VALUES(#{name}, #{email})")
    void insertUser(User user);

    @Update("UPDATE users SET name = #{name}, email = #{email} WHERE id = #{id}")
    void updateUser(User user);

    @Delete("DELETE FROM users WHERE id = #{id}")
    void deleteUser(int id);
}

通过注解方式，SQL 语句直接在 Java 接口中编写，简单直观，适合小型项目或简单 SQL 语句的情况。

4. 优点与缺点

优点：

开发简单，不需要 XML 配置文件。
代码与 SQL 语句紧密结合，便于理解和维护。
避免了大量的配置文件，代码更简洁。

缺点：

当 SQL 语句较为复杂时，代码会显得繁杂，难以维护。
不易复用 SQL 片段，尤其是涉及到动态 SQL 的时候，注解方式会显得冗长。
注解不适合处理长篇 SQL 查询，尤其是多表关联查询。

三、XML 映射

1. 什么是 XML 映射

XML 映射是 MyBatis 中更传统的方式，它通过 XML 文件来编写 SQL 语句，将 SQL 与 Mapper 接口的方法进行绑定。XML 映射提供了更强的灵活性，特别是对于动态 SQL 以及复杂查询的情况，更加清晰易维护。

2. XML 映射示例

继续以 User 实体类为例，首先需要定义 UserMapper.xml 文件，并在其中编写 SQL 语句。

UserMapper.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">

    <!-- 查询所有用户 -->
    <select id="findAllUsers" resultType="User">
        SELECT * FROM users
    </select>

    <!-- 根据 ID 查询用户 -->
    <select id="findUserById" parameterType="int" resultType="User">
        SELECT * FROM users WHERE id = #{id}
    </select>

    <!-- 插入新用户 -->
    <insert id="insertUser" parameterType="User">
        INSERT INTO users (name, email)
        VALUES (#{name}, #{email})
    </insert>

    <!-- 更新用户 -->
    <update id="updateUser" parameterType="User">
        UPDATE users SET name = #{name}, email = #{email} WHERE id = #{id}
    </update>

    <!-- 删除用户 -->
    <delete id="deleteUser" parameterType="int">
        DELETE FROM users WHERE id = #{id}
    </delete>

</mapper>

在上述 XML 文件中：

<select> 标签用于定义查询语句。
<insert> 标签用于插入数据。
<update> 和 <delete> 分别用于更新和删除操作。
#{} 用于参数占位符，它会自动将 Java 对象的属性值映射到 SQL 中。

3. Mapper 接口与 XML 的绑定

在使用 XML 映射时，我们需要在 UserMapper 接口中定义方法，但不需要为这些方法添加注解。MyBatis 会自动将接口与对应的 XML 映射文件关联。

public interface UserMapper {
    List<User> findAllUsers();
    User findUserById(int id);
    void insertUser(User user);
    void updateUser(User user);
    void deleteUser(int id);
}

MyBatis 会根据方法名自动匹配 XML 中的 SQL 语句，并执行相应的数据库操作。

4. 动态 SQL

动态 SQL 是 XML 映射的一大优势。MyBatis 提供了丰富的动态 SQL 支持，可以根据传入的参数动态生成 SQL 语句。例如，使用 <if> 标签进行条件判断：

<select id="findUsers" resultType="User">
    SELECT * FROM users
    <where>
        <if test="name != null">
            AND name = #{name}
        </if>
        <if test="email != null">
            AND email = #{email}
        </if>
    </where>
</select>