mybatis入門及自定義框架

1、什麼是框架?
    它是我們軟件開發中的一套解決方案,不同的框架解決的是不同的問題。
    使用框架的好處:
        框架封裝了很多的細節,使開發者可以使用極簡的方式實現功能。大大提高開發效率。
2、三層架構
    表現層:
        是用於展示數據的
    業務層:
        是處理業務需求
    持久層:
        是和數據庫交互的


3、持久層技術解決方案
    JDBC技術:
        Connection
        PreparedStatement
        ResultSet
    Spring的JdbcTemplate:
        Spring中對jdbc的簡單封裝
    Apache的DBUtils:
        它和Spring的JdbcTemplate很像,也是對Jdbc的簡單封裝

    以上這些都不是框架
        JDBC是規範
        Spring的JdbcTemplate和Apache的DBUtils都只是工具類

4、mybatis的概述
    mybatis是一個持久層框架,用java編寫的。
    它封裝了jdbc操作的很多細節,使開發者只需要關注sql語句本身,而無需關注註冊驅動,創建連接等繁雜過程
    它使用了ORM思想實現了結果集的封裝。

    ORM:
        Object Relational Mappging 對象關係映射
        簡單的說:
            就是把數據庫表和實體類及實體類的屬性對應起來
            讓我們可以操作實體類就實現操作數據庫表。

            user            User
            id            userId
            user_name        userName
    今天我們需要做到
        實體類中的屬性和數據庫表的字段名稱保持一致。
            user            User
            id            id
            user_name        user_name

5、mybatis的入門
    mybatis的環境搭建
        第一步:創建maven工程並導入座標

<?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>org.example</groupId>
    <artifactId>untitled12</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>
    <dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.5</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.44</version>
        </dependency>
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.12</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.10</version>
        </dependency>
    </dependencies>

</project>

第二步:創建實體類和dao的接口

package com.tiger.dao;

import com.tiger.domin.User;

import java.util.List;

/**
 * power by tigerchen
 */
public interface IUserDao {
    List<User> findAll();
}
package com.tiger.domin;

import java.io.Serializable;
import java.util.Date;

/**
 * power by tigerchen
 */
public class User implements Serializable {
    private Integer id;
    private String username;
    private Date birthday;
    private String sex;
    private String address;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public Date getBirthday() {
        return birthday;
    }

    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", username='" + username + '\'' +
                ", birthday=" + birthday +
                ", sex='" + sex + '\'' +
                ", address='" + address + '\'' +
                '}';
    }
}

第三步:創建Mybatis的主配置文件
                SqlMapConifg.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">
<!-- mybatis的主配置文件 -->
<configuration>
    <!-- 配置環境 -->
    <environments default="mysql">
        <!-- 配置mysql的環境-->
        <environment id="mysql">
            <!-- 配置事務的類型-->
            <transactionManager type="JDBC"></transactionManager>
            <!-- 配置數據源(連接池) -->
            <dataSource type="POOLED">
                <!-- 配置連接數據庫的4個基本信息 -->
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/eesy"/>
                <property name="username" value="root"/>
                <property name="password" value=""/>
            </dataSource>
        </environment>
    </environments>

    <!-- 指定映射配置文件的位置,映射配置文件指的是每個dao獨立的配置文件 -->
    <mappers>
        <mapper resource="com/tiger/dao/IUserDao.xml"/>
    </mappers>
</configuration>

第四步:創建映射配置文件
                IUserDao.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="com.tiger.dao.IUserDao">
    <!--配置查詢所有-->
    <select id="findAll" resultType="com.tiger.domin.User">
        select * from user
    </select>
</mapper>

            IUserDao.xml
    環境搭建的注意事項:
        第一個:創建IUserDao.xml 和 IUserDao.java時名稱是爲了展示它是接口。
            在Mybatis中它把持久層的操作接口名稱和映射文件也叫做:Mapper
            所以:IUserDao 和 IUserMapper是一樣的
        第二個:在idea中創建目錄的時候,它和包是不一樣的
            包在創建時:com.itheima.dao它是三級結構
            目錄在創建時:com.itheima.dao是一級目錄
        第三個:mybatis的映射配置文件位置必須和dao接口的包結構相同
        第四個:映射配置文件的mapper標籤namespace屬性的取值必須是dao接口的全限定類名
        第五個:映射配置文件的操作配置(select),id屬性的取值必須是dao接口的方法名

        當我們遵從了第三,四,五點之後,我們在開發中就無須再寫dao的實現類。

自定義Mybatis的分析:
  

        注意事項:
            不要忘記在映射配置中告知mybatis要封裝到哪個實體類中
            配置的方式:指定實體類的全限定類名

/**
 * by tigerchen
 */
public class MybatisTest {
    public static void main(String[] args)throws Exception {
        //1.讀取配置文件
        InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
        //2.創建SqlSessionFactory工廠
        SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
        SqlSessionFactory factory = builder.build(in);
        //3.使用工廠生產SqlSession對象
        SqlSession session = factory.openSession();
        //4.使用SqlSession創建Dao接口的代理對象
        IUserDao userDao = session.getMapper(IUserDao.class);
        //5.使用代理對象執行方法
        List<User> users = userDao.findAll();
       // System.out.println(users);
        for(User user : users){
            System.out.println(user);
        }
        //6.釋放資源
        session.close();
        in.close();
    }
}

這是測試類代碼

 第一步:讀取配置文件,於是我們寫上Resources類

/**
 * 使用類加載器讀取配置文件的類
 */
public class Resources {

    /**
     * 根據傳入的參數,獲取一個字節輸入流
     * @param filePath
     * @return
     */
    public static InputStream getResourceAsStream(String filePath){
        return Resources.class.getClassLoader().getResourceAsStream(filePath);
    }
}

  使用dom4j技術解析配置文件

import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 *  用於解析配置文件
 */
public class XMLConfigBuilder {
    /**
     * 解析主配置文件,把裏面的內容填充到DefaultSqlSession所需要的地方
     * 使用的技術:
     *      dom4j+xpath
     */
    public static Configuration loadConfiguration(InputStream config){
        try{
            //定義封裝連接信息的配置對象(mybatis的配置對象)
            Configuration cfg = new Configuration();

            //1.獲取SAXReader對象
            SAXReader reader = new SAXReader();
            //2.根據字節輸入流獲取Document對象
            System.out.println(config);
            Document document = reader.read(config);
            //3.獲取根節點
            Element root = document.getRootElement();
            //4.使用xpath中選擇指定節點的方式,獲取所有property節點
            List<Element> propertyElements = root.selectNodes("//property");
            //5.遍歷節點
            for(Element propertyElement : propertyElements){
                //判斷節點是連接數據庫的哪部分信息
                //取出name屬性的值
                String name = propertyElement.attributeValue("name");
                if("driver".equals(name)){
                    //表示驅動
                    //獲取property標籤value屬性的值
                    String driver = propertyElement.attributeValue("value");
                    cfg.setDriver(driver);
                }
                if("url".equals(name)){
                    //表示連接字符串
                    //獲取property標籤value屬性的值
                    String url = propertyElement.attributeValue("value");
                    cfg.setUrl(url);
                }
                if("username".equals(name)){
                    //表示用戶名
                    //獲取property標籤value屬性的值
                    String username = propertyElement.attributeValue("value");
                    cfg.setUsername(username);
                }
                if("password".equals(name)){
                    //表示密碼
                    //獲取property標籤value屬性的值
                    String password = propertyElement.attributeValue("value");
                    cfg.setPassword(password);
                }
            }
            //取出mappers中的所有mapper標籤,判斷他們使用了resource還是class屬性
            List<Element> mapperElements = root.selectNodes("//mappers/mapper");
            //遍歷集合
            for(Element mapperElement : mapperElements){
                //判斷mapperElement使用的是哪個屬性
                Attribute attribute = mapperElement.attribute("resource");
                if(attribute != null){
                    System.out.println("使用的是XML");
                    //表示有resource屬性,用的是XML
                    //取出屬性的值
                    String mapperPath = attribute.getValue();//獲取屬性的值"com/itheima/dao/IUserDao.xml"
                    //把映射配置文件的內容獲取出來,封裝成一個map
                    Map<String,Mapper> mappers = loadMapperConfiguration(mapperPath);
                    //給configuration中的mappers賦值
                    cfg.setMappers(mappers);
                }else{
                    System.out.println("使用的是註解");
                    //表示沒有resource屬性,用的是註解
                    //獲取class屬性的值
                    String daoClassPath = mapperElement.attributeValue("class");
                    //根據daoClassPath獲取封裝的必要信息
                    Map<String,Mapper> mappers = loadMapperAnnotation(daoClassPath);
                    //給configuration中的mappers賦值
                    cfg.setMappers(mappers);
                }
            }
            //返回Configuration
            return cfg;
        }catch(Exception e){
            throw new RuntimeException(e);
        }finally{
            try {
                config.close();
            }catch(Exception e){
                e.printStackTrace();
            }
        }

    }

    /**
     * 根據傳入的參數,解析XML,並且封裝到Map中
     * @param mapperPath    映射配置文件的位置
     * @return  map中包含了獲取的唯一標識(key是由dao的全限定類名和方法名組成)
     *          以及執行所需的必要信息(value是一個Mapper對象,裏面存放的是執行的SQL語句和要封裝的實體類全限定類名)
     */
    private static Map<String,Mapper> loadMapperConfiguration(String mapperPath)throws IOException {
        InputStream in = null;
        try{
            //定義返回值對象
            Map<String,Mapper> mappers = new HashMap<String,Mapper>();
            //1.根據路徑獲取字節輸入流
            in = Resources.getResourceAsStream(mapperPath);
            //2.根據字節輸入流獲取Document對象
            SAXReader reader = new SAXReader();
            Document document = reader.read(in);
            //3.獲取根節點
            Element root = document.getRootElement();
            //4.獲取根節點的namespace屬性取值
            String namespace = root.attributeValue("namespace");//是組成map中key的部分
            //5.獲取所有的select節點
            List<Element> selectElements = root.selectNodes("//select");
            //6.遍歷select節點集合
            for(Element selectElement : selectElements){
                //取出id屬性的值      組成map中key的部分
                String id = selectElement.attributeValue("id");
                //取出resultType屬性的值  組成map中value的部分
                String resultType = selectElement.attributeValue("resultType");
                //取出文本內容            組成map中value的部分
                String queryString = selectElement.getText();
                //創建Key
                String key = namespace+"."+id;
                //創建Value
                Mapper mapper = new Mapper();
                mapper.setQueryString(queryString);
                mapper.setResultType(resultType);
                System.out.println("這是結果類型"+resultType);
                System.out.println("這是sql"+queryString);
                //把key和value存入mappers中
                System.out.println("這是mapper"+mapper);
                mappers.put(key,mapper);
                System.out.println("mappers"+mappers);
                String queryString1 = mapper.getQueryString();
                System.out.println(queryString1);
            }
            return mappers;
        }catch(Exception e){
            throw new RuntimeException(e);
        }finally{
            in.close();
        }
    }

    /**
     * 根據傳入的參數,得到dao中所有被select註解標註的方法。
     * 根據方法名稱和類名,以及方法上註解value屬性的值,組成Mapper的必要信息
     * @param daoClassPath
     * @return
     */
    private static Map<String,Mapper> loadMapperAnnotation(String daoClassPath)throws Exception{
        //定義返回值對象
        Map<String,Mapper> mappers = new HashMap<String, Mapper>();

        //1.得到dao接口的字節碼對象
        Class daoClass = Class.forName(daoClassPath);
        //2.得到dao接口中的方法數組
        Method[] methods = daoClass.getMethods();
        //3.遍歷Method數組
        for(Method method : methods){
            //取出每一個方法,判斷是否有select註解
            boolean isAnnotated = method.isAnnotationPresent(Select.class);
            if(isAnnotated){
                //創建Mapper對象
                Mapper mapper = new Mapper();
                //取出註解的value屬性值
                Select selectAnno = method.getAnnotation(Select.class);
                String queryString = selectAnno.value();
                mapper.setQueryString(queryString);
                //獲取當前方法的返回值,還要求必須帶有泛型信息
                Type type = method.getGenericReturnType();//List<User>
                //判斷type是不是參數化的類型
                if(type instanceof ParameterizedType){
                    //強轉
                    ParameterizedType ptype = (ParameterizedType)type;
                    //得到參數化類型中的實際類型參數
                    Type[] types = ptype.getActualTypeArguments();
                    //取出第一個
                    Class domainClass = (Class)types[0];
                    //獲取domainClass的類名
                    String resultType = domainClass.getName();
                    //給Mapper賦值
                    mapper.setResultType(resultType);
                }
                //組裝key的信息
                //獲取方法的名稱
                String methodName = method.getName();
                String className = method.getDeclaringClass().getName();
                String key = className+"."+methodName;
                //給map賦值
                mappers.put(key,mapper);
            }
        }
        return mappers;
    }
}

第二步:創建SqlSessionFactory工廠

(創建者)



/**
 *  用於創建一個SqlSessionFactory對象
 */
public class SqlSessionFactoryBuilder {

    /**
     * 根據參數的字節輸入流來構建一個SqlSessionFactory工廠
     * @param config
     * @return
     */
    public SqlSessionFactory build(InputStream config){
        Configuration cfg = XMLConfigBuilder.loadConfiguration(config);
        System.out.println("這是cfg"+cfg);
        return  new DefaultSqlSessionFactory(cfg);
    }
}

(工廠類)接口和實現類


public interface SqlSessionFactory {

    /**
     * 用於打開一個新的SqlSession對象
     * @return
     */
    SqlSession openSession();
}
/**
 * SqlSessionFactory接口的實現類
 */
public class DefaultSqlSessionFactory implements SqlSessionFactory{

    private Configuration cfg;

    public DefaultSqlSessionFactory(Configuration cfg){

        this.cfg = cfg;
    }

    /**
     * 用於創建一個新的操作數據庫對象
     * @return
     */
    @Override
    public SqlSession openSession() {

        return new DefaultSqlSession(cfg);
    }
}

 第三步:創建SqlSession,創建Dao接口的代理對象(這裏涉及動態代理)

/**
 * 自定義Mybatis中和數據庫交互的核心類
 *  它裏面可以創建dao接口的代理對象
 */
public interface SqlSession {

    /**
     * 根據參數創建一個代理對象
     * @param daoInterfaceClass dao的接口字節碼
     * @param <T>
     * @return
     */
    <T> T getMapper(Class<T> daoInterfaceClass);

    /**
     * 釋放資源
     */
    void close();
}

實現類

/**
 * SqlSession接口的實現類
 */
public class DefaultSqlSession implements SqlSession {

    private Configuration cfg;
    private Connection connection;

    public DefaultSqlSession(Configuration cfg){
        this.cfg = cfg;
        connection = DataSourceUtil.getConnection(cfg);
        System.out.println("connection"+connection);
    }

    /**
     * 用於創建代理對象
     * @param daoInterfaceClass dao的接口字節碼
     * @param <T>
     * @return
     */
    @Override
    public <T> T getMapper(Class<T> daoInterfaceClass) {
        return (T) Proxy.newProxyInstance(daoInterfaceClass.getClassLoader(),
                new Class[]{daoInterfaceClass},new MapperProxy(cfg.getMappers(),connection));
    }

    /**
     * 用於釋放資源
     */
    @Override
    public void close() {
        if(connection != null) {
            try {
                connection.close();
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }
}

 connection從工具類獲取

/**
 * 用於創建數據源的工具類
 */
public class DataSourceUtil {

    /**
     * 用於獲取一個連接
     * @param cfg
     * @return
     */
    public static Connection getConnection(Configuration cfg){
        try {
            Class.forName(cfg.getDriver());
            return DriverManager.getConnection(cfg.getUrl(), cfg.getUsername(), cfg.getPassword());
        }catch(Exception e){
            throw new RuntimeException(e);
        }
    }
}

第四步:執行dao中的方法

public class MapperProxy implements InvocationHandler {

    //map的key是全限定類名+方法名
    private Map<String,Mapper> mappers;
    private Connection conn;

    public MapperProxy(Map<String,Mapper> mappers,Connection conn){
        this.mappers = mappers;
        this.conn = conn;
    }

    /**
     * 用於對方法進行增強的,我們的增強其實就是調用selectList方法
     * @param proxy
     * @param method
     * @param args
     * @return
     * @throws Throwable
     */
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        //1.獲取方法名
        String methodName = method.getName();
        System.out.println("方法名"+methodName);
        //2.獲取方法所在類的名稱
        String className = method.getDeclaringClass().getName();
        System.out.println("classname'"+className);
        //3.組合key
        String key = className+"."+methodName;
        //4.獲取mappers中的Mapper對象
        Mapper mapper = mappers.get(key);
        //5.判斷是否有mapper
        if(mapper == null){
            throw new IllegalArgumentException("傳入的參數有誤");
        }
        //6.調用工具類執行查詢所有
        return new Executor().selectList(mapper,conn);
    }
}

這裏調用工具類查詢所有

/**
 * 負責執行SQL語句,並且封裝結果集
 */
public class Executor {

    public <E> List<E> selectList(Mapper mapper, Connection conn) {
        PreparedStatement pstm = null;
        ResultSet rs = null;
        try {
            //1.取出mapper中的數據
            String queryString = mapper.getQueryString();//select * from user
            String resultType = mapper.getResultType();//com.itheima.domain.User
            Class domainClass = Class.forName(resultType);
            //2.獲取PreparedStatement對象
            pstm = conn.prepareStatement(queryString);
            //3.執行SQL語句,獲取結果集
            rs = pstm.executeQuery();
            //4.封裝結果集
            List<E> list = new ArrayList<E>();//定義返回值
            while(rs.next()) {
                //實例化要封裝的實體類對象
                E obj = (E)domainClass.newInstance();

                //取出結果集的元信息:ResultSetMetaData
                ResultSetMetaData rsmd = rs.getMetaData();
                //取出總列數
                int columnCount = rsmd.getColumnCount();
                //遍歷總列數
                for (int i = 1; i <= columnCount; i++) {
                    //獲取每列的名稱,列名的序號是從1開始的
                    String columnName = rsmd.getColumnName(i);
                    //根據得到列名,獲取每列的值
                    Object columnValue = rs.getObject(columnName);
                    //給obj賦值:使用Java內省機制(藉助PropertyDescriptor實現屬性的封裝)
                    PropertyDescriptor pd = new PropertyDescriptor(columnName,domainClass);//要求:實體類的屬性和數據庫表的列名保持一種
                    //獲取它的寫入方法
                    Method writeMethod = pd.getWriteMethod();
                    System.out.println("寫入方法"+writeMethod);
                    //把獲取的列的值,給對象賦值
                    writeMethod.invoke(obj,columnValue);
                }
                //把賦好值的對象加入到集合中
                list.add(obj);
            }
            return list;
        } catch (Exception e) {
            throw new RuntimeException(e);
        } finally {
            release(pstm,rs);
        }
    }


    private void release(PreparedStatement pstm,ResultSet rs){
        if(rs != null){
            try {
                rs.close();
            }catch(Exception e){
                e.printStackTrace();
            }
        }

        if(pstm != null){
            try {
                pstm.close();
            }catch(Exception e){
                e.printStackTrace();
            }
        }
    }
}

mybatis的分析

查詢所有的分析

入門案例的分析

自定義maybatis分析

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章