引言
使用Mybatis时如果sql语句存在多个参数,那么这就涉及到 java 代码给mapper文件传参问题,这里有四种方法:
- 使用@Param注解给参数命名:#{自定义的名称}
- 使用java对象传参:#{java对象属性名称}
- 使用参数的位置:#{arg位置值,从0开始}
- 使用map记录参数:#{map的key}
下面我一一介绍;
注:下面示例使用的数据库表student为:
使用@Param注解给参数命名:#{自定义的名称}
这个就是在mapper.java文件中每一个参数前加一个@Param(“随便起个名”),然后在sql语句中对应起的名就行:#{随便起的名}
示例:
mapper对应的java文件
int insertStudent(@Param("myId") int id,
@Param("myName") String name,
@Param("myEmail") String email,
@Param("myAge") int age);
mapper.xml文件对应sql语句:
<insert id="insertStudent">
insert into student(id, name, email, age) values(#{myId}, #{myName}, #{myEmail}, #{myAge})
</insert>
一定要注意#{}花括号中的名称要和@Param中的名称相同且对应;
使用java对象传参:#{java对象属性名称}
这个方法就是:新建一个类(不一定新建,要灵活应用,但要包含所有参数),把需要传入的多个参数封装到这个类中成为属性,然后参数传这个类的实例即可;
注意:#{参数}中的参数必须和新建类中的属性名一一对应,否则会报错;
示例:
新建了Student类,这里属性名和数据库表的对应字段名相同,当然属性名你可以随便写,但是要保证可读性;
而且要注意属性类型要和对应字段的类型相同;
mapper对应的java文件
int insertStudent(Student student);
mapper.xml文件对应sql语句:
#{参数}中的参数和Student类中对应属性名相同
<insert id="insertStudent">
insert into student(id, name, email, age) values(#{id}, #{name}, #{email}, #{age})
</insert>
使用参数的位置:#{arg位置值,从0开始}
这个就很好理解,就是对应位置放对应参数;
示例:
mapper对应的java文件
int insertStudent(int id, String name, String email, int age);
mapper.xml文件对应sql语句:
<insert id="insertStudent">
insert into student(id, name, email, age) values(#{arg0}, #{arg1}, #{arg2}, #{arg3})
</insert>
可能有人就说了:我用的这个#{}中不是这样的啊,好像#{0}, #{1}, #{2}, #{3}
这样写也可以啊;
这里就要注意了:在mybatis-3.3版本及之前是这种方式,但是从mybatis-3.4开始就是#{arg0}, #{arg1}, #{arg2}, #{arg3}
这样了;
使用Map集合记录参数:#{map的key}
使用一个Map集合来存放所有参数,最后传入map对象;
#{}里面的名称对应Map里面的key;
示例:
mapper对应的java文件
int insertStudent(Map<String, Object> map);
这里测试时map存入参数为:
Map<String, Object> map = new HashMap<>();
map.put("myId", 1007);
map.put("myName", "小七");
map.put("myEmail", "xiaoqi@123.com");
map.put("myAge", 77);
mapper.xml文件对应sql语句:
<insert id="insertStudent">
insert into student(id, name, email, age) values(#{myId}, #{myName}, #{myEmail}, #{myAge})
</insert>
#{}中的值就是key,要一 一对应;
总结
说了四种方法,那么到底用哪种好呢?
最常用的两种就是第一种和第二种,
第一种在参数较少时非常方便而且保证了可读性;
第二种在参数较多时可以使用并且修改方便可读性也好;
后两种方法并不推荐使用,
因为它们的可读性差,
比如第三种,单看mapper.xml文件无法判断传入的参数是什么,并且可能存在参数传递错误的问题;
第四种同样,如果只给你一个mapper.java文件,你就无法判断参数map集合中到底有什么参数,在大型项目中不利于维护;
再来个w3cSchool中的总结:
•使用 map 传递参数导致了业务可读性的丧失,导致后续扩展和维护的困难,在实际的应用中要果断废弃这种方式。
•使用 @Param 注解传递多个参数,受到参数个数(n)的影响。当 n≤5 时,这是最佳的传参方式,它比用 Java Bean
更好,因为它更加直观;当 n>5 时,多个参数将给调用带来困难,此时不推荐使用它。•当参数个数多于5个时,建议使用 Java Bean 方式。
所以就学会第一种和第二种方法就可以了,后两种了解一下就行,当然这几种方法在有些情况下也可以混合使用,学会基础会灵活运用就好;
欢迎大家的点评!