Mybatis中的Mapper代理

以你之姓@ 2024-03-17 21:44 93阅读 0赞

在MyBatis中，Mapper代理是一种流行的用于执行数据库操作的方式。通过使用Mapper代理，您可以编写接口来定义与数据库交互的方法，并让MyBatis根据接口和映射文件的配置生成相应的实现代码。

使用Mapper代理的步骤如下：

1.  创建一个Java接口，该接口包含与数据库交互相关的方法声明。
2.  使用 `@Mapper`注解或者在MyBatis的配置文件中进行配置，将该接口标识为Mapper接口。
3.  在MyBatis的配置文件中，为Mapper接口配置相应的映射文件或者使用注解方式直接映射。
4.  在DAO层或者Service层中，通过使用 `SqlSession.getMapper()`方法获取Mapper接口的实例。
5.  可以使用获取到的Mapper接口对象调用其中的方法，MyBatis会根据映射配置帮助您执行相应的数据库操作。

MyBatis会根据Mapper接口的方法名、参数类型以及返回类型来动态生成底层的SQL语句和执行代码。这简化了数据库操作的编写过程，同时保持了灵活性。

虽然Mapper代理提供了很大的便利性，但需要确保Mapper接口定义的方法与对应的映射文件或者注解配置保持一致，否则可能会导致运行时错误。

当配置了Mapper接口和对应的映射文件后，可以通过Java代码来使用Mapper代理进行数据库操作。下面是一个例子：

首先，假设有一个数据库表存储 `User`信息。我们创建一个Mapper接口 `UserMapper`，并定义方法来进行相关的数据库操作：

public interface UserMapper {
        User getUserById(int userId);
        void insertUser(User user);
        void updateUser(User user);
        void deleteUser(int userId);
        List<User> getAllUsers();
    }

然后，可以提供Mapper接口对应的映射文件UserMapper.xml,其中定义了具体的SQL语句和映射规则：

<?xml version="1.0" encoding="UTF-8"?>
    <mapper namespace="com.example.dao.UserMapper">
        <select id="getUserById" resultType="com.example.model.User">
            SELECT * FROM users WHERE id = #{userId}
        </select>
      
        <insert id="insertUser">
            INSERT INTO users(id, name, age) VALUES (#{id}, #{name}, #{age})
        </insert>
    
        <update id="updateUser">
            UPDATE users SET name = #{name}, age = #{age} WHERE id = #{id}
        </update>
    
        <delete id="deleteUser">
            DELETE FROM users WHERE id = #{userId}
        </delete>
      
        <select id="getAllUsers" resultType="com.example.model.User">
            SELECT * FROM users
        </select>
    </mapper>

接下来，在Java代码中获取一个SqlSession对象并获取Mapper接口实例，然后就可以调用Mapper接口的方法来执行数据库操作：

// 获取SqlSessionFactory实例（需要提前配置好）
    SqlSessionFactory sqlSessionFactory = ...
    
    // 获取SqlSession对象
    try (SqlSession sqlSession = sqlSessionFactory.openSession()) {
        // 获取Mapper接口实例
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
      
        // 使用Mapper代理执行数据库操作
        User user = userMapper.getUserById(1);
        System.out.println(user.getName());
      
        List<User> users = userMapper.getAllUsers();
        System.out.println(users);
        
        User newUser = new User(2, "John", 25);
        userMapper.insertUser(newUser);
      
        newUser.setAge(26);
        userMapper.updateUser(newUser);
      
        userMapper.deleteUser(2);
      
        sqlSession.commit();  // 提交事务
    }

以上代码展示了如何通过Java代码使用Mapper代理进行数据库操作。使用Mapper代理可以方便地调用不同的方法来执行数据库查询、插入、更新和删除操作，MyBatis框架会根据相应的映射文件来生成和执行SQL语句。