映射文件中定义了操作数据库的sql,每个sql是一个statement,映射文件是mybatis的核心。
SQL 映射文件有很少的几个顶级元素(按照它们应该被定义的顺序):
- cache:给定命名空间的缓存配置。
- cache-ref – 其他命名空间缓存配置的引用。
- resultMap – 是最复杂也是最强大的元素,用来描述如何从数据库结果集中来加载对象。
- parameterMap – 已废弃!老式风格的参数映射。内联参数是首选,这个元素可能在将来被移除,这里不会记录。
- sql – 可被其他语句引用的可重用语句块。
- insert – 映射插入语句
- update – 映射更新语句
- delete – 映射删除语句
- select – 映射查询语
一、insert、update、delete标签的属性
id | 命名空间中的唯一标识符 |
parameterType | 将要传入语句的参数的完全限定类型名或别名。这个属性是可选的,因为MyBatis可以通过TypeHandler推断出具体传入语句的参数类型,默认值是unset |
flushCache | 将其设置为true,任何时候只要语句被调用,都会导致本地缓存和二级缓存被清空,默认值:true(对应插入更新和删除语句) |
timeout | 这个设置是抛出异常之前,驱动程序等待数据库返回请求结果的秒数,默认是unset(依赖驱动) |
statementType | STATEMENT、PREPARED、或CALLABLE的一个,这会让Mybatis分别使用Statement,PreparedStatement或CallableStatement,默认值是:PREPARED。 |
useGenerateKeys | (仅对insert和update有用)这会令Mybatis使用JDBC的getGeneratedKeys方法来取出由数据库内部生产的主键(比如:像MySQL和SQL Server这样的关系数据库管理系统的自动递增字段),默认值:false |
keyProperty | (仅对insert 和update有用)唯一标记一个属性,Mybatis会通过getGenrateKeys的返回值或者通过insert语句的selectkey子元素设置它的键值,默认是unset。 |
keyColumn | (仅对insert 和update有用)通过生成的键值设置表中的列明,这个设置仅在某写数据库(像PostgreSQL)是必须的,当主键列不是表中的第一列的时候需要设置,如果希望得到更多个生成的列,也可以是逗号分隔的属性名称列表。 |
databaseId | 如果配置了databaseProvider,Mybatis会加载所有不带databaseId或匹配当前databaseId的语句,如果带或者不带的语句都有,则不带的会被忽略 |
二、参数传递
2.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="findUserLikeUsername" resultType="com.jdy.mybatis2020.bean.User"> select <include refid="sqlColumnsForUserTable"/> 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}
如果使用#{}将无法实现此功能。
- #{key}:获取参数的值,预编译到SQL中。安全。
- ${key}:获取参数的值,拼接到SQL中。有SQL注入问 题。
- ORDER BY ${name}
2.2、传递简单类型
- 单个参数:可以接受基本类型,对象类型,集合类型的值。这种情况 MyBatis可直接使用这个参数,不需要经过任何处理。
- 多个参数:任意多个参数,都会被MyBatis重新包装成一个Map传入。 Map的key是param1,param2,0,1…,值就是参数的值。
2.3、传递pojo对象
Mybatis使用ognl表达式解析对象字段的值,如下例子:
<!—传递pojo对象综合查询用户信息 --> <select id="findUserByUser" parameterType="com.jdy.mybatis2020.bean.User" resultType="com.jdy.mybatis2020.bean.User">
select * from user where id=#{id} and username like '%${username}%';
</select>
id、username 是User对象中的字段名称。
2.4、传递pojo包装对象
开发中通过pojo传递查询条件 ,查询条件是综合的查询条件,不仅包括用户查询条件还包括其它的查询条件(比如将用户购买商品信息也作为查询条件),这时可以使用包装对象传递输入参数。、
定义包装对象将查询条件(pojo)以类组合的方式包装起来。
@Data @ToString public class QueryVo { private User user; }
<select id="findUserByQueryVo" parameterType="com.jdy.mybatis2020.bean.QueryVo" resultType="com.jdy.mybatis2020.bean.User"> select * from user where id = #{user.id } and username =#{user.username} </select>
说明:mybatis底层通过ognl从pojo中获取属性值:#{user.username},user即是传入的包装对象的属性。
2.5、命名参数
为参数使用@Param起一个名字,MyBatis就会将这些参数封装进map中,key就是我们自己指定的名字
取值: #{自己指定的名字 / param1 param2 … paramN}
2.6、传递Map
<select id="findUserByMap" parameterType="java.util.Map" resultType="com.jdy.mybatis2020.bean.User"> select * from user where id = #{id} </select>
上边id、username是HashMap的key。
@Test public void test_Method11() { SqlSession sqlSession = sqlSessionFactory.openSession(); UserMapperDao dao = sqlSession.getMapper(UserMapperDao.class); Map<String ,Object> maps = new HashMap<>(); maps.put("id","26"); User user = dao.queryUserByMap(maps); System.out.println("user = " + user); }
三、结果映射
3.1、resultType自动映射
全局setting设置
-
- autoMappingBehavior默认是PARTIAL,开启自动映射 的功能。唯一的要求是列名和javaBean属性名一致
- 如果autoMappingBehavior设置为null则会取消自动映射
- 数据库字段命名规范,POJO属性符合驼峰命名法,如 A_COLUMNaColumn,我们可以开启自动驼峰命名规 则映射功能,mapUnderscoreToCamelCase=true。
- 输出pojo对象和输出pojo列表在sql中定义的resultType是一样的。
3.2、resultMap自定义映射
输出pojo对象可以改用HashMap输出类型,将输出的字段名称作为map的key,value为字段值。解决的是数据库字段名称和对象属性名称不一致的映射问题。
resultType可以指定pojo将查询结果映射为pojo,但需要pojo的属性名和sql查询的列名一致方可映射成功。 如果sql查询字段名和pojo的属性名不一致,可以通过resultMap将字段名和属性名作一个对应关系 ,resultMap实质上还需要将查询结果映射到pojo对象中。 resultMap可以实现将查询结果映射为复杂类型的pojo,比如在查询结果映射对象中包括pojo和list实现一对一查询和一对多查询。
<!-- 定义resultMap 将 USER表 和User类中的属性作一个映射关系 type:resultMap最终映射的java对象类型,可以使用别名 id:对resultMap的唯一标识 --> <resultMap type="com.jdy.mybaties2020.bean.User" id="userMap"> <!-- 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" /> <result column="sex" property="sex" /> <result column="birthday" property="birthday" /> <result column="address" property="address" /> </resultMap>
四、动态sql
动态 SQL是MyBatis强大特性之一。极大的简化我们拼装SQL的操作,通过mybatis提供的各种标签方法实现动态拼接sql。
4.1、If、set 标签
<!-- 更新用户 --> <update id="updateUser" parameterType="com.jdy.mybaties2020.bean.User"> update user <set> <if test="username != null"> username = #{username}, </if> <if test="birthday != null"> birthday = #{birthday}, </if> <if test="sex != null"> sex = #{sex}, </if> <if test="address != null"> address = #{address}, </if> </set> where id=#{id} </update>
注意要做不等于空字符串校验。
4.2、foreach
(1)、通过pojo传递list
需求:传入多个id查询用户信息,用下边两个sql实现
SELECT * FROM user WHERE username LIKE '%张%' id IN (10,89,16)
<select id="findUserList" parameterType="hashmap" resultMap="userResultMap"> select * from user <where> <if test="ids!=null and ids.size>0"> <foreach collection="ids" item="id" open="id in(" close=")" separator=","> #{id} </foreach> </if> </where> </select>
入参是一个map
-
-
conllection:指定要遍历的集合,list类型的参数会特殊处理封装在map中,map的key就叫list
-
item: 将当前遍历出的元素赋值给指定的变量,自定义就行
-
open:遍历出所有结果拼接一个开始的字符
-
close:遍历出所有结果拼接一个结束的字符
-
separator:每个元素之间的分隔符
-
测试
List<Integer> ids = new ArrayList<>(); ids.add(10); ids.add(16); ids.add(24);
List<User> result = mapper.findUserList(maps); sqlSession.close();
<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>
测试
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("3"); userlist.add(user); user = new User(); user.setId("1"); userlist.add(user); //传递userlist列表查询用户列表 List<User>list = userMapper.selectUserByList(userlist); //关闭session session.close(); }
<!-- 传递数组综合查询用户信息 --> <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:为数组每个元素的名称,名称随意定义
-
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("3"); userlist[1]=user; //传递user对象查询用户列表 List<User>list = userMapper.selectUserByArray(userlist); //关闭session session.close(); }
<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获取对象属性值了。
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(); }