自己動手寫一個持久層框架
阿新 • • 發佈：2020-11-10
[TOC]
## 0. 前言 and Flag
不得不說我又買課了，之前買課都花了大幾百了，但是這次又沒躲過去。買了拉鉤教育的【**java高薪訓練營**】。主要看到那個課程目錄有點牛逼，基本上把我聽說過的技術都包括了，不過真假不太確定，之後就是知乎百度谷歌一頓搜尋，沒查到什麼負面資訊，B站也有一部分視訊，我看了幾節，不錯。加上**拉鉤**的背書，所以半信半疑的就報名了。
我這是第十期，11月5號開班的，課程的第一模組是講mybatis，所以剛開始講了一個簡單的持久層框架該怎麼寫 （也就是下面我做的這些筆記），這一部分確實讓我茅塞頓開，例如框架是如可讀取配置檔案的，為什麼我們只需要呼叫dao層的介面就能夠執行sql、**Mapper.xml中為什麼要有namespace，namespace和id為什麼要與被呼叫方法所在類的全類名和方法名一致。一下子就通了，原來如此簡單~ 在使用mybatis的時候有一些不明所以的必要步驟也知道為什麼如此了。
這才是任務一，這周還要完成兩個任務————mybatis使用方式回顧、原始碼分析。重頭戲馬上到來有點期待。
**當一個技術人"知其所以然"了一個使用好久但"不知其所以然"的技術，然後脫口而出的“原來如此”時那種喜悅感！完全不亞於5殺逆風翻盤把？**
**最後立個Flag，今後每週都會把我在java高薪訓練營的學習筆記發表上來，風雨無阻！**
## 1. JDBC問題分析
我們來看一段JDBC的程式碼：
``` java
public static void main(String[] args) {
Connection connection = null;
PreparedStatement preparedStatement = null;
ResultSet resultSet = null;
try {
//1. 載入資料庫驅動
Class.forName("com.mysql.jdbc.Drive");
//2. 通過驅動管理類獲取資料庫連結
connection = DriverManager.getConnection("jdbc:mysql://hocalhost:3306/mybatis?characterEncoding=utf-8",
"root","root");
//3. 定義SQL語句 ？表示佔位符
String sql = "SELECT * FROM user WHERE username = ?";
//4. 獲取預處理物件Statement
preparedStatement = connection.prepareStatement(sql);
//5. 設定引數，第一個引數為SQL語句中引數的序號（從1開始），第二個引數為設定的引數值
preparedStatement.setString(1,"tom");
//6. 向資料庫發出SQL執行查詢，查詢出結果集
resultSet = preparedStatement.executeQuery();
//7. 遍歷查詢結果集
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開發是存在一些問題的，我們來分析下：
### 問題分析：
1. 資料庫配置資訊存在**硬編碼**問題
2. 頻繁建立、釋放資料庫連結
``` java
//1. 載入資料庫驅動
Class.forName("com.mysql.jdbc.Drive");
//2. 通過驅動管理類獲取資料庫連結
connection = DriverManager.getConnection("jdbc:mysql://hocalhost:3306/mybatis?characterEncoding=utf-8","root","root");
```
3. sql語句、設定引數、獲取結果集均存在硬編碼問題
``` java
//3. 定義SQL語句 ？表示佔位符
String sql = "SELECT * FROM user WHERE username = ?";
//4. 獲取預處理物件Statement
preparedStatement = connection.prepareStatement(sql);
//5. 設定引數，第一個引數為SQL語句中引數的序號（從1開始），第二個引數為設定的引數值
preparedStatement.setString(1,"tom");
//6. 向資料庫發出SQL執行查詢，查詢出結果集
resultSet = preparedStatement.executeQuery();
int id = resultSet.getInt("id");
String userName = resultSet.getString("username");
```
4. 手動封裝返回結果集 較為繁瑣
``` java
//7. 遍歷查詢結果集
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. 寫在配置檔案中
2. 連線池（c3p0、dbcp、德魯伊...）
3. 配置檔案 （和1放一起嗎？ No，經常變動和不經常變動的不要放在一起）
4. 反射、內省
下面根據這個解決思路，自己動手寫一個持久層框架，寫框架之前分析這個框架需要做什麼
---
## 2. 自定義框架思路分析
### 使用端（專案）：
1. 引入自定義持久層框架的jar包
2. 提供兩部分配置資訊：
- 資料庫配置資訊
- SQL配置資訊(SQL語句)
3. 使用配置檔案來提供這些資訊：
1. sqlMapConfig.xml ：存放資料庫的配置資訊
2. mapper.xml ：存放SQL配置資訊
### 自定義持久層框架（工程）：
**持久層框架的本質就是對JDBC程式碼進行了封裝**
1. 載入配置檔案：根據配置檔案的路徑載入配置檔案成位元組輸入流，儲存記憶體中
1. 建立Resources類 方法：getResourceAsStream(String path)
> Q： getResourceAsStearm方法需要執行兩次分別載入sqlMapConfig額和mapper嗎？
>
> A：可以但沒必要，我們可以在sqlMapConfig.xml中寫入mapper.xml的全路徑即可
2. 建立兩個javaBean：（容器物件）：存放的就是配置檔案解析出來的內容
1. Configuration：核心配置類：存放sqlMapConfig.xml解析出來的內容
2. MappedStatement：對映配置類：存放mapper.xml解析出來的內容
3. 解析配置檔案：使用dom4j
1. 建立類：SqlSessionFactoryBuilder 方法：build(InputStream in) 這個流就是剛才存在記憶體中的
2. 使用dom4j解析配置檔案，將解析出來的內容封裝到容器物件中
3. 建立SqlSessionFactory物件；生產sqlSession：會話物件（**工廠模式** 降低耦合，根據不同需求生產不同狀態的物件）
4. 建立sqlSessionFactory介面及實現類DefaultSqlSessionFactory
1. openSession(); 生產sqlSession
5. 建立SqlSession介面及實現類DefaultSession
1. 定義對資料庫的CRUD操作，例如：
1. selectList()
2. selectOne()
3. update()
4. delete()
5. ...
6. 建立Executor介面及實現類SimpleExecutor實現類
1. query(Configuration con,MappedStatement ms,Object ...param)；執行JDBC程式碼,`Object ...param`具體的引數值，可變參；
---
## 3. 建立表並編寫測試類
``` sql
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. 建立一個Maven專案—— Ipersistence_test
### 2. 在resource中建立sqlMapConfig.xml 和 UserMapper.xml
UserMapper.xml
``` xml
```
---
## 4. 開始編寫持久層框架
### 自定義持久層框架（工程）：
> 本質就是對JDBC程式碼進行了封裝
>
> 1. 載入配置檔案：根據配置檔案的路徑載入配置檔案成位元組輸入流，儲存記憶體中
>
> 1. 建立Resources類 方法：getResourceAsStream(String path)
>
> 2. 建立兩個javaBean：（容器物件）：存放的就是配置檔案解析出來的內容
> 1. Configuration：核心配置類：存放sqlMapConfig.xml解析出來的內容
> 2. MappedStatement：對映配置類：存放mapper.xml解析出來的內容
> mappedStatementMap = new HashMap<>();
getset省略...
}
```
### 3.解析xml檔案
這一步我們解析兩個xml檔案`sqlMapConfig.xml`、`mapper.xml`
我們首先把解析的過程封裝起來：新建`XMLConfigBuild.java`
``` 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();
}
/**
* 該方法就是將配置檔案進行解析(dom4j)，封裝Configuration
*/
public Configuration parseConfig(InputStream inputStream) throws DocumentException, PropertyVetoException {
Document document = new SAXReader().read(inputStream);
//
Element rootElement = document.getRootElement();
List list = rootElement.selectNodes("//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解析 ：拿到路徑--位元組輸入流---dom4j解析
List mapperList = rootElement.selectNodes("//mapper");
for (Element element : mapperList) {
//拿到路徑
String mapperPath = element.attributeValue("resource");
//位元組輸入流
InputStream resourceAsStream = Resource.getResourceAsStream(mapperPath);
//dom4j解析
// 因為解析完成後的MappedStatement要放在Configuration裡，所以傳入一個configuration進去
XMLMapperBuild xmlMapperBuild = new XMLMapperBuild(configuration);
xmlMapperBuild.parse(resourceAsStream);
}
return configuration;
}
}
```
**3.1 解析Mapper.xml檔案**：
```java
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("//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);
}
}
}
```
很容易理解，因為我們解析後要返回`Configuration`物件，所以我們需要宣告一個Configuration 並初始化。
我們把載入檔案後的流傳入，通過dom4j解析，並通過`ComboPooledDataSource`（C3P0連線池）生成我們需要的`DataSource`，並存入Configuration物件中。
Mapper.xml解析方式同理。
**3.2 建立SqlSessionFactoryBuilder類：**
有了上述兩個解析方法後，我們建立一個類，用來呼叫這個方法，同時這個類返回`SqlSessionFacetory`
SqlSessionFacetory：用來生產sqlSession：sqlSession就是會話物件（**工廠模式** 降低耦合，根據不同需求生產不同狀態的物件）
```java
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解析配置檔案，將解析出來的內容封裝到configuration中
XMLConfigBuild xmlConfigBuild = new XMLConfigBuild();
Configuration configuration = xmlConfigBuild.parseConfig(in);
//2. 建立sqlSessionFactory物件 工廠類：生產sqlSession：會話物件，與資料庫互動的增刪改查都封裝在sqlSession中
DefaultSqlSessionFactory sqlSessionFacetory = new DefaultSqlSessionFactory(configuration);
return sqlSessionFacetory;
}
}
```
### 4. 建立SqlSessionFacetory介面和實現類
基於開閉原則我們建立SqlSessionFacetory介面和實現類DefaultSqlSessionFactory
介面中我們定義`openSession()`方法，用於生產`SqlSession`
``` java
package com.dxh.sqlSession;
public interface SqlSessionFacetory {
public SqlSession openSession();
}
```
``` java
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);
}
}
```
同樣我們在`DefaultSqlSessionFactory`中傳入`Configuration`，Configuration需要我們一直往下傳遞
### 5.建立SqlSession介面以及它的實現類
在介面中，我定義兩個方法：
因為引數型別和個數我們都不知道，所以我們使用泛型，同時，傳入`statementId`（namespace、. 、id 組成）
``` java
package com.dxh.sqlSession;
import java.util.List;
public interface SqlSession {
//查詢多條
public List selectList(String statementId,Object... params) throws Exception;
//根據條件查詢單個
public T selectOne(String statementId,Object... params) throws Exception;
}
```
``` java
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 {
//將要完成對simpleExecutor裡的query方法呼叫
SimpleExecutor simpleExecutor = new SimpleExecutor();
List