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

前言

大家都知道当方法中存在多个参数的时候，才需要添加@Param注解，然而这种理解是不准确的。即使方法中只有一个参数，也有可能会用到@Param注解的。但是，到底何时才需要呢，是不是感觉有点莫名其妙啊，仅当一个参数时，有时候需要添加@Param注解，否则会报错，有时候不需要添加。有人觉得是Mybatis的版本不同导致的。
不可否认，Mybatis发展快，个版本之间确实存在这差异，但是这个@Param注解问题，确实不是版本的锅。那么，下面我将集中需要@Param的场景记录下来。

第一种：方法有多个参数，需要@Param（最常见）

例如下面这样：
接口方法：

Integer insertUser(@Param("id") Integer id, @Param("username") String username, @Param("password") String password, @Param("age") Integer age);

xml文件：

    <insert id="insertUser">
        INSERT INTO T_USER (ID, USERNAME, PASSWORD, AGE)
        VALUES(#{id}, #{username}, #{password}, #{age})
    </insert>

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

当需要给一个参数取一个别名时，我们也需要@Param注解，例如：
接口方法：

User getUserByUsername(@Param("name") String username);

xml文件：

<select id="getUserByUsername" resultMap="BaseResultMap" parameterType="String">
        SELECT * FROM T_USER WHERE USERNAME = #{name}
</select>

第三种：xml中的SQL使用了$，需要@Param

虽然$存在SQL注入安全问题，但是有时候确实要使用，比如说传入列名或者表名时，就需要加上@Param注解，例如：
接口方法：

List<User> getUsersOrderByParam(@Param("order_by") String order_by);

xml文件：

<select id="getUsersOrderByParam" resultMap="BaseResultMap" parameterType="String">
        SELECT * FROM T_USER
        <if test="order_by != null and order_by != ''">
            ORDER BY ${order_by} DESC
        </if>
</select>

第四种：动态SQL中使用参数作为变量，则需要@Param注解，即使只有一个参数。

这一种是比较特殊的，但是也是容易出错的，如果在动态SQL中使用参数作为判断条件，那么久要加上@Param注解，例如：
接口方法：

User getUserById(@Param("id") Integer id);

xml文件：

    <select id="getUserById" resultMap="BaseResultMap">
        SELECT * FROM T_USER
        <where>
            <if test="id != null">
                ID = #{id}
            </if>
        </where>
    </select>

这种情况，即使只有一个参数，也需要添加@Param注解，否则会报错，这种情况也最容易被忽略。