mybatis分享

Mybatis入门

一、Mybatis环境搭建及简单实例

pom.xml

mybatis-config.xml

 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE configuration
   PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
   "http://mybatis.org/dtd/mybatis-3-config.dtd">
 <configuration>

   <!-- 指定properties配置文件， 我这里面配置的是数据库相关 -->
   <properties resource="dbConfig.properties"></properties>

   <environments default="development">
     <environment id="development">
       <transactionManager type="JDBC"/>
       <dataSource type="POOLED">
           <!--
           如果上面没有指定数据库配置的properties文件，那么此处可以这样直接配置
         <property name="driver" value="com.mysql.jdbc.Driver"/>
         <property name="url" value="jdbc:mysql://localhost:3306/test1"/>
         <property name="username" value="root"/>
         <property name="password" value="root"/>
          -->

          <!-- 上面指定了数据库配置文件， 配置文件里面也是对应的这四个属性 -->
          <property name="driver" value="${driver}"/>
          <property name="url" value="${url}"/>
          <property name="username" value="${username}"/>
          <property name="password" value="${password}"/>

       </dataSource>
     </environment>
   </environments>

   <!-- 映射文件，mybatis精髓， 后面才会细讲 -->
   <mappers>
     <mapper resource="com/dy/dao/userDao-mapping.xml"/>
   </mappers>

 </configuration>

1. configuration节点为根节点。

2. 在configuration节点之下，我们可以配置10个子节点， 分别为：properties、typeAliases、plugins、objectFactory、objectWrapperFactory、settings、environments、databaseIdProvider、typeHandlers、mappers。

实体类——User

properties的使用方法

envirements元素节点的使用方法

environments元素节点可以配置多个environment子节点， 怎么理解呢？

　　假如我们系统的开发环境和正式环境所用的数据库不一样（这是肯定的）， 那么可以设置两个environment, 两个id分别对应开发环境（dev）和正式环境（final），那么通过配置environments的default属性就能选择对应的environment了， 例如，我将environments的deault属性的值配置为dev, 那么就会选择dev的environment。

typeAliases

typeHandler

Mybatis中的TypeHandler是什么？

　　无论是 MyBatis 在预处理语句（PreparedStatement）中设置一个参数时，还是从结果集中取出一个值时，都会用类型处理器将获取的值以合适的方式转换成 Java 类型。Mybatis默认为我们实现了许多TypeHandler, 当我们没有配置指定TypeHandler时，Mybatis会根据参数或者返回结果的不同，默认为我们选择合适的TypeHandler处理。

配置typeHandler

 <configuration>
     <typeHandlers>
       <!--
           当配置package的时候，mybatis会去配置的package扫描TypeHandler
           <package name="com.dy.demo"/>
        -->

       <!-- handler属性直接配置我们要指定的TypeHandler -->
       <typeHandler handler=""/>

       <!-- javaType 配置java类型，例如String, 如果配上javaType, 那么指定的typeHandler就只作用于指定的类型 -->
       <typeHandler javaType="" handler=""/>

       <!-- jdbcType 配置数据库基本数据类型，例如varchar, 如果配上jdbcType, 那么指定的typeHandler就只作用于指定的类型  -->
       <typeHandler jdbcType="" handler=""/>

       <!-- 也可两者都配置 -->
       <typeHandler javaType="" jdbcType="" handler=""/>

   </typeHandlers>

   ......

 </configuration>

objectFactory是干什么的？ 需要配置吗？

　　MyBatis 每次创建结果对象的新实例时，它都会使用一个对象工厂（ObjectFactory）实例来完成。默认的对象工厂需要做的仅仅是实例化目标类，要么通过默认构造方法，要么在参数映射存在的时候通过参数构造方法来实例化。默认情况下，我们不需要配置，mybatis会调用默认实现的objectFactory。 除非我们要自定义ObjectFactory的实现， 那么我们才需要去手动配置。

plugin有何作用？ 需要配置吗？

　　plugins 是一个可选配置。mybatis中的plugin其实就是个interceptor， 它可以拦截Executor 、ParameterHandler 、ResultSetHandler 、StatementHandler 的部分方法，处理我们自己的逻辑。Executor就是真正执行sql语句的东西， ParameterHandler 是处理我们传入参数的，还记得前面讲TypeHandler的时候提到过，mybatis默认帮我们实现了不少的typeHandler, 当我们不显示配置typeHandler的时候，mybatis会根据参数类型自动选择合适的typeHandler执行，其实就是ParameterHandler 在选择。ResultSetHandler 就是处理返回结果的。

mappers作用 ? 需要配置吗？

　　mappers 节点下，配置我们的mapper映射文件， 所谓的mapper映射文件，就是让mybatis 用来建立数据表和javabean映射的一个桥梁。在我们实际开发中，通常一个mapper文件对应一个dao接口， 这个mapper可以看做是dao的实现。所以,mappers必须配置。

mapper映射文件配置之insert、update、delete

 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE mapper
 PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"
 "http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd"> 

 <!-- mapper 为根元素节点， 一个namespace对应一个dao -->
 <mapper namespace="com.dy.dao.UserDao">

     <insert
       <!-- 1. id （必须配置）
         id是命名空间中的唯一标识符，可被用来代表这条语句。
         一个命名空间（namespace） 对应一个dao接口,
         这个id也应该对应dao里面的某个方法（相当于方法的实现），因此id 应该与方法名一致 -->

       id="insertUser"

       <!-- 2. parameterType （可选配置, 默认为mybatis自动选择处理）
         将要传入语句的参数的完全限定类名或别名， 如果不配置，mybatis会通过ParameterHandler 根据参数类型默认选择合适的typeHandler进行处理
         parameterType 主要指定参数类型，可以是int, short, long, string等类型，也可以是复杂类型（如对象） -->

       parameterType="com.demo.User"

       <!-- 3. flushCache （可选配置，默认配置为true）
         将其设置为 true，任何时候只要语句被调用，都会导致本地缓存和二级缓存都会被清空，默认值：true（对应插入、更新和删除语句） -->

       flushCache="true"

       <!-- 4. statementType （可选配置，默认配置为PREPARED）
         STATEMENT，PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement，默认值：PREPARED。 -->

       statementType="PREPARED"

       <!-- 5. keyProperty (可选配置， 默认为unset)
         （仅对 insert 和 update 有用）唯一标记一个属性，MyBatis 会通过 getGeneratedKeys 的返回值或者通过 insert 语句的 selectKey 子元素设置它的键值，默认：unset。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。 -->

       keyProperty=""

       <!-- 6. keyColumn     (可选配置)
         （仅对 insert 和 update 有用）通过生成的键值设置表中的列名，这个设置仅在某些数据库（像 PostgreSQL）是必须的，当主键列不是表中的第一列的时候需要设置。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。 -->

       keyColumn=""

       <!-- 7. useGeneratedKeys (可选配置， 默认为false)
         （仅对 insert 和 update 有用）这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键（比如：像 MySQL 和 SQL Server 这样的关系数据库管理系统的自动递增字段），默认值：false。  -->

       useGeneratedKeys="false"

       <!-- 8. timeout  (可选配置， 默认为unset, 依赖驱动)
         这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为 unset（依赖驱动）。 -->
       timeout="20">

     <update
       id="updateUser"
       parameterType="com.demo.User"
       flushCache="true"
       statementType="PREPARED"
       timeout="20">

     <delete
       id="deleteUser"
       parameterType="com.demo.User"
       flushCache="true"
       statementType="PREPARED"
       timeout="20">
 </mapper>

如果我们在使用mysql的时候，想在数据插入后返回插入的id, 我们也可以使用 selectKey 这个元素：

 <!-- 对应userDao中的insertUser方法，  -->
    <insert id="insertUser" parameterType="com.dy.entity.User">
            <!-- oracle等不支持id自增长的，可根据其id生成策略，先获取id 

         <selectKey resultType="int" order="BEFORE" keyProperty="id">
               select seq_user_id.nextval as id from dual
         </selectKey>

         --> 

         <!-- mysql插入数据后，获取id -->
         <selectKey keyProperty="id" resultType="int" order="AFTER" >
                SELECT LAST_INSERT_ID() as id
            </selectKey>

            insert into user(id, name, password, age, deleteFlag)
                values(#{id}, #{name}, #{password}, #{age}, #{deleteFlag})
    </insert>

mapper映射文件配置之select、resultMap

select配置

 <select
         <!--  1. id （必须配置）
         id是命名空间中的唯一标识符，可被用来代表这条语句。
         一个命名空间（namespace） 对应一个dao接口,
         这个id也应该对应dao里面的某个方法（相当于方法的实现），因此id 应该与方法名一致  -->

      id="selectPerson"

      <!-- 2. parameterType （可选配置, 默认为mybatis自动选择处理）
         将要传入语句的参数的完全限定类名或别名， 如果不配置，mybatis会通过ParameterHandler 根据参数类型默认选择合适的typeHandler进行处理
         parameterType 主要指定参数类型，可以是int, short, long, string等类型，也可以是复杂类型（如对象） -->
      parameterType="int"

      <!-- 3. resultType (resultType 与 resultMap 二选一配置)
          resultType用以指定返回类型，指定的类型可以是基本类型，可以是java容器，也可以是javabean -->
      resultType="hashmap"

      <!-- 4. resultMap (resultType 与 resultMap 二选一配置)
          resultMap用于引用我们通过 resultMap标签定义的映射类型，这也是mybatis组件高级复杂映射的关键 -->
      resultMap="personResultMap"

      <!-- 5. flushCache (可选配置)
          将其设置为 true，任何时候只要语句被调用，都会导致本地缓存和二级缓存都会被清空，默认值：false -->
      flushCache="false"

      <!-- 6. useCache (可选配置)
          将其设置为 true，将会导致本条语句的结果被二级缓存，默认值：对 select 元素为 true -->
      useCache="true"

      <!-- 7. timeout (可选配置)
          这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为 unset（依赖驱动）-->
      timeout="10000"

      <!-- 8. fetchSize (可选配置)
          这是尝试影响驱动程序每次批量返回的结果行数和这个设置值相等。默认值为 unset（依赖驱动)-->
      fetchSize="256"

      <!-- 9. statementType (可选配置)
          STATEMENT，PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement，默认值：PREPARED-->
      statementType="PREPARED"

      <!-- 10. resultSetType (可选配置)
          FORWARD_ONLY，SCROLL_SENSITIVE 或 SCROLL_INSENSITIVE 中的一个，默认值为 unset （依赖驱动）-->
      resultSetType="FORWARD_ONLY">

resultMap配置

 <!--
         1.type 对应类型，可以是javabean, 也可以是其它
         2.id 必须唯一， 用于标示这个resultMap的唯一性，在使用resultMap的时候，就是通过id指定
      -->
     <resultMap type="" id="">

         <!-- id, 唯一性，注意啦，这个id用于标示这个javabean对象的唯一性， 不一定会是数据库的主键（不要把它理解为数据库对应表的主键）
             property属性对应javabean的属性名，column对应数据库表的列名
             （这样，当javabean的属性与数据库对应表的列名不一致的时候，就能通过指定这个保持正常映射了）
         -->
         <id property="" column=""/>

         <!-- result与id相比， 对应普通属性 -->
         <result property="" column=""/>

         <!--
             constructor对应javabean中的构造方法
          -->
         <constructor>
             <!-- idArg 对应构造方法中的id参数 -->
             <idArg column=""/>
             <!-- arg 对应构造方法中的普通参数 -->
             <arg column=""/>
         </constructor>

         <!--
             collection，对应javabean中容器类型, 是实现一对多的关键
             property 为javabean中容器对应字段名
             column 为体现在数据库中列名
             ofType 就是指定javabean中容器指定的类型
         -->
         <collection property="" column="" ofType=""></collection>

         <!--
             association 为关联关系，是实现N对一的关键。
             property 为javabean中容器对应字段名
             column 为体现在数据库中列名
             javaType 指定关联的类型
          -->
         <association property="" column="" javaType=""></association>
     </resultMap>

强大的动态SQL

那么，问题来了： 什么是动态SQL? 动态SQL有什么作用？

　　传统的使用JDBC的方法，相信大家在组合复杂的的SQL语句的时候，需要去拼接，稍不注意哪怕少了个空格，都会导致错误。Mybatis的动态SQL功能正是为了解决这种问题， 其通过 if, choose, when, otherwise, trim, where, set, foreach标签，可组合成非常灵活的SQL语句，从而提高开发人员的效率。

if

 <select id="findUserById" resultType="user">
            select * from user where
            <if test="id != null">
                id=#{id}
            </if>
             and deleteFlag=0;
 </select>

有问题？

where

 <select id="findUserById" resultType="user">
            select * from user
            <where>
                <if test="id != null">
                    id=#{id}
                </if>
                and deleteFlag=0;
            </where>
  </select>

从表面上来看，就是多了个where标签而已， 不过实质上， mybatis是对它做了处理，当它遇到AND或者OR这些，它知道怎么处理。其实我们可以通过 trim 标签去自定义这种处理规则。

trim

上面的where标签，其实可以用trim表示：

<trim prefix="WHERE" prefixOverrides="AND |OR ">
  ...
</trim>

set

 <update id="updateUser" parameterType="com.dy.entity.User">
            update user set
            <if test="name != null">
                name = #{name},
            </if>
            <if test="password != null">
                password = #{password},
            </if>
            <if test="age != null">
                age = #{age}
            </if>
            <where>
                <if test="id != null">
                    id = #{id}
                </if>
                and deleteFlag = 0;
            </where>
 </update>

 <update id="updateUser" parameterType="com.dy.entity.User">
            update user
         <set>
           <if test="name != null">name = #{name},</if>
              <if test="password != null">password = #{password},</if>
              <if test="age != null">age = #{age},</if>
         </set>
            <where>
                <if test="id != null">
                    id = #{id}
                </if>
                and deleteFlag = 0;
            </where>
 </update>

这个用trim 可表示为：

<trim prefix="SET" suffixOverrides=",">
  ...
</trim>

foreach

 <select id="selectPostIn" resultType="domain.blog.Post">
   SELECT *
   FROM POST P
   WHERE ID in
   <foreach item="item" index="index" collection="list"
       open="(" separator="," close=")">
         #{item}
   </foreach>
 </select>

choose

<select id="findActiveBlogLike"
     resultType="Blog">
  SELECT * FROM BLOG WHERE state = ‘ACTIVE’
  <choose>
    <when test="title != null">
      AND title like #{title}
    </when>
    <when test="author != null and author.name != null">
      AND author_name like #{author.name}
    </when>
    <otherwise>
      AND featured = 1
    </otherwise>
  </choose>
</select>

SqlSessionFactory与sqlsession

从表面上来看，咱们都是通过SqlSession去执行sql语句。那么咱们就先看看是怎么获取SqlSession的吧：

 SqlSessionFactory sessionFactory = null;
 String resource = "mybatis-conf.xml";
 try {
      //SqlSessionFactoryBuilder读取配置文件
     sessionFactory = new SqlSessionFactoryBuilder().build(Resources
               .getResourceAsReader(resource));
 } catch (IOException e) {
     e.printStackTrace();
 }
 //通过SqlSessionFactory获取SqlSession
 SqlSession sqlSession = sessionFactory.openSession();

SqlSession咱们也拿到了，咱们可以调用SqlSession中一系列的select...,  insert..., update..., delete...方法轻松自如的进行CRUD操作了。 就这样？ 那咱配置的映射文件去哪儿了？  别急， 咱们接着往下看：

2. 利器之MapperProxy:

在mybatis中，通过MapperProxy动态代理咱们的dao， 也就是说， 当咱们执行自己写的dao里面的方法的时候，其实是对应的mapperProxy在代理。