MyBatis 接口绑定主要有两种实现方式，它们都旨在将 Mapper 接口的方法与 SQL 语句关联起来，从而实现无需编写 Mapper 接口实现类即可执行 SQL 操作。 这两种方式分别是：
1. XML 映射文件绑定 (XML Mapper Configuration):
- 实现方式: 这是 MyBatis 最传统和最常用的接口绑定方式。它通过在 XML 映射文件中定义 SQL 语句，并将 XML 文件的 namespace 属性设置为 Mapper 接口的完全限定名，然后通过 XML 文件中的
- 具体操作步骤:
- a) 定义 Mapper 接口: 创建一个 Java 接口，接口中的方法对应数据库操作。
- java复制代码
- package com.example.mapper; import com.example.model.User; import org.apache.ibatis.annotations.Param; public interface UserMapper { User getUserById(@Param("id") int id); int insertUser(User user); int updateUser(User user); int deleteUser(@Param("id") int id); }
- b) 创建 XML 映射文件: 创建一个 XML 文件 (通常与 Mapper 接口同名，例如 UserMapper.xml)，并放置在资源目录下 (例如 src/main/resources/mapper/)。
- xml复制代码
- <!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="getUserById" parameterType="int" resultType="com.example.model.User"> SELECT * FROM users WHERE id = #{id} </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>
- c) 在 MyBatis 配置文件中注册 XML 映射文件: 在 mybatis-config.xml 文件中，通过
标签注册 XML 映射文件。 - xml复制代码
- <configuration> <mappers> <mapper resource="mapper/UserMapper.xml"/> </mappers> </configuration>
- d) 获取 Mapper 接口实例并使用: 通过 SqlSession 获取 Mapper 接口的实例，然后调用接口方法执行 SQL 操作。
- java复制代码
- SqlSession sqlSession = sqlSessionFactory.openSession(); try { UserMapper userMapper = sqlSession.getMapper(UserMapper.class); // 获取 Mapper 接口实例 User user = userMapper.getUserById(1); // 调用接口方法，MyBatis 会执行 UserMapper.xml 中 id="getUserById" 的 SQL System.out.println(user); // ... 其他操作 ... } finally { sqlSession.close(); }
- 原理: MyBatis 在启动时会解析 mybatis-config.xml 文件，加载注册的 XML 映射文件。它会读取 XML 文件中的 namespace 和各个 SQL 标签的 id 属性，并将它们与对应的 Mapper 接口和方法关联起来。 当通过 sqlSession.getMapper(UserMapper.class) 获取 Mapper 接口实例时，MyBatis 会动态地创建一个 Mapper 接口的代理对象。 当调用代理对象的方法时，MyBatis 会根据方法名找到对应的 XML 映射文件中 id 相同的 SQL 语句并执行。
2. 注解绑定 (Annotation Configuration):
- 实现方式: 注解绑定直接在 Mapper 接口的方法上使用 MyBatis 提供的注解 (例如 @Select, @Insert, @Update, @Delete) 来定义 SQL 语句。
- 具体操作步骤:
- a) 定义 Mapper 接口并使用注解: 在 Mapper 接口的方法上使用注解来定义 SQL 语句。
- java复制代码
- package com.example.mapper; import com.example.model.User; import org.apache.ibatis.annotations.*; public interface UserMapper { @Select("SELECT * FROM users WHERE id = #{id}") // 使用 @Select 注解定义 SQL User getUserById(@Param("id") int id); @Insert("INSERT INTO users(name, email) VALUES(#{name}, #{email})") // 使用 @Insert 注解定义 SQL int insertUser(User user); @Update("UPDATE users SET name = #{name}, email = #{email} WHERE id = #{id}") // 使用 @Update 注解定义 SQL int updateUser(User user); @Delete("DELETE FROM users WHERE id = #{id}") // 使用 @Delete 注解定义 SQL int deleteUser(@Param("id") int id); }
- b) 在 MyBatis 配置文件中注册 Mapper 接口 (可选，但推荐): 在 mybatis-config.xml 文件中，可以通过
标签注册 Mapper 接口所在的包，MyBatis 会自动扫描该包下的所有接口并进行绑定。 - xml复制代码
- <configuration> <mappers> <package name="com.example.mapper"/> </mappers> </configuration>
- 注意: 如果使用包扫描注册，MyBatis 会扫描包下所有接口，如果某些接口不需要被 MyBatis 管理，需要进行排除配置或者放在不同的包下。
- c) 获取 Mapper 接口实例并使用 (与 XML 绑定相同): 通过 SqlSession 获取 Mapper 接口的实例，然后调用接口方法执行 SQL 操作。
- java复制代码
- SqlSession sqlSession = sqlSessionFactory.openSession(); try { UserMapper userMapper = sqlSession.getMapper(UserMapper.class); // 获取 Mapper 接口实例 User user = userMapper.getUserById(1); // 调用接口方法，MyBatis 会执行 @Select 注解中的 SQL System.out.println(user); // ... 其他操作 ... } finally { sqlSession.close(); }
- 原理: MyBatis 在启动时会解析 mybatis-config.xml 文件，加载注册的 Mapper 接口或包。 它会扫描 Mapper 接口，读取接口方法上的注解 (例如 @Select, @Insert 等) 中定义的 SQL 语句，并将它们与对应的方法关联起来。 同样，当通过 sqlSession.getMapper(UserMapper.class) 获取 Mapper 接口实例时，MyBatis 会动态地创建一个 Mapper 接口的代理对象。 当调用代理对象的方法时，MyBatis 会根据方法找到对应方法上的注解 SQL 语句并执行。
总结:
实现方式 | XML 映射文件绑定 (XML Mapper Configuration) | 注解绑定 (Annotation Configuration) |
SQL 定义位置 | XML 映射文件 | Mapper 接口方法注解 |
配置方式 | XML 文件配置 | 注解配置 |
可读性 (简单SQL) | 中等 | 高 |
可读性 (复杂SQL) | 高 | 低 |
维护性 (简单SQL) | 中等 | 中等 |
维护性 (复杂SQL) | 高 | 低 |
动态 SQL | 强大，XML 标签 | 相对较弱，@Script 注解 |
SQL 与代码解耦 | 高 | 低 |
适用场景 | 复杂 SQL, 大型项目, 需要 SQL 与代码解耦 | 简单 CRUD, 小型项目, 简单 SQL |
选择建议:
- 简单 CRUD 操作或小型项目: 注解绑定通常更简洁快速。
- 复杂 SQL 操作、动态 SQL、大型项目、需要 SQL 与代码解耦: XML 映射文件绑定更适合，更易于维护和管理复杂的 SQL。
- 混合使用: 在实际项目中，可以根据具体情况混合使用两种方式，例如简单的 CRUD 使用注解，复杂的查询或动态 SQL 使用 XML。
无论选择哪种方式，MyBatis 的核心思想都是将 SQL 语句与 Java 代码分离，提高代码的可维护性和灵活性。 接口绑定是 MyBatis 的核心特性之一，它极大地简化了数据库操作的代码编写，提高了开发效率。