MyBatis框架浅析之 Mapper.xml 映射文件

少年意气强不羁，虎胁插翼白日飞。这篇文章主要讲述MyBatis框架浅析之 Mapper.xml 映射文件相关的知识，希望能为你提供帮助。
Mapper XML 文件MyBatis 的真正强大在于它的映射语句，也是它的魔力所在。由于它的异常强大，映射器的 XML 文件就显得相对简单。如果拿它跟具有相同功能的 JDBC 代码进行对比，你会立即发现省掉了将近 95% 的代码。MyBatis 就是针对 SQL 构建的，并且比普通的方法做的更好。
同样需要介绍定级元素:
【MyBatis框架浅析之 Mapper.xml 映射文件】mapper

cache – 给定命名空间的缓存配置。
cache-ref – 其他命名空间缓存配置的引用。
resultMap – 是最复杂也是最强大的元素，用来描述如何从数据库结果集中来加载对象。
parameterMap – 已废弃！老式风格的参数映射。内联参数是首选,这个元素可能在将来被移除，这里不会记录。
sql – 可被其他语句引用的可重用语句块。
insert – 映射插入语句
update – 映射更新语句
delete – 映射删除语句
select – 映射查询语句

1.mapper 根节点
有且必须只有一个属性值:namespace, 建议设置为Mapper接口的全限定名

< mapper namespace="com.baoxian.dao.UserInfoMapper"> ... < /mapper>

2.select 元素
2.1 简单的select语句

< select id="selectPerson" parameterType="int" resultType="hashmap"> SELECT * FROM PERSON WHERE ID = #{id} < /select>

解释一下上面配置:
这个语句被称作 selectPerson，接受一个 int（或 Integer）类型的参数，并返回一个 HashMap 类型的对象，其中的键是列名，值便是结果行中的对应值。

假如调用该条SQL传入的参数为 1,selectPerson(1)
原来的sql语句经过处理后相当于 SELECT * FROM PERSON WHERE ID = ?
?相当于参数的占位符
调用时传入的参数值将会被替换

2.2 select元素中的所有属性

< select id="selectPerson"#必须 parameterType="int"#可选,写出来会更加直观 parameterMap="deprecated"　#已不使用 resultType="hashmap"#必须指定 resultMap="personResultMap"#自定义结果集的映射 flushCache="false"#调用该语句是否刷新缓存,一般insert update delete 会配置成true useCache="true"# timeout="10000"# 语句最大等待时间 10S fetchSize="256"# statementType="PREPARED" resultSetType="FORWARD_ONLY">

Select Attributes
属性	描述
`id`	在命名空间中唯一的标识符，可以被用来引用这条语句。
`parameterType`	将会传入这条语句的参数类的完全限定名或别名。这个属性是可选的，因为 MyBatis 可以通过 TypeHandler 推断出具体传入语句的参数，默认值为 unset。
parameterMap	这是引用外部 parameterMap 的已经被废弃的方法。使用内联参数映射和 parameterType 属性。
`resultType`	从这条语句中返回的期望类型的类的完全限定名或别名。注意如果是集合情形，那应该是集合可以包含的类型，而不能是集合本身。使用 resultType 或 resultMap，但不能同时使用。
`resultMap`	外部 resultMap 的命名引用。结果集的映射是 MyBatis 最强大的特性，对其有一个很好的理解的话，许多复杂映射的情形都能迎刃而解。使用 resultMap 或 resultType，但不能同时使用。
`flushCache`	将其设置为 true，任何时候只要语句被调用，都会导致本地缓存和二级缓存都会被清空，默认值：false。
`useCache`	将其设置为 true，将会导致本条语句的结果被二级缓存，默认值：对 select 元素为 true。
`timeout`	这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为 unset（依赖驱动）。
`fetchSize`	这是尝试影响驱动程序每次批量返回的结果行数和这个设置值相等。默认值为 unset（依赖驱动）。
`statementType`	STATEMENT，PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement，默认值：PREPARED。
`resultSetType`	FORWARD_ONLY，SCROLL_SENSITIVE 或 SCROLL_INSENSITIVE 中的一个，默认值为 unset （依赖驱动）。
`databaseId`	如果配置了 databaseIdProvider，MyBatis 会加载所有的不带 databaseId 或匹配当前 databaseId 的语句；如果带或者不带的语句都有，则不带的会被忽略。
`resultOrdered`	这个设置仅针对嵌套结果 select 语句适用：如果为 true，就是假设包含了嵌套结果集或是分组了，这样的话当返回一个主结果行的时候，就不会发生有对前面结果集的引用的情况。这就使得在获取嵌套的结果集的时候不至于导致内存不够用。默认值：`false`。
`resultSets`	这个设置仅对多结果集的情况适用，它将列出语句执行后返回的结果集并每个结果集给一个名称，名称是逗号分隔的。

2.3 insert ,update,delete

< insert id="insertAuthor" parameterType="domain.blog.Author" flushCache="true" statementType="PREPARED" keyProperty=""#将JDBC生成的主键值赋值给keyProperty对应的属性名 keyColumn="" useGeneratedKeys="" #取出JDBC生成的主键 timeout="20"> < update id="updateAuthor" parameterType="domain.blog.Author" flushCache="true" statementType="PREPARED" timeout="20"> < delete id="deleteAuthor" parameterType="domain.blog.Author" flushCache="true" statementType="PREPARED" timeout="20">

属性	描述
`id`	命名空间中的唯一标识符，可被用来代表这条语句。
`parameterType`	将要传入语句的参数的完全限定类名或别名。这个属性是可选的，因为 MyBatis 可以通过 TypeHandler 推断出具体传入语句的参数，默认值为 unset。
`parameterMap`	这是引用外部 parameterMap 的已经被废弃的方法。使用内联参数映射和 parameterType 属性。
`flushCache`	将其设置为 true，任何时候只要语句被调用，都会导致本地缓存和二级缓存都会被清空，默认值：true（对应插入、更新和删除语句）。
`timeout`	这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为 unset（依赖驱动）。
`statementType`	STATEMENT，PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement，默认值：PREPARED。
`useGeneratedKeys`	（仅对 insert 和 update 有用）这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键（比如：像 mysql 和 SQL Server 这样的关系数据库管理系统的自动递增字段），默认值：false。
`keyProperty`	（仅对 insert 和 update 有用）唯一标记一个属性，MyBatis 会通过 getGeneratedKeys 的返回值或者通过 insert 语句的 selectKey 子元素设置它的键值，默认：`unset`。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。
`keyColumn`	（仅对 insert 和 update 有用）通过生成的键值设置表中的列名，这个设置仅在某些数据库（像 PostgreSQL）是必须的，当主键列不是表中的第一列的时候需要设置。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。
`databaseId`	如果配置了 databaseIdProvider，MyBatis 会加载所有的不带 databaseId 或匹配当前 databaseId 的语句；如果带或者不带的语句都有，则不带的会被忽略。

insert,update,delete语句实例:

< insert id="insertAuthor"> insert into Author (id,username,password,email,bio) values (#{id},#{username},#{password},#{email},#{bio}) < /insert> < update id="updateAuthor"> update Author set username = #{username}, password = #{password}, email = #{email}, bio = #{bio} where id = #{id} < /update> < delete id="deleteAuthor"> delete from Author where id = #{id} < /delete>

如果设置了主键自增,则上述insert语句可以更改为:

< insert id="insertAuthor" useGeneratedKeys="true" keyProperty="id"> insert into Author (username,password,email,bio) values (#{username},#{password},#{email},#{bio}) < /insert>

如果数据库支持多行插入(例如MySQL数据库),则insert语句可以修改为:

< insert id="insertAuthor" useGeneratedKeys="true" keyProperty="id"> insert into Author (username, password, email, bio) values < foreach item="item" collection="list" separator=","> (#{item.username}, #{item.password}, #{item.email}, #{item.bio}) < /foreach> < /insert>

其中foreach 会对集合进行迭代 , item 表示集合中每个元素,collection 表示集合的类型, separator表示分隔符,并且智能的在最后一个元素后去除分隔符

如果数据库不支持自动生成主键,则可以使用另外一种 MyBatis提供的方式

< insert id="insertAuthor"> < selectKey keyProperty="id" resultType="int" order="BEFORE"> select CAST(RANDOM()*1000000 as INTEGER) a from SYSIBM.SYSDUMMY1 < /selectKey> insert into Author (id, username, password, email,bio, favourite_section) values (#{id}, #{username}, #{password}, #{email}, #{bio}, #{favouriteSection,jdbcType=VARCHAR}) < /insert>

上述语句的执行顺序是,先执行自动生成随机ID的语句, 并将随机生成的值转成int类型再通过set方法设置到Author的id属性中,从而执行插入时,id属性值将对应数据库的id列,插入到数据库中
selectKey 的重要属性如下:

< selectKey keyProperty="id" resultType="int" order="BEFORE" statementType="PREPARED">

属性	描述
`keyProperty`	selectKey 语句结果应该被设置的目标属性。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。
`keyColumn`	匹配属性的返回结果集中的列名称。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。
`resultType`	结果的类型。MyBatis 通常可以推算出来，但是为了更加确定写上也不会有什么问题。MyBatis 允许任何简单类型用作主键的类型，包括字符串。如果希望作用于多个生成的列，则可以使用一个包含期望属性的 Object 或一个 Map。
`order`	这可以被设置为 BEFORE 或 AFTER。如果设置为 BEFORE，那么它会首先选择主键，设置 keyProperty 然后执行插入语句。如果设置为 AFTER，那么先执行插入语句，然后是 selectKey 元素 - 这和像 Oracle 的数据库相似，在插入语句内部可能有嵌入索引调用。
`statementType`	与前面相同，MyBatis 支持 STATEMENT，PREPARED 和 CALLABLE 语句的映射类型，分别代表 PreparedStatement 和 CallableStatement 类型。

2.4 sql
sql元素可以用来定义可复用的sql代码:

< sql id="fromClause"> /*通过${}取调用者传递的属性值*/ from ${tableName} < /sql>

使用< include> 元素调用定义的sql元素,以下是简单的实现了复用的效果,往往实际中会更加复杂:

< !--通过ID查找用户--> < select id="selectUserById" resultMap="BaseResultMap" parameterType="java.lang.Long" > select id,userName,age /*通过property属性向sql元素动态传递参数值,两边规定好property的属性名称即可*/ < include refid="fromClause"> < property name="tableName" value="https://www.songbingjia.com/android/userinfo"/> < /include> where id = #{id} < /select> < !--查询出所有用户--> < select id="selectAll" resultMap="BaseResultMap" > select id, username,age < include refid="fromClause"> < property name="tableName" value="https://www.songbingjia.com/android/userinfo"/> < /include> < /select>

此外,调用者传递过的属性值,同样也可以使用在include 元素的 refid,例如:

< sql id="sometable"> ${prefix}Table < /sql> < sql id="someinclude"> from < include refid="${include_target}"/> < /sql> < select id="select" resultType="map"> select field1, field2, field3 < include refid="someinclude"> < property name="prefix" value="https://www.songbingjia.com/android/Some"/> < property name="include_target" value="https://www.songbingjia.com/android/sometable"/> < /include> < /select>

2.5 参数 parameters
sql语句接收的参数有两种类型,一种是基本类型,另一种是复杂的对象类型
如果sql语句接收的参数是一个对象.那么传递过来的对象要提供相应的getter方法,此时mybatis才能正确的取出属性值
例如:

< !--通过ID更新用户--> < update id="updateByPrimaryKey" parameterType="com.baoxian.domain.UserInfo" > update UserInfo set username = #{userName},age = #{age} where id = #{id} < /update>

每一个参数都支持为其指定特殊的类型
格式如下:

< !--通过ID更新用户--> < update id="updateByPrimaryKey" parameterType="com.baoxian.domain.UserInfo" > update UserInfo set username = #{userName},age = #{age,javaType=int,jdbcType=NUMERIC} where id = #{id} < /update>

其中age参数,指明java类型是int , jdbcType是NUMERIC
如果传递一个为null的参数值到数据库中,并且该列允许为null,那么必须为该参数指定javaType
除了javaType,与 jdbcType之外,还可以指定以下:

typeHandler: 需要特殊类型处理器处理参数的映射 (几乎不用这么做)

numericScale:如果参数值是一个小数,希望保存进数据库的值保留小数点后两位 ,则可以通这样实现: #{salary,javaType=double,jdbcType=NUMERIC,numericScale=2}

mode:该属性有三个可选值,IN,OUT,及INOUT; 如果参数为 OUT 或 INOUT，参数对象属性的真实值将会被改变，就像你在获取输出参数时所期望的那样。

如果 mode 为 OUT（或 INOUT），而且 jdbcType 为 CURSOR(也就是 Oracle 的 REFCURSOR)，你必须指定一个 resultMap 来映射结果集 ResultMap 到参数类型。
要注意这里的 javaType 属性是可选的，如果留空并且 jdbcType 是 CURSOR，它会被自动地被设为 ResultMap。

说了那么多,其实更多时候,我们90%的情况是不需要为参数指定什么额外属性,MyBatis已经帮你做好该做的
最多在java参数为null时,指定javaType即可

2.6 字符串替换
使用#{} 会生成一个预处理参数,提高了SQL的安全性, 但有时不希望对参数值进行转义,保持参数原本的值,则可以使用 ${}进行取值