從0 開始手寫一個 Mybatis 框架,三步搞定!

本文轉載自【微信公眾號：java進階架構師，ID:java_jiagoushi】經微信公眾號授權轉載，如需轉載與原文作者聯繫

繼上一篇手寫SpringMVC之後，我最近趁熱打鐵，研究了一下Mybatis。MyBatis框架的核心功能其實不難，無非就是動態代理和jdbc的操作，難的是寫出來可擴展，高內聚，低耦合的規範的代碼。

本文完成的Mybatis功能比較簡單，代碼還有許多需要改進的地方，大家可以結合Mybatis源碼去動手完善。

1

Mybatis框架流程簡介

在手寫自己的Mybatis框架之前，我們先來了解一下Mybatis，它的源碼中使用了大量的設計模式，閱讀源碼並觀察設計模式在其中的應用，才能夠更深入的理解源碼（ref：Mybatis源碼解讀-設計模式總結）。

我們對上圖進行分析總結：

1、mybatis的配置文件有2類

mybatisconfig.xml，配置文件的名稱不是固定的，配置了全局的參數的配置，全局只能有一個配置文件。Mapper.xml 配置多個statemement，也就是多個sql，整個mybatis框架中可以有多個Mappe.xml配置文件。2、通過mybatis配置文件得到SqlSessionFactory

3、通過SqlSessionFactory得到SqlSession，用SqlSession就可以操作數據了。

4、SqlSession通過底層的Executor（執行器），執行器有2類實現：

基本實現帶有緩存功能的實現5、MappedStatement是通過Mapper.xml中定義statement生成的對象。

6、參數輸入執行並輸出結果集，無需手動判斷參數類型和參數下標位置，且自動將結果集映射為Java對象

HashMap，KV格式的數據類型Java的基本數據類型POJO，java的對象

2

梳理自己的Mybatis的設計思路

根據上文Mybatis流程，我簡化了下，分為以下步驟：

1.讀取xml文件，建立連接

從圖中可以看出，MyConfiguration負責與人交互。待讀取xml後，將屬性和連接資料庫的操作封裝在MyConfiguration對象中供後面的組件調用。本文將使用dom4j來讀取xml文件，它具有性能優異和非常方便使用的特點。

2.創建SqlSession，搭建Configuration和Executor之間的橋梁

我們經常在使用框架時看到Session，Session到底是什麼呢？一個Session僅擁有一個對應的資料庫連接。類似於一個前段請求Request，它可以直接調用exec(SQL)來執行SQL語句。

從流程圖中的箭頭可以看出，MySqlSession的成員變量中必須得有MyExecutor和MyConfiguration去集中做調配，箭頭就像是一種關聯關係。我們自己的MySqlSession將有一個getMapper方法，然後使用動態代理生成對象後，就可以做資料庫的操作了。

3.創建Executor，封裝JDBC操作資料庫

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

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

我們只是希望對指定的接口生成一個對象，使得執行它的時候能運行一句sql罷了，而接口無法直接調用方法，所以這裡使用動態代理生成對象，在執行時還是回到MySqlSession中調用查詢，最終由MyExecutor做JDBC查詢。這樣設計是為了單一職責，可擴展性更強。推薦閱讀：手寫實現一個迷你版的Tomcat

3

實現自己的Mybatis

工程文件及目錄：

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

<projectxmlns="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><propertyname="driverClassName">com.mysql.jdbc.Driver</property> <propertyname="url">jdbc:mysql://localhost:3306/test?useUnicode=true&amp;characterEncoding=utf8</property> <propertyname="username">root</property> <propertyname="password">123456</property></database>

然後在資料庫創建test庫，執行如下SQL語句：

CREATETABLE`user`(`id`varchar(64)NOTNULL, `password`varchar(255)DEFAULTNULL, `username`varchar(255)DEFAULTNULL, PRIMARYKEY(`id`))ENGINE=InnoDBAUTO_INCREMENT=2DEFAULTCHARSET=utf8;INSERTINTO`test`.`user`(`id`,`password`,`username`)VALUES('1','123456','liugh');

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

package com.liugh.bean;publicclassUser{privateString id; privateString username; privateString password; //省略get set toString方法...}package com.liugh.mapper;import com.liugh.bean.User;publicinterfaceUserMapper{ publicUsergetUserById(String id); }<?xml version="1.0"encoding="UTF-8"?><mapper nameSpace="com.liugh.mapper.UserMapper"> <selectid="getUserById"resultType ="com.liugh.bean.User"> select*fromuserwhereid = ? </select></mapper>

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

package com.liugh.sqlSession;importjava.io.InputStream;importjava.sql.Connection;importjava.sql.DriverManager;importjava.sql.SQLException;importjava.util.ArrayList;importjava.util.Iterator;importjava.util.List;importorg.dom4j.Document;importorg.dom4j.DocumentException;importorg.dom4j.Element;importorg.dom4j.io.SAXReader;importcom.liugh.config.Function;importcom.liugh.config.MapperBean;/*** 讀取與解析配置信息，並返回處理後的Environment*/publicclassMyConfiguration {privatestaticClassLoader loader = ClassLoader.getSystemClassLoader(); /** * 讀取xml信息並處理 */ public Connection build(Stringresource){ try{ InputStream stream = loader.getResourceAsStream(resource); SAXReader reader =newSAXReader(); Documentdocument= reader.read(stream); Element root =document.getRootElement(); returnevalDataSource(root); }catch(Exception e) { thrownewRuntimeException("error occured while evaling xml "+ resource); } } private Connection evalDataSource(Element node) throws ClassNotFoundException { if(!node.getName().equals("database")) { thrownewRuntimeException("root should be <database>"); } StringdriverClassName =null; Stringurl =null; Stringusername =null; Stringpassword =null; //獲取屬性節點 for(Objectitem : node.elements("property")) { Element i = (Element) item; Stringvalue = getValue(i); Stringname = i.attributeValue("name"); if(name ==null|| value ==null) { thrownewRuntimeException("[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:thrownewRuntimeException("[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(); } returnconnection; } //獲取property屬性的值,如果有value值,則讀取 沒有設置value,則讀取內容 private StringgetValue(Element node) { returnnode.hasContent() ? node.getText() : node.attributeValue("value"); } @SuppressWarnings("rawtypes") public MapperBean readMapper(Stringpath){ MapperBean mapper =newMapperBean(); try{ InputStream stream = loader.getResourceAsStream(path); SAXReader reader =newSAXReader(); Documentdocument= reader.read(stream); Element root =document.getRootElement(); mapper.setInterfaceName(root.attributeValue("nameSpace").trim());//把mapper節點的nameSpace值存為接口名 List<Function> list =newArrayList<Function>();//用來存儲方法的List for(Iterator rootIter = root.elementIterator();rootIter.hasNext();) {//遍歷根節點下所有子節點 Functionfun =newFunction(); //用來存儲一條方法的信息 Element e = (Element) rootIter.next(); Stringsqltype = e.getName().trim(); StringfuncName = e.attributeValue("id").trim(); Stringsql = e.getText().trim(); StringresultType = e.attributeValue("resultType").trim(); fun.setSqltype(sqltype); fun.setFuncName(funcName); ObjectnewInstance=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(); } returnmapper; }}

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

package com.liugh.config;import java.util.List;publicclassMapperBean{privateString interfaceName;//接口名 privateList<Function>list;//接口下所有方法 //省略 get set方法...}

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

package com.liugh.config;publicclassFunction{privateStringsqltype; privateStringfuncName; privateStringsql; privateObjectresultType; privateStringparameterType; //省略 get set方法}

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

packagecom.liugh.sqlSession;importjava.lang.reflect.Proxy;publicclassMySqlsession{privateExcutor excutor=newMyExcutor(); privateMyConfiguration myConfiguration =newMyConfiguration(); public<T>TselectOne(String statement,Object parameter){ returnexcutor.query(statement, parameter); } @SuppressWarnings("unchecked") public<T>TgetMapper(Class<T> clas){ //動態代理調用 return(T)Proxy.newProxyInstance(clas.getClassLoader(),newClass[]{clas}, newMyMapperProxy(myConfiguration,this)); } }

緊接著創建Excutor和實現類：

package com.liugh.sqlSession;publicinterfaceExcutor {public<T> T query(Stringstatement,Objectparameter); }

MyExcutor中封裝了JDBC的操作：

package com.liugh.sqlSession;importjava.sql.Connection;importjava.sql.PreparedStatement;importjava.sql.ResultSet;importjava.sql.SQLException;importcom.liugh.bean.User;publicclassMyExcutorimplementsExcutor{privateMyConfiguration xmlConfiguration =newMyConfiguration();@Override public<T> T query(Stringsql,Objectparameter) { Connection connection=getConnection(); ResultSetset=null; PreparedStatement pre =null; try{ pre = connection.prepareStatement(sql); //設置參數 pre.setString(1, parameter.toString()); set= pre.executeQuery(); User u=newUser(); //遍歷結果集 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(); } } returnnull; } privateConnection getConnection() { try{ Connection connection =xmlConfiguration.build("config.xml"); returnconnection; }catch(Exception e) { e.printStackTrace(); } returnnull; } }

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

package com.liugh.sqlSession;importjava.lang.reflect.InvocationHandler;importjava.lang.reflect.Method;importjava.util.List;importcom.liugh.config.Function;importcom.liugh.config.MapperBean;publicclassMyMapperProxyimplementsInvocationHandler{private MySqlsession mySqlsession; privateMyConfiguration myConfiguration; publicMyMapperProxy(MyConfiguration myConfiguration,MySqlsession mySqlsession) { this.myConfiguration=myConfiguration; this.mySqlsession=mySqlsession; } @Override publicObjectinvoke(Objectproxy, Method method,Object[] args) throws Throwable { MapperBean readMapper = myConfiguration.readMapper("UserMapper.xml"); //是否是xml文件對應的接口 if(!method.getDeclaringClass().getName().equals(readMapper.getInterfaceName())){ returnnull; } List<Function> list = readMapper.getList(); if(null!= list ||0!= list.size()){ for(Functionfunction:list){ //id是否和接口方法名一樣if(method.getName().equals(function.getFuncName())){ returnmySqlsession.selectOne(function.getSql(),String.valueOf(args[0])); } } }returnnull; }}

到這裡，就完成了自己的Mybatis框架，我們測試一下：

packagecom.liugh;importcom.liugh.bean.User;importcom.liugh.mapper.UserMapper;importcom.liugh.sqlSession.MySqlsession;publicclassTestMybatis{publicstaticvoidmain(String[] args){ MySqlsession sqlsession=newMySqlsession(); UserMapper mapper = sqlsession.getMapper(UserMapper.class); User user = mapper.getUserById("1"); System.out.println(user); }}

執行結果：

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

到這裡我們就大功告成了！