Mybatis的原理、搭建与使用

前几天搭建了一个mybatis的Demo, 刚好整理出来。

我们先来简单看一下Mybatis的原理。

1、Mybatis的简单介绍

MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis 。2013年11月迁移到Github。是一个基于Java的持久层框架。iBATIS提供的持久层框架包括SQL Maps和Data Access Objects（DAO）。

MyBatis 是支持普通 SQL查询，存储过程和高级映射的优秀持久层框架。MyBatis 消除了几乎所有的JDBC代码和参数的手工设置以及结果集的检索。MyBatis 使用简单的 XML或注解用于配置和原始映射，将接口和 Java 的POJOs（Plain Old Java Objects，普通的 Java对象）映射成数据库中的记录。

每个MyBatis应用程序主要都是使用SqlSessionFactory实例的，一个SqlSessionFactory实例可以通过SqlSessionFactoryBuilder获得。SqlSessionFactoryBuilder可以从一个xml配置文件或者一个预定义的配置类的实例获得。

用xml文件构建SqlSessionFactory实例是非常简单的事情。推荐在这个配置中使用类路径资源（classpath resource)，但你可以使用任何Reader实例，包括用文件路径或file://开头的url创建的实例。MyBatis有一个实用类—-Resources，它有很多方法，可以方便地从类路径及其它位置加载资源。

2、Mybatis的工作流程

(1)加载配置并初始化

触发条件：加载配置文件

将SQL的配置信息加载成为一个个MappedStatement对象（包括了传入参数映射配置、执行的SQL语句、结果映射配置），存储在内存中。

(2)接收调用请求

触发条件：调用Mybatis提供的API

传入参数：为SQL的ID和传入参数对象

处理过程：将请求传递给下层的请求处理层进行处理。

(3)处理操作请求 触发条件：API接口层传递请求过来

传入参数：为SQL的ID和传入参数对象

处理过程：

(A)根据SQL的ID查找对应的MappedStatement对象。

(B)根据传入参数对象解析MappedStatement对象，得到最终要执行的SQL和执行传入参数。

(C)获取数据库连接，根据得到的最终SQL语句和执行传入参数到数据库执行，并得到执行结果。

(D)根据MappedStatement对象中的结果映射配置对得到的执行结果进行转换处理，并得到最终的处理结果。

(E)释放连接资源。

(4)返回处理结果将最终的处理结果返回。

3.工作原理详解

功能架构：



我们把Mybatis的功能架构分为三层：

(1)API接口层：提供给外部使用的接口API，开发人员通过这些本地API来操纵数据库。接口层一接收到调用请求就会调用数据处理层来完成具体的数据处理。

(2)数据处理层：负责具体的SQL查找、SQL解析、SQL执行和执行结果映射处理等。它主要的目的是根据调用的请求完成一次数据库操作。

(3)基础支撑层：负责最基础的功能支撑，包括连接管理、事务管理、配置加载和缓存处理，这些都是共用的东西，将他们抽取出来作为最基础的组件。为上层的数据处理层提供最基础的支撑。

框架架构：



框架架构讲解：

(1)加载配置：配置来源于两个地方，一处是配置文件，一处是Java代码的注解，将SQL的配置信息加载成为一个MappedStatement对象（包括了传入参数映射配置、执行的SQL语句、结果映射配置），存储在内存中。

(2)SQL解析：当API接口层接收到调用请求时，会接收到传入SQL的ID和传入对象（可以是Map、JavaBean或者基本数据类型），Mybatis会根据SQL的ID找到对应的MappedStatement，然后根据传入参数对象对MappedStatement进行解析，解析后可以得到最终要执行的SQL语句和参数。

（3）SQL执行：将最终得到的SQL和参数拿到数据库进行执行，得到操作数据库的结果。

(4)结果映射：将操作数据库的结果按照映射的配置进行转换，可以转换成HashMap、JavaBean或者基本数据类型，并将最终结果返回。

4、Demo

下面我们上干货，并结合这个Demo来简单分析一下原理。

(1)我们先看一下Demo的工程结构



稍微解释一下，conf.xml是配置文件，UserMapper.xml是写sql语句的地方，Users.java是一个封装的数据库用户对象， test1.java是一个测试类。

(2)代码在这里

conf.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>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC" />
<!-- 配置数据库信息 -->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver" />
<property name="url" value="jdbc:mysql://localhost:3306/mybatis" />
<property name="username" value="root" />
<property name="password" value="admin" />
</dataSource>
</environment>
</environments>
<mappers>
<!-- 注册userMapper.xml文件，userMapper.xml位于com.soft.mappring这个包下，所以resource写成 com/soft/mapping/uesrMapper.xml -->
<mapper resource="com/soft/mapping/UserMapper.xml" />
</mappers>
</configuration>

UserMapper.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!-- 为这个mapper指定一个唯一的namespace， namespace的值习惯上设置成包名+sql映射文件名，这样能够保证namespace的值是唯一的
例如namespace="com.soft.mapping.userMapping" 就是com.soft.mapping(包名)+userMapper(userMapper.xml文件去掉后缀)
-->
<mapper namespace="com.soft.mapping.UserMapper">
<!-- 在select标签中编写查询的SQL语句，设置select标签的id属性为getUser, id属性值必须是唯一的，不能够重复
使用paramterType 属性指明操作的类型，resultType属性指明查询返回的结果集类型
resultType="com.soft.domain.Users" 就表示将查询结果封装成一个Users类的对象返回
Users类就是users表对应的实体类 -->

<!-- 查询语句样例 -->
<select id="select1" parameterType="int" resultType="com.soft.domain.Users">
select * from Users where id = 1
</select>
</mapper>

Users.java

package com.soft.domain;
/*
* users表对应的实体类
*
* */
public class Users {

//实体类的属性和表的字段一一对应
private int id;
private String name;
private int age;

public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
};

@Override
public String toString(){
return "User [id= "+ id +",age= "+age+",name= "+ name +"]";
};

}

test1.java

package com.mybatis.test;

import java.io.IOException;
import java.io.InputStream;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import com.soft.domain.Users;

public class test1 {
public static void main(String []args) throws IOException{
//mybatis的配置文件
String resource = "conf.xml";
//使用类加载器加载mybatis的配置文件(它也加载关联的映射文件)
InputStream is = test1.class.getResourceAsStream("conf.xml");
//System.out.println(test1.class.getClassLoader());

//构建sqlSession的工厂
SqlSessionFactory sessionFactory = new SqlSessionFactoryBuilder().build(is);
//使用Mybatis提供的Resources类加载mybatis的配置文件（它在加载关联的映射文件）
//Reader reader = Resources.getResourceAsReader(resource);
//构建sqlSession的工厂
//SqlSessionFactory sessionFactory = new SqlSessionFactoryBuilder().build(reader);
//创建能执行映射文件中sql的sqlSession
SqlSession session = sessionFactory.openSession();
/*
* 映射sql的标示字符串
* com.soft.mapping.UserMapper是userMapper.xml文件中mapper标签的namespace属性的值
* select1是select标签的id属性值，通过select标签的id属性值就可以找到要执行的sql
* */
//映射sql的标识字符串
String statement = "com.soft.mapping.UserMapper.select1";
//执行查询返回唯一一个user对象的sql
Users user = session.selectOne(statement, 1);
System.out.println(user);
}
}

结合原理和流程大致的讲解一下。Users.java中封装了一个User类，这个类中的属性是和数据库中的这个对象一致的。



conf.xml中配置了数据库信息，并指定了我们书写SQL语句的地方是UserMapper.xml。test1.java中加载配置文件，生成statement, 然后调用我们在xml中映射的sql语句块儿，最后将查询的结果打印出来，完成了一个完整的流程。

5.Demo运行效果