sqlmap-xml.xml | searchcode

/src/site/zh/xdoc/sqlmap-xml.xml

Large files files are truncated, but you can click here to view the full file

<?xml version="1.0" encoding="UTF-8"?>
<!--
  Copyright 2010-2012 the original author or authors.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
-->

<!-- version: $Id$ -->

<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">

  <properties>
    <title>MyBatis 3 | Mapper XML 文件</title>
    <author email="clinton.begin@gmail.com">Clinton Begin</author>
    <author email="nanlei1987@gmail.com">Nan Lei</author>
    <author email="echowdx@gmail.com">Dongxu Wang</author>
  </properties>

  <body>
    <section name="Mapper XML 文件">
      <p>MyBatis 的真正强大在于它的映射语句，也是它的魔力所在。由于它的异常强大，映射器的 XML 文件就显得相对简单。如果拿它跟具有相同功能的 JDBC 代码进行对比，你会立即发现省掉了将近 95% 的代码。MyBatis 就是针对 SQL 构建的，并且比普通的方法做的更好。</p>
      <p>SQL 映射文件有很少的几个顶级元素（按照它们应该被定义的顺序）：</p>
      <ul>
        <li>
          <code>cache</code>
          – 给定命名空间的缓存配置。
        </li>
        <li>
          <code>cache-ref</code>
          – 其他命名空间缓存配置的引用。
        </li>
        <li>
          <code>resultMap</code>
          – 是最复杂也是最强大的元素，用来描述如何从数据库结果集中来加载对象。
        </li>
        <li>
          <strike>
            <code>parameterMap</code>
            – 已废弃！老式风格的参数映射。内联参数是首选,这个元素可能在将来被移除，这里不会记录。
          </strike>
        </li>
        <li>
          <code>sql</code>
          – 可被其他语句引用的可重用语句块。
        </li>
        <li>
          <code>insert</code>
          – 映射插入语句
        </li>
        <li>
          <code>update</code>
          – 映射更新语句
        </li>
        <li>
          <code>delete</code>
          – 映射删除语句
        </li>
        <li>
          <code>select</code>
          – 映射查询语句
        </li>
      </ul>
      <p>下一部分将从语句本身开始来描述每个元素的细节。</p>

      <subsection name="select">
        <p>查询语句是 MyBatis 中最常用的元素之一，光能把数据存到数据库中价值并不大，如果还能重新取出来才有用，多数应用也都是查询比修改要频繁。对每个插入、更新或删除操作，通常对应多个查询操作。这是 MyBatis 的基本原则之一，也是将焦点和努力放到查询和结果映射的原因。简单查询的 select 元素是非常简单的。比如：
        </p>

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

        <p>这个语句被称作 selectPerson，接受一个 int（或 Integer）类型的参数，并返回一个 HashMap 类型的对象，其中的键是列名，值便是结果行中的对应值。
        </p>

        <p>注意参数符号：</p>

        <source><![CDATA[#{id}]]></source>

        <p>这就告诉 MyBatis 创建一个预处理语句参数，通过 JDBC，这样的一个参数在 SQL 中会由一个“?”来标识，并被传递到一个新的预处理语句中，就像这样：
        </p>

        <source><![CDATA[// Similar JDBC code, NOT MyBatis…
String selectPerson = "SELECT * FROM PERSON WHERE ID=?";
PreparedStatement ps = conn.prepareStatement(selectPerson);
ps.setInt(1,id);]]></source>

        <p>当然，这需要很多单独的 JDBC 的代码来提取结果并将它们映射到对象实例中，这就是 MyBatis 节省你时间的地方。我们需要深入了解参数和结果映射，细节部分我们下面来了解。
        </p>

        <p>select 元素有很多属性允许你配置，来决定每条语句的作用细节。
        </p>

        <source><![CDATA[<select
  id="selectPerson"
  parameterType="int"
  parameterMap="deprecated"
  resultType="hashmap"
  resultMap="personResultMap"
  flushCache="false"
  useCache="true"
  timeout="10000"
  fetchSize="256"
  statementType="PREPARED"
  resultSetType="FORWARD_ONLY">]]></source>

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

      <subsection name="insert, update 和 delete">
        <p>
        数据变更语句 insert，update 和 delete 的实现非常接近：
        </p>

        <source><![CDATA[<insert
  id="insertAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  keyProperty=""
  keyColumn=""
  useGeneratedKeys=""
  timeout="20">

<update
  id="insertAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  timeout="20">

<delete
  id="insertAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  timeout="20">]]></source>

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

        <p>下面就是 insert，update 和 delete 语句的示例：</p>

        <source><![CDATA[<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>]]></source>

        <p>如前所述，插入语句的配置规则更加丰富，在插入语句里面有一些额外的属性和子元素用来处理主键的生成，而且有多种生成方式。</p>

        <p>首先，如果你的数据库支持自动生成主键的字段（比如 MySQL 和 SQL Server），那么你可以设置 useGeneratedKeys=”true”，然后再把 keyProperty 设置到目标属性上就OK了。例如，如果上面的 Author 表已经对 id 使用了自动生成的列类型，那么语句可以修改为:</p>

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

        <p>对于不支持自动生成类型的数据库或可能不支持自动生成主键 JDBC 驱动来说，MyBatis 有另外一种方法来生成主键。
        </p>

        <p>这里有一个简单（甚至很傻）的示例，它可以生成一个随机 ID（你最好不要这么做，但这里展示了 MyBatis 处理问题的灵活性及其所关心的广度）：
        </p>
        
        <source><![CDATA[<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>]]></source>
        <p>在上面的示例中，selectKey 元素将会首先运行，Author 的 id 会被设置，然后插入语句会被调用。这给你了一个和数据库中来处理自动生成的主键类似的行为，避免了使 Java 代码变得复杂。
        </p>
        <p>selectKey 元素描述如下：
        </p>
        <source><![CDATA[<selectKey
  keyProperty="id"
  resultType="int"
  order="BEFORE"
  statementType="PREPARED">]]></source>

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

      <subsection name="sql">
        <p>这个元素可以被用来定义可重用的 SQL 代码段，可以包含在其他语句中。比如：
        </p>

        <source><![CDATA[<sql id="userColumns"> id,username,password </sql>]]></source>

        <p>这个 SQL 片段可以被包含在其他语句中，例如：
        </p>

        <source><![CDATA[<select id="selectUsers" resultType="map">
  select <include refid="userColumns"/>
  from some_table
  where id = #{id}
</select>]]></source>
      </subsection>

      <subsection name="参数（Parameters）">
        <p>前面的所有语句中你所见到的都是简单参数的例子，实际上参数是 MyBatis 非常强大的元素，对于简单的做法，大概 90% 的情况参数都很少，比如：
        </p>

        <source><![CDATA[<select id="selectUsers" resultType="User">
  select id, username, password
  from users
  where id = #{id}
</select>]]></source>

        <p>上面的这个示例说明了一个非常简单的命名参数映射。参数类型被设置为 <code>int</code>，这样这个参数就可以被设置成任何内容。原生的类型或简单数据类型（比如整型和字符串）因为没有相关属性，它会完全用参数值来替代。然而，如果传入一个复杂的对象，行为就会有一点不同了。比如：
        </p>

        <source><![CDATA[<insert id="insertUser" parameterType="User">
  insert into users (id, username, password)
  values (#{id}, #{username}, #{password})
</insert>]]></source>

        <p>如果 User 类型的参数对象传递到了语句中，id、username 和 password 属性将会被查找，然后将它们的值传入预处理语句的参数中。
        </p>

        <p>这点对于向语句中传参是比较好的而且又简单，不过参数映射的功能远不止于此。
        </p>

        <p>首先，像 MyBatis 的其他部分一样，参数也可以指定一个特殊的数据类型。
        </p>

        <source><![CDATA[#{property,javaType=int,jdbcType=NUMERIC}]]></source>

        <p>像 MyBatis 的剩余部分一样，javaType 通常可以从参数对象中来去确定，前提是只要对象不是一个 HashMap。那么 javaType 应该被确定来保证使用正确类型处理器。
        </p>

        <p><span class="label important">NOTE</span> 如果 null 被当作值来传递，对于所有可能为空的列，JDBC Type 是需要的。你可以自己通过阅读预处理语句的 setNull() 方法的 JavaDocs 文档来研究这种情况。
        </p>

        <p>为了以后定制类型处理方式，你也可以指定一个特殊的类型处理器类（或别名），比如：
        </p>

        <source><![CDATA[#{age,javaType=int,jdbcType=NUMERIC,typeHandler=MyTypeHandler}]]></source>

        <p>尽管看起来配置变得越来越繁琐，但实际上是很少去设置它们。
        </p>

        <p>对于数值类型，还有一个小数保留位数的设置，来确定小数点后保留的位数。
        </p>

        <source><![CDATA[#{height,javaType=double,jdbcType=NUMERIC,numericScale=2}]]></source>

        <p>最后，mode 属性允许你指定 IN，OUT 或 INOUT 参数。如果参数为 OUT 或 INOUT，参数对象属性的真实值将会被改变，就像你在获取输出参数时所期望的那样。如果 mode 为 OUT（或 INOUT），而且 jdbcType 为 CURSOR(也就是 Oracle 的 REFCURSOR)，你必须指定一个 resultMap 来映射结果集到参数类型。要注意这里的 javaType 属性是可选的，如果左边的空白是 jdbcType 的 CURSOR 类型，它会自动地被设置为结果集。
        </p>

        <source><![CDATA[#{department, mode=OUT, jdbcType=CURSOR, javaType=ResultSet, resultMap=departmentResultMap}]]></source>

        <p>MyBatis 也支持很多高级的数据类型，比如结构体，但是当注册 out 参数时你必须告诉它语句类型名称。比如（再次提示，在实际中要像这样不能换行）：
        </p>

        <source><![CDATA[#{middleInitial, mode=OUT, jdbcType=STRUCT, jdbcTypeName=MY_TYPE, resultMap=departmentResultMap}]]></source>

        <p>尽管所有这些强大的选项很多时候你只简单指定属性名，其他的事情 MyBatis 会自己去推断，最多你需要为可能为空的列名指定 <code>jdbcType</code>。
        </p>

        <source><![CDATA[#{firstName}
#{middleInitial,jdbcType=VARCHAR}
#{lastName}]]></source>

        <h4>
          字符串替换
        </h4>

        <p>默认情况下,使用#{}格式的语法会导致 MyBatis 创建预处理语句属性并安全地设置值（比如?）。这样做更安全，更迅速，通常也是首选做法，不过有时你只是想直接在 SQL 语句中插入一个不改变的字符串。比如，像 ORDER BY，你可以这样来使用：
        </p>

        <source><![CDATA[ORDER BY ${columnName}]]></source>

        <p>这里 MyBatis 不会修改或转义字符串。
        </p>

        <p>
          <span class="label important">NOTE</span> 以这种方式接受从用户输出的内容并提供给语句中不变的字符串是不安全的，会导致潜在的 SQL 注入攻击，因此要么不允许用户输入这些字段，要么自行转义并检验。
        </p>
      </subsection>

      <subsection name="Result Maps">
        <p>
resultMap 元素是 MyBatis 中最重要最强大的元素。它就是让你远离 90%的需要从结果
集中取出数据的 JDBC 代码的那个东西,
而且在一些情形下允许你做一些 JDBC 不支持的事
情。
事实上,
编写相似于对复杂语句联合映射这些等同的代码,
也许可以跨过上千行的代码。
ResultMap 的设计就是简单语句不需要明确的结果映射,而很多复杂语句确实需要描述它们
的关系。
        </p>

        <p>
你已经看到简单映射语句的示例了,但没有明确的 resultMap。比如:
        </p>

        <source><![CDATA[<select id="selectUsers" resultType="map">
  select id, username, hashedPassword
  from some_table
  where id = #{id}
</select>]]></source>

        <p>
这样一个语句简单作用于所有列被自动映射到 HashMap 的键上,这由 resultType 属性
指定。这在很多情况下是有用的,但是 HashMap 不能很好描述一个领域模型。那样你的应
用程序将会使用 JavaBeans 或 POJOs(Plain Old Java Objects,普通 Java 对象)来作为领域
模型。MyBatis 对两者都支持。看看下面这个 JavaBean:
        </p>
        <source><![CDATA[package com.someapp.model;
public class User {
  private int id;
  private String username;
  private String hashedPassword;
  
  public int getId() {
    return id;
  }
  public void setId(int id) {
    this.id = id;
  }
  public String getUsername() {
    return username;
  }
  public void setUsername(String username) {
    this.username = username;
  }
  public String getHashedPassword() {
    return hashedPassword;
  }
  public void setHashedPassword(String hashedPassword) {
    this.hashedPassword = hashedPassword;
  }
}]]></source>

        <p>
基于 JavaBean 的规范,上面这个类有 3 个属性:id,username 和 hashedPassword。这些
在 select 语句中会精确匹配到列名。
        </p>

        <p>
这样的一个 JavaBean 可以被映射到结果集,就像映射到 HashMap 一样简单。
        </p>

        <source><![CDATA[<select id="selectUsers" resultType="com.someapp.model.User">
  select id, username, hashedPassword
  from some_table
  where id = #{id}
</select>]]></source>

        <p>
要记住类型别名是你的伙伴。使用它们你可以不用输入类的全路径。比如:
        </p>

        <source><![CDATA[<!-- In mybatis-config.xml file -->
<typeAlias type="com.someapp.model.User" alias="User"/>

<!-- In SQL Mapping XML file -->
<select id="selectUsers" resultType="User">
  select id, username, hashedPassword
  from some_table
  where id = #{id}
</select>]]></source>

        <p>
这些情况下,MyBatis 会在幕后自动创建一个 ResultMap,基于属性名来映射列到
JavaBean 的属性上。如果列名没有精确匹配,你可以在列名上使用 select 字句的别名(一个
基本的 SQL 特性)来匹配标签。比如:
        </p>

        <source><![CDATA[<select id="selectUsers" resultType="User">
  select
    user_id             as "id",
    user_name           as "userName",
    hashed_password     as "hashedPassword"
  from some_table
  where id = #{id}
</select>]]></source>

        <p>
ResultMap 最优秀的地方你已经了解了很多了,但是你还没有真正的看到一个。这些简
单的示例不需要比你看到的更多东西。
只是出于示例的原因,
让我们来看看最后一个示例中
外部的 resultMap 是什么样子的,这也是解决列名不匹配的另外一种方式。
        </p>

        <source><![CDATA[<resultMap id="userResultMap" type="User">
  <id property="id" column="user_id" />
  <result property="username" column="username"/>
  <result property="password" column="password"/>
</resultMap>]]></source>

        <p>
引用它的语句使用 resultMap 属性就行了(注意我们去掉了 resultType 属性)。比如:
        </p>

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

        <p>
如果世界总是这么简单就好了。
        </p>

	      <h4>高级结果映射</h4>

        <p>
MyBatis 创建的一个想法:数据库不用永远是你想要的或需要它们是什么样的。而我们
最喜欢的数据库最好是第三范式或 BCNF 模式,但它们有时不是。如果可能有一个单独的
数据库映射,所有应用程序都可以使用它,这是非常好的,但有时也不是。结果映射就是
MyBatis 提供处理这个问题的答案。
        </p>

        <p>
比如,我们如何映射下面这个语句?
        </p>

        <source><![CDATA[<!-- Very Complex Statement -->
<select id="selectBlogDetails" resultMap="detailedBlogResultMap">
  select
       B.id as blog_id,
       B.title as blog_title,
       B.author_id as blog_author_id,
       A.id as author_id,
       A.username as author_username,
       A.password as author_password,
       A.email as author_email,
       A.bio as author_bio,
       A.favourite_section as author_favourite_section,
       P.id as post_id,
       P.blog_id as post_blog_id,
       P.author_id as post_author_id,
       P.created_on as post_created_on,
       P.section as post_section,
       P.subject as post_subject,
       P.draft as draft,
       P.body as post_body,
       C.id as comment_id,
       C.post_id as comment_post_id,
       C.name as comment_name,
       C.comment as comment_text,
       T.id as tag_id,
       T.name as tag_name
  from Blog B
       left outer join Author A on B.author_id = A.id
       left outer join Post P on B.id = P.blog_id
       left outer join Comment C on P.id = C.post_id
       left outer join Post_Tag PT on PT.post_id = P.id
       left outer join Tag T on PT.tag_id = T.id
  where B.id = #{id}
</select>]]></source>

        <p>
你可能想把它映射到一个智能的对象模型,包含一个作者写的博客,有很多的博文,每
篇博文有零条或多条的评论和标签。
下面是一个完整的复杂结果映射例子
(假设作者,
博客,
博文,
评论和标签都是类型的别名) 我们来看看,
。
但是不用紧张,
我们会一步一步来说明。
当天最初它看起来令人生畏,但实际上非常简单。
        </p>

        <source><![CDATA[<!-- Very Complex Result Map -->
<resultMap id="detailedBlogResultMap" type="Blog">
  <constructor>
    <idArg column="blog_id" javaType="int"/>
  </constructor>
  <result property="title" column="blog_title"/>
  <association property="author" javaType="Author">
    <id property="id" column="author_id"/>
    <result property="username" column="author_username"/>
    <result property="password" column="author_password"/>
    <result property="email" column="author_email"/>
    <result property="bio" column="author_bio"/>
    <result property="favouriteSection" column="author_favourite_section"/>
  </association>
  <collection property="posts" ofType="Post">
    <id property="id" column="post_id"/>
    <result property="subject" column="post_subject"/>
    <association property="author" javaType="Author"/>
    <collection property="comments" ofType="Comment">
      <id property="id" column="comment_id"/>
    </collection>
    <collection property="tags" ofType="Tag" >
      <id property="id" column="tag_id"/>
    </collection>
    <discriminator javaType="int" column="draft">
      <case value="1" resultType="DraftPost"/>
    </discriminator>
  </collection>
</resultMap>]]></source>

        <p>
resultMap 元素有很多子元素和一个值得讨论的结构。
下面是 resultMap 元素的概念视图
        </p>

        <h4>resultMap</h4>
        <ul>
          <li>
            <code>constructor</code> - 类在实例化时,用来注入结果到构造方法中
            <ul>
              <li><code>idArg</code> - ID 参数;标记结果作为 ID 可以帮助提高整体效能</li>
              <li><code>arg</code> - 注入到构造方法的一个普通结果</li>
            </ul>
          </li>
          <li><code>id</code> – 一个 ID 结果;标记结果作为 ID 可以帮助提高整体效能</li>
          <li><code>result</code> – 注入到字段或 JavaBean 属性的普通结果</li>
          <li>
            <code>association</code> – 一个复杂的类型关联;许多结果将包成这种类型
            <ul>
              <li>嵌入结果映射 – 结果映射自身的关联,或者参考一个
              </li>
            </ul>
          </li>
          <li>
            <code>collection</code> – 复杂类型的集
            <ul>
              <li>嵌入结果映射 – 结果映射自身的集,或者参考一个</li>
            </ul>
          </li>
          <li>
            <code>discriminator</code> – 使用结果值来决定使用哪个结果映射
            <ul>
              <li>
                <code>case</code> – 基于某些值的结果映射
                <ul>
                  <li>嵌入结果映射 – 这种情形结果也映射它本身,因此可以包含很多相
                      同的元素,或者它可以参照一个外部的结果映射。
                  </li>
                </ul>
              </li>
            </ul>
          </li>
        </ul>

        <table>
          <caption>ResultMap Attributes</caption>
          <thead>
            <tr>
              <th>Attribute</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td><code>id</code></td>
              <td>A unique identifier in this namespace that can be used to reference this result map.</td>
            </tr>
            <tr>
              <td><code>type</code></td>
              <td>A fully qualified Java class name, or a type alias (see the table above for the list of built-in type aliases). 
              </td>
            </tr>
            <tr>
              <td><code>autoMapping</code></td>
              <td>If present, MyBatis will enable or disable the automapping for this ResultMap. 
                This attribute overrides the global autoMappingBehavior. Default: unset. 
              </td>
            </tr>
          </tbody>
        </table>

        <p>
          <span class="label important">最佳实践</span> 通常逐步建立结果映射。单元测试的真正帮助在这里。如果你尝试创建
一次创建一个向上面示例那样的巨大的结果映射,
那么可能会有错误而且很难去控制它
来工作。开始简单一些,一步一步的发展。而且要进行单元测试!使用该框架的缺点是
它们有时是黑盒(是否可见源代码)
。你确定你实现想要的行为的最好选择是编写单元
测试。它也可以你帮助得到提交时的错误。
        </p>

        <p>
下面一部分将详细说明每个元素。
        </p>

        <h4>id &amp; result</h4>

        <source><![CDATA[<id property="id" column="post_id"/>
<result property="subject" column="post_subject"/>]]></source>

        <p>
这些是结果映射最基本内容。id 和 result 都映射一个单独列的值到简单数据类型(字符
串,整型,双精度浮点数,日期等)的单独属性或字段。
        </p>

        <p>
这两者之间的唯一不同是 id 表示的结果将是当比较对象实例时用到的标识属性。这帮
助来改进整体表现,特别是缓存和嵌入结果映射(也就是联合映射)
。      </p>

        <p>
每个都有一些属性:
        </p>

        <table>
          <caption>Id and Result Attributes</caption>
          <thead>
            <tr>
              <th>属性</th>
              <th>描述</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td><code>property</code></td>
              <td>
映射到列结果的字段或属性。如果匹配的是存在的,和给定名称相同
的 JavaBeans 的属性,那么就会使用。否则 MyBatis 将会寻找给定名称
property
的字段。这两种情形你可以使用通常点式的复杂属性导航。比如,你
可以这样映射一些东西:
“username”
,或者映射到一些复杂的东西:
“address.street.number”
。
              </td>
            </tr>
            <tr>
              <td><code>column</code></td>
              <td>
从数据库中得到的列名,或者是列名的重命名标签。这也是通常和会
传递给 resultSet.getString(columnName)方法参数中相同的字符串。
              </td>
            </tr>
            <tr>
              <td><code>javaType</code></td>
              <td>
一个 Java 类的完全限定名,或一个类型别名(参考上面内建类型别名
的列表)
。如果你映射到一个 JavaBean,MyBatis 通常可以断定类型。
然而,如果你映射到的是 HashMap,那么你应该明确地指定 javaType
来保证所需的行为。
              </td>
            </tr>
            <tr>
              <td><code>jdbcType</code></td>
              <td>
在这个表格之后的所支持的 JDBC 类型列表中的类型。JDBC 类型是仅
仅需要对插入,更新和删除操作可能为空的列进行处理。这是 JDBC
jdbcType
的需要,而不是 MyBatis 的。如果你直接使用 JDBC 编程,你需要指定
这个类型-但仅仅对可能为空的值。
              </td>
            </tr>
            <tr>
              <td><code>typeHandler</code></td>
              <td>
我们在前面讨论过默认的类型处理器。使用这个属性,你可以覆盖默
认的类型处理器。这个属性值是类的完全限定名或者是一个类型处理
器的实现,或者是类型别名。
              </td>
            </tr>
          </tbody>
        </table>

        <h4>支持的 JDBC 类型</h4>

        <p>
为了未来的参考,MyBatis 通过包含的 jdbcType 枚举型,支持下面的 JDBC 类型。
        </p>

        <table>
          <tr>
            <td><code>BIT</code></td>
            <td><code>FLOAT</code></td>
            <td><code>CHAR</code></td>
            <td><code>TIMESTAMP</code></td>
            <td><code>OTHER</code></td>
            <td><code>UNDEFINED</code></td>
          </tr>
          <tr>
            <td><code>TINYINT</code></td>
            <td><code>REAL</code></td>
            <td><code>VARCHAR</code></td>
            <td><code>BINARY</code></td>
            <td><code>BLOG</code></td>
            <td><code>NVARCHAR</code></td>
          </tr>
          <tr>
            <td><code>SMALLINT</code></td>
            <td><code>DOUBLE</code></td>
            <td><code>LONGVARCHAR</code></td>
            <td><code>VARBINARY</code></td>
            <td><code>CLOB</code></td>
            <td><code>NCHAR</code></td>
          </tr>
          <tr>
            <td><code>INTEGER</code></td>
            <td><code>NUMERIC</code></td>
            <td><code>DATE</code></td>
            <td><code>LONGVARBINARY</code></td>
            <td><code>BOOLEAN</code></td>
            <td><code>NCLOB</code></td>
          </tr>
          <tr>
            <td><code>BIGINT</code></td>
            <td><code>DECIMAL</code></td>
            <td><code>TIME</code></td>
            <td><code>NULL</code></td>
            <td><code>CURSOR</code></td>
            <td><code>ARRAY</code></td>
          </tr>
        </table>

        <h4>构造方法</h4>

        <source><![CDATA[<constructor>
   <idArg column="id" javaType="int"/>
   <arg column="username" javaType="String"/>
</constructor>]]></source>

        <p>
对于大多数数据传输对象(Data Transfer Object,DTO)类型,属性可以起作用,而且像
你绝大多数的领域模型,
指令也许是你想使用一成不变的类的地方。
通常包含引用或查询数
据的表很少或基本不变的话对一成不变的类来说是合适的。
构造方法注入允许你在初始化时
为类设置属性的值,而不用暴露出公有方法。MyBatis 也支持私有属性和私有 JavaBeans 属
性来达到这个目的,但是一些人更青睐构造方法注入。构造方法元素支持这个。
        </p>

        <p>
看看下面这个构造方法:
        </p>

        <source><![CDATA[public class User {
   //...
   public User(int id, String username) {
     //...
  }
//...
}]]></source>

        <p>
为了向这个构造方法中注入结果,MyBatis 需要通过它的参数的类型来标识构造方法。
Java 没有自查(反射)参数名的方法。所以当创建一个构造方法元素时,保证参数是按顺序
排列的,而且数据类型也是确定的。
        </p>

        <source><![CDATA[<constructor>
   <idArg column="id" javaType="int"/>
   <arg column="username" javaType="String"/>
</constructor>]]></source>

        <p>
剩余的属性和规则和固定的 id 和 result 元素是相同的。
        </p>

        <table>
          <thead>
            <tr>
              <th>属性</th>
              <th>描述</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td><code>column</code></td>
              <td>
来自数据库的类名,或重命名的列标签。这和通常传递给
resultSet.getString(columnName)方法的字符串是相同的。
              </td>
            </tr>
            <tr>
              <td><code>javaType</code></td>
              <td>
一个 Java 类的完全限定名,或一个类型别名(参考上面内建类型别名的列表)。
如果你映射到一个 JavaBean,MyBatis 通常可以断定类型。然而,如
果你映射到的是 HashMap,那么你应该明确地指定 javaType 来保证所需的
行为。
              </td>
            </tr>
            <tr>
              <td><code>jdbcType</code></td>
              <td>
在这个表格之前的所支持的 JDBC 类型列表中的类型。JDBC 类型是仅仅
需要对插入,
更新和删除操作可能为空的列进行处理。这是 JDBC 的需要,
jdbcType
而不是 MyBatis 的。如果你直接使用 JDBC 编程,你需要指定这个类型-但
仅仅对可能为空的值。
              </td>
            </tr>
            <tr>
              <td><code>typeHandler</code></td>
              <td>
我们在前面讨论过默认的类型处理器。使用这个属性,你可以覆盖默认的
类型处理器。
这个属性值是类的完全限定名或者是一个类型处理器的实现,
或者是类型别名。
              </td>
            </tr>
            <tr>
              <td><code>select</code></td>
              <td>
                The ID of another mapped statement that will load the complex type required by this
                property mapping. The values retrieved from columns specified in the column attribute
                will be passed to the target select statement as parameters. See the Association element
                for more.
              </td>
            </tr>
            <tr>
              <td><code>resultMap</code></td>
              <td>
                This is the ID of a ResultMap that can map the nested results of this argument into an
                appropriate object graph. This is an alternative to using a call to another select
                statement. It allows you to join multiple tables together into a single <code>ResultSet</code>. Such
                a <code>ResultSet</code> will contain duplicated, repeating groups of data that needs to be
                decomposed and mapped properly to a nested object graph. To facilitate this, MyBatis
                lets you "chain" result maps together, to deal with the nested results. See the
                Association element below for more.
              </td>
            </tr>
          </tbody>
        </table>

        <h4><code>关联</code></h4>

        <source><![CDATA[<association property="author" column="blog_author_id" javaType="Author">
  <id property="id" column="author_id"/>
  <result property="username" column="author_username"/>
</association>]]></source>

        <p>
关联元素处理“有一个”类型的关系。比如,在我们的示例中,一个博客有一个用户。
关联映射就工作于这种结果之上。你指定了目标属性,来获取值的列,属性的 java 类型(很
多情况下 MyBatis 可以自己算出来)
,如果需要的话还有 jdbc 类型,如果你想覆盖或获取的
结果值还需要类型控制器。
        </p>

        <p>
关联中不同的是你需要告诉 MyBatis 如何加载关联。MyBatis 在这方面会有两种不同的
方式:
        </p>

        <ul>
          <li>
            嵌套查询:通过执行另外一个 SQL 映射语句来返回预期的复杂类型。
          </li>
          <li>
            嵌套结果:使用嵌套结果映射来处理重复的联合结果的子集。首先,然让我们来查看这个元素的属性。所有的你都会看到,它和普通的只由 select 和
          </li>
        </ul>

        <p>
          resultMap 属性的结果映射不同。
        </p>

        <table>
          <thead>
            <tr>
              <th>属性</th>
              <th>描述</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td><code>property</code></td>
              <td>
映射到列结果的字段或属性。如果匹配的是存在的,和给定名称相同的
property
JavaBeans 的属性,
那么就会使用。
否则 MyBatis 将会寻找给定名称的字段。
这两种情形你可以使用通常点式的复杂属性导航。比如,你可以这样映射
一 些 东 西 :“ username ”, 或 者 映 射 到 一 些 复 杂 的 东 西 :
“address.street.number”
。              </td>
            </tr>
            <tr>
              <td><code>javaType</code></td>
              <td>
一个 Java 类的完全限定名,或一个类型别名(参考上面内建类型别名的列
表)
。如果你映射到一个 JavaBean,MyBatis 通常可以断定类型。然而,如
javaType
果你映射到的是 HashMap,那么你应该明确地指定 javaType 来保证所需的
行为。
              </td>
            </tr>
            <tr>
              <td><code>jdbcType</code></td>
              <td>
在这个表格之前的所支持的 JDBC 类型列表中的类型。JDBC 类型是仅仅
需要对插入,
更新和删除操作可能为空的列进行处理。这是 JDBC 的需要,
jdbcType
而不是 MyBatis 的。如果你直接使用 JDBC 编程,你需要指定这个类型-但
仅仅对可能为空的值。
              </td>
            </tr>
            <tr>
              <td><code>typeHandler</code></td>
              <td>
我们在前面讨论过默认的类型处理器。使用这个属性,你可以覆盖默认的
typeHandler
类型处理器。
这个属性值是类的完全限定名或者是一个类型处理器的实现,
或者是类型别名。
              </td>
            </tr>
          </tbody>
        </table>

        <h4>关联的嵌套查询</h4>

        <table>
          <thead>
            <tr>
              <th>属性</th>
              <th>描述</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td><code>column</code></td>
              <td>
来自数据库的类名,或重命名的列标签。这和通常传递给
resultSet.getString(columnName)方法的字符串是相同的。
column
注 意 : 要 处 理 复 合 主 键 , 你 可 以 指 定 多 个 列 名 通 过 column= ”
{prop1=col1,prop2=col2} ” 这种语法来传递给嵌套查询语 句。这会引起
prop1 和 prop2 以参数对象形式来设置给目标嵌套查询语句。
              </td>
            </tr>
            <tr>
              <td><code>select</code></td>
              <td>
另外一个映射语句的 ID,可以加载这个属性映射需要的复杂类型。获取的
在列属性中指定的列的值将被传递给目标 select 语句作为参数。表格后面
有一个详细的示例。
select
注 意 : 要 处 理 复 合 主 键 , 你 可 以 指 定 多 个 列 名 通 过 column= ”
{prop1=col1,prop2=col2} ” 这种语法来传递给嵌套查询语 句。这会引起
prop1 和 prop2 以参数对象形式来设置给目标嵌套查询语句。
              </td>
            </tr>
            <tr>
              <td><code>fetchType</code></td>
              <td>
                Optional. Valid values are <code>lazy</code> and <code>eager</code>. If present, it supersedes
                the global configuration parameter <code>lazyLoadingEnabled</code> for this mapping.
              </td>
            </tr>
          </tbody>
        </table>

        <p>
示例:
        </p>

        <source><![CDATA[<resultMap id="blogResult" type="Blog">
  <association property="author" column="author_id" javaType="Author" select="selectAuthor"/>
</resultMap>

<select id="selectBlog" resultMap="blogResult">
  SELECT * FROM BLOG WHERE ID = #{id}
</select>

<select id="selectAuthor" resultType="Author">
  SELECT * FROM AUTHOR WHERE ID = #{id}
</select>]]></source>

        <p>
我们有两个查询语句:一个来加载博客,另外一个来加载作者,而且博客的结果映射描
述了“selectAuthor”语句应该被用来加载它的 author 属性。
        </p>

        <p>
其他所有的属性将会被自动加载,假设它们的列和属性名相匹配。
        </p>

        <p>
这种方式很简单,
但是对于大型数据集合和列表将不会表现很好。
问题就是我们熟知的
“N+1 查询问题”。概括地讲,N+1 查询问题可以是这样引起的:
        </p>

        <ul>
          <li>你执行了一个单独的 SQL 语句来获取结果列表(就是“+1”)。</li>
          <li>对返回的每条记录,你执行了一个查询语句来为每个加载细节(就是“N”)。
          </li>
        </ul>

        <p>
这个问题会导致成百上千的 SQL 语句被执行。这通常不是期望的。
        </p>

        <p>
MyBatis 能延迟加载这样的查询就是一个好处,因此你可以分散这些语句同时运行的消
耗。然而,如果你加载一个列表,之后迅速迭代来访问嵌套的数据,你会调用所有的延迟加
载,这样的行为可能是很糟糕的。
        </p>

        <p>
所以还有另外一种方法。
        </p>

        <h4>关联的嵌套结果</h4>

        <table>
          <thead>
            <tr>
              <th>属性</th>
              <th>描述</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td><code>resultMap</code></td>
              <td>
这是结果映射的 ID,可以映射关联的嵌套结果到一个合适的对象图中。这
是一种替代方法来调用另外一个查询语句。这允许你联合多个表来合成到
resultMap
一个单独的结果集…
Large files files are truncated, but you can click here to view the full file