图解Mybatis框架原理及使用

1、前言

努力学习完ssm框架之后，终于也成功的把三大框架的使用以及配置文件细节忘得一干二净。为了努力捡起来以及方便今后的复习，决定写一篇博客记录一下。

• 本博客的所有分析都是在持久层接口以及接口中的方法已经创建的基础上进行的。
• 本博客对于Mybatis中标签的细节属性不做过多探讨，主要着重于Mybatis框架的底层原理和大体使用步骤。
• 本博客着重于以Mybatis的xml配置方式为主，作源码分析。
• 本博客中的所有图片均为原创，如需原图，请联系作者。

2、 mybatis简介

持久层框架Mybatis，该框架涉及Java与数据库的交互，有一下几个特点：

（1）采用了高大上的ORM(Object-Relation Mapper) 思想，其作用也就是将关系型数据库(mysql,oracle等)中的表与Java中的类作一个映射，从而使得在需要操作数据库时，可以直接操作java中的对象完成操作。

• 实际使用时的体现：将Java中的类名与数据库表中的列名保持一致
• 优点：解耦，操作简便
• 缺点：影响性能(使用缓存技术解决)，复杂查询困难。

（2）使用了构建者模式以及工厂模式。构建者模式了解不多，而工厂模式则在创建对象和设置缓存时起到了极为重要的作用。

（3）使用动态代理创建持久层对象，得利于该方法，在使用mybatis框架进行持久层操作时，不需要实现定义好的java接口，只需在配置文件中使用合适标签完成需要的sql语句操作即可。

（4）与原始的JDBC相比，使用Mybatis能让我们的注意力放在SQL语句的编写上，而屏蔽了注册驱动，建立连接和获取执行SQL语句的statement对象等一系列操作。(虽然这些操作都反映在了配置文件中，但是我们还是假装看不到吧…)

3、 Mybatis配置文件

Mybatis通常都是有一个主配置文件和多个映射配置文件。主配置文件定义在项目中的resources包下，主配置文件中有各个映射配置文件的路径，而每个映射配置文件就对应Dao层中定义好的接口，映射配置文件的位置也要和dao的文件位置保持一致，具体见下图：

3.1、主配置文件

首先，我们需要知道主配置文件的主要功能是什么，从我的现阶段的学习来说，主配置文件的功能主要有以下四个方面：

• 配置数据库连接
• 映射其他配置文件位置
• 起别名简化操作
• 设置缓存

那么，如何实现这些功能，此处先将主配置文件的内容展示如下：

<configuration>
    <!--引入外部数据库连接池的配置文件jdbcConfig.properties-->
    <properties resource="jdbcConfig.properties"/>

     <!--开始配置环境-->
    <environments default="mysql">
        <!--配置mysql的环境-->
        <environment id="mysql">
            <!--配置事务-->
            <transactionManager type="JDBC"/>

     		 <!--配置数据库连接池-->
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>

        </environment>
    </environments>
    <!--配置映射文件的位置-->
    <mappers>
        <package name="com.zjl.dao"></package>
        <mapper resource="com/zjl/dao/UserDao.xml"/>
        <mapper class="com.zjl.dao.UserDao"/>
    </mappers>
</configuration>

第一步，从数据库的连接开始，对代码中的数据库配置的图解分析如下：



第二步，确定映射配置文件的位置，这一阶段的开启标签是mapper，对于代码的图解分析如下：



在映射文件路径的配置中，我们可以直接通过package标签进行别名的配置，故而就不再论述。

对于提及的缓存配置，因为所牵涉的细节过多，且在不进行配置的情况下，其默认设置可以符合我们大多数场景的需求，在此处就不再过多论述，之后可能会另写一篇博客记录一下标签的详细使用细节。

3.2、映射配置文件

在主配置文件创建完成的情况下，我们应该依照主配置文件中指定的映射配置文件路径创建映射配置文件，并根据对应的dao层中接口的方法编写好映射配置文件，而映射配置文件的功能即：

• 使用标签编写sql语句，从而对dao层中接口的方法进行实现

要实现该功能，我们需要知道想要通过一个映射文件实现一个接口中定义好的方法，所必备的因素有哪些？列举如下：

• 接口及方法名
• 方法输出参数类型
• 方法返回参数类型
• 方法实现的功能

有了以上的大致分析，再列举出一个映射文件书写的例子进行分析：

首先，我们dao接口UserDao中定义的方法如下：

<mapper namespace="com.zjl.dao.UserDao">

    <!--添加用户-->
    <insert id="saveUser" parameterType="com.zjl.domain.User">
        <!--配置插入操作后，获取插入用户的id-->
        <!--keyProperty对应与实体类中属性的名称-->
        <selectKey keyProperty="id" keyColumn="id" resultType="int" order="AFTER">
            select last_insert_id();
        </selectKey>
        insert into user(username,address,sex,birthday)values(#{username},#{address},#{sex},#{birthday});
    </insert>

    <!--更新用户-->
    <update id="updateUser" parameterType="com.zjl.domain.User">
        update user set username=#{username},address=#{address},sex=#{sex},birthday=#{birthday} where id=#{id};
    </update>

    <!--删除用户-->
    <delete id="deleteUser" parameterType="Integer">
        delete from user where id=#{uid};
    </delete>

    <!--查询一个用户-->
    <select id="findById" parameterType="INT" resultType="com.zjl.domain.User">
        select * from user where id=#{uid};
    </select>

    <!--根据姓名查询(模糊查询)用户-->
    <select id="findByName" resultType="com.zjl.domain.User" parameterType="String">
        select * from user where username like #{name};
    </select>
</mapper>

对于配置文件对应以上接口的联合图解分析如下：

在完成了主配置文件和映射配置文件的编写之后，实际上我们已经能够根据这两种配置文件的内容去连接数据库，并且对接口中的方法进行实现从而完成dao层的操作了，而mybatis框架正是封装了从配置文件实现dao层操作，所需要的各种方法和对象。

4、 Mybatis实现原理

从我们之前的经验可以知道，实现dao层的操作，获取可以对数据库进行操作Connection连接对象以及PrepareStatement执行sql语句的对象是最重要的，在主配置文件中，我们已经配置了数据库连接的信息，那么Mybatis是如何通过xml文件中的信息完成数据库连接呢？我们先对数据库连接做分析，首先mybatis使用时的代码如下：

public class mybatisTest {
    private UserDao userDao;
    private InputStream in;
    private SqlSessionFactoryBuilder builder;
    private SqlSessionFactory factory;
    private SqlSession sqlSession;

    public void init() throws IOException {
        //读取配置文件，生成字节码文件
        in = Resources.getResourceAsStream("SqlMapConfig.xml");
        //使用构建者模式，创建SqlSessionfactory工厂
        builder = new SqlSessionFactoryBuilder();
        factory = builder.build(in);
        //使用工厂模式，创建sqlSession
        sqlSession = factory.openSession();
        //使用sqlsession中的方法获取UserDao的代理对象，相当于对UserDao接口进行实现
        userDao = sqlSession.getMapper(UserDao.class);
    }

对于以上的代码，分步做以下图解：





在通过SqlSession.getMapper()方法获得接口的实现类之后，即可使用接口实现类直接调用方法即可。

5、 Mybatis小结

想要深入Mybatis的原理细节，有几个重要的对象需要去熟悉：

• Configuration：虽然并未直接在代码中出现，但其却贯穿Mybatis框架始终；
• SqlSession：Mybatis的核心对象；
• Executor：执行sql语句的执行器；
• MapperRegister：动态代理的开端，SqlSession.getMapper()方法的后端实现。

框架的学习往往繁杂易忘，希望自己有足够的耐心去阅读源码，深入分析。