MyBatis中參數使用 @Param 註解的四種使用場景

Mybatis中參數使用@Param註解的四種使用場景
前言
第一種：方法有多個參數，需要@Param（最常見）
第二種：方法參數要取別名，需要@Param
第三種：xml中的SQL使用了$，需要@Param
第四種：動態SQL中使用參數作爲變量，則需要@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註解，否則會報錯，這種情況也最容易被忽略。
————————————————
版權聲明：本文爲CSDN博主「不倒翁868」的原創文章，遵循 CC 4.0 BY-SA 版權協議，轉載請附上原文出處鏈接及本聲明。
原文鏈接：https://blog.csdn.net/kangxingjun/article/details/96990918