mybatis中必须使用@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 注解时,mybatis 是不认识哪个参数叫什么名字的,尽管在接口中定义了参数的名称,mybatis仍然不认识。这时mybatis将会以接口中参数定义的顺序和SQL语句中的表达式进行映射,这是默认的。
二、方法参数要取别名
例如
@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>
三、XML 中的 SQL 使用了 $ 拼接sql
$ 会有注入的问题,但是有的时候不得不使用 $ 符号,例如要传入列名或者表名的时候,这个时候必须要添加 @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); }
对应xml:
<select id="getUserById" resultType="org.javaboy.helloboot.bean.User"> select * from user <if test="id!=null"> where id=#{id} </if> </select>