笔记：MyBatis Mapper XML文件详解 - 映射和参数

MyBatis 的真正强大在于它的映射语句，也是它的魔力所在。由于它的异常强大，映射器的 XML 文件就显得相对简单。如果拿它跟具有相同功能的 JDBC 代码进行对比，你会立即发现省掉了将近 95% 的代码。MyBatis 就是针对 SQL 构建的，并且比普通的方法做的更好。

SQL 映射文件有很少的几个顶级元素（按照它们应该被定义的顺序）：

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

1. select（查询）

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

   <select id="selectPerson" parameterType="int" resultType="hashmap">

       SELECT * FROM PERSON WHERE ID = #{id}

   </select>

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

   注意参数符号：

   #{id}

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

       // Similar JDBC code, NOT MyBatis…

       String selectPerson = "SELECT * FROM PERSON WHERE ID=?";

       PreparedStatement ps = conn.prepareStatement(selectPerson);

       ps.setInt(1,id);

   当然，这需要很多单独的 JDBC 的代码来提取结果并将它们映射到对象实例中，这就是 MyBatis 节省你时间的地方。我们需要深入了解参数和结果映射，细节部分我们下面来了解，select 元素有很多属性允许你配置，来决定每条语句的作用细节：

属性	描述
id	在命名空间中唯一的标识符，可以被用来引用这条语句。
parameterType	将会传入这条语句的参数类的完全限定名或别名。这个属性是可选的，因为 MyBatis 可以通过 TypeHandler 推断出具体传入语句的参数，默认值为 unset。
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	这个设置仅对多结果集的情况适用，它将列出语句执行后返回的结果集并每个结果集给一个名称，名称是逗号分隔的。

1. 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 推断出具体传入语句的参数，默认值为 unset。
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 的语句；如果带或者不带的语句都有，则不带的会被忽略。

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

<insert id="insertAuthor" useGeneratedKeys="true"

        keyProperty="id">

    insert into Author (username,password,email,bio)

    values (#{username},#{password},#{email},#{bio})

</insert>

如果你的数据库还支持多行插入, 你也可以传入一个Authors数组或集合，并返回自动生成的主键：

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

对于不支持自动生成类型的数据库或可能不支持自动生成主键 JDBC 驱动来说，MyBatis 有另外一种方法来生成主键。 这里有一个简单（甚至很傻）的示例，它可以生成一个随机 ID（你最好不要这么做，但这里展示了 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>

在上面的示例中，selectKey 元素将会首先运行，Author 的 id 会被设置，然后插入语句会被调用。这给你了一个和数据库中来处理自动生成的主键类似的行为，避免了使 Java 代码变得复杂。 selectKey 元素描述如下：

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

1. Sql

   这个元素可以被用来定义可重用的 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>

   属性值可以用于包含的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="Some"/>

           <property name="include_target" value="sometable"/>

       </include>

   </select>

2. 参数（Parameters）

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

       <select id="selectUsers" resultType="User">

        select id, username, password

        from users

        where id = #{id}

       </select>

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

       <insert id="insertUser" parameterType="User">

        insert into users (id, username, password)

        values (#{id}, #{username}, #{password})

       </insert>

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

   这点对于向语句中传参是比较好的而且又简单，不过参数映射的功能远不止于此。首先，像 MyBatis 的其他部分一样，参数也可以指定一个特殊的数据类型，配置示例：

       #{property,javaType=int,jdbcType=NUMERIC}

   像 MyBatis 的typeHandler部分一样，javaType 通常可以从参数对象中来去确定，前提是只要对象不是一个 HashMap。那么 javaType 应该被确定来保证使用正确类型处理器。为了以后定制类型处理方式，你也可以指定一个特殊的类型处理器类（或别名），比如：

   #{age,javaType=int,jdbcType=NUMERIC,typeHandler=MyTypeHandler}

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

   #{height,javaType=double,jdbcType=NUMERIC,numericScale=2}

   最后，mode 属性允许你指定 IN，OUT 或 INOUT 参数。如果参数为 OUT 或 INOUT，参数对象属性的真实值将会被改变，就像你在获取输出参数时所期望的那样。如果 mode 为 OUT（或 INOUT），而且 jdbcType 为 CURSOR(也就是 Oracle 的 REFCURSOR)，你必须指定一个 resultMap 来映射结果集到参数类型。要注意这里的 javaType 属性是可选的，如果左边的空白是 jdbcType 的 CURSOR 类型，它会自动地被设置为结果集。 尽管所有这些强大的选项很多时候你只简单指定属性名，其他的事情 MyBatis 会自己去推断，最多你需要为可能为空的列名指定 jdbcType。

• 字符串替换

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

  ORDER BY ${columnName}

  这里 MyBatis 不会修改或转义字符串，以这种方式接受从用户输出的内容并提供给语句中不变的字符串是不安全的，会导致潜在的 SQL 注入攻击，因此要么不允许用户输入这些字段，要么自行转义并检验。

1. 多参数传递

   MyBatis中的映射语句有一个parameterType属性来制定输入参数的类型。如果我们想给映射语句传入多个参数的话，我们可以将所有的输入参数放到HashMap中，将HashMap传递给映射语句。MyBatis 还提供了另外一种传递多个输入参数给映射语句的方法。假设我们想通过给定的name和email信息查找学生信息，定义查询接口如下：

   Public interface StudentMapper

   {

           List<Student> findAllStudentsByNameEmail(String name, String email);

   }

   MyBatis 支持将多个输入参数传递给映射语句，并以#{param}的语法形式引用它们：

   <select id="findAllStudentsByNameEmail" resultMap="StudentResult">

           select stud_id, name,email, phone from Students

                   where name=#{param1} and email=#{param2}

   </select>

   这里#{param1}引用第一个参数name，而#{param2}引用了第二个参数email

   还可以使用 @Param 注解来给参数命名，定义查询接口如下：

   Public interface StudentMapper

   {

           List<Student> findAllStudentsByNameEmail(@Param("name") String name, @Param("email") String email);

   }

   MyBatis 配置文件可以直接使用命名的参数，如下配置：

   <select id="findAllStudentsByNameEmail" resultMap="StudentResult">

           select stud_id, name,email, phone from Students

                   where name=#{name} and email=#{email}

   </select>

2. 存储过程和输入参数

   存储过程的调用必须设置 statementType="CALLABLE"，并且存储过程的调用语法为 { call proc_name} 如果有输出参数，则还需要设置参数的 mode，示例如下：

   1. 存储过程：

      CREATE DEFINER=`dev`@`%` PROCEDURE `procBuild_BillNo`(in prefix varchar(8),in serial varchar(10),out billNo varchar(20))

      BEGIN

          SET billNo = CONCAT(prefix,serial);

      END

   2. 方法定义：

      void BuildBillNo(HashMap<String,Object> map);

      注意：存储过程的输出参数，只能通过传入的 HashMap 来获取

   3. Mapper配置：

      <select id="BuildBillNo" parameterType="map" statementType="CALLABLE">

              {call procBuild_BillNo(#{prefix},#{serial},#{billNo,mode=OUT,jdbcType=VARCHAR})}

      </select>

      注意：存储过程调用，其 statementType 必须设置为 CALLABLE；存储过程/函数的返回结果需要使用 #{参数}=call procName(?,?...) 参数接收，并且需要指定对应的mode为 OUT 类型和 jdbcType 类型

   4. Java代码调用：

      HashMap<String, Object> map = new HashMap<String, Object>();

      map.put("prefix", "H");

      map.put("serial", "223232323");

      mapper.BuildBillNo(map);

      System.out.println("BuildBillNo is " + map.get("billNo"));

3. 自动映射

   当自动映射查询结果时，MyBatis会获取sql返回的列名并在java类中查找相同名字的属性（忽略大小写）。 这意味着如果Mybatis发现了ID列和id属性，Mybatis会将ID的值赋给id。 通常数据库列使用大写单词命名，单词间用下划线分隔；而java属性一般遵循驼峰命名法。 为了在这两种命名方式之间启用自动映射，需要将 mapUnderscoreToCamelCase设置为true。 自动映射甚至在特定的result map下也能工作。在这种情况下，对于每一个result map,所有的ResultSet提供的列， 如果没有被手工映射，则将被自动映射。自动映射处理完毕后手工映射才会被处理。

   通过配置 autoMappingBehavior 来设置自动映射等级，有三种自动映射等级：

• NONE - 禁用自动映射。仅设置手动映射属性。
• PARTIAL - 将自动映射结果除了那些有内部定义内嵌结果映射的(joins)（默认）
• FULL - 自动映射所有。

默认值是PARTIAL，这是有原因的。当使用FULL时，自动映射会在处理join结果时执行，并且join取得若干相同行的不同实体数据，因此这可能导致非预期的映射。