MyBatis Mapper XML 文件 01

阅读更多

         前面说了 MyBatis 的配置文件，现在我们来说说 Mapper XML 文件，前面所说的都是基本配置而已，这里才是 MyBatis 真正的核心。在这个配置文件中，其实只有几个顶级元素，按顺序分别是：

         • cache ：配置给定命名空间的缓存。

• cache-ref ：从其他命名空间引用缓存配置。

• resultMap ：最复杂 , 也是最有力量的元素 , 用来描述如何从数据库结果集中来加 载你的对象。

• parameterMap ：已经被废弃了 ! 老式风格的参数映射。内联参数是首选 , 这个元 素可能在将来被移除。这里不会记录。

• sql ：可以重用的 SQL 块 , 也可以被其他语句引用。

• insert ：映射插入语句

• update ：映射更新语句

• delete ：映射删除语句

• select ：映射查询语句

 

select 、 insert 、 update 、 delete

         查询语句是 MyBatis 中最常用的元素之一。例如

  
  SELECT * FROM PERSON WHERE ID = #{id}

 

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

String selectPerson = "SELECT * FROM PERSON WHERE ID=?";
PreparedStatement ps = conn.prepareStatement(selectPerson);
ps.setInt(1,id);

 

从这里我们可以看出 MyBatis 与 JDBC 的区别点了，在相对灵活的情况下，比 JDBC 节省了很多的代码量。

下面我们来说说 select 、 update 、 insert 、 delete 中的属性。

  
  




 
 
 
 
 
 
  
 
   
 
    
 
属性  
 
 
    
 
描述  
 
 
   
 
   
 
    
 
id 
 
 
    
 
在命名空间中唯一的标识符, 可以被用来引用这条语句。  
 
 
   
 
   
 
    
 
parameterType 
 
 
    
 
将会传入这条语句的参数类的完全限定名或别名。  
 
 
   
 
   
 
    
 
parameterMap 
 
 
    
 
这是引用外部 parameterMap  的已经被废弃的方法。使用内联参数 映射和 parameterType  属性。  
 
 
   
 
   
 
    
 
resultType 
 
 
    
 
从这条语句中返回的期望类型的类的完全限定名或别名。注意集 合情形, 那应该是集合可以包含的类型, 而不能是集合本身。使 用 resultType  或 resultMap, 但不能同时使用。  
 
 
   
 
   
 
    
 
resultMap 
 
 
    
 
命名引用外部的 resultMap 。 返回 map  是 MyBatis  最具力量的特性, 对其有一个很好的理解的话, 许多复杂映射的情形就能被解决了。 使用 resultMap  或 resultType, 但不能同时使用。  
 
 
   
 
   
 
    
 
flushCache 
 
 
    
 
将其设置为 true, 不论语句什么时候被带哦用, 都会导致缓存被 清空。默认值:false 。  
 
 
   
 
   
 
    
 
useCache 
 
 
    
 
将其设置为 true, 将会导致本条语句的结果被缓存。 默认值:true 。  
 
 
   
 
   
 
    
 
timeout 
 
 
    
 
这个设置驱动程序等待数据库返回请求结果, 并抛出异常时间的 最大等待值。默认不设置( 驱动自行处理)   
 
 
   
 
   
 
    
 
fetchSize 
 
 
    
 
这是暗示驱动程序每次批量返回的结果行数。默认不设置( 驱动 自行处理) 。  
 
 
   
 
   
 
    
 
statementType 
 
 
    
 
STA TEMENT,PREPARED  或 CALLABLE  的一种。 这会让 MyBatis 使用选择使用 Statement,PreparedStatement  或 CallableStatement 。 默认值:PREPARED 。  
 
 
   
 
   
 
    
 
resultSetType 
 
 
    
 
FORWARD_ONLY|SCROLL_SENSITIVE|SCROLL_INSENSITIVE 中的一种。默认是不设置( 驱动自行处理) 。 
 
 
   
 
   
 
    
 
useGeneratedKeys 
 
 
    
 
(  仅 对 insert  有 用 )  这 会 告 诉 MyBatis  使 用 JDBC  的getGeneratedKeys  方法来取出由数据( 比如: 像 MySQL  和 SQL Server  这样的数据库管理系统的自动递增字段) 内部生成的主键。 默认值:false 。  
 
 
   
 
   
 
    
 
keyProperty 
 
 
    
 
( 仅对 insert  有用) 标记一个属性,MyBatis  会通过 getGeneratedKeys 或者通过 insert  语句的 selectKey  子元素设置它的值。 默认: 不设置。  
 
 
   
 
   
 
    
 
keyColumn 
 
 
    
 
( 仅对 insert  有用) 标记一个属性,MyBatis  会通过 getGeneratedKeys 或者通过 insert  语句的 selectKey  子元素设置它的值。 默认: 不设置。 
 
 
   
 
  
 
 
 
 
下面我们来看看 insert,update  和  delete  语句的 Demo 
 
 

  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}
 
 
 
 
 
这里需要对 insert 语句多说点， insert 元素有一些属性和子元素用来处理主键的生成。 
 
 
首先 , 如果你的数据库支持自动生成主键的字段 ( 比如  MySQL  和  SQL Server) , 那么   你可以设置  useGeneratedKeys= ” true ” , 而且设置  keyProperty  到你已经做好的目标属性上。   例如 , 如果上面的  Author  表已经对  id  使用了自动生成的列类型 , 那么语句可以修改为 : 
 
 

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

 
 
 
 
 
官方文档中还提到一种方法来处理数据库不支持自动生成类型 , 或者可能  JDBC  驱动不支   持自动生成主键时的主键生成问题。即，随机生成 ID 
 
 

  
    select CAST(RANDOM()*1000000 as INTEGER) a from SYSIBM.SYSDUMMY1
  
  insert into Author
    (id, username, password, email,bio, favourite_section)
  values
    (#{id}, #{username}, #{password}, #{email}, #{bio}, #{favouriteSection,jdbcType=VARCHAR})

 
 
 
 
 
这里涉及一个 selectkey 元素，在上面的三个 xml 中， selectkey 将会首先运行 , 实体类的 id 会被优先设置 , 然后再执行插入语句。 selectKey  元素描述如下 : 
 
 

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

    
      SELECT LAST_INSERT_ID()
    
    insert into tbl_student (name, birth, score)
    values (#{name,jdbcType=VARCHAR}, #{birth,jdbcType=DATE}, #{score,jdbcType=REAL})
  
 
 
 
 
 
不同的数据库，获取方式有点区别，因为有的数据库是在插入之前生成 id （ Oracle ），有的是插入之后（ MySQL 、 MSSQL ），还有就是具体的方式也不太一样， MySQL 使用“ SELECT LAST_INSERT_ID() ”， MSSQL 使用“ SELECT SCOPE_IDENTITY() ” 
 
 
“ SELECT @@IDENTITY AS ID ”对于 MySQL 和 MSSQL 都可以，但是网上说该方法不安全，不是很理解，没去深究了。 Oracle 使用“ SELECT STOCKIDSEQUENCE.NEXTVAL AS ID FROM DUAL ”，这个如果使用 generator 自动生成的话会自动根据不同的数据库生成。（不过我这里搞死也没搞出来，返回的都是 1 ，不知道 why ？） 
 
 
  
 
 
sql  
 
 
 这个元素可以被用来定义可重用的 SQL 代码段，这样就可以包含在其他语句中。 
 
 
 id,username,password 
 	
	
	  select 
	  from some_table
	  where id = #{id}
	

 

 

Parameters

	  select id, username, password
	  from users
	  where id = #{id}
	

 

上面的这个示例说明了一个非常简单的命名参数映射。参数类型被设置为“ int ” , 因此 这个参数可以被设置成任何内容。 原生的类型或简单数据类型 , 比如整型和没有相关属性的 字符串 , 因此它会完全用参数来替代。然而 , 如果你传递了一个复杂的对象 , 那么 MyBatis 的处理方式就会有一点不同。比如 :

	
	  insert into users (id, username, password)
	  values (#{id}, #{username}, #{password})
	

 

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

这点对于传递参数到语句中非常好。但是对于参数映射也有一些其他的特性。

首先 , 像 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 语句中插入一个不改变的字符串。比如说模糊查询时 name like '%${username }%' （ ORDER BY ${columnName} ） , 这里 MyBatis 不会修改或转义字符串。但是我们使用这个时候需要注意对 username 进行相关验证和转义，因为这里会存在潜在的 SQL 注入攻击。

 

Result Maps

这个主要是由 resultType 和 resultMap 来指定。

先看看 resultType 的方式

		select id, name, birth, score
		from tbl_student
		where id = #{id}
	

 

这样返回的 hashmap 值为： {id=8, birth=2012-12-12, name=xwang04, score=99.5}

但是这个个人感觉不是很友好，看上去比较混乱，没有对象来的方便。下面我们来看看 JavaBean 的

package com.iflytek.dao.model;

import java.text.MessageFormat;
import java.util.Date;

public class Student {
	private Integer id;

	private String name;

	private Date birth;

	private Float score;

	public Integer getId() {
		return id;
	}

	public void setId(Integer id) {
		this.id = id;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name == null ? null : name.trim();
	}

	public Date getBirth() {
		return birth;
	}

	public void setBirth(Date birth) {
		this.birth = birth;
	}

	public Float getScore() {
		return score;
	}

	public void setScore(Float score) {
		this.score = score;
	}

	@Override
	public String toString() {
		return MessageFormat.format("id：{0},姓名：{1},出生日期:{2},分数：{3}", id, name, birth, score);
	}
}

 上面的JavaBean中有四个属性，这些在select语句中会精确匹配到列名

		select id, name, birth, score
		from tbl_student
		where id = #{id}
	

 

当然上面的 resultType 中的类的全名可以通过在 mybatis-config.xml 中配置 typeAlias 来进行缩写。

MyBatis 会在幕后自动创建一个 ResultMap ，基于属性名来映射列到 JavaBean 的属性上。如果列名没有精确匹配 , 你可以在列名上使用 select 字句的别名 (SQL 语句特性 ) 来匹配标签。

  select
    user_id             as "id",
    user_name           as "userName",
    hashed_password     as "hashedPassword"
  from some_table
  where id = #{id}

 Ok，再来看看resultMap的方式

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