1. 程式人生 > >MyBatis全版教程+原始碼分析(一)

MyBatis全版教程+原始碼分析(一)

一.什麼是 MyBatis

MyBatis 是一款優秀的持久層框架,它支援定製化 SQL、儲存過程以及高階對映。MyBatis 避免了幾乎所有的 JDBC 程式碼和手動設定引數以及獲取結果集。MyBatis 可以使用簡單的 XML 或註解來配置和對映原生資訊,將介面和 Java 的 POJOs(Plain Old Java Objects,普通的 Java物件)對映成資料庫中的記錄。(摘自MyBatis官網:http://www.mybatis.org/mybatis-3/zh/index.html)

我們來將他的介紹仔細分析一下

(1)首先它是一款持久層框架(persistence framework),什麼是持久化,顧名思義就是將瞬時資料(比如記憶體中的資料,是不能永久儲存的)持久化為持久資料(比如持久化至資料庫中,能夠長久儲存)。規範的定義是將程式資料在持久狀態和瞬時狀態間轉換的機制。目前比較流行的持久化框架就是Hibernate與MyBatis。

(2)它的優點是<避免了幾乎所有的 JDBC 程式碼和手動設定引數以及獲取結果集,我們在使用原生JDBC程式碼實現資料庫的增刪改查時,肯定會寫大量冗餘的程式碼比如資料庫連線,將檢索出來的資料原型對映成物件,當然我們可以在自己的專案手動將該類方法抽象成工具類。但是每個專案都需要這種工具類時,我們可以將其整理起來封裝為jar包,隨處使用,mybatis底層就實現了這種工具類

(3)方式:通過XML或註解來配置和對映原生資訊,通過XML來獲取配置,通過註解來入侵類,這是大量開源框架的慣用方式。

更多資訊可以參見MyBatis官網

二.MyBatis專案構建

2.1.準備開發環境

(1)新建一個maven專案,

(2)目前mybatis最新版本是mybatis-3.4.5,pom檔案如下:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.vichoufa</groupId>
    <artifactId>mybatis</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.5</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>6.0.6</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/junit/junit -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.10</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.1</version>
                <configuration>
                    <source>1.7</source>
                    <target>1.7</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <configuration>
                    <skip>true</skip>
                </configuration>
            </plugin>

        </plugins>
    </build>

</project>


(3)建立測試資料庫

create database test default character utf8 COLLATE utf8_general_ci;  
CREATE TABLE `dept` (  
  `id` int(11) NOT NULL AUTO_INCREMENT,  
  `dept_name` varchar(50) DEFAULT NULL,  
  PRIMARY KEY (`id`)  
) ENGINE=InnoDB AUTO_INCREMENT=9 DEFAULT CHARSET=utf8;  
insert into dept (dept_name) values ('開發部'),('運營部'),('銷售部'),('人事部'),('財務部'),('總經理辦公室'),('後勤部'),('市場部');  

在mysql中執行


到此,前期的開發環境準備工作全部完成。
2.2.使用MyBatis查詢表中的資料

(1)新增配置檔案

<?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">
<!-- 在這個檔案放置一些全域性性的配置 如handler、objectFactory、plugin、以及mappers的對映路徑 -->
<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/test" />
                    <property name="username" value="root" />
                    <property name="password" value="root" />
                </dataSource>
            </environment>
        </environments>
</configuration>
(2)新建對應的實體類


程式碼如下

package com.vichoufa.mybatis.pojo;

/**
 * Created by vichoufa on 2017/11/19 0019.
 */
public class DeptPojo {
    private int id;

    private String name;

    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;
    }

    @Override
    public String toString() {
        return "DeptPojo{" +
                "id=" + id +
                ", name='" + name + '\'' +
                '}';
    }
}

(3)定義操作dept表的sql檔案


<?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.vichoufa.mybatis.mapper.deptMapper"就是com.vichoufa.mybatis.mapper(包名)+deptMapper(deptMapper.xml
 檔案去除字尾)
 -->
<mapper namespace="com.vichoufa.mybatis.mapper.deptMapper">
    <!--更具ID檢索部門-->
    <select id="selectDeptById" parameterType="int" 
            resultType="com.vichoufa.mybatis.pojo.DeptPojo">
        select id, name
        from dept
        where id = #{id}
    </select>
</mapper>

(4)將對映檔案新增到mybatis.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">
<!-- 在這個檔案放置一些全域性性的配置 如handler、objectFactory、plugin、以及mappers的對映路徑 -->
<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/test" />
                    <property name="username" value="root" />
                    <property name="password" value="root" />
                </dataSource>
            </environment>
        </environments>
        <mappers>
            <mapper resource="com/vichoufa/mybatis/mapper/deptMapper.xml"></mapper>
        </mappers>
</configuration>

(5)編寫測試程式碼

package com.vichoufa.mybatis.test;

import com.vichoufa.mybatis.pojo.DeptPojo;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Test;

import java.io.IOException;
import java.io.Reader;

/**
 * Created by vizhoufa on 2017/11/19 0019.
 */
public class TestDeptMapper {
    @Test
    public void testSelectDeptById() throws IOException {
        //mybatis的配置檔案
        String resource = "MyBatis.xml";
        //使用類載入器載入mybatis的配置檔案(它也載入關聯的對映檔案)
//        InputStream is = TestDeptMapper.class.getClassLoader().getResourceAsStream(resource);
//        //構建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();

        String statement = "com.vichoufa.mybatis.mapper.deptMapper.selectDeptById";//對映sql的標識字串
        //執行查詢返回一個唯一user物件的sql
        DeptPojo dept = session.selectOne(statement, 1);
        System.out.println(dept);
    }
}

(6)執行測試用例:


有什麼問題的話,請留言,我會及時回覆