五、SQL映射的XML文件

MyBatis真正的力量是在映射语句中。这里是奇迹发生的地方。对于所有的力量，SQL映射的XML文件是相当的简单。当然如果你将它们和对等功能的JDBC代码来比较，你会发现映射文件节省了大约95%的代码量。MyBatis的构建就是聚焦于SQL的，使其远离于普通的方式。

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

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

下一部分将从语句本身开始来描述每个元素的细节。

select

　　查询语句是使用MyBatis时最常用的元素之一。直到你从数据库取出数据时才会发现将数据存在数据库中是多么的有价值，所以许多应用程序查询要比更改数据多的多。对于每次插入，更新或删除，那也会有很多的查询。这是MyBatis的一个基本原则，也是将重心和努力放到查询和结果映射的原因。对简单类别的查询元素是非常简单的。比如：

<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元素有很多属性允许你配置，来决定每条语句的作用细节。 

<select
id=”selectPerson”
parameterType=”int”
parameterMap=”deprecated”
resultType=”hashmap”
resultMap=”personResultMap”
flushCache=”false”
useCache=”true”
timeout=”10000”
fetchSize=”256”
statementType=”PREPARED”
resultSetType=”FORWARD_ONLY”
>

insert，update，delete 

数据变更语句insert，update和delete在它们的实现中非常相似：

<insert 
    id="insertAuthor" 
    parameterType="domain.blog.Author" 
    flushCache="true" 
    statementType="PREPARED" 
    keyProperty="" 
    useGeneratedKeys="" 
    timeout="20000"> 
 
<update 
    id="insertAuthor" 
    parameterType="domain.blog.Author" 
    flushCache="true" 
    statementType="PREPARED" 
    timeout="20000"> 
 
<delete 
    id="insertAuthor" 
    parameterType="domain.blog.Author" 
    flushCache="true" 
    statementType="PREPARED" 
    timeout="20000">

下面就是insert，update和delete语句的示例： 

<insert i d="insertAuthor" parameterType="domain.bl og.Author">
    insert into Author (id,username,password,email,bio)
    values (#{id},#{username},#{password},#{email},#{bio})
</insert>
<update i d="updateAuthor " parameterType="domain.bl og.Author">
    update Author set
    username = #{username},
    password = #{password},
    email = #{email},
    bio = #{bio}
    where id = #{id}
</update>
<delete id="deleteAuthor” parameterType=" int ">
    delete from Author where id = #{id}
</delete>

　　如前所述，插入语句有一点多，它有一些属性和子元素用来处理主键的生成。
　　首先，如果你的数据库支持自动生成主键的字段（比如MySQL和SQL Server），那么你可以设置useGeneratedKeys=”true”，而且设置keyProperty到你已经做好的目标属性上。例如，如果上面的Author表已经对id 使用了自动生成的列类型，那么语句可以修改为：

<insert i d="insertAuthor" parame terType ="domain.bl og.Author" useGeneratedKeys=”true” keyProperty=”id”> 
    insert into Author (username,password,email,bio) 
    values (#{username},#{password},#{email},#{bio}) 
</insert>

MyBatis有另外一种方法来处理数据库不支持自动生成类型，或者可能JDBC驱动不支持自动生成主键时的主键生成问题。

这里有一个简单（甚至很傻）的示例，它可以生成一个随机ID（可能你不会这么做，但是这展示了MyBatis处理问题的灵活性，因为它并不真的关心ID的生成）：

<insert i d="insertAuthor" parame terType ="domain.bl og.Author">
<selectKe y keyPr operty="i d" resultType="int" or der="B EFORE">
　　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元素描述如下：
<selectKey
　　keyProperty="id"
　　resultType="int"
　　order="BEFORE"
　　statementType="PREPARED">

sql

这个元素可以被用来定义可重用的SQL代码段，可以包含在其他语句中。比如：
<sql id=”userColumns”> id,username,password </sql>
这个SQL片段可以被包含在其他语句中，例如：
<select id=”selectUsers” parameterType=”int” resultType=”hashmap”>
　　select <include refid=”userColumns”/>
　　from some_table
　　where id = #{id}
</select>

Parameters 

　　在之前的语句中，你已经看到了一些简单参数的示例。在MyBatis中参数是非常强大的元素。对于简单的做法，大概90%的情况，是不用太多的，比如：
<select id=”selectUsers” parameterType=”int” resultType=”User”>
　　select id, username, password
　　from users
　　where id = #{id}
</select>
　　上面的这个示例说明了一个非常简单的命名参数映射。参数类型被设置为“int”，因此这个参数可以被设置成任何内容。原生的类型或简单数据类型，比如整型和没有相关属性的字符串，因此它会完全用参数来替代。然而，如果你传递了一个复杂的对象，那么MyBatis的处理方式就会有一点不同。比如：
<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的剩余部分，javaType 通常可以从参数对象中来去顶，除非对象是一个HashMap。那么javaType 应该被确定来保证使用正确类型处理器。
　　注意：如果null被当作值来传递，对于所有可能为空的列，JDBC Type是需要的。以可以自己通过阅读预处理语句的setNull()方法的JavaDocs文档来研究这个。
　　为了自定义类型处理器，你可以指定一个确定的类型处理器类（或别名），比如：
#{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类型，它会自动地被设置为结果集。
#{department,
　　mode=OUT,
　　jdbcType=CURSOR,
　　javaType=ResultSet,
　　resultMap=departmentResultMap}
MyBatis也支持很多高级的数据类型，比如结构体，但是当注册out参数时你必须告诉语句类型名称。比如（再次提示，在实际中不要像这样换行）：
#{middleInitial,
　　mode=OUT,
　　jdbcType=STRUCT,
　　jdbcTypeName=MY_TYPE,
　　resultMap=departmentResultMap}
　　尽管所有这些强大的选项很多时候你只简单指定属性名，MyBatis会自己计算剩余的。
　　最多的情况是你为jdbcType 指定可能为空的列名。
#{firstName}
#{middleInitial,jdbcType=VARCHAR}
#{lastName}
　　字符串替换
　　默认情况下，使用#{}格式的语法会导致MyBatis创建预处理语句属性并以它为背景设置安全的值（比如?）。这样做很安全，很迅速也是首选做法，有时你只是想直接在SQL语句中插入一个不改变的字符串。比如，像ORDER BY，你可以这样来使用：
ORDER BY ${columnName}
　　这里MyBatis不会修改或转义字符串。
　　重要：接受从用户输出的内容并提供给语句中不变的字符串，这样做是不安全的。这会导致潜在的SQL注入攻击，因此你不应该允许用户输入这些字段，或者通常自行转义并检查。

resultMap

resultMap 元素是MyBatis中最重要最强大的元素。它就是让你远离90%的需要从结果集中取出数据的JDBC代码的那个东西，而且在一些情形下允许你做一些JDBC不支持的事情。事实上，编写相似于对复杂语句联合映射这些等同的代码，也许可以跨过上千行的代码。ResultMap的设计就是简单语句不需要明确的结果映射，而很多复杂语句确实需要描述它们的关系。 你已经看到简单映射语句的示例了，但没有明确的resultMap。比如：
<select id=”selectUsers” parameterType=”int” resultType=”hashmap”>
　　select id, username, hashedPassword
　　from some_table
　　where id = #{id}
</select>
这样一个语句简单作用于所有列被自动映射到HashMap的键上，这由resultType 属性指定。这在很多情况下是有用的，但是HashMap不能很好描述一个领域模型。那样你的应用程序将会使用JavaBeans或POJOs（Plain Old Java Objects，普通Java对象）来作为领域模型。MyBatis对两者都支持。看看下面这个JavaBean：

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

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

这样的一个JavaBean可以被映射到结果集，就像映射到HashMap一样简单。
<select id=”selectUsers” parameterType=”int”
　　resultType=”com.some app.model.User”>
　　select id, username, hashedPassword
　　from some_table
　　where id = #{id}
</select>
要记住类型别名是你的伙伴。使用它们你可以不用输入类的全路径。比如：
<!-- In Config XML file -->
<typeAlias type=”com.some app.model.User” alias=”User”/>
<!-- In SQL Mapping XML file -->
<select id=”selectUsers” parameterType=”int” resultType=”User”>
　　select id, username, hashedPassword
　　from some_table
　　where id = #{id}
</select>
这些情况下，MyBatis会在幕后自动创建一个ResultMap，基于属性名来映射列到JavaBean的属性上。如果列名没有精确匹配，你可以在列名上使用select字句的别名（一个基本的SQL特性）来匹配标签。比如：
<select id=”selectUsers” parameterType=”int” resultType=”User”>
　　select
　　user_id as “id”,
　　user_name as “userName”,
　　hashed_password as “hashedPassword”
　　from some_table
　　where id = #{id}
</select>

ResultMap最优秀的地方你已经了解了很多了，但是你还没有真正的看到一个。这些简单的示例不需要比你看到的更多东西。只是出于示例的原因，让我们来看看最后一个示例中外部的resultMap 是什么样子的，这也是解决列名不匹配的另外一种方式。
<resultMap id="userResultMap" type="User">
　　<id property="id" column="user_id" />
　　<result property="username" column="username"/>
　　<result property="password" column="password"/>
</resultMap>
引用它的语句使用resultMap 属性就行了（注意我们去掉了resultType属性）。比如：
<select id=”selectUsers” parameterType=”int” resultMap=”userResultMap”>
　　select user_id, user_name, hashed_password
　　from some_table
　　where id = #{id}
</select>
如果世界总是这么简单就好了。