【深入淺出MyBatis系列一】MyBatis入門
陶邦仁](https://my.oschina.net/xianggao) 發(fā)布于 2015/12/22 10:37
0 系列目錄#
- 深入淺出MyBatis系列
- 【深入淺出MyBatis系列一】MyBatis入門
- 【深入淺出MyBatis系列二】配置簡介（MyBatis源碼篇）
- 【深入淺出MyBatis系列三】Mapper映射文件配置
- 【深入淺出MyBatis系列四】強大的動態(tài)SQL
- 【深入淺出MyBatis系列五】SQL執(zhí)行流程分析（源碼篇）
- 【深入淺出MyBatis系列六】插件原理
- 【深入淺出MyBatis系列七】分頁插件
- 【深入淺出MyBatis系列八】SQL自動生成插件
- 【深入淺出MyBatis系列九】改造Cache插件
- 【深入淺出MyBatis系列十】與Spring集成
- 【深入淺出MyBatis系列十一】緩存源碼分析
- 【深入淺出MyBatis系列十二】終結(jié)篇：MyBatis原理深入解析
MyBatis 是一個可以自定義SQL、存儲過程和高級映射的持久層框架。MyBatis 摒除了大部分的JDBC代碼过蹂、手工設(shè)置參數(shù)和結(jié)果集重獲乡括。MyBatis 只使用簡單的XML 和注解來配置和映射基本數(shù)據(jù)類型企软、Map 接口和POJO 到數(shù)據(jù)庫記錄评也。相對Hibernate和Apache OJB等“一站式”O(jiān)RM解決方案而言攒磨，Mybatis 是一種“半自動化”的ORM實現(xiàn)逐样。
ORM工具的基本思想蜗字，無論是用過的hibernate,mybatis,你都可以法相他們有一個共同點：
- 從配置文件(通常是XML配置文件中)得到 sessionfactory。
- 由sessionfactory 產(chǎn)生 session脂新。
- 在session 中完成對數(shù)據(jù)的增刪改查和事務(wù)提交等挪捕。
- 在用完之后關(guān)閉session。
- 在java 對象和 數(shù)據(jù)庫之間有做mapping的配置文件争便，也通常是xml文件盲赊。
1 Mybatis的功能架構(gòu)
1.1 功能架構(gòu)分為三層
-
API接口層：提供給外部使用的接口API夺艰，開發(fā)人員通過這些本地API來操縱數(shù)據(jù)庫。接口層一接收到調(diào)用請求就會調(diào)用數(shù)據(jù)處理層來完成具體的數(shù)據(jù)處理。 -
數(shù)據(jù)處理層：負責(zé)具體的SQL查找棠赛、SQL解析高职、SQL執(zhí)行和執(zhí)行結(jié)果映射處理等或粮。它主要的目的是根據(jù)調(diào)用的請求完成一次數(shù)據(jù)庫操作器虾。 -
基礎(chǔ)支撐層：負責(zé)最基礎(chǔ)的功能支撐，包括連接管理浇垦、事務(wù)管理炕置、配置加載和緩存處理，這些都是共用的東西男韧，將他們抽取出來作為最基礎(chǔ)的組件朴摊。為上層的數(shù)據(jù)處理層提供最基礎(chǔ)的支撐。
而下面是MyBatis源碼包對應(yīng)的架構(gòu)圖：
1.2 快速入門
- SqlSessionFactoryBuilder
每一個MyBatis的應(yīng)用程序的入口是SqlSessionFactoryBuilder此虑，它的作用是通過XML配置文件創(chuàng)建Configuration對象（當(dāng)然也可以在程序中自行創(chuàng)建）甚纲，然后通過build方法創(chuàng)建SqlSessionFactory對象。沒有必要每次訪問Mybatis就創(chuàng)建一次SqlSessionFactoryBuilder朦前，通常的做法是創(chuàng)建一個全局的對象就可以了介杆。示例程序如下：
private static SqlSessionFactoryBuilder sqlSessionFactoryBuilder;
private static SqlSessionFactory sqlSessionFactory;
private static void init() throws IOException {
String resource = "mybatis-config.xml";
Reader reader = Resources.getResourceAsReader(resource);
sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
sqlSessionFactory = sqlSessionFactoryBuilder.build(reader);
}
- ** SqlSessionFactory**
SqlSessionFactory對象由SqlSessionFactoryBuilder創(chuàng)建鹃操。它的主要功能是創(chuàng)建SqlSession對象，和SqlSessionFactoryBuilder對象一樣春哨，沒有必要每次訪問Mybatis就創(chuàng)建一次SqlSessionFactory荆隘，通常的做法是創(chuàng)建一個全局的對象就可以了。SqlSessionFactory對象一個必要的屬性是Configuration對象,它是保存Mybatis全局配置的一個配置對象赴背，通常由SqlSessionFactoryBuilder從XML配置文件創(chuàng)建椰拒。這里給出一個簡單的示例：
<?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>
<!-- 配置別名 -->
<typeAliases>
<typeAlias type="org.iMybatis.abc.dao.UserDao" alias="UserDao" />
<typeAlias type="org.iMybatis.abc.dto.UserDto" alias="UserDto" />
</typeAliases>
<!-- 配置環(huán)境變量 -->
<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://127.0.0.1:3306/iMybatis?characterEncoding=GBK" />
<property name="username" value="iMybatis" />
<property name="password" value="iMybatis" />
</dataSource>
</environment>
</environments>
<!-- 配置mappers -->
<mappers>
<mapper resource="org/iMybatis/abc/dao/UserDao.xml" />
</mappers>
</configuration>
- SqlSession
SqlSession對象的主要功能是完成一次數(shù)據(jù)庫的訪問和結(jié)果的映射，它類似于數(shù)據(jù)庫的session概念凰荚，由于不是線程安全的燃观，所以SqlSession對象的作用域需限制方法內(nèi)。SqlSession的默認實現(xiàn)類是DefaultSqlSession便瑟，它有兩個必須配置的屬性：Configuration和Executor缆毁。Configuration前文已經(jīng)描述這里不再多說。SqlSession對數(shù)據(jù)庫的操作都是通過Executor來完成的胳徽。
SqlSession有一個重要的方法getMapper积锅，顧名思義，這個方式是用來獲取Mapper對象的养盗。什么是Mapper對象？根據(jù)Mybatis的官方手冊适篙，應(yīng)用程序除了要初始并啟動Mybatis之外往核，還需要定義一些接口，接口里定義訪問數(shù)據(jù)庫的方法嚷节，存放接口的包路徑下需要放置同名的XML配置文件聂儒。SqlSession的getMapper方法是聯(lián)系應(yīng)用程序和Mybatis紐帶，應(yīng)用程序訪問getMapper時硫痰，Mybatis會根據(jù)傳入的接口類型和對應(yīng)的XML配置文件生成一個代理對象衩婚，這個代理對象就叫Mapper對象。應(yīng)用程序獲得Mapper對象后效斑，就應(yīng)該通過這個Mapper對象來訪問Mybatis的SqlSession對象非春，這樣就達到里插入到Mybatis流程的目的。
SqlSession session= sqlSessionFactory.openSession();
UserDao userDao = session.getMapper(UserDao.class);
UserDto user = new UserDto();
user.setUsername("iMybatis");
List<UserDto> users = userDao.queryUsers(user);
public interface UserDao {
public List<UserDto> queryUsers(UserDto user) throws Exception;
}
<?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="org.iMybatis.abc.dao.UserDao">
<select id="queryUsers" parameterType="UserDto" resultType="UserDto"
useCache="false">
<![CDATA[
select * from t_user t where t.username = #{username}
]]>
</select>
</mapper>
- Executor
Executor對象在創(chuàng)建Configuration對象的時候創(chuàng)建缓屠，并且緩存在Configuration對象里奇昙。Executor對象的主要功能是調(diào)用StatementHandler訪問數(shù)據(jù)庫，并將查詢結(jié)果存入緩存中（如果配置了緩存的話）敌完。
- StatementHandler
StatementHandler是真正訪問數(shù)據(jù)庫的地方储耐，并調(diào)用ResultSetHandler處理查詢結(jié)果。
- ResultSetHandler
處理查詢結(jié)果滨溉。
2 Mybatis環(huán)境搭建及簡單實例# ##2.1 Maven依賴##
<dependencies>
<!-- 添加junit -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency>
<!-- 添加log4j -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.16</version>
</dependency>
<!-- 添加mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.2.6</version>
</dependency>
<!-- 添加mysql驅(qū)動 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.12</version>
</dependency>
</dependencies>
2.2 配置Log4j, 配置MyBatis## 在classpath建立一個用于配置log4j的配置文件log4j.properties, 再建立一個用于配置Mybatis的配置文件configuration.xml（文件可隨便命名）什湘。log4j的配置长赞，我就不多說，這兒主要說一下configuration.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配置文件闽撤， 我這里面配置的是數(shù)據(jù)庫相關(guān) -->
<properties resource="dbConfig.properties"></properties>
<!-- 指定Mybatis使用log4j -->
<settings>
<setting name="logImpl" value="LOG4J"/>
</settings>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<!--
如果上面沒有指定數(shù)據(jù)庫配置的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"/>
-->
<!-- 上面指定了數(shù)據(jù)庫配置文件， 配置文件里面也是對應(yīng)的這四個屬性 -->
<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>
2.3 創(chuàng)建一張User表##
- 在mysql數(shù)據(jù)庫test1建立一張表user：
- 看看項目的代碼結(jié)構(gòu)：
2.4 編寫代碼##
- 先編寫一個實體類User: User類用于與User表相對應(yīng)：User.java
package com.dy.entity;
public class User {
private int id;
private String name;
private String password;
private int age;
private int deleteFlag;
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 String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
public int getDeleteFlag() {
return deleteFlag;
}
public void setDeleteFlag(int deleteFlag) {
this.deleteFlag = deleteFlag;
}
}
- 再編寫一個UserDao 接口：UserDao.java
package com.dy.dao;
import java.util.List;
import com.dy.entity.User;
public interface UserDao {
public void insert(User user);
public User findUserById (int userId);
public List<User> findAllUsers();
}
- 再編寫一個userDao-mapping.xml （可隨便命名）:
<?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="com.dy.dao.UserDao">
<select id="findUserById" resultType="com.dy.entity.User" >
select * from user where id = #{id}
</select>
</mapper>
userDao-mapping.xml相當(dāng)于是UserDao的實現(xiàn)， 同時也將User實體類與數(shù)據(jù)表User成功關(guān)聯(lián)起來热幔。
- 編寫junit測試代碼UserDaoTest：
public class UserDaoTest {
@Test
public void findUserById() {
SqlSession sqlSession = getSessionFactory().openSession();
UserDao userMapper = sqlSession.getMapper(UserDao.class);
User user = userMapper.findUserById(2);
Assert.assertNotNull("沒找到數(shù)據(jù)", user);
}
//Mybatis 通過SqlSessionFactory獲取SqlSession, 然后才能通過SqlSession與數(shù)據(jù)庫進行交互
private static SqlSessionFactory getSessionFactory() {
SqlSessionFactory sessionFactory = null;
String resource = "configuration.xml";
try {
sessionFactory = new SqlSessionFactoryBuilder().build(Resources.getResourceAsReader(resource));
} catch (IOException e) {
e.printStackTrace();
}
return sessionFactory;
}
}
查看SqlSessionFactory.java開啟事務(wù)：MyBatis對事務(wù)的處理相對簡單乐设，TransactionIsolationLevel中定義了幾種隔離級別，并不支持內(nèi)嵌事務(wù)這樣較復(fù)雜的場景绎巨，同時由于其是持久層的緣故近尚，所以真正在應(yīng)用開發(fā)中會委托Spring來處理事務(wù)實現(xiàn)真正的與開發(fā)者隔離。分析事務(wù)的實現(xiàn)是個入口场勤，借此可以了解不少JDBC規(guī)范方面的事情戈锻。
public interface SqlSessionFactory {
SqlSession openSession(); // 事務(wù)默認自動提交
SqlSession openSession(boolean autoCommit); // 可傳入 事務(wù)是否自動提交
SqlSession openSession(Connection connection); // 可傳入 數(shù)據(jù)庫連接
SqlSession openSession(TransactionIsolationLevel level); // 可傳入 事務(wù)隔離級別
SqlSession openSession(ExecutorType execType);
SqlSession openSession(ExecutorType execType, boolean autoCommit);
SqlSession openSession(ExecutorType execType, TransactionIsolationLevel level);
SqlSession openSession(ExecutorType execType, Connection connection);
Configuration getConfiguration();
}
