Mybatis Mapper文件配置

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

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

Select

最基本的查询语句，能够配置一些属性来决定每个细节，相关属性以下：

属性	描述
id	在命名空间中惟一的标识符，能够被用来引用这条语句。
parameterType	将会传入这条语句的参数类的彻底限定名或别名。这个属性是可选的，由于 MyBatis 能够经过 TypeHandler 推断出具体传入语句的参数，默认值为 unset。
parameterMap	这是引用外部 parameterMap 的已经被废弃的方法。使用内联参数映射和 parameterType 属性。
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	这个设置仅对多结果集的状况适用，它将列出语句执行后返回的结果集并每一个结果集给一个名称，名称是逗号分隔的。

insert、update、delete

插入、更新和删除语句，相关属性以下：

属性	描述
id	命名空间中的惟一标识符，可被用来表明这条语句。
parameterType	将要传入语句的参数的彻底限定类名或别名。这个属性是可选的，由于 MyBatis 能够经过 TypeHandler 推断出具体传入语句的参数，默认值为 unset。
parameterMap	这是引用外部 parameterMap 的已经被废弃的方法。使用内联参数映射和 parameterType 属性。
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 的语句；若是带或者不带的语句都有，则不带的会被忽略。

sql

这个元素能够被用来定义可重用的 SQL 代码段，能够包含在其余语句中。它能够被静态地(在加载参数) 参数化. 不一样的属性值经过包含的实例变化。例如：

<sql id="table"> tbl_sales_activities </sql>

<sql id="Base_Column_List" >
    ID, VERSION, CREATE_TIME, UPDATE_TIME, ADTYPE, MARKET_CHANNEL, AD_MASTER, AD_MATERIAL_ID,
</sql>

<sql id="condition_sql">
    <if test="activityId != null and activityId != ''"> and ACTIVITY_ID = #{activityId}</if>
    <if test="activityName != null and activityName != ''"> and ACTIVITY_NAME  LIKE CONCAT('%' ,CONCAT(#{activityName},'%')) </if>
    <if test="adtype != null and adtype != ''"> and ADTYPE = #{adtype}</if>
</sql>

如上三个sql声明，能够在其余sql语句中直接引用

  <select id="listPage" parameterType="java.util.Map" resultMap="BaseResultMap">
    select <include refid="Base_Column_List" /> from
    <include refid="table" />
    <where>
      <include refid="condition_sql" />
    </where>
  </select>

 Result Maps

 ResultMap 的设计思想是，简单的语句不须要明确的结果映射，而复杂一点的语句只须要描述它们的关系就好了。

　　- constructor - 用于在实例化类时，注入结果到构造方法中

• idArg - ID 参数;标记出做为 ID 的结果能够帮助提升总体性能
• arg - 将被注入到构造方法的一个普通结果

　　- id – 一个 ID 结果;标记出做为 ID 的结果能够帮助提升总体性能

　　- result – 注入到字段或 JavaBean 属性的普通结果

　　- association – 一个复杂类型的关联；许多结果将包装成这种类型 

　　嵌套结果映射 – 关联能够指定为一个 resultMap 元素，或者引用一个
- collection – 一个复杂类型的集合
　　嵌套结果映射 – 集合能够指定为一个 resultMap 元素，或者引用一个
- discriminator – 使用结果值来决定使用哪一个 resultMap
　　case – 基于某些值的结果映射：一个 case 也是一个映射它自己的结果,所以能够包含不少相 同的元素，或者它能够参照一个外部的 resultMap。

<!--  Result Map -->
<resultMap id="detailedBlogResultMap" type="Blog">
  <constructor>
    <idArg column="blog_id" javaType="int"/>
  </constructor>
  <result property="title" column="blog_title"/>
  <association property="author" javaType="Author">
    <id property="id" column="author_id"/>
    <result property="username" column="author_username"/>
    <result property="password" column="author_password"/>
    <result property="email" column="author_email"/>
    <result property="bio" column="author_bio"/>
    <result property="favouriteSection" column="author_favourite_section"/>
  </association>
  <collection property="posts" ofType="Post">
    <id property="id" column="post_id"/>
    <result property="subject" column="post_subject"/>
    <association property="author" javaType="Author"/>
    <collection property="comments" ofType="Comment">
      <id property="id" column="comment_id"/>
    </collection>
    <collection property="tags" ofType="Tag" >
      <id property="id" column="tag_id"/>
    </collection>
    <discriminator javaType="int" column="draft">
      <case value="1" resultType="DraftPost"/>
    </discriminator>
  </collection>
</resultMap>

缓存

　　Mybatis 使用到了两种缓存：本地缓存（local cache）和二级缓存（second level cache）。
　　本地缓存：每当一个新 session 被建立，MyBatis 就会建立一个与之相关联的本地缓存。任何在 session 执行过的查询语句自己都会被保存在本地缓存中，那么，相同的查询语句和相同的参数所产生的更改就不会二度影响数据库了。本地缓存会被增删改、提交事务、关闭事务以及关闭 session 所清空。

　　二级缓存：默认状况下是没有开启二级缓存,能够加强变现并且处理循环 依赖也是必须的。要开启二级缓存,你须要在你的 SQL 映射文件中添加一行: 

<cache/>

实现的效果以下：

• 映射语句文件中的全部 select 语句将会被缓存。
• 映射语句文件中的全部 insert,update 和 delete 语句会刷新缓存。
• 缓存会使用 Least Recently Used(LRU,最近最少使用的)算法来收回。
• 根据时间表(好比 no Flush Interval,没有刷新间隔), 缓存不会以任什么时候间顺序 来刷新。
• 缓存会存储列表集合或对象(不管查询方法返回什么)的 1024 个引用。
• 缓存会被视为是 read/write(可读/可写)的缓存,意味着对象检索不是共享的,而 且能够安全地被调用者修改,而不干扰其余调用者或线程所作的潜在修改

也能够经过改变其中的参数来达到不一样的缓存效果。

<cache
  eviction="FIFO"
  flushInterval="60000"
  size="512"
  readOnly="true"/>

自定义缓存

也能够经过实现其余缓存或第三方缓存方案，建立适配器来彻底覆盖缓存行为。若是自定义缓存实现则必须实现 org.mybatis.cache.Cache接口。

public interface Cache {
  String getId();
  int getSize();
  void putObject(Object key, Object value);
  Object getObject(Object key);
  boolean hasKey(Object key);
  Object removeObject(Object key);
  void clear();
}

以下MybatiesRedisCache类实现了cache接口，在对应的Mapper定义文件中，首先经过标签<cache>将MybatiesRedisCache引入，而后针对各类操做 select、insert、upate和delete经过标签flushCache和useCache两个标签来配置数据库操做利用缓存状况。

<cache type="com.gw.common.core.mybatis.cache.redis.MybatiesRedisCache" />
...
<select ... flushCache="false" useCache="true"/>
<insert ... flushCache="true"/>
<update ... flushCache="true"/>
<delete ... flushCache="true"/>