Mapper 代理开发方式，并进一步对比使用 resource 属性的方式

小小不清楚

于 2024-11-15 17:09:09 发布

阅读量818

点赞数 25

文章标签： java tomcat mybatis

本文链接：https://blog.youkuaiyun.com/qq_51263863/article/details/143803541

版权

一、什么是 Mapper 代理开发方式？

1. Mapper 代理的基本概念

Mapper 代理 是 MyBatis 提供的一种机制，它利用 Java 的动态代理技术，自动为您的 DAO 接口生成实现类。这样，您无需手动编写 DAO 接口的实现类，只需定义接口方法和对应的 SQL 语句，MyBatis 会在运行时生成代理对象，并处理方法调用，将其映射到相应的 SQL 语句执行。

2. 代理机制的工作流程

接口定义：您定义一个 DAO 接口（如 UserMapper），声明方法但不实现。
XML 映射：创建一个与接口同名的 Mapper XML 文件（如 UserMapper.xml），在其中编写对应的方法的 SQL 语句。
MyBatis 配置：在 MyBatis 配置文件中，通过 <mapper class="com.example.mapper.UserMapper"/> 指定 Mapper 接口。
获取代理对象：在代码中，通过 SqlSession 获取该接口的代理对象，调用方法时，MyBatis 会自动执行对应的 SQL 语句。

3. 优点

简化开发：无需手动编写实现类，减少样板代码。
类型安全：编译时即可检查方法签名，提高代码可靠性。
易于维护：接口与 SQL 映射清晰分离，便于管理和修改。

二、Mapper 代理与使用 `resource` 属性的区别

1. 使用 `resource` 属性

配置方式：在 MyBatis 配置文件中，通过 <mapper resource="com/example/mapper/UserMapper.xml"/> 明确指定 Mapper XML 文件的位置。
适用场景：适用于 Mapper XML 文件路径不遵循与接口一致的命名规则，或者需要手动指定路径的情况。
示例配置：

<!-- mybatis-config.xml -->
<configuration>
    <mappers>
        <mapper resource="com/example/mapper/UserMapper.xml"/>
    </mappers>

</configuration>

特点：

- 手动指定路径：需要明确知道 XML 文件的位置。
- 灵活性较高：适用于文件路径不规范或有特殊需求的场景。

2. 使用 Mapper 代理（`class` 属性）

配置方式：在 MyBatis 配置文件中，通过 <mapper class="com.example.mapper.UserMapper"/> 指定 Mapper 接口的全限定名，MyBatis 会自动根据接口名称加载对应的 Mapper XML 文件。
适用场景：适用于 Mapper 接口和 XML 文件命名一致，且放置在同一编译后的目录结构中。
示例配置：

<!-- mybatis-config.xml -->
<configuration>
    <mappers>
        <mapper class="com.example.mapper.UserMapper"/>
    </mappers>

</configuration>

特点：

- 自动匹配：无需手动指定 XML 文件路径，MyBatis 根据接口名自动加载。
- 规范要求：接口名与 XML 文件名必须一致，且放在相同的包路径下。
- 开发简便：减少配置步骤，适合大多数常规项目。

3. 对比总结

方式	配置方式	优点	缺点
`resource` 属性	手动指定 Mapper XML 文件路径	灵活，适用于特殊路径或不规范命名的场景	需要手动维护路径，增加配置复杂度
Mapper 代理方式	指定 Mapper 接口的全限定名，自动加载对应 XML 文件	配置简便，减少样板代码，适用于规范命名的项目	需要接口与 XML 文件命名和路径严格一致

三、具体实现步骤与示例

1. 目录结构

确保在 编译后的目录（如 target/classes）中，Mapper 接口和 XML 文件位于相同的包路径下。例如：

src/main/java/com/example/mapper/
    UserMapper.java
src/main/resources/com/example/mapper/
    UserMapper.xml

编译后：

target/classes/com/example/mapper/
    UserMapper.class
    UserMapper.xml

2. DAO 接口定义

// src/main/java/com/example/mapper/UserMapper.java
package com.example.mapper;
import com.example.model.User;
import java.util.List;
public interface UserMapper {
    User selectUserById(int id);
    List<User> selectAllUsers();
    void insertUser(User user);
    void updateUser(User user);
    void deleteUser(int id);
}

3. Mapper XML 文件

<!-- src/main/resources/com/example/mapper/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="selectUserById" parameterType="int" resultType="com.example.model.User">
        SELECT * FROM users WHERE id = #{id}
    </select>

    <select id="selectAllUsers" resultType="com.example.model.User">
        SELECT * FROM users
    </select>

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

    <update id="updateUser" parameterType="com.example.model.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>

4. MyBatis 配置文件

使用 Mapper 代理方式：

<!-- src/main/resources/mybatis-config.xml -->
<configuration>
    <mappers>
        <mapper class="com.example.mapper.UserMapper"/>
    </mappers>

</configuration>

5. 获取 Mapper 代理对象并调用方法

// src/main/java/com/example/Main.java
package com.example;
import com.example.mapper.UserMapper;
import com.example.model.User;
import org.apache.ibatis.session.SqlSession;
public class Main {
    public static void main(String[] args) {
        try (SqlSession session = MyBatisUtil.getSqlSession()) {
            // 获取 Mapper 代理对象
            UserMapper userMapper = session.getMapper(UserMapper.class);
            
            // 调用方法
            User user = userMapper.selectUserById(1);
            System.out.println(user);
        }
    }
}

解释：

session.getMapper(UserMapper.class)：MyBatis 会自动生成 UserMapper 接口的代理对象。
调用 userMapper.selectUserById(1) 时，MyBatis 会根据 UserMapper.xml 中对应的 <select> 标签执行 SQL，并返回结果。