MyBatis 中 @Param 注解的四种使用场景

柔光的暖阳◎ 2022-10-22 12:52 99阅读 0赞

转载自：[https://zhuanlan.zhihu.com/p/74853451][https_zhuanlan.zhihu.com_p_74853451]

# 叙述 #

有一些小伙伴觉得 MyBatis 只有方法中存在多个参数的时候，才需要添加 @Param 注解，其实这个理解是不准确的。即使 MyBatis 方法只有一个参数，也可能会用到 @Param 注解。

但是，在你总结出规律之前，你可能会觉得莫名其妙，有的时候一个参数明明不用添加 @Param 注解，有的时候，却需要添加，不添加会报错。

有的人会觉得这是 MyBatis 各个版本差异的锅，不可否认，MyBatis 发展很快，不同版本之间的差异还挺明显的，不过这个加不加 @Param 注解的问题，却并不是版本的锅！今天松哥就和大家来聊一聊这个问题，到底哪些情况下需要添加 @Param 注解。

## 场景 ##

首先，如下几个需要添加 @Param 注解的场景，相信大家都已经有共识了：

*  第一种：方法有多个参数，需要 @Param 注解

@Mapper
    public interface UserMapper {
     Integer insert(@Param("username") String username, @Param("address") String address);
    }

<insert id="insert" parameterType="org.javaboy.helloboot.bean.User">
        insert into user (username,address) values (#{username},#{address});
    </insert>

*  第二种：方法参数要取别名，需要 @Param 注解

@Mapper
    public interface UserMapper {
     User getUserByUsername(@Param("name") String username);
    }

<select id="getUserByUsername" parameterType="org.javaboy.helloboot.bean.User">
        select * from user where username=#{name};
    </select>

*  第三种：XML 中的 SQL 使用了 $ ，那么参数中也需要 @Param 注解

$ 会有注入漏洞的问题，但是有的时候你不得不使用 $ 符号，例如要传入列名或者表名的时候，这个时候必须要添加 @Param 注解

@Mapper
    public interface UserMapper {
     List<User> getAllUsers(@Param("order_by")String order_by);
    }

<select id="getAllUsers" resultType="org.javaboy.helloboot.bean.User">
        select * from user
     <if test="order_by!=null and order_by!=''">
            order by ${order_by} desc
     </if>
    </select>

*  第四种，那就是动态 SQL ，如果在动态 SQL 中使用了参数作为变量，那么也需要 @Param 注解，即使你只有一个参数

@Mapper
    public interface UserMapper {
     List<User> getUserById(@Param("id")Integer id);
    }

<select id="getUserById" resultType="org.javaboy.helloboot.bean.User">
        select * from user
     <if test="id!=null">
            where id=#{id}
     </if>
    </select>

[https_zhuanlan.zhihu.com_p_74853451]: https://zhuanlan.zhihu.com/p/74853451