3. MyBatis中的参数
我个人理解,MyBatis中得参数分为传入参数和返回参数,传入参数就是在Mapper接口中定义abstract方法中传入的参数,返回参数就是该抽象方法的返回值。
在这儿我分别给大家介绍传入参数和返回参数,本篇博客就给大家介绍下传入参数,下面一篇日志专门介绍返回参数。
3.1 传入参数
Mybatis的Mapper文件中的select、insert、update、delete元素中有一个parameterType属性,用于对应的mapper接口方法接受的参数类型。
可以接受的参数类型有基本类型和复杂类型。
mapper接口方法一般接受一个参数,可以通过使用@Param注释将多个参数绑定到一个map做为输入参数。
3.1.1 简单类型
public Posts getPostsById(int id);
public Posts getPostsById(int id);
<!-- 这里的id必须和PostsMapper接口中的接口方法名相同,不然运行的时候也要报错 -->
<select id="getPostsById" resultType="Posts" parameterType="int">
select * from posts where id=#{id}
</select>
对于简单数据类型,sql映射语句中直接#{变量名}这种方式引用就行了,其实这里的”变量名”可以是任意的。mapper接口方法传递过来的值,至于其叫什么名字其实是不可考也没必要知道的。
而且JAVA反射只能获取方法参数的类型,是无从得知方法参数的名字的。
比如上面这个示例中,使用#{id}来引用只是比较直观而已,使用其他名字来引用也是一样的。所以当在if元素中test传递的参数时,就必须要用_parameter来引用这个参数了。像这样:
<select id="getPostsById" resultType="Posts" parameterType="int">
select * from posts
<if test="_parameter!=0">
where id=#{id}
</if>
<if test="_parameter==0">
limit 0,1
</if>
</select>
以上案例中的_parameter参数指代的是接口中相应方法的入参的名称。
3.1.2 对象类型
传入JAVA复杂对象类型的话,sql映射语句中就可以直接引用对象的属性名了,这里的属性名是实实在在的真实的名字,不是随意指定的。
Mapper中的接口方法:
public void addPosts(Posts posts);
sql映射:
<insert id="addPosts" parameterType="Posts">
insert into posts(title,context) values(#{title},#{context})
<!-- 这里sql结尾不能加分号,否则报“ORA-00911”的错误 -->
</insert>
虽然可以明确的引用对象的属性名了,但如果要在if元素中测试传入的posts参数,仍然要使用_parameter来引用传递进来的实际参数,因为传递进来的Posts对象的名字是不可考的。如果测试对象的属性,则直接引用属性名字就可以了。
3.1.3 Map类型
传入map类型,直接通过#{keyname}就可以引用到键对应的值。使用@param注释的多个参数值也会组装成一个map数据结构,和直接传递map进来没有区别。
Mapper接口:
int updateByExample(@Param("user") User user, @Param("example") UserExample example);
SQL映射:
<update id="updateByExample" parameterType="map" >
update tb_user
set id = #{user.id,jdbcType=INTEGER},
...
<if test="_parameter != null" >
<include refid="Update_By_Example_Where_Clause" />
</if>
注意这里测试传递进来的map是否为空,仍然使用_parameter
3.1.4 集合类型
You can pass a List instance or an Array to MyBatis as a parameter object. When you do, MyBatis will automatically wrap it in a Map, and key it by name. List instances will be keyed to the name “list” and array instances will be keyed to the name “array”.
可以传递一个List或Array类型的对象作为参数,MyBatis会自动的将List或Array对象包装到一个Map对象中,List类型对象会使用list作为键名,而Array对象会用array作为键名。
集合类型通常用于构造IN条件,sql映射文件中使用foreach元素来遍历List或Array元素。
Mapper接口:
public void batchUpdate(List<Posts> list);
SQL映射:
<update id="batchUpdate" parameterType="java.util.List">
update posts set badcount=3,goodcount=5 where id in
<foreach collection="list" item="item" open="(" close=")" index="index" separator=",">
#{item.id}
</foreach>
</update>
<update id="batchUpdate" parameterType="java.util.List">
update posts set badcount=3,goodcount=5 where id in
<foreach collection="list" item="item" open="(" close=")" index="index" separator=",">
#{item.id}
</foreach>
</update>
3.1.5 对象类型中的集合属性
对于单独传递的List或Array,在SQL映射文件中映射时,只能通过list或array来引用。但是如果对象类型有属性的类型为List或Array,则在sql映射文件的foreach元素中,可以直接使用属性名字来引用。
Mapper接口:
List<User> selectByExample(UserExample example);
List<User> selectByExample(UserExample example);
SQL映射:
<where >
<foreach collection="oredCriteria" item="criteria" separator="or" >
<if test="criteria.valid" >
<where >
<foreach collection="oredCriteria" item="criteria" separator="or" >
<if test="criteria.valid" >