MyBatis映射文件之——概述

MyBatis的真正强大在于它的语句映射。
映射器的XML文件相对简单，拿他跟具有相同功能的JDBC代码进行对比，
会发现省掉了95%的代码。
MyBatis致力于减少使用成本，让用户能更专注于SQL代码。
SQL映射文件只有很少的几个顶级元素（按照应被定义的顺序列出）：

• cache - 该命名空间的缓存配置
• cache-ref -引用其他命名空间的缓存配置
• resultMap- 描述如何从数据库结果集中加载对象，是最复杂也是最强大的元素。
• sql - 可被其他语句引用的可重用语句块
• insert - 映射插入语句
• update - 映射更新语句
• delete - 映射删除语句
• select - 映射查询语句

cache

给定命名空间的缓存配置（是否开启二级缓存）

cache-ref

其他命名空间的缓存配置的引用。

resultMap

描述如何从数据库结果集中加载对象，是最复杂也是最强大的元素。

<resultMap id="userResultMap" type="User">
  <id property="id" column="user_id" />
  <result property="username" column="user_name"/>
  <result property="password" column="hashed_password"/>
</resultMap>

然后在引用它的语句中设置 resultMap 属性就行了

<select id="selectUsers" resultMap="userResultMap">
  select user_id, user_name, hashed_password
  from some_table
  where id = #{id}
</select>

sql

可被其他语句引用的可重用语句块。示例：

<sql id="userColumns"> ${alias}.id,${alias}.username,${alias}.password </sql>

这个SQL片段可以在其他语句中使用，如：

<select id="selectUsers" resultType="map">
  select
    <include refid="userColumns"><property name="alias" value="t1"/></include>,
    <include refid="userColumns"><property name="alias" value="t2"/></include>
  from some_table t1
    cross join some_table t2
</select>

insert，update 和 delete

Insert, Update, Delete 元素的属性：

<insert
  id="insertAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  keyProperty=""
  keyColumn=""
  useGeneratedKeys=""
  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）推断出具体传入语句的参数，默认值为未设置
flushCache	将其设置为true后，只要语句被调用，都会导致本地缓存和二级缓存被清空，默认值：（对insert、update和delete语句）true
timeout	这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为未设置（依赖数据库驱动）
statementType	可选STATEMENT,PREPARED或CALLABLE。这会让MyBatis分别使用Statement，PreparedStatement或CallableStatement，默认值PREPARED
useGeneratedKeys	（仅适用于insert和update）这会令MyBatis使用JDBC的getGeneratedKeys方法来取出由数据库内部生成的主键，默认值 false
keyProperty	（仅适用于insert和update）指定能够唯一识别对象的属性，MyBatis会使用getGeneratedKeys的返回值或insert语句的selectKey子元素设置它的值，默认值：未设置。如果生成列不止一个，可以用逗号分隔多个属性名称。
keyColumn	（仅适用于insert和update）设置生成键值在表中的列名，在某些数据库当主键列不是表的第一列的时候，是必须设置的。如果生成列不止一个，可以用逗号分隔多个属性名称。
以下是示例：

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

<!--
	生成一个随机ID的示例
	首先会运行selectKey元素中的语句，并设置Author的id，然后才会调用插入语句。
	这样实现了数据库自动生成逐渐类似的行为，同时保持了Java代码的简洁。
-->
<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>

<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>

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 类型的映射语句，分别代表 Statement, PreparedStatement 和 CallableStatement 类型。

select

查询语句是 MyBatis 中最常用的元素之一。
一个简单select示例：

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

select 元素允许你配置很多属性来配置每条语句的行为细节。

<select
  id="selectPerson"
  parameterType="int"
  resultType="hashmap"
  resultMap="personResultMap"
  flushCache="false"
  useCache="true"
  timeout="10"
  fetchSize="256"
  statementType="PREPARED"
  resultSetType="FORWARD_ONLY">

属性	描述
id	在命名空间中唯一的标识符，可以被用来引用这条语句。
parameterType	将会传入这条语句的参数的类全限定名或别名。这个属性是可选的，因为 MyBatis 可以通过类型处理器（TypeHandler）推断出具体传入语句的参数，默认值为未设置（unset）。
resultType	期望从这条语句中返回结果的类全限定名或别名。 注意，如果返回的是集合，那应该设置为集合包含的类型，而不是集合本身的类型。 resultType 和 resultMap 之间只能同时使用一个。
resultMap	对外部 resultMap 的命名引用。结果映射是 MyBatis 最强大的特性，如果你对其理解透彻，许多复杂的映射问题都能迎刃而解。 resultType 和 resultMap 之间只能同时使用一个。
flushCache	将其设置为 true 后，只要语句被调用，都会导致本地缓存和二级缓存被清空，默认值：false。
useCache	将其设置为 true 后，将会导致本条语句的结果被二级缓存缓存起来，默认值：对 select 元素为 true。
timeout	这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为未设置（unset）（依赖数据库驱动）。
fetchSize	这是一个给驱动的建议值，尝试让驱动程序每次批量返回的结果行数等于这个设置值。 默认值为未设置（unset）（依赖驱动）。
statementType	可选 STATEMENT，PREPARED 或 CALLABLE。这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement，默认值：PREPARED。