【深入淺出MyBatis系列一】MyBatis入門

【深入淺出MyBatis系列一】MyBatis入門

陶邦仁](https://my.oschina.net/xianggao) 發(fā)布于 2015/12/22 10:37

原文鏈接

0 系列目錄#

MyBatis 是一個(gè)可以自定義SQL、存儲(chǔ)過程和高級(jí)映射的持久層框架。MyBatis 摒除了大部分的JDBC代碼、手工設(shè)置參數(shù)和結(jié)果集重獲。MyBatis 只使用簡(jiǎn)單的XML 和注解來配置和映射基本數(shù)據(jù)類型、Map 接口和POJO 到數(shù)據(jù)庫(kù)記錄。相對(duì)Hibernate和Apache OJB等“一站式”O(jiān)RM解決方案而言，Mybatis 是一種“半自動(dòng)化”的ORM實(shí)現(xiàn)。

ORM工具的基本思想，無論是用過的hibernate,mybatis,你都可以法相他們有一個(gè)共同點(diǎn)：

  1. 從配置文件(通常是XML配置文件中)得到 sessionfactory。
  2. 由sessionfactory 產(chǎn)生 session。
  3. 在session 中完成對(duì)數(shù)據(jù)的增刪改查和事務(wù)提交等。
  4. 在用完之后關(guān)閉session。
  5. 在java 對(duì)象和 數(shù)據(jù)庫(kù)之間有做mapping的配置文件，也通常是xml文件。

1 Mybatis的功能架構(gòu)

1.1 功能架構(gòu)分為三層

  1. API接口層：提供給外部使用的接口API，開發(fā)人員通過這些本地API來操縱數(shù)據(jù)庫(kù)。接口層一接收到調(diào)用請(qǐng)求就會(huì)調(diào)用數(shù)據(jù)處理層來完成具體的數(shù)據(jù)處理。
  2. 數(shù)據(jù)處理層：負(fù)責(zé)具體的SQL查找、SQL解析、SQL執(zhí)行和執(zhí)行結(jié)果映射處理等。它主要的目的是根據(jù)調(diào)用的請(qǐng)求完成一次數(shù)據(jù)庫(kù)操作。
  3. 基礎(chǔ)支撐層：負(fù)責(zé)最基礎(chǔ)的功能支撐，包括連接管理、事務(wù)管理、配置加載和緩存處理，這些都是共用的東西，將他們抽取出來作為最基礎(chǔ)的組件。為上層的數(shù)據(jù)處理層提供最基礎(chǔ)的支撐。
輸入圖片說明

而下面是MyBatis源碼包對(duì)應(yīng)的架構(gòu)圖：

輸入圖片說明

1.2 快速入門

輸入圖片說明
  1. SqlSessionFactoryBuilder

每一個(gè)MyBatis的應(yīng)用程序的入口是SqlSessionFactoryBuilder，它的作用是通過XML配置文件創(chuàng)建Configuration對(duì)象（當(dāng)然也可以在程序中自行創(chuàng)建），然后通過build方法創(chuàng)建SqlSessionFactory對(duì)象。沒有必要每次訪問Mybatis就創(chuàng)建一次SqlSessionFactoryBuilder，通常的做法是創(chuàng)建一個(gè)全局的對(duì)象就可以了。示例程序如下：

   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);
   }
  1. ** SqlSessionFactory**

SqlSessionFactory對(duì)象由SqlSessionFactoryBuilder創(chuàng)建。它的主要功能是創(chuàng)建SqlSession對(duì)象，和SqlSessionFactoryBuilder對(duì)象一樣，沒有必要每次訪問Mybatis就創(chuàng)建一次SqlSessionFactory，通常的做法是創(chuàng)建一個(gè)全局的對(duì)象就可以了。SqlSessionFactory對(duì)象一個(gè)必要的屬性是Configuration對(duì)象,它是保存Mybatis全局配置的一個(gè)配置對(duì)象，通常由SqlSessionFactoryBuilder從XML配置文件創(chuàng)建。這里給出一個(gè)簡(jiǎn)單的示例：

<?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>
  1. SqlSession

SqlSession對(duì)象的主要功能是完成一次數(shù)據(jù)庫(kù)的訪問和結(jié)果的映射，它類似于數(shù)據(jù)庫(kù)的session概念，由于不是線程安全的，所以SqlSession對(duì)象的作用域需限制方法內(nèi)。SqlSession的默認(rèn)實(shí)現(xiàn)類是DefaultSqlSession，它有兩個(gè)必須配置的屬性：Configuration和Executor。Configuration前文已經(jīng)描述這里不再多說。SqlSession對(duì)數(shù)據(jù)庫(kù)的操作都是通過Executor來完成的。

SqlSession有一個(gè)重要的方法getMapper，顧名思義，這個(gè)方式是用來獲取Mapper對(duì)象的。什么是Mapper對(duì)象？根據(jù)Mybatis的官方手冊(cè)，應(yīng)用程序除了要初始并啟動(dòng)Mybatis之外，還需要定義一些接口，接口里定義訪問數(shù)據(jù)庫(kù)的方法，存放接口的包路徑下需要放置同名的XML配置文件。SqlSession的getMapper方法是聯(lián)系應(yīng)用程序和Mybatis紐帶，應(yīng)用程序訪問getMapper時(shí)，Mybatis會(huì)根據(jù)傳入的接口類型和對(duì)應(yīng)的XML配置文件生成一個(gè)代理對(duì)象，這個(gè)代理對(duì)象就叫Mapper對(duì)象。應(yīng)用程序獲得Mapper對(duì)象后，就應(yīng)該通過這個(gè)Mapper對(duì)象來訪問Mybatis的SqlSession對(duì)象，這樣就達(dá)到里插入到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>
  1. Executor

Executor對(duì)象在創(chuàng)建Configuration對(duì)象的時(shí)候創(chuàng)建，并且緩存在Configuration對(duì)象里。Executor對(duì)象的主要功能是調(diào)用StatementHandler訪問數(shù)據(jù)庫(kù)，并將查詢結(jié)果存入緩存中（如果配置了緩存的話）。

  1. StatementHandler

StatementHandler是真正訪問數(shù)據(jù)庫(kù)的地方，并調(diào)用ResultSetHandler處理查詢結(jié)果。

  1. ResultSetHandler

處理查詢結(jié)果。

2 Mybatis環(huán)境搭建及簡(jiǎn)單實(shí)例# ##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ū)動(dòng) -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.12</version>
    </dependency>
</dependencies>

2.2 配置Log4j, 配置MyBatis## 在classpath建立一個(gè)用于配置log4j的配置文件log4j.properties, 再建立一個(gè)用于配置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ù)庫(kù)相關(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ù)庫(kù)配置的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ù)庫(kù)配置文件， 配置文件里面也是對(duì)應(yīng)的這四個(gè)屬性 -->
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>

    <!-- 映射文件，mybatis精髓， 后面才會(huì)細(xì)講 -->
    <mappers>
        <mapper resource="com/dy/dao/userDao-mapping.xml"/>
    </mappers>
</configuration>

2.3 創(chuàng)建一張User表##

  1. 在mysql數(shù)據(jù)庫(kù)test1建立一張表user：
輸入圖片說明
  1. 看看項(xiàng)目的代碼結(jié)構(gòu)：
輸入圖片說明

2.4 編寫代碼##

  1. 先編寫一個(gè)實(shí)體類User: User類用于與User表相對(duì)應(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;
    }
}
  1. 再編寫一個(gè)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();

}
  1. 再編寫一個(gè)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的實(shí)現(xiàn)， 同時(shí)也將User實(shí)體類與數(shù)據(jù)表User成功關(guān)聯(lián)起來。

  1. 編寫junit測(cè)試代碼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ù)庫(kù)進(jìn)行交互
    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對(duì)事務(wù)的處理相對(duì)簡(jiǎn)單，TransactionIsolationLevel中定義了幾種隔離級(jí)別，并不支持內(nèi)嵌事務(wù)這樣較復(fù)雜的場(chǎng)景，同時(shí)由于其是持久層的緣故，所以真正在應(yīng)用開發(fā)中會(huì)委托Spring來處理事務(wù)實(shí)現(xiàn)真正的與開發(fā)者隔離。分析事務(wù)的實(shí)現(xiàn)是個(gè)入口，借此可以了解不少JDBC規(guī)范方面的事情。

public interface SqlSessionFactory {

 SqlSession openSession(); // 事務(wù)默認(rèn)自動(dòng)提交

 SqlSession openSession(boolean autoCommit); // 可傳入 事務(wù)是否自動(dòng)提交
 SqlSession openSession(Connection connection); // 可傳入 數(shù)據(jù)庫(kù)連接
 SqlSession openSession(TransactionIsolationLevel level); // 可傳入 事務(wù)隔離級(jí)別

 SqlSession openSession(ExecutorType execType);
 SqlSession openSession(ExecutorType execType, boolean autoCommit);
 SqlSession openSession(ExecutorType execType, TransactionIsolationLevel level);
 SqlSession openSession(ExecutorType execType, Connection connection);

 Configuration getConfiguration();

}
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容