Mapper.xml映射文件
2017-03-02 13:20
357 查看
1 Mapper.xml映射文件 Mapper.xml映射文件中定义了操作数据库的sql,每个sql是一个statement,映射文件是mybatis的核心。 1.1 parameterType(输入类型) 1.1.1 #{}与${} #{}实现的是向prepareStatement中的预处理语句中设置参数值,sql语句中#{}表示一个占位符即?。 <!-- 根据id查询用户信息 --> <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="selectUserByName" parameterType="string" resultType="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.1.2 传递简单类型 参考上边的例子。 1.1.3 传递pojo对象 Mybatis使用ognl表达式解析对象字段的值,如下例子: <!—传递pojo对象综合查询用户信息 --> <select id="findUserByUser" parameterType="user" resultType="user"> select * from user where id=#{id} and username like '%${username}%' </select> 上边红色标注的是user对象中的字段名称。 测试: Public void testFindUserByUser()throws Exception{ //获取session SqlSession session = sqlSessionFactory.openSession(); //获限mapper接口实例 UserMapper userMapper = session.getMapper(UserMapper.class); //构造查询条件user对象 User user = new User(); user.setId(1); user.setUsername("管理员"); //传递user对象查询用户列表 List<User>list = userMapper.findUserByUser(user); //关闭session session.close(); } 异常测试: Sql中字段名输入错误后测试,username输入dusername测试结果报错: org.apache.ibatis.exceptions.PersistenceException: ### Error querying database. Cause: org.apache.ibatis.reflection.ReflectionException: There is no getter for property named 'dusername' in 'class cn.itcast.mybatis.po.User' ### Cause: org.apache.ibatis.reflection.ReflectionException: There is no getter for property named 'dusername' in 'class cn.itcast.mybatis.po.User' 1.1.4 传递pojo包装对象 开发中通过pojo传递查询条件 ,查询条件是综合的查询条件,不仅包括用户查询条件还包括其它的查询条件(比如将用户购买商品信息也作为查询条件),这时可以使用包装对象传递输入参数。 1.1.4.1 定义包装对象 定义包装对象将查询条件(pojo)以类组合的方式包装起来。 public class QueryVo { private User user; //自定义用户扩展类 private UserCustom userCustom; 1.1.4.2 mapper.xml映射文件 说明:mybatis底层通过ognl从pojo中获取属性值:#{user.username},user即是传入的包装对象的属性。queryVo是别名,即上边定义的包装对象类型。 1.1.5 传递hashmap Sql映射文件定义如下: <!-- 传递hashmap综合查询用户信息 --> <select id="findUserByHashmap" parameterType="hashmap" resultType="user"> select * from user where id=#{id} and username like '%${username}%' </select> 上边红色标注的是hashmap的key。 测试: Public void testFindUserByHashmap()throws Exception{ //获取session SqlSession session = sqlSessionFactory.openSession(); //获限mapper接口实例 UserMapper userMapper = session.getMapper(UserMapper.class); //构造查询条件Hashmap对象 HashMap<String, Object> map = new HashMap<String, Object>(); map.put("id", 1); map.put("username", "管理员"); //传递Hashmap对象查询用户列表 List<User>list = userMapper.findUserByHashmap(map); //关闭session session.close(); } 异常测试: 传递的map中的key和sql中解析的key不一致。 测试结果没有报错,只是通过key获取值为空。 1.2 resultType(输出类型) 1.2.1 输出简单类型 参考getnow输出日期类型,看下边的例子输出整型: Mapper.xml文件 <!-- 获取用户列表总数 --> <select id="findUserCount" parameterType="user" resultType="int"> select count(1) from user </select> Mapper接口 public int findUserCount(User user) throws Exception; 调用: Public void testFindUserCount() throws Exception{ //获取session SqlSession session = sqlSessionFactory.openSession(); //获取mapper接口实例 UserMapper userMapper = session.getMapper(UserMapper.class); User user = new User(); user.setUsername("管理员"); //传递Hashmap对象查询用户列表 int count = userMapper.findUserCount(user); //关闭session session.close(); } 总结: 输出简单类型必须查询出来的结果集有一条记录,最终将第一个字段的值转换为输出类型。 使用session的selectOne可查询单条记录。 1.2.2 输出pojo对象 参考findUserById的定义: Mapper.xml <!-- 根据id查询用户信息 --> <select id="findUserById" parameterType="int" resultType="user"> select * from user where id = #{id} </select> Mapper接口: public User findUserById(int id) throws Exception; 测试: Public void testFindUserById() throws Exception { //获取session SqlSession session = sqlSessionFactory.openSession(); //获限mapper接口实例 UserMapper userMapper = session.getMapper(UserMapper.class); //通过mapper接口调用statement User user = userMapper.findUserById(1); System.out.println(user); //关闭session session.close(); } 使用session调用selectOne查询单条记录。 1.2.3 输出pojo列表 参考selectUserByName的定义: Mapper.xml <!-- 根据名称模糊查询用户信息 --> <select id="findUserByUsername" parameterType="string" resultType="user"> select * from user where username like '%${value}%' </select> Mapper接口: public List<User> findUserByUsername(String username) throws Exception; 测试: Public void testFindUserByUsername()throws Exception{ //获取session SqlSession session = sqlSessionFactory.openSession(); //获限mapper接口实例 UserMapper userMapper = session.getMapper(UserMapper.class); //如果使用占位符号则必须人为在传参数中加% //List<User> list = userMapper.selectUserByName("%管理员%"); //如果使用${}原始符号则不用人为在参数中加% List<User> list = userMapper.findUserByUsername("管理员"); //关闭session session.close(); } 使用session的selectList方法获取pojo列表。 1.2.4 resultType总结: 输出pojo对象和输出pojo列表在sql中定义的resultType是一样的。 返回单个pojo对象要保证sql查询出来的结果集为单条,内部使用session.selectOne方法调用,mapper接口使用pojo对象作为方法返回值。 返回pojo列表表示查询出来的结果集可能为多条,内部使用session.selectList方法,mapper接口使用List<pojo>对象作为方法返回值。 1.2.5 输出hashmap 输出pojo对象可以改用hashmap输出类型,将输出的字段名称作为map的key,value为字段值。 1.3 resultMap resultType可以指定pojo将查询结果映射为pojo,但需要pojo的属性名和sql查询的列名一致方可映射成功。 如果sql查询字段名和pojo的属性名不一致,可以通过resultMap将字段名和属性名作一个对应关系 ,resultMap实质上还需要将查询结果映射到pojo对象中。 resultMap可以实现将查询结果映射为复杂类型的pojo,比如在查询结果映射对象中包括pojo和list实现一对一查询和一对多查询。 1.3.1 Mapper.xml定义 使用resultMap指定上边定义的personmap。 1.3.2 定义resultMap 由于上边的mapper.xml中sql查询列和Users.java类属性不一致,需要定义resultMap:userListResultMap将sql查询列和Users.java类属性对应起来 <id />:此属性表示查询结果集的唯一标识,非常重要。如果是多个字段为复合唯一约束则定义多个<id />。 Property:表示person类的属性。 Column:表示sql查询出来的字段名。 Column和property放在一块儿表示将sql查询出来的字段映射到指定的pojo类属性上。 <result />:普通结果,即pojo的属性。 1.3.3 Mapper接口定义 public List<User> findUserListResultMap() throws Exception; 1.4 动态sql(重点) 通过mybatis提供的各种标签方法实现动态拼接sql。 1.4.1 If <!-- 传递pojo综合查询用户信息 --> <select id="findUserList" parameterType="user" resultType="user"> select * from user where 1=1 <if test="id!=null and id!=''"> and id=#{id} </if> <if test="username!=null and username!=''"> and username like '%${username}%' </if> </select> 注意要做不等于空字符串校验。 1.4.2 Where 上边的sql也可以改为: <select id="findUserList" parameterType="user" resultType="user"> select * from user <where> <if test="id!=null and id!=''"> and id=#{id} </if> <if test="username!=null and username!=''"> and username like '%${username}%' </if> </where> </select> <where />可以自动处理第一个and。 1.4.3 foreach 向sql传递数组或List,mybatis使用foreach解析,如下: 1.4.3.1 通过pojo传递list u 需求 传入多个id查询用户信息,用下边两个sql实现: SELECT * FROM USERS WHERE username LIKE '%张%' AND (id =10 OR id =89 OR id=16) SELECT * FROM USERS WHERE username LIKE '%张%' id IN (10,89,16) u 在pojo中定义list属性ids存储多个用户id,并添加getter/setter方法 u mapper.xml <if test="ids!=null and ids.size>0"> <foreach collection="ids" open=" and id in(" close=")" item="id" separator="," > #{id} </foreach> </if> u 测试代码: List<Integer> ids = new ArrayList<Integer>(); ids.add(1);//查询id为1的用户 ids.add(10); //查询id为10的用户 queryVo.setIds(ids); List<User> list = userMapper.findUserList(queryVo); 1.4.3.2 传递单个List 传递List类型在编写mapper.xml没有区别,唯一不同的是只有一个List参数时它的参数名为list。 如下: u Mapper.xml <select id="selectUserByList" parameterType="java.util.List" resultType="user"> select * from user <where> <!-- 传递List,List中是pojo --> <if test="list!=null"> <foreach collection="list" item="item" open="and id in("separator=","close=")"> #{item.id} </foreach> </if> </where> </select> u Mapper接口 public List<User> selectUserByList(List userlist) throws Exception; u 测试: Public void testselectUserByList()throws Exception{ //获取session SqlSession session = sqlSessionFactory.openSession(); //获限mapper接口实例 UserMapper userMapper = session.getMapper(UserMapper.class); //构造查询条件List List<User> userlist = new ArrayList<User>(); User user = new User(); user.setId(1); userlist.add(user); user = new User(); user.setId(2); userlist.add(user); //传递userlist列表查询用户列表 List<User>list = userMapper.selectUserByList(userlist); //关闭session session.close(); } 1.4.3.3 传递单个数组(数组中是pojo): 请阅读文档学习。 u Mapper.xml <!-- 传递数组综合查询用户信息 --> <select id="selectUserByArray" parameterType="Object[]" resultType="user"> select * from user <where> <!-- 传递数组 --> <if test="array!=null"> <foreach collection="array" index="index" item="item" open="and id in("separator=","close=")"> #{item.id} </foreach> </if> </where> </select> sql只接收一个数组参数,这时sql解析参数的名称mybatis固定为array,如果数组是通过一个pojo传递到sql则参数的名称为pojo中的属性名。 index:为数组的下标。 item:为数组每个元素的名称,名称随意定义 open:循环开始 close:循环结束 separator:中间分隔输出 u Mapper接口: public List<User> selectUserByArray(Object[] userlist) throws Exception; u 测试: Public void testselectUserByArray()throws Exception{ //获取session SqlSession session = sqlSessionFactory.openSession(); //获限mapper接口实例 UserMapper userMapper = session.getMapper(UserMapper.class); //构造查询条件List Object[] userlist = new Object[2]; User user = new User(); user.setId(1); userlist[0]=user; user = new User(); user.setId(2); userlist[1]=user; //传递user对象查询用户列表 List<User>list = userMapper.selectUserByArray(userlist); //关闭session session.close(); } 1.4.3.4 传递单个数组(数组中是字符串类型): 请阅读文档学习。 u Mapper.xml <!-- 传递数组综合查询用户信息 --> <select id="selectUserByArray" parameterType="Object[]" resultType="user"> select * from user <where> <!-- 传递数组 --> <if test="array!=null"> <foreach collection="array"index="index"item="item"open="and id in("separator=","close=")"> #{item} </foreach> </if> </where> </select> 如果数组中是简单类型则写为#{item},不用再通过ognl获取对象属性值了。 u Mapper接口: public List<User> selectUserByArray(Object[] userlist) throws Exception; u 测试: Public void testselectUserByArray()throws Exception{ //获取session SqlSession session = sqlSessionFactory.openSession(); //获限mapper接口实例 UserMapper userMapper = session.getMapper(UserMapper.class); //构造查询条件List Object[] userlist = new Object[2]; userlist[0]=”1”; userlist[1]=”2”; //传递user对象查询用户列表 List<User>list = userMapper.selectUserByArray(userlist); //关闭session session.close(); } 1.4.4 Sql片段 Sql中可将重复的sql提取出来,使用时用include引用即可,最终达到sql重用的目的,如下: <!-- 传递pojo综合查询用户信息 --> <select id="findUserList" parameterType="user" resultType="user"> select * from user <where> <if test="id!=null and id!=''"> and id=#{id} </if> <if test="username!=null and username!=''"> and username like '%${username}%' </if> </where> </select> u 将where条件抽取出来: <sql id="query_user_where"> <if test="id!=null and id!=''"> and id=#{id} </if> <if test="username!=null and username!=''"> and username like '%${username}%' </if> </sql> u 使用include引用: <select id="findUserList" parameterType="user" resultType="user"> select * from user <where> <include refid="query_user_where"/> </where> </select> 注意:如果引用其它mapper.xml的sql片段,则在引用时需要加上namespace,如下: <include refid="namespace.sql片段”/>
相关文章推荐
- Mapper的XML映射文件---2.2: 设置(settings)
- Mapper的XML映射文件---2.7: 环境(environments)
- MyBatis框架的学习(四)——Mapper.xml文件中的输入和输出映射以及动态sql
- 【MyBatis】mybatis配置文件祥解(mybatis.xml)与映射文件祥解(StudentMapper.xml)(四)
- MyBatis之XML文件配置实现映射器Mapper
- Mapper的XML映射文件---2.3: 类型别名(typeAliases)
- Mapper.xml映射文件---Mybatis学习笔记(八)
- #五.mybatis--XXmapper.xml(映射文件解析)
- 代码自动生成(二)数据库表字段生成mybaties 映射配置文件**mapper.xml
- JAVA mybatis:mapper XML映射文件
- Mapper的XML映射文件---2.5: 对象工厂(ObjectFactory)
- Mapper.xml映射文件
- mapper.xml映射文件中命名空间问题
- (转)MyBatis框架的学习(四)——Mapper.xml文件中的输入和输出映射以及动态sql
- Spring、MyBatis的整合数据映射器类(UserMapper->iocContext.xml)配置文件详解
- Mapper的XML映射文件---2.6: 插件(plugins)
- 3、XML映射文件Mapper
- mybatis映射文件mapper.xml的写法。
- Mapper.xml映射文件---Mybatis学习笔记(八)
- xml 文件不给提示(以mybatis 的 mapper映射文件为例)