Mybatis学习笔记（三）

SQL映射的XML文件
MyBatis的构建就是聚焦于SQL的，使其远离于普通的方式。
SQL映射文件有很少的几个顶级元素（按照它们应该被定义的顺序）：
 cache - 配置给定命名空间的缓存。
 cache-ref – 从其他命名空间引用缓存配置。
 resultMap – 最复杂，也是最有力量的元素，用来描述如何从数据库结果集中来加载你的对象。
 parameterMap – 已经被废弃了！老式风格的参数映射。内联参数是首选，这个元素可能在将来被移除。这里不会记录。
 sql – 可以重用的SQL块，也可以被其他语句引用。
 insert – 映射插入语句
 update – 映射更新语句? delete – 映射删除语句
 select – 映射查询语句
下面将从语句本身开始来描述每个元素的细节。

select

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

 

[html] view plaincopy

1. <select id=”selectPerson” parameterType=”int” resultType=”hashmap”>  
2.     SELECT * FROM PERSON WHERE ID = #{id}  
3. </select>  

这个语句被称作selectPerson，使用一个int（或Integer）类型的参数，并返回一个HashMap类型的对象，其中的键是列名，值是列对应的值。
注意参数注释：
#{id}
这就告诉MyBatis创建一个PreparedStatement（预处理语句）参数。使用JDBC，这样的一个参数在SQL中会由一个“?”来标识，并被传递到一个新的预处理语句中。

 

 

属性	描述
id	在命名空间中唯一的标识符，可以被用来引用这条语句。
parameterType	将会传入这条语句的参数类的完全限定名或别名。
parameterMap	这是引用外部parameterMap的已经被废弃的方法。使用内联参数映射和parameterType属性。
resultType	从这条语句中返回的期望类型的类的完全限定名或别名。注意集合情形，那应该是集合可以包含的类型，而不能是集合本身。使用resultType或resultMap，但不能同时使用。
resultMap	命名引用外部的resultMap。返回map是MyBatis最具力量的特性，对其有一个很好的理解的话，许多复杂映射的情形就能被解决了。使用resultMap或resultType，但不能同时使用。
flushCache	将其设置为true，无论语句什么时候被调用，都会导致缓存被清空。默认值：false。
useCache	将其设置为true，将会导致本条语句的结果被缓存。默认值：true。
timeout	这个设置驱动程序等待数据库返回请求结果，并抛出异常时间的最大等待值。默认不设置（驱动自行处理）。
fetchSize	这是暗示驱动程序每次批量返回的结果行数。默认不设置（驱动自行处理）。
statementType	STATEMENT,PREPARED或CALLABLE的一种。这会让MyBatis使用选择使用Statement，PreparedStatement或CallableStatement。默认值：PREPARED。
resultSetType	FORWARD_ONLY|SCROLL_SENSITIVE|SCROLL_INSENSITIVE中的一种。默认是不设置（驱动自行处理）。

 

[html] view plaincopy

1. <select id="doSelectDemo"  
2.         fetchSize="256"  
3.         flushCache="false"  
4.         parameterType="parameterType"  
5.         resultMap="persistenceMap"      
6.         resultType="PersistenceType"  
7.         resultSetType="FORWARD_ONLY"  
8.         statementType="STATEMENT"  
9.         timeout="1000"  
10.         useCache="true"  
11.     >  
12.     SELECT COLUMNS FROM TABLE  
13. </select>  

insert，update，delete

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

 

属性	描述
id	在命名空间中唯一的标识符，可以被用来引用这条语句。
parameterType	将会传入这条语句的参数类的完全限定名或别名。
parameterMap	这是引用外部parameterMap的已经被废弃的方法。使用内联参数映射和parameterType属性。
flushCache	将其设置为true，不论语句什么时候被调用，都会导致缓存被清空。默认值：false。
timeout	这个设置驱动程序等待数据库返回请求结果，并抛出异常时间的最大等待值。默认不设置（驱动自行处理）。
statementType	STATEMENT,PREPARED或CALLABLE的一种。这会让MyBatis使用选择使用Statement，PreparedStatement或CallableStatement。默认值：PREPARED。
useGeneratedKeys	（仅对insert有用）这会告诉MyBatis使用JDBC的getGeneratedKeys方法来取出由数据（比如：像MySQL和SQL Server这样的数据库管理系统的自动递增字段）内部生成的主键。默认值：false。
keyProperty	（仅对insert有用）标记一个属性，MyBatis会通过getGeneratedKeys或者通过insert语句的selectKey子元素设置它的值。默认：不设置。

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

 

 

[html] view plaincopy

1. <insert id="insertAuthor" parameterType="domain.blog.Author">  
2.     insert into Author (id,username,password,email,bio)  
3.     values (#{id},#{username},#{password},#{email},#{bio})  
4. </insert>  
5. <update id="updateAuthor" parameterType="domain.blog.Author">  
6.     update Author set  
7.     username = #{username},  
8.     password = #{password},  
9.     email = #{email},  
10.     bio = #{bio}  
11.     where id = #{id}  
12. </update>  
13. <delete id="deleteAuthor” parameterType="int">  
14.     delete from Author where id = #{id}  
15. </delete>  

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

 

[html] view plaincopy

1. <insert id="insertAuthor" parameterType="domain.blog.Author"  
2.     useGeneratedKeys=”true” keyProperty=”id”>  
3.     insert into Author (username,password,email,bio)  
4.     values (#{username},#{password},#{email},#{bio})  
5. </insert>  

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

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

 

[html] view plaincopy

1. <insert id="insertAuthor" parameterType="domain.blog.Author">  
2.     <selectKey keyProperty="id" resultType="int" order="BEFORE">  
3.         select CAST(RANDOM()*1000000 as INTEGER) a from SYSIBM.SYSDUMMY1  
4.     </selectKey>  
5.     insert into Author  
6.         (id, username, password, email,bio, favourite_section)  
7.     values  
8.         (#{id}, #{username}, #{password}, #{email}, #{bio},#{favouriteSection,jdbcType=VARCHAR})  
9. </insert>  

注：select CAST(RANDOM()*1000000 as INTEGER) a from SYSIBM.SYSDUMMY1可以替换成序列的形式。

 

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

 

[html] view plaincopy

1. <selectKey  
2.     keyProperty="id"  
3.     resultType="int"  
4.     order="BEFORE"  
5.     statementType="PREPARED">  

属性	描述
keyProperty	selectKey语句结果应该被设置的目标属性。
resultType	结果的类型。MyBatis通常可以算出来，但是写上也没有问题。MyBatis允许任何简单类型用作主键的类型，包括字符串。
order	这可以被设置为BEFORE或AFTER。如果设置为BEFORE，那么它会首先选择主键，设置keyProperty然后执行插入语句。如果设置为AFTER，那么先执行插入语句，然后是selectKey元素-这和如Oracle数据库相似，可以在插入语句中嵌入序列调用。
statementType	和前面的相同，MyBatis支持STATEMENT，PREPARED和CALLABLE语句的映射类型，分别代表PreparedStatement和CallableStatement类型。

sql
这个元素可以被用来定义可重用的SQL代码段，可以包含在其他语句中。比如：

[html] view plaincopy

1. <sql id=”userColumns”> id,username,password </sql>  

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

[html] view plaincopy

1. <select id=”selectUsers” parameterType=”int” resultType=”hashmap”>  
2.     select <include refid=”userColumns”/>  
3.     from some_table  
4.     where id = #{id}  
5. </select>  

Parameters
以下代码：

[html] view plaincopy

1. <insert id=”insertUser” parameterType=”User” >  
2.     insert into users (id, username, password)  
3.     values (#{id}, #{username}, #{password})  
4. </insert>  

如果User类型的参数对象传递到了语句中，id、username和password属性将会被查找，然后它们的值就被传递到预处理语句的参数中。
这点对于传递参数到语句中非常好。但是对于参数映射也有一些其他的特性。
首先，像MyBatis的其他部分，参数可以指定一个确定的数据类型。

[html] view plaincopy

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

像MyBatis的剩余部分，javaType通常可以从参数对象中来确定，除非对象是一个HashMap。那么javaType应该被确定来保证使用正确类型处理器。
注意：如果null被当作值来传递，对于所有可能为空的列，JDBC Type是需要的。也可以通过阅读PreparedStatement. setNull()方法的JavaDocs文档来研究它。
为了以后自定义类型处理器，你可以指定一个确定的类型处理器类（或别名），比如：

[html] view plaincopy

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

尽管它看起来繁琐，但是实际上是你很少设置它们其中之一。
对于数值类型，对于决定有多少数字是相关的，有一个数值范围。

[html] view plaincopy

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

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

[html] view plaincopy

1. #{department,  
2.     mode=OUT,  
3.     jdbcType=CURSOR,  
4.     javaType=ResultSet,  
5.     resultMap=departmentResultMap}  

字符串替换
默认情况下，使用#{}格式的语法会导致MyBatis创建预处理语句属性并以它为背景设置安全的值（比如?）。这样做很安全，很迅速，也是首选的做法，有时你只是想直接在SQL语句中插入一个不改变的字符串。比如，像ORDER BY，你可以这样来使用：
ORDER BY ${columnName}
这里MyBatis不会修改或转义字符串。

重要：接受从用户输出的内容并提供给语句中不变的字符串，这样做是不安全的。这会导致潜在的SQL注入攻击，因此你不应该允许用户输入这些字段，或者通常自行转义并检查。

 

resultMap

resultMap元素是MyBatis中最重要最强大的元素。ResultMap的设计就是简单语句不需要明确的结果映射，而很多复杂语句确实需要描述它们的关系。
我们来看下面代码：

[java] view plaincopy

1. package com.someapp.model;  
2. public class User {  
3.     private int id;  
4.     private String username;  
5.     private String hashedPassword;  
6.     public int getId() {  
7.         return id;  
8.     }  
9.     public void setId(int id) {  
10.         this.id = id;  
11.     }  
12.     public String getUsername() {  
13.         return username;  
14.     }  
15.     public void setUsername(String username) {  
16.         this.username = username;  
17.     }  
18.     public String getHashedPassword() {  
19.         return hashedPassword;  
20.     }  
21.     public void setHashedPassword(String hashedPassword) {  
22.         this.hashedPassword = hashedPassword;  
23.     }  
24. }  

基于JavaBean的规范，上面这个类有3个属性：id，username和hashedPassword。这些在select语句中会精确匹配到列名。
这样的一个JavaBean可以被映射到结果集，就像映射到HashMap一样简单。

[html] view plaincopy

1. <select id=”selectUsers” parameterType=”int”  
2.     resultType=”com.someapp.model.User”>  
3.         select id, username, hashedPassword  
4.         from some_table  
5.         where id = #{id}  
6. </select>  

这些情况下，MyBatis会在幕后自动创建一个ResultMap，基于属性名来映射列到JavaBean的属性上。如果列名没有精确匹配，你可以在列名上使用select字句的别名（一个标准的SQL特性）来匹配标签。
ResultMap最优秀的地方你已经了解了很多了，但是你还没有真正的看到一个。只是出于示例的原因，让我们来看看最后一个示例中外部的resultMap是什么样子的，这也是解决列名不匹配的另外一种方式。

 

 

[html] view plaincopy

1. <resultMap id="userResultMap" type="User">  
2.     <id property="id" column="user_id" />  
3.     <result property="username" column="user_name"/>  
4.     <result property="password" column="hashed_password"/>  
5. </resultMap>  

引用它的语句使用resultMap属性就行了（注意我们去掉了resultType属性）。比如：

[html] view plaincopy

1. <select id=”selectUsers” parameterType=”int”  
2.     resultMap=”userResultMap”>  
3.         select user_id, user_name, hashed_password  
4.         from some_table  
5.         where id = #{id}  
6. </select>  

如果世界总是这么简单就好了。