自己動(dòng)手寫(xiě)一個(gè)持久層框架

1. JDBC問(wèn)題分析

我們來(lái)看一段JDBC的代碼：

public?static?void?main(String[]?args)?{
????????Connection?connection?=?null;
????????PreparedStatement?preparedStatement?=?null;
????????ResultSet?resultSet?=?null;
????????try?{
????????????//1.?加載數(shù)據(jù)庫(kù)驅(qū)動(dòng)
????????????Class.forName("com.mysql.jdbc.Drive");
????????????//2.?通過(guò)驅(qū)動(dòng)管理類獲取數(shù)據(jù)庫(kù)鏈接
????????????connection?=?DriverManager.getConnection("jdbc:mysql://hocalhost:3306/mybatis?characterEncoding=utf-8",
????????????????????"root","root");
????????????//3. 定義SQL語(yǔ)句?？表示占位符
????????????String?sql?=?"SELECT?*?FROM?user?WHERE?username?=??";
????????????//4.?獲取預(yù)處理對(duì)象Statement
????????????preparedStatement?=?connection.prepareStatement(sql);
????????????//5.?設(shè)置參數(shù)，第一個(gè)參數(shù)為SQL語(yǔ)句中參數(shù)的序號(hào)（從1開(kāi)始），第二個(gè)參數(shù)為設(shè)置的參數(shù)值
????????????preparedStatement.setString(1,"tom");
????????????//6.?向數(shù)據(jù)庫(kù)發(fā)出SQL執(zhí)行查詢，查詢出結(jié)果集
????????????resultSet?=?preparedStatement.executeQuery();
????????????//7.?遍歷查詢結(jié)果集
????????????while?(resultSet.next()){
????????????????int?id?=?resultSet.getInt("id");
????????????????String?userName?=?resultSet.getString("username");
????????????????//封裝User
????????????????user.setId(id);
????????????????user.setUserName(userName);
????????????}
????????????System.out.println(user);
????????}?catch?(ClassNotFoundException?e)?{
????????????e.printStackTrace();
????????}?catch?(SQLException?throwables)?{
????????????throwables.printStackTrace();
????????}
????}

可以看到，直接使用JDBC開(kāi)發(fā)是存在一些問(wèn)題的，我們來(lái)分析下：

問(wèn)題分析：

1. 數(shù)據(jù)庫(kù)配置信息存在硬編碼問(wèn)題
2. 頻繁創(chuàng)建、釋放數(shù)據(jù)庫(kù)鏈接

//1.?加載數(shù)據(jù)庫(kù)驅(qū)動(dòng)
Class.forName("com.mysql.jdbc.Drive");
//2.?通過(guò)驅(qū)動(dòng)管理類獲取數(shù)據(jù)庫(kù)鏈接
connection?=?DriverManager.getConnection("jdbc:mysql://hocalhost:3306/mybatis?characterEncoding=utf-8","root","root");

1. sql語(yǔ)句、設(shè)置參數(shù)、獲取結(jié)果集均存在硬編碼問(wèn)題

//3. 定義SQL語(yǔ)句?？表示占位符
String?sql?=?"SELECT?*?FROM?user?WHERE?username?=??";
//4.?獲取預(yù)處理對(duì)象Statement
preparedStatement?=?connection.prepareStatement(sql);
//5.?設(shè)置參數(shù)，第一個(gè)參數(shù)為SQL語(yǔ)句中參數(shù)的序號(hào)（從1開(kāi)始），第二個(gè)參數(shù)為設(shè)置的參數(shù)值
?preparedStatement.setString(1,"tom");
?//6.?向數(shù)據(jù)庫(kù)發(fā)出SQL執(zhí)行查詢，查詢出結(jié)果集
?resultSet?=?preparedStatement.executeQuery();

??????int?id?=?resultSet.getInt("id");
??????String?userName?=?resultSet.getString("username");

1. 手動(dòng)封裝返回結(jié)果集 較為繁瑣

//7.?遍歷查詢結(jié)果集
while?(resultSet.next()){
????int?id?=?resultSet.getInt("id");
????String?userName?=?resultSet.getString("username");
????//封裝User
????user.setId(id);
????user.setUserName(userName);
?}
?System.out.println(user);

解決思路：

1. 寫(xiě)在配置文件中
2. 連接池（c3p0、dbcp、德魯伊...）
3. 配置文件 （和1放一起嗎？No，經(jīng)常變動(dòng)和不經(jīng)常變動(dòng)的不要放在一起）
4. 反射、內(nèi)省

下面根據(jù)這個(gè)解決思路，自己動(dòng)手寫(xiě)一個(gè)持久層框架，寫(xiě)框架之前分析這個(gè)框架需要做什么

2. 自定義框架思路分析

使用端（項(xiàng)目）：

1. 引入自定義持久層框架的jar包
2. 提供兩部分配置信息：

• 數(shù)據(jù)庫(kù)配置信息
• SQL配置信息(SQL語(yǔ)句)

1. 使用配置文件來(lái)提供這些信息：
1. sqlMapConfig.xml ：存放數(shù)據(jù)庫(kù)的配置信息
2. mapper.xml ：存放SQL配置信息

自定義持久層框架（工程）：

持久層框架的本質(zhì)就是對(duì)JDBC代碼進(jìn)行了封裝

1. 加載配置文件：根據(jù)配置文件的路徑加載配置文件成字節(jié)輸入流，存儲(chǔ)內(nèi)存中

   “

   Q：getResourceAsStearm方法需要執(zhí)行兩次分別加載sqlMapConfig額和mapper嗎？

   A：可以但沒(méi)必要，我們可以在sqlMapConfig.xml中寫(xiě)入mapper.xml的全路徑即可

   ”

1. 創(chuàng)建Resources類 方法：getResourceAsStream(String path)

2. 創(chuàng)建兩個(gè)javaBean：（容器對(duì)象）：存放的就是配置文件解析出來(lái)的內(nèi)容

1. Configuration：核心配置類：存放sqlMapConfig.xml解析出來(lái)的內(nèi)容
2. MappedStatement：映射配置類：存放mapper.xml解析出來(lái)的內(nèi)容

3. 解析配置文件：使用dom4j

1. 創(chuàng)建類：SqlSessionFactoryBuilder 方法：build(InputStream in) 這個(gè)流就是剛才存在內(nèi)存中的
2. 使用dom4j解析配置文件，將解析出來(lái)的內(nèi)容封裝到容器對(duì)象中
3. 創(chuàng)建SqlSessionFactory對(duì)象；生產(chǎn)sqlSession：會(huì)話對(duì)象（工廠模式 降低耦合，根據(jù)不同需求生產(chǎn)不同狀態(tài)的對(duì)象）

4. 創(chuàng)建sqlSessionFactory接口及實(shí)現(xiàn)類DefaultSqlSessionFactory

1. openSession(); 生產(chǎn)sqlSession

5. 創(chuàng)建SqlSession接口及實(shí)現(xiàn)類DefaultSession

1. selectList()
2. selectOne()
3. update()
4. delete()
5. ...
6. 定義對(duì)數(shù)據(jù)庫(kù)的CRUD操作，例如：

6. 創(chuàng)建Executor接口及實(shí)現(xiàn)類SimpleExecutor實(shí)現(xiàn)類

1. query(Configuration con,MappedStatement ms,Object ...param)；執(zhí)行JDBC代碼,Object ...param具體的參數(shù)值，可變參；

3. 創(chuàng)建表并編寫(xiě)測(cè)試類

SET?NAMES?utf8mb4;
SET?FOREIGN_KEY_CHECKS?=?0;

--?----------------------------
--?Table?structure?for?user
--?----------------------------
DROP?TABLE?IF?EXISTS?`user`;
CREATE?TABLE?`user`??(
??`id`?int(11)?NOT?NULL?AUTO_INCREMENT,
??`username`?varchar(50)?CHARACTER?SET?utf8?COLLATE?utf8_general_ci?NULL?DEFAULT?NULL,
??PRIMARY?KEY?(`id`)?USING?BTREE
)?ENGINE?=?InnoDB?AUTO_INCREMENT?=?4?CHARACTER?SET?=?utf8?COLLATE?=?utf8_general_ci?ROW_FORMAT?=?Dynamic;

--?----------------------------
--?Records?of?user
--?----------------------------
INSERT?INTO?`user`?VALUES?(1,?'lucy');
INSERT?INTO?`user`?VALUES?(2,?'tom');
INSERT?INTO?`user`?VALUES?(3,?'jack');

SET?FOREIGN_KEY_CHECKS?=?1;

1. 創(chuàng)建一個(gè)Maven項(xiàng)目—— Ipersistence_test

2. 在resource中創(chuàng)建sqlMapConfig.xml 和 UserMapper.xml

UserMapper.xml

<mapper?namespace="user">
????
????<select?id="selectList"?resultType="com.dxh.pojo.User">
????????select?*?from?user
????select>
????<select?id="selectOne"?resultType="com.dxh.pojo.User"?paramterType="com.dxh.pojo.User">
????????select?*?from?user?where?id?=?#{id}?and?username?=?#{userName}
????select>
mapper>

“

Q:為什么要有namespace和id ?A:當(dāng)一個(gè)*Mapper.xml中有多條sql時(shí)，無(wú)法區(qū)分具體是哪一條所以增加 id 如果有UserMapper.xml和ProductMapper.xml，假設(shè)他們的查詢的id都為”selectList“，那么將無(wú)法區(qū)分具體是查詢user還是查詢product的。所以增加 namespacenamespace.id 組成sql的唯一標(biāo)識(shí)，也稱為statementId

”

sqlMapConfig.xml

<configuration>
????
????<dataSource>
????????<property?name="driverClass"?value="com.mysql.jdbc.Driver">property>
????????<property?name="jdbcUrl"?value="jdbc:mysql:///zdy_mybatis">property>
????????<property?name="username"?value="root">property>
????????<property?name="password"?value="root">property>
????dataSource>
????
????<mapper?resource="UserMapper.xml">mapper>
configuration>

4. 開(kāi)始編寫(xiě)持久層框架

自定義持久層框架（工程）：

“

本質(zhì)就是對(duì)JDBC代碼進(jìn)行了封裝

1. 加載配置文件：根據(jù)配置文件的路徑加載配置文件成字節(jié)輸入流，存儲(chǔ)內(nèi)存中
1. 創(chuàng)建Resources類 方法：getResourceAsStream(String path)
2. 創(chuàng)建兩個(gè)javaBean：（容器對(duì)象）：存放的就是配置文件解析出來(lái)的內(nèi)容
1. Configuration：核心配置類：存放sqlMapConfig.xml解析出來(lái)的內(nèi)容
2. MappedStatement：映射配置類：存放mapper.xml解析出來(lái)的內(nèi)容
3. 解析配置文件：使用dom4j
1. 創(chuàng)建類：SqlSessionFactoryBuilder 方法：build(InputStream in) 這個(gè)流就是剛才存在內(nèi)存中的
2. 使用dom4j解析配置文件，將解析出來(lái)的內(nèi)容封裝到容器對(duì)象中
3. 創(chuàng)建SqlSessionFactory對(duì)象；生產(chǎn)sqlSession：會(huì)話對(duì)象（工廠模式 降低耦合，根據(jù)不同需求生產(chǎn)不同狀態(tài)的對(duì)象）
4. 創(chuàng)建sqlSessionFactory接口及實(shí)現(xiàn)類DefaultSqlSessionFactory
1. openSession(); 生產(chǎn)sqlSession
5. 創(chuàng)建SqlSession接口及實(shí)現(xiàn)類DefaultSession
1. 定義對(duì)數(shù)據(jù)庫(kù)的CRUD操作
6. 創(chuàng)建Executor接口及實(shí)現(xiàn)類SimpleExecutor實(shí)現(xiàn)類
1. query(Configuration con,MappedStatement ms,Object ...param)；執(zhí)行JDBC代碼,Object ...param具體的參數(shù)值，可變參；

”

我們之前已經(jīng)對(duì)持久層框架進(jìn)行了分析，需要做6部分組成，如下：

1. 加載配置文件

我們要把用戶端的配置文件成字節(jié)輸入流并存到內(nèi)存中：

新建Resource類，提供一個(gè)static InputStream getResourceAsStream(String path)方法，并返回inputstream

package?com.dxh.io;
import?java.io.InputStream;

public?class?Resource?{
????//根據(jù)配置文件的路徑，將配置文件加載成字節(jié)輸入流，存儲(chǔ)在內(nèi)存中
????public?static?InputStream?getResourceAsStream(String?path){
????????InputStream?resourceAsStream?=?Resource.class.getClassLoader().getResourceAsStream(path);
????????return?resourceAsStream;
????}
}

2. 創(chuàng)建JavaBean（容器對(duì)象）

之前我們說(shuō)到，要把解析出來(lái)的配置文件封裝成對(duì)象。

• MappedStatement (存放SQL信息)
• Configuration （存放數(shù)據(jù)庫(kù)配置信息）

//?MappedStatement，我們存放SQL的信息?
package?com.dxh.pojo;
public?class?MappedStatement?{
????//?id標(biāo)識(shí)
????private?String?id;
????//返回值類型
????private?String?resultType;
????//參數(shù)值類型
????private?String?paramterType;
????//sql語(yǔ)句
????private?String?sql;
????
??getset省略...
}

這里我們把封裝好的MappedStatement對(duì)象也放在Configuration中，同時(shí)我們不存放數(shù)據(jù)庫(kù)的url、username...了，直接存放DataSource

package?com.dxh.pojo;

import?javax.sql.DataSource;
import?java.util.HashMap;
import?java.util.Map;

public?class?Configuration?{
????private?DataSource?dataSource;
????/**
?????*?key?statementId??(就是namespace.id)
?????*?value:封裝好的MappedStatement對(duì)象
?????*/
????Map?mappedStatementMap?=?new?HashMap<>();
?
????getset省略...
}

3.解析xml文件

這一步我們解析兩個(gè)xml文件sqlMapConfig.xml、mapper.xml

我們首先把解析的過(guò)程封裝起來(lái)：新建XMLConfigBuild.java

package?com.dxh.config;

import?com.dxh.io.Resource;
import?com.dxh.pojo.Configuration;
import?com.mchange.v2.c3p0.ComboPooledDataSource;
import?org.dom4j.Document;
import?org.dom4j.DocumentException;
import?org.dom4j.Element;
import?org.dom4j.io.SAXReader;

import?java.beans.PropertyVetoException;
import?java.io.InputStream;
import?java.util.List;
import?java.util.Properties;

public?class?XMLConfigBuild?{
????private?Configuration?configuration;

????public?XMLConfigBuild()?{
????????this.configuration?=?new?Configuration();
????}

????/**
?????*?該方法就是將配置文件進(jìn)行解析(dom4j)，封裝Configuration
?????*/
????public?Configuration?parseConfig(InputStream?inputStream)?throws?DocumentException,?PropertyVetoException?{
????????Document?document?=?new?SAXReader().read(inputStream);
????????//
????????Element?rootElement?=?document.getRootElement();
????????List?list?=?rootElement.selectNodes("http://property");
????????Properties?properties?=?new?Properties();
????????for?(Element?element?:?list)?{
????????????String?name?=?element.attributeValue("name");
????????????String?value?=?element.attributeValue("value");
????????????properties.setProperty(name,value);
????????}
??//C3P0連接池
????????ComboPooledDataSource?comboPooledDataSource?=?new?ComboPooledDataSource();
????????comboPooledDataSource.setDriverClass(properties.getProperty("driverClass"));
????????comboPooledDataSource.setJdbcUrl(properties.getProperty("jdbcUrl"));
????????comboPooledDataSource.setUser(properties.getProperty("username"));
????????comboPooledDataSource.setPassword(properties.getProperty("password"));
????????configuration.setDataSource(comboPooledDataSource);

????????//mapper.xml解析?：拿到路徑--字節(jié)輸入流---dom4j解析
????????List?mapperList?=?rootElement.selectNodes("http://mapper");
????????for?(Element?element?:?mapperList)?{
????????????//拿到路徑
????????????String?mapperPath?=?element.attributeValue("resource");
????????????//字節(jié)輸入流
????????????InputStream?resourceAsStream?=?Resource.getResourceAsStream(mapperPath);
????????????//dom4j解析
????????????//??因?yàn)榻馕鐾瓿珊蟮腗appedStatement要放在Configuration里，所以傳入一個(gè)configuration進(jìn)去
????????????XMLMapperBuild?xmlMapperBuild?=?new?XMLMapperBuild(configuration);
????????????xmlMapperBuild.parse(resourceAsStream);
????????}
????????return?configuration;
????}
}

3.1 解析Mapper.xml文件：

package?com.dxh.config;

import?com.dxh.pojo.Configuration;
import?com.dxh.pojo.MappedStatement;
import?org.dom4j.Document;
import?org.dom4j.DocumentException;
import?org.dom4j.Element;
import?org.dom4j.io.SAXReader;

import?java.io.InputStream;
import?java.util.List;

public?class?XMLMapperBuild?{
????private?Configuration?configuration;

????public?XMLMapperBuild(Configuration?configuration)?{
????????this.configuration?=?configuration;
????}

????public?void?parse(InputStream?inputStream)?throws?DocumentException?{
????????Document?document?=?new?SAXReader().read(inputStream);
????????Element?rootElement?=?document.getRootElement();
????????String?namespace?=?rootElement.attributeValue("namespace");

????????List?list?=?rootElement.selectNodes("http://select");
????????for?(Element?element?:?list)?{
????????????String?id?=?element.attributeValue("id");
????????????String?resultType?=?element.attributeValue("resultType");
????????????String?paramterType?=?element.attributeValue("paramterType");
????????????String?sqlText?=?element.getTextTrim();
????????????MappedStatement?mappedStatement?=?new?MappedStatement();
????????????mappedStatement.setId(id);
????????????mappedStatement.setParamterType(paramterType);
????????????mappedStatement.setResultType(resultType);
????????????mappedStatement.setSql(sqlText);
????????????String?key?=?namespace+"."+id;
????????????configuration.getMappedStatementMap().put(key,mappedStatement);
????????}
????}
}

很容易理解，因?yàn)槲覀兘馕龊笠祷?code style>Configuration對(duì)象，所以我們需要聲明一個(gè)Configuration 并初始化。

我們把加載文件后的流傳入，通過(guò)dom4j解析，并通過(guò)ComboPooledDataSource（C3P0連接池）生成我們需要的DataSource，并存入Configuration對(duì)象中。

Mapper.xml解析方式同理。

3.2 創(chuàng)建SqlSessionFactoryBuilder類：有了上述兩個(gè)解析方法后，我們創(chuàng)建一個(gè)類，用來(lái)調(diào)用這個(gè)方法，同時(shí)這個(gè)類返回SqlSessionFacetory

SqlSessionFacetory：用來(lái)生產(chǎn)sqlSession：sqlSession就是會(huì)話對(duì)象（工廠模式 降低耦合，根據(jù)不同需求生產(chǎn)不同狀態(tài)的對(duì)象）

package?com.dxh.sqlSession;

import?com.dxh.config.XMLConfigBuild;
import?com.dxh.pojo.Configuration;
import?org.dom4j.DocumentException;

import?java.beans.PropertyVetoException;
import?java.io.InputStream;

public?class?SqlSessionFacetoryBuild?{
????public?SqlSessionFacetory?build(InputStream?in)?throws?DocumentException,?PropertyVetoException?{
????????//1.?使用dom4j解析配置文件，將解析出來(lái)的內(nèi)容封裝到configuration中
????????XMLConfigBuild?xmlConfigBuild?=?new?XMLConfigBuild();
????????Configuration?configuration?=?xmlConfigBuild.parseConfig(in);

????????//2. 創(chuàng)建sqlSessionFactory對(duì)象?工廠類：生產(chǎn)sqlSession：會(huì)話對(duì)象，與數(shù)據(jù)庫(kù)交互的增刪改查都封裝在sqlSession中
????????DefaultSqlSessionFactory?sqlSessionFacetory?=?new?DefaultSqlSessionFactory(configuration);
????????return?sqlSessionFacetory;
????}

}

4. 創(chuàng)建SqlSessionFacetory接口和實(shí)現(xiàn)類

基于開(kāi)閉原則我們創(chuàng)建SqlSessionFacetory接口和實(shí)現(xiàn)類DefaultSqlSessionFactory

接口中我們定義openSession()方法，用于生產(chǎn)SqlSession

package?com.dxh.sqlSession;

public?interface?SqlSessionFacetory?{
????public?SqlSession?openSession();
}
package?com.dxh.sqlSession;
import?com.dxh.pojo.Configuration;

public?class?DefaultSqlSessionFactory?implements?SqlSessionFacetory{
????private?Configuration?configuration;

????public?DefaultSqlSessionFactory(Configuration?configuration)?{
????????this.configuration?=?configuration;
????}

????@Override
????public?SqlSession?openSession()?{
????????return?new?DefaultSqlSession(configuration);
????}
}

同樣我們?cè)?code style>DefaultSqlSessionFactory中傳入Configuration，Configuration需要我們一直往下傳遞

5.創(chuàng)建SqlSession接口以及它的實(shí)現(xiàn)類

在接口中，我定義兩個(gè)方法：

因?yàn)閰?shù)類型和個(gè)數(shù)我們都不知道，所以我們使用泛型，同時(shí)，傳入statementId（namespace、. 、id 組成）

package?com.dxh.sqlSession;
import?java.util.List;

public?interface?SqlSession?{
????//查詢多條
????public??List?selectList(String?statementId,Object...?params)?throws?Exception;
????//根據(jù)條件查詢單個(gè)
????public??T?selectOne(String?statementId,Object...?params)?throws?Exception;
}
package?com.dxh.sqlSession;
import?com.dxh.pojo.Configuration;
import?java.util.List;

public?class?DefaultSqlSession?implements?SqlSession?{
????private?Configuration?configuration;

????public?DefaultSqlSession(Configuration?configuration)?{
????????this.configuration?=?configuration;
????}

????@Override
????public??List?selectList(String?statementId,?Object...?params)?throws?Exception?{
????????//將要完成對(duì)simpleExecutor里的query方法調(diào)用
????????SimpleExecutor?simpleExecutor?=?new?SimpleExecutor();
????????List