MyBatis映射文件配置：入参详解

MyBatis 是一个优秀的持久层框架，它简化了数据库操作的复杂性，尤其是在处理 SQL 语句和 Java 对象之间的映射时。在 MyBatis 中，映射文件的配置是非常重要的一部分，尤其是如何正确地处理 SQL 语句的入参。本文将详细介绍 MyBatis 映射文件中入参的配置方式，帮助开发者更好地理解和使用 MyBatis。

1. parameterType 属性

在 MyBatis 的映射文件中，parameterType 属性用于指定 SQL 语句的入参类型。虽然这个属性是可选的，但在某些情况下，明确指定参数类型可以帮助 MyBatis 更好地处理参数。

可选性：MyBatis 可以通过类型处理器（TypeHandler）自动推断参数类型，因此 parameterType 属性是可选的。
支持的参数类型：
- 基本数据类型（如 int、String 等）
- 包装类（如 Integer、String 等）
- 实体类（POJO）
- Map

2. 单个参数的入参处理

当接口方法传入单个参数时，MyBatis 的处理非常简单。

示例：

// 接口方法
User queryById(Integer id);

<!-- 映射文件 -->
<select id="queryById" resultType="User" parameterType="int">
    select user_name AS userName from user where id = #{id}
</select>

说明：
- 在 XML 中，可以使用任意变量名（如 #{id}）来接收参数。
- 建议使用与参数名一致的变量名，以提高代码的可读性。

3. 多个参数的入参处理

当接口方法传入多个参数时，MyBatis 的处理稍微复杂一些。默认情况下，MyBatis 会将多个参数封装为一个 Map，并使用参数的索引或位置来访问这些参数。

示例：

// 接口方法
List<User> findUsersByUserNameAndSex(String name, String sex);

<!-- 映射文件 -->
<select id="findUsersByUserNameAndSex" resultType="User">
    select * from user where user_name = #{param1} and sex = #{param2}
</select>

问题：
- 直接使用参数名（如 #{name}）会导致 Parameter 'name' not found 的错误。

解决方案：

使用参数索引：

通过 arg0、arg1 或 param1、param2 来访问参数。

示例：

<select id="findUsersByUserNameAndSex" resultType="User">
    select * from user where user_name = #{arg0} and sex = #{arg1}
</select>

使用命名参数：

在接口方法中使用 @Param 注解为参数命名，然后在 XML 中使用这些名称。

示例：

List<User> findUsersByUserNameAndSex(@Param("name") String name, @Param("sex") String sex);

<select id="findUsersByUserNameAndSex" resultType="User">
    select * from user where user_name = #{name} and sex = #{sex}
</select>

推荐方式：使用 @Param 注解为参数命名，这种方式更直观且易于维护。

4. POJO 参数的入参处理

当接口方法传入一个 POJO 对象时，MyBatis 可以直接通过对象的属性名来访问参数。

示例：

// 接口方法
void saveUser(User user);

<!-- 映射文件 -->
<insert id="saveUser">
    insert into user values(null, #{username}, #{age}, #{birthday}, #{sex}, #{address})
</insert>

说明：
- 在 XML 中，使用 #{属性名} 可以直接访问 POJO 对象的属性值。
- 属性名必须与 POJO 类中的字段名一致。

5. Map 参数的入参处理

当接口方法传入一个 Map 对象时，MyBatis 可以通过 Map 的键名来访问参数。

示例：

// 接口方法
List<User> queryByNameAndSex(Map<String, String> map);

<!-- 映射文件 -->
<select id="queryByNameAndSex" resultType="User" parameterType="map">
    select * from user where user_name = #{name} and sex = #{sex}
</select>

说明：
- 在 XML 中，使用 #{key} 可以直接访问 Map 中的值。
- 键名必须与 Map 中的键一致。

6. 注意事项

单个参数：
- 可以使用任意变量名接收参数，但建议使用与参数名一致的变量名。
多个参数：
- 推荐使用 @Param 注解为参数命名，避免使用参数索引或位置。
POJO 参数：
- XML 中的参数名必须与 POJO 类中的属性名一致。
Map 参数：
- XML 中的参数名必须与 Map 中的键名一致。

7. 总结

MyBatis 提供了多种方式来处理 SQL 语句的入参，开发者可以根据实际情况选择合适的方式：

单个参数：简单直接，使用任意变量名接收。
多个参数：推荐使用 @Param 注解为参数命名，避免参数索引或位置的混乱。
POJO 参数：通过属性名直接访问对象的属性。
Map 参数：通过键名直接访问 Map 中的值。

通过合理地配置 parameterType 和使用注解，可以大大提高 MyBatis 的开发效率和代码的可维护性。

希望本文能帮助您更好地理解和使用 MyBatis 的入参配置。如果您有任何问题或建议，欢迎留言讨论！

标签：Map,name,入参,详解,参数,user,MyBatis,sex
From： https://www.cnblogs.com/itcq1024/p/18602254

MyBatis映射文件配置：入参详解