Mybatis之mapper XML 文件

Mybatis之mapper XML 文件

原文链接：http://www.mybatis.org/mybatis-3/zh/sqlmap-xml.html

一、mapper XML 文件

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

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

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

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

1.1、select

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

  SELECT * FROM PERSON WHERE ID = #{id}

    这个语句被称作 selectPerson，接受一个 int（或 Integer）类型的参数，并返回一个 HashMap 类型的对象，其中的键是列名，值便是结果行中的对应值
select 元素有很多属性允许你配置，来决定每条语句的作用细节。

 
   
  
 
  
 
  
1.2、insert，update 和 delete
 
  
数据变更语句 insert，update 和 delete 的实现非常接近：
 
  
 
  




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

  insert into Author (id,username,password,email,bio)
  values (#{id},#{username},#{password},#{email},#{bio})



  update Author set
    username = #{username},
    password = #{password},
    email = #{email},
    bio = #{bio}
  where id = #{id}



  delete from Author where id = #{id}
 
  
 
  
   如前所述，插入语句的配置规则更加丰富，在插入语句里面有一些额外的属性和子元素用来处理主键的生成，而且有多种生成方式。
 
  
   首先，如果你的数据库支持自动生成主键的字段（比如 MySQL 和 SQL Server），那么你可以设置 useGeneratedKeys=”true”，然后再把 keyProperty 设置到目标属性上就OK了。例如，如果上面的 Author 表已经对 id 使用了自动生成的列类型，那么语句可以修改为:
 
  

  insert into Author (username,password,email,bio)
  values (#{username},#{password},#{email},#{bio})
 
  如果你的数据库还支持多行插入, 你也可以传入一个Authors数组或集合，并返回自动生成的主键 
  
 
  

  insert into Author (username, password, email, bio) values
  
    (#{item.username}, #{item.password}, #{item.email}, #{item.bio})
  
 
  
1.3、SQL
 
  
   这个元素可以被用来定义可重用的 SQL 代码段，可以包含在其他语句中。它可以被静态地(在加载参数) 参数化. 不同的属性值通过包含的实例变化. 比如：
 
  
 
  
 ${alias}.id,${alias}.username,${alias}.password 
这个 SQL 片段可以被包含在其他语句中，例如： 
  
 
  

  select
    ,
    
  from some_table t1
    cross join some_table t2

属性值可以用于包含的refid属性或者包含的字句里面的属性值，例如：

  ${prefix}Table



  from
    



  select
    field1, field2, field3
  
    
    
  

1.4、ResultMap

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

解决列名不匹配的一种方式：

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

  select user_id, user_name, hashed_password
  from some_table
  where id = #{id}

高级结果映射

resultMap

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

关联

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

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

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

resultMap 属性的结果映射不同。

  



  SELECT * FROM BLOG WHERE ID = #{id}



  SELECT * FROM AUTHOR WHERE ID = #{id}
 
  
 
  
我们有两个查询语句:一个来加载博客,另外一个来加载作者,而且博客的结果映射描述了“selectAuthor”语句应该被用来加载它的 author 属性。 
 
  
其他所有的属性将会被自动加载,假设它们的列和属性名相匹配。 
 
  
集合（一对多映射）
 
  

  
  
  
 
  
集合元素的作用几乎和关联是相同的。实际上,它们也很相似,文档的异同是多余的。所以我们更多关注于它们的不同。 
 
  
我们来继续上面的示例,一个博客只有一个作者。但是博客有很多文章。在博客类中,这可以由下面这样的写法来表示: 
 
  
private List posts;
 
  要映射嵌套结果集合到 List 中,我们使用集合元素。就像关联元素一样,我们可以从连接中使用嵌套查询,或者嵌套结果。
 
  
集合的嵌套查询
 
  首先,让我们看看使用嵌套查询来为博客加载文章 
  
 
  

  



  SELECT * FROM BLOG WHERE ID = #{id}



  SELECT * FROM POST WHERE BLOG_ID = #{id}

这里你应该注意很多东西,但大部分代码和上面的关联元素是非常相似的。首先,你应该注意我们使用的是集合元素。然后要注意那个新的“ofType”属性。这个属性用来区分JavaBean(或字段)属性类型和集合包含的类型来说是很重要的。所以你可以读出下面这个映射:

读作: “在 Post 类型的 ArrayList 中的 posts 的集合。”

javaType 属性是不需要的,因为 MyBatis 在很多情况下会为你算出来。所以你可以缩短写法:

集合的嵌套结果

  select
  B.id as blog_id,
  B.title as blog_title,
  B.author_id as blog_author_id,
  P.id as post_id,
  P.subject as post_subject,
  P.body as post_body,
  from Blog B
  left outer join Post P on B.id = P.blog_id
  where B.id = #{id}

在用文章映射集合映射博客,可以简单写为:

同样,要记得 id 元素的重要性,如果你不记得了,请阅读上面的关联部分。

同样,如果你引用更长的形式允许你的结果映射的更多重用,你可以使用下面这个替代的映射: