mybatis中@Param注解的四种使用场景
第一种:方法有多个参数,需要 @Param 注解
例如:
@Mapper
public interface UserMapper {
Integer insert(@Param("username") String username, @Param("address") String address);
}
对应的 XML 文件如下:
<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);
}
对应的 XML 定义如下:
<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);
}
对应的 XML 定义如下:
<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);
}
定义出来的 SQL 如下:
<select id="getUserById" resultType="org.javaboy.helloboot.bean.User">
select * from user
<if test="id!=null">
where id=#{id}
</if>
</select>
这种情况,即使只有一个参数,也需要添加 @Param 注解,而这种情况却经常被人忽略!