MyBatis@Param注解的用法

一、前言

本人在学习mybatis的过程中遇到的一个让人不爽的bug,在查找了些相关的资料后得以解决,遂记录。

二、报错及解决

mapper中有一方法:

@Select("select * from emp " +
            "where name like concat('%', #{name}, '%') " +
            "and gender = #{gender} " +
            "and entrydate between #{begin} and #{end} " +
            "order by update_time desc")
 public List<Emp> list(String name,Short gender, LocalDate begin, LocalDate end);

测试方法:

 @Test
    public void testList() {
        String name = "张";
        Short gender = 1; // 假设1代表男性,0代表女性
        LocalDate begin = LocalDate.parse("2001-01-01");
        LocalDate end = LocalDate.parse("2023-12-31");

        List<Emp> empList = empMapper.list(name, gender, begin, end);

        // 遍历打印查询结果
        for (Emp emp : empList) {
            System.out.println(emp);
        }
    }

报错信息:
org.mybatis.spring.MyBatisSystemException: nested exception is org.apache.ibatis.binding.BindingException: Parameter 'name' not found. Available parameters are [arg3, arg2, arg1, arg0, param3, param4, param1, param2]

说是name参数找不到,靠。

原因:
在 MyBatis 中,当方法参数只有一个时,会使用基于位置的参数映射。这意味着 MyBatis 会将第一个参数与 SQL 查询语句中的第一个占位符进行匹配,以此类推。

然而,当方法参数超过一个时,MyBatis 就无法准确地确定每个参数应该映射到 SQL 查询语句中的哪个占位符。

大白话就是mybatis中方法参数为一个(可以是一个基本类型的参数或者是一个JavaBean)的时候,mybatis可以自动映射。有多个参数时需要一些措施让他成功映射。

解决方法:

1、使用 @Param 注解为方法参数指定名称:

@Select("select * from emp " +
            "where name like concat('%', #{name}, '%') " +
            "and gender = #{gender} " +
            "and entrydate between #{begin} and #{end} " +
            "order by update_time desc")
public List<Emp> list(@Param("name") String name, @Param("gender") Short gender, @Param("begin") LocalDate begin, @Param("end") LocalDate end);

在接口方法中使用 @Param 注解为每个参数指定名称,确保名称与 SQL 查询语句中的占位符名称匹配。

2、将参数包装在一个对象中:

创建一个包含所有查询参数的对象,例如 EmpQuery,并将该对象作为方法的参数:

@Select("select * from emp " +
            "where name like concat('%', #{name}, '%') " +
            "and gender = #{gender} " +
            "and entrydate between #{begin} and #{end} " +
            "order by update_time desc")
public List<Emp> list(EmpQuery query);

其中 EmpQuery 类包括 namegenderbeginend 等字段。

三、@Param

1、概述

首先明确这个注解是为SQL语句中参数赋值而服务的。

@Param的作用就是给参数命名,比如在mapper里面某方法A(int id),当添加注解后A(@Param("userId") int id),也就是说外部想要取出传入的id值,只需要取它的参数名userId就可以了。将参数值传如SQL语句中,通过#{userId}进行取值给SQL的参数赋值。

2、实例:

实例一:@Param注解基本类型的参数

public User selectUser(@Param("userName") String name,@Param("password") String pwd);

映射到xml中的标签

<select id="selectUser" resultMap="User">  
   select * from user  where user_name = #{userName} and user_password=#{password}  
</select>

实例二:@Param注解JavaBean对象

SQL语句通过@Param注解中的别名把对象中的属性取出来然后复制

mapper中的方法:

public List<User> getAllUser(@Param("user") User u);

映射到xml中的标签

<select id="getAllUser" parameterType="com.vo.User" resultMap="userMapper">  
        select   
        from user t where 1=1  
             and   t.user_name = #{user.userName}  
              and   t.user_age = #{user.userAge}  
 </select>  

<!-- 不加@Param的话 -->
<select id="getAllUser" parameterType="com.vo.User" resultMap="userMapper">  
        select   
        from user t where 1=1  
             and   t.user_name = #{userName}  
              and   t.user_age = #{userAge}  
 </select>  

3、注意点
使用了@Param注解来声明参数的时候,SQL语句取值使用#{}${}取值都可以。

不使用@Param注解声明参数的时候,必须使用的是#{}来取参数。使用${}方式取值会报错。

不使用@Param注解时,参数只能有一个,并且是Javabean。在SQL语句里可以引用JavaBean的属性,而且只能引用JavaBean的属性。

参考文章:【详解】@Param注解的用法

MyBatis中的@Param注解是用来指定方法参数与SQL语句中的参数对应关系的。 在MyBatis中,SQL语句中的参数是通过#{parameterName}的格式指定的,而方法参数则是以参数名作为占位符的。当方法参数与SQL语句中的参数名不一致时,就需要使用@Param注解来指定它们之间的对应关系。 例如,假设有一个方法是这样的: ```java public List<User> getUserByNameAndAge(String name, int age); ``` 对应的SQL语句是这样的: ```xml <select id="getUserByNameAndAge" resultType="User"> SELECT * FROM user WHERE name=#{name} AND age=#{age} </select> ``` 可以看到,SQL语句中的参数名与方法参数名并不一致,这时就需要使用@Param注解来指定它们之间的对应关系: ```java public List<User> getUserByNameAndAge(@Param("name") String name, @Param("age") int age); ``` 这样,在SQL语句中就可以使用#{name}和#{age}来分别表示name和age两个参数了。 除了指定参数名之外,@Param注解还可以用来指定参数类型。例如,假设有一个方法是这样的: ```java public void updateUser(User user); ``` 对应的SQL语句是这样的: ```xml <update id="updateUser"> UPDATE user SET name=#{user.name}, age=#{user.age} WHERE id=#{user.id} </update> ``` 可以看到,SQL语句中的参数是一个对象,但是方法参数只有一个User对象。这时就需要使用@Param注解来指定参数类型: ```java public void updateUser(@Param("user") User user); ``` 这样,在SQL语句中就可以使用#{user.name}、#{user.age}和#{user.id}来分别表示User对象的name、age和id属性了。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值