Spring+SpringMVC+MyBatis深入学习及搭建(四)——MyBatis输入映射与输出映射
1. 输入映射
通过parameterType指定输入参数的类型,类型可以是简单类型、hashmap、pojo的包装类型。
1.1 #{}与${}
#{}实现的是向prepareStatement中的预处理语句设置参数值,sql语句中#{}表示一个占位符即?
<select id="findUserById" parameterType="int" resultType="user"> select * from user where id=#{id} </select>
使用占位符#{}可以有效防止sql注入,在使用时不需要关系参数值的类型,mybatis会自动进行java类型和jdbc类型的转换。#{}可以接收简单类型值或pojo属性值,如果parameterType传输单个类型值,#{}括号可以是value或其它名称。
${}和#{}不同,通过${}可以将parameterType传入的内容拼接在sql中且不进行jdbc类型转换,${}可以接收简单类型值或pojo属性值,如果parameterType传输单个简单类型值,${}括号中只能是value。使用${}不能防止sql注入,但是有时用${}会非常方便,如下例子:
<select id="findUserByName" parameterType="java.lang.String" resultType="joanna.yan.mybatis.entity.User"> select * from user where username LIKE '%${value}%' </select>
如果本例子使用#{}则传入的字符串中必须要有%,而%是人为拼接在参数中,显然有点麻烦,如果采用${}在sql中拼接为%的方式则在调用mapper接口传递参数就方便很多。
//如果使用占位符号则必须人为在传参数中加% List<User> list = userMapper.selectUserByName("%管理员%");
//如果使用${}原始符号则不用人为在参数中加% List<User>list = userMapper.selectUserByName("管理员");
再比如order by排序,如果将列名通过参数传入sql,根据传的列名进行排序,应该写为:ORDER BY ${columnName}
如果使用#{}将无法实现此功能。
1.2 传递简单类型
参考上边的例子。
1.3 传递pojo对象
mybatis使用ognl表达式解析对象字段的值,如下例子:
<!--传递pojo对象综合查询用户信息 --> <select id="findUserByUser" parameterType="user" resultType="user"> select * from user where id=#{id} and username like '%${username}%' </select>
sql中红色标注的是user对象中的字段名称。
测试:
@Test public void findUserByUserTest() throws Exception{ SqlSession sqlSession=sqlSessionFactory.openSession(); UserMapper userMapper=sqlSession.getMapper(UserMapper.class); User user=new User(); user.setId(10); user.setUsername("张三"); List<User> list=userMapper.findUserByUser(user); System.out.println(list); sqlSession.close(); }
1.4 传递pojo包装对象
开发中通过pojo传递查询条件,查询条件是综合的查询条件,不仅包括用户查询条件,还包括其它的查询条件(比如将用户购买的商品信息也作为查询条件),这时可以使用包装对象传递输入参数。
1.4.1 需求
完成用户信息的综合查询,需要传入查询条件很复杂(可能包括用户信息、其它信息,比如商品、订单等)
1.4.2 定义包装类型pojo
针对上边需求,建议使用自定义的包装类型的pojo,在包装类型的pojo中将复杂的查询条件包装进去。
/** * 包装类型 * @author Joanna.Yan * */ public class UserQueryVo { //在这里包装所需要的查询条件 //用户查询条件 private UserCustom userCustom; public UserCustom getUserCustom() { return userCustom; } public void setUserCustom(UserCustom userCustom) { this.userCustom = userCustom; } //可以包装其它的查询条件,订单、商品 //...... }
1.4.3 mapper.xml
在UserMapper.xml中定义用户信息综合查询(查询条件复杂,通过高级查询进行复杂关联查询)
<!--用户信息综合查询 UserQueryVo中定义了userCustom属性 #{userCustom.sex}:取出pojo包装对象中性别值 ${userCustom.username}:取出pojo包装对象中用户名称 --> <select id="findUserList" parameterType="joanna.yan.mybatis.entity.UserQueryVo" resultType="joanna.yan.mybatis.entity.UserCustom"> SELECT * FROM USER WHERE user.sex=#{userCustom.sex} AND user.username LIKE '%${userCustom.username}%' </select>
1.4.4 mapper.java
//用户信息综合查询 public List<UserCustom> findUserList(UserQueryVo userQueryVo) throws Exception;
1.4.5 测试代码
@Test public void findUserListTest() throws Exception{ SqlSession sqlSession=sqlSessionFactory.openSession(); UserMapper userMapper=sqlSession.getMapper(UserMapper.class); //创建包装对象,设置查询条件 UserQueryVo userQueryVo=new UserQueryVo(); UserCustom userCustom=new UserCustom(); userCustom.setSex("1"); userCustom.setUsername("张三丰"); userQueryVo.setUserCustom(userCustom); List<UserCustom> list=userMapper.findUserList(userQueryVo); System.out.println(list); }
1.5 传递hashmap
sql映射文件定义如下:
<!--传递hashmap综合查询用户信息 --> <select id="findUserByHashmap" parameterType="hashmap" resultType="user"> select * from user where id=#{id} and username like '%${username}%' </select>
sql中红的标注的是hashmap的key。
mapper.java:
//传递hashmap综合查询用户信息 public List<User> findUserByHashmap(HashMap<String, Object> map) throws Exception;
测试:
@Test public void findUserByHashmapTest() throws Exception{ SqlSession sqlSession=sqlSessionFactory.openSession(); UserMapper userMapper=sqlSession.getMapper(UserMapper.class); //构造查询条件HashMap对象 HashMap<String, Object> map=new HashMap<>(); map.put("id", 10); map.put("username", "张三"); //传递HashMap对象查询用户列表 List<User> list=userMapper.findUserByHashmap(map); System.out.println(list); sqlSession.close(); }
传递的map中的key和sql中解析的key不一致时,不会报错,只是通过key获取的值为空。
2. 输出映射
2.1 输出简单类型
看下边的例子,输出整型,mapper.xml文件:
<!--获取用户列表总数 --> <select id="findUserCount" parameterType="user" resultType="int"> select count(*) from user </select>
mapper接口:
public interface UserMapper { //获取用户列表总数 public int findUserCount(User user) throws Exception; }
测试:
@Test public void findUserCountTest() throws Exception{ SqlSession sqlSession=sqlSessionFactory.openSession(); //创建UserMapper对象,mybatis自动生成mapper代理对象 UserMapper userMapper=sqlSession.getMapper(UserMapper.class); User user=new User(); user.setUsername("yan"); //调用userMapper的方法 int count=userMapper.findUserCount(user); System.out.println(count); sqlSession.close(); }
总结:
查询出来的结果集只有一行且一列,可以使用简单类型进行输出映射。
2.2 输出pojo对象和pojo列表
不管是输出的pojo单个对象还是一个列表(list中包括pojo),在mapper.xml中resultType指定的类型是一样的。
在mapper.java指定的方法返回值类型不一样:
(1)输出单个pojo对象,方法返回值是单个对象类型。
(2)输出pojo对象list,方法返回值是List<POJO>
生成的动态代理对象中是根据mapper方法的返回值类型确定是调用session.selectOne(返回单个对象调用)还是session.selectList(返回集合对象调用)。
2.3 resultType总结
使用resultType进行输出映射,只有查询出来的列名和pojo中的属性名一致,该列才可以映射成功。
如果查询出来的列名和pojo中的属性名全部不一致,则不会创建pojo对象。
只要查询出来的列名和pojo中的属性有一个一致,就会创建pojo对象。
2.4 输出hashmap
输出pojo对象可以改用hashmap输出类型,将输出的字段名称作为map的key,value为字段值。
2.5 resultMap
resultType可以指定将查询结果映射为pojo,但需要pojo的属性名和sql查询的列名一致才可映射成功。
如果sql查询字段名和pojo的属性名不一致,可以通过resultMap将字段名和属性名作一个对应关系,resultMap实质上还需要将查询结果映射到pojo对象中。
resultMap可以实现将查询结果映射为复杂类型的pojo,比如在查询结果映射对象中包括pojo和list实现实现一对一查询和一对多查询。
2.5.1 resultMap使用方法
如果查询出来的列名和pojo的属性名不一致,通过定义一个resultMap对列名和pojo属性名之间作一个映射关系。
(1)定义resultMap
(2)使用resultMap作为statement的输出映射类型。
2.5.2 将下边的sql使用User完成映射
SELECT id id_,username username_ FROM USER WHERE id=#{value}
改sql对查询结果的列名进行了重新命名:
User类中属性名和上边查询列名不一致。
2.5.2.1 定义resultMap
<!--定义resultMap 将SELECT id id_,username username_ FROM USER和User类中的属性作一个映射关系。 type:resultMap最终映射的java对象类型,可以使用别名 id:对resultMap的唯一标识 --> <resultMap type="user" id="userResultMap"> <!--id表示查询结果集中唯一标识 column:查询出来的列名 property:type指定的pojo类型中的属性名 最终resultMap对column和property作一个映射关系(对应关系) --> <id column="id_" property="id"/> <!--result:对普通名映射定义 column:查询出来的列名 property:type指定的pojo类型中的属性名 最终resultMap对column和property作一个映射关系(对应关系) --> <result column="username_" property="username"/> </resultMap>
2.5.2.2 使用resultMap作为statement的输出映射类型
<!--使用resultMap进行输出映射 resultMap:指定定义的resultMap的id,如果这个resultMap在其它的mapper文件,前边需要加namespace --> <select id="findUserByIdResultMap" parameterType="int" resultMap="userResultMap"> SELECT id id_,username username_ FROM USER WHERE id=#{value} </select>
2.5.2.3 mapper.java
//根据id查询用户信息,使用resultMap输出 public User findUserByIdResultMap(int id) throws Exception;
2.5.2.4 测试
@Test public void findUserByIdResultMapTest() throws Exception{ SqlSession sqlSession=sqlSessionFactory.openSession(); UserMapper userMapper=sqlSession.getMapper(UserMapper.class); User user=userMapper.findUserByIdResultMap(1); System.out.println(user); sqlSession.close(); }
2.6 小结
使用resultType进行输出映射,只有查询出来的列名和pojo中的属性名一致,该列才可以映射成功。
如果查询出来的列名和pojo的属性名不一致,通过定义一个resultMap对列名和pojo属性名之间作一个映射关系。