本身手寫一個Mybatis框架(簡化)

時間 2019-11-06

原文原文鏈接

繼上一篇手寫SpringMVC以後，我最近趁熱打鐵，研究了一下Mybatis。MyBatis框架的核心功能其實不難，無非就是動態代理和jdbc的操做，難的是寫出來可擴展，高內聚，低耦合的規範的代碼。本文完成的Mybatis功能比較簡單，代碼還有許多須要改進的地方，你們能夠結合Mybatis源碼去動手完善。html

1、Mybatis框架流程簡介

在手寫本身的Mybatis框架以前，咱們先來了解一下Mybatis，它的源碼中使用了大量的設計模式，閱讀源碼並觀察設計模式在其中的應用，纔可以更深刻的理解源碼（ref：Mybatis源碼解讀-設計模式總結）。咱們對上圖進行分析總結：java

mybatis的配置文件有2類
- mybatisconfig.xml，配置文件的名稱不是固定的，配置了全局的參數的配置，全局只能有一個配置文件。
- Mapper.xml 配置多個statemement，也就是多個sql，整個mybatis框架中能夠有多個Mappe.xml配置文件。
經過mybatis配置文件獲得SqlSessionFactory
經過SqlSessionFactory獲得SqlSession，用SqlSession就能夠操做數據了。
SqlSession經過底層的Executor（執行器），執行器有2類實現：
- 基本實現
- 帶有緩存功能的實現
MappedStatement是經過Mapper.xml中定義statement生成的對象。
參數輸入執行並輸出結果集，無需手動判斷參數類型和參數下標位置，且自動將結果集映射爲Java對象
- HashMap，KV格式的數據類型
- Java的基本數據類型
- POJO，java的對象

2、梳理本身的Mybatis的設計思路

根據上文Mybatis流程，我簡化了下，分爲如下步驟：node

1.讀取xml文件，創建鏈接

從圖中能夠看出，MyConfiguration負責與人交互。待讀取xml後，將屬性和鏈接數據庫的操做封裝在MyConfiguration對象中供後面的組件調用。本文將使用dom4j來讀取xml文件，它具備性能優異和很是方便使用的特色。mysql

2.建立SqlSession，搭建Configuration和Executor之間的橋樑

咱們常常在使用框架時看到Session，Session究竟是什麼呢？一個Session僅擁有一個對應的數據庫鏈接。相似於一個前段請求Request，它能夠直接調用exec(SQL)來執行SQL語句。從流程圖中的箭頭能夠看出，MySqlSession的成員變量中必須得有MyExecutor和MyConfiguration去集中作調配，箭頭就像是一種關聯關係。咱們本身的MySqlSession將有一個getMapper方法，而後使用動態代理生成對象後，就能夠作數據庫的操做了。git

3.建立Executor，封裝JDBC操做數據庫

Executor是一個執行器，負責SQL語句的生成和查詢緩存（緩存還沒完成）的維護，也就是jdbc的代碼將在這裏完成，不過本文只實現了單表，有興趣的同窗能夠嘗試完成多表。github

4.建立MapperProxy，使用動態代理生成Mapper對象

咱們只是但願對指定的接口生成一個對象，使得執行它的時候能運行一句sql罷了，而接口沒法直接調用方法，因此這裏使用動態代理生成對象，在執行時仍是回到MySqlSession中調用查詢，最終由MyExecutor作JDBC查詢。這樣設計是爲了單一職責，可擴展性更強。sql

3、實現本身的Mybatis

工程文件及目錄：數據庫

首先，新建一個maven項目，在pom.xml中導入如下依賴：apache

<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.liugh</groupId>
  <artifactId>liugh-mybatis</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>jar</packaging>
  
  <properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<maven.compiler.source>1.8</maven.compiler.source>
		<maven.compiler.target>1.8</maven.compiler.target>
		<java.version>1.8</java.version>
	</properties>
	
	<dependencies>
	     <!-- 讀取xml文件 -->
		<dependency>
			<groupId>dom4j</groupId>
			<artifactId>dom4j</artifactId>
			<version>1.6.1</version>
		</dependency>
		
		<!-- MySQL -->
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<version>5.1.29</version>
		</dependency>
    </dependencies>
</project>

建立咱們的數據庫xml配置文件：設計模式

<?xml version="1.0" encoding="UTF-8"?>
<database>
	<property name="driverClassName">com.mysql.jdbc.Driver</property>
	<property name="url">jdbc:mysql://localhost:3306/test?useUnicode=true&amp;characterEncoding=utf8</property>
	<property name="username">root</property>
	<property name="password">123456</property>
</database>

而後在數據庫建立test庫，執行以下SQL語句：

CREATE TABLE `user` (
  `id` varchar(64) NOT NULL,
  `password` varchar(255) DEFAULT NULL,
  `username` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;
INSERT INTO `test`.`user` (`id`, `password`, `username`) VALUES ('1', '123456', 'liugh');

建立User實體類，和UserMapper接口和對應的xml文件:

package com.liugh.bean;

public class User {
    private String id;
    private String username;
    private String password;
    //省略get set toString方法...
}

package com.liugh.mapper;

import com.liugh.bean.User;

public interface UserMapper {
	
	public User getUserById(String id);  
}

<?xml version="1.0" encoding="UTF-8"?>
<mapper nameSpace="com.liugh.mapper.UserMapper">
    <select id="getUserById" resultType ="com.liugh.bean.User">
        select * from user where id = ?
    </select>
</mapper>

基本操做配置完成，接下來咱們開始實現MyConfiguration：

package com.liugh.sqlSession;

import java.io.InputStream;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;
import com.liugh.config.Function;
import com.liugh.config.MapperBean;


/**
 * 讀取與解析配置信息，並返回處理後的Environment
 */
public class MyConfiguration {
	private static ClassLoader loader = ClassLoader.getSystemClassLoader();

	/**
	 * 讀取xml信息並處理
	 */
	public  Connection build(String resource){
	    try {
	        InputStream stream = loader.getResourceAsStream(resource);
			SAXReader reader = new SAXReader();
			Document document = reader.read(stream);
			Element root = document.getRootElement();
			return evalDataSource(root);
		} catch (Exception e) {
			throw new RuntimeException("error occured while evaling xml " + resource);
		}
	}
	
	private  Connection evalDataSource(Element node) throws ClassNotFoundException {
        if (!node.getName().equals("database")) {
        	throw new RuntimeException("root should be <database>");
        }
		String driverClassName = null;
		String url = null;
		String username = null;
		String password = null;
		//獲取屬性節點
		for (Object item : node.elements("property")) {
			Element i = (Element) item;			
			String value = getValue(i);
			String name = i.attributeValue("name");
			if (name == null || value == null) {
				throw new RuntimeException("[database]: <property> should contain name and value");
			}
			//賦值
			switch (name) {
				case "url" : url = value; break;
				case "username" : username = value; break;
				case "password" : password = value; break;
				case "driverClassName" : driverClassName = value; break; 
				default : throw new RuntimeException("[database]: <property> unknown name"); 
			}
		}
		
		 Class.forName(driverClassName); 
		 Connection connection = null;
		try {
			//創建數據庫連接
			connection = DriverManager.getConnection(url, username, password);
		} catch (SQLException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		return connection;
	}
	
	//獲取property屬性的值,若是有value值,則讀取 沒有設置value,則讀取內容
	private  String getValue(Element node) {
		return node.hasContent() ? node.getText() : node.attributeValue("value");
	}
	
	
	
    @SuppressWarnings("rawtypes")
    public  MapperBean readMapper(String path){
        MapperBean mapper = new MapperBean();
        try{
        	InputStream stream = loader.getResourceAsStream(path);
 			SAXReader reader = new SAXReader();
 			Document document = reader.read(stream);
 			Element root = document.getRootElement();
            mapper.setInterfaceName(root.attributeValue("nameSpace").trim()); //把mapper節點的nameSpace值存爲接口名
            List<Function> list = new ArrayList<Function>(); //用來存儲方法的List
            for(Iterator rootIter = root.elementIterator();rootIter.hasNext();) {//遍歷根節點下全部子節點
                Function fun = new Function();    //用來存儲一條方法的信息
                Element e = (Element) rootIter.next(); 
                String sqltype = e.getName().trim();
                String funcName = e.attributeValue("id").trim();
                String sql = e.getText().trim();
                String resultType = e.attributeValue("resultType").trim();
                fun.setSqltype(sqltype);
                fun.setFuncName(funcName);
                Object newInstance=null;
				try {
					newInstance = Class.forName(resultType).newInstance();
				} catch (InstantiationException e1) {
					e1.printStackTrace();
				} catch (IllegalAccessException e1) {
					e1.printStackTrace();
				} catch (ClassNotFoundException e1) {
					e1.printStackTrace();
				}
                fun.setResultType(newInstance);
                fun.setSql(sql);
                list.add(fun);
            }
            mapper.setList(list);
            
        } catch (DocumentException e) {
            e.printStackTrace();
        }
        return mapper;
    }
}

用面向對象的思想設計讀取xml配置後：

package com.liugh.config;

import java.util.List;
public class MapperBean {
	private String interfaceName; //接口名
    private List<Function> list; //接口下全部方法
    //省略 get  set方法...
}

Function對象包括sql的類型、方法名、sql語句、返回類型和參數類型。

package com.liugh.config;

public class Function {
	private String sqltype;  
    private String funcName;  
    private String sql;       
    private Object resultType;  
    private String parameterType; 
	//省略 get set方法
}

接下來實現咱們的MySqlSession,首先的成員變量裏得有Excutor和MyConfiguration，代碼的精髓就在getMapper的方法裏。

package com.liugh.sqlSession;

import java.lang.reflect.Proxy;

public class MySqlsession {
	
	private Excutor excutor= new MyExcutor();  
	
	private MyConfiguration myConfiguration = new MyConfiguration();
	
    public <T> T selectOne(String statement,Object parameter){  
        return excutor.query(statement, parameter);  
    }  
	      
    @SuppressWarnings("unchecked")
	public <T> T getMapper(Class<T> clas){ 
    	//動態代理調用
        return (T)Proxy.newProxyInstance(clas.getClassLoader(),new Class[]{clas},
        		new MyMapperProxy(myConfiguration,this));  
    }  

}

緊接着建立Excutor和實現類：

package com.liugh.sqlSession;

public interface Excutor {
	public <T> T query(String statement,Object parameter);  
}

MyExcutor中封裝了JDBC的操做：

package com.liugh.sqlSession;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import com.liugh.bean.User;


public class MyExcutor implements Excutor{
	
	private MyConfiguration xmlConfiguration = new MyConfiguration();
	
	 @Override  
	    public <T> T query(String sql, Object parameter) {  
	        Connection connection=getConnection();  
	        ResultSet set =null;
	        PreparedStatement pre =null;
	        try {  
	            pre = connection.prepareStatement(sql); 
	            //設置參數
	            pre.setString(1, parameter.toString());
	            set = pre.executeQuery();  
	            User u=new User();  
	            //遍歷結果集
	            while(set.next()){  
	                u.setId(set.getString(1));
	                u.setUsername(set.getString(2)); 
	                u.setPassword(set.getString(3));
	            }  
	            return (T) u;  
	        } catch (SQLException e) {  
	            e.printStackTrace();  
	        } finally{
	               try{  
	                   if(set!=null){  
	                	   set.close();  
	                   }if(pre!=null){  
	                	   pre.close();  
	                   }if(connection!=null){  
	                	   connection.close();  
	                   }  
	               }catch(Exception e2){  
	                   e2.printStackTrace();  
	               }  
	           }   
	        return null;  
	    }  
	  
	    private Connection getConnection() {  
	        try {  
	            Connection connection =xmlConfiguration.build("config.xml");
	            return connection;  
	        } catch (Exception e) {  
	            e.printStackTrace();  
	        }  
	        return null;  
	    }  
}

MyMapperProxy代理類完成xml方法和真實方法對應，執行查詢：

package com.liugh.sqlSession;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.util.List;
import com.liugh.config.Function;
import com.liugh.config.MapperBean;

public class MyMapperProxy implements InvocationHandler{
	
	private  MySqlsession mySqlsession;  
	
	private MyConfiguration myConfiguration;
     
    public MyMapperProxy(MyConfiguration myConfiguration,MySqlsession mySqlsession) {  
        this.myConfiguration=myConfiguration;  
        this.mySqlsession=mySqlsession;  
    }  

	@Override
	public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
		MapperBean readMapper = myConfiguration.readMapper("UserMapper.xml");
		//是不是xml文件對應的接口
		if(!method.getDeclaringClass().getName().equals(readMapper.getInterfaceName())){
			return null;  
		}
		List<Function> list = readMapper.getList();
		if(null != list || 0 != list.size()){
			for (Function function : list) {
			//id是否和接口方法名同樣
			 if(method.getName().equals(function.getFuncName())){  
		            return mySqlsession.selectOne(function.getSql(), String.valueOf(args[0]));  
		        }  
			}
		}
	     return null;  
	}
}

到這裏，就完成了本身的Mybatis框架，咱們測試一下：

package com.liugh;

import com.liugh.bean.User;
import com.liugh.mapper.UserMapper;
import com.liugh.sqlSession.MySqlsession;

public class TestMybatis {
	
    public static void main(String[] args) {  
        MySqlsession sqlsession=new MySqlsession();  
        UserMapper mapper = sqlsession.getMapper(UserMapper.class);  
        User user = mapper.getUserById("1");  
        System.out.println(user);
    } 
}

執行結果：

查詢一個不存在的用戶試試：

到這裏咱們就大功告成了！

我是個普通的程序猿，水平有限，文章不免有錯誤，歡迎犧牲本身寶貴時間的讀者，就本文內容直抒己見，個人目的僅僅是但願對讀者有所幫助。源碼地址：https://github.com/qq53182347/liugh-mybatis