Node.js自研ORM框架深度解析與實踐

前言

在現代Web開發中，對象關系映射（ORM）框架扮演著至關重要的角色。它們為開發者提供了一層抽象，使得數據庫操作變得更加簡單和直觀。本文將深入解析一個基于Node.js和MySQL的自研ORM框架，該框架雖然輕量級，但功能完善，包含了連接池管理、查詢構建器、事務處理、字段驗證等核心功能。

項目概述

技術棧

運行環境: Node.js
數據庫: MySQL
核心依賴: mysql@2.18.1

項目結構

Node/
├── orm/                    # ORM核心模塊
│   ├── db.js              # 數據庫連接與事務處理
│   ├── dbSet.js           # 數據集操作（CRUD）
│   └── QueryBuilder.js    # SQL查詢構建器
├── entitys/               # 實體層
│   └── dbContext.js       # 數據庫上下文
├── dbtest.js              # 測試文件
└── package.json           # 項目配置

核心模塊深度解析

1. 數據庫連接層 (db.js)

數據庫連接層是整個ORM框架的基礎，負責管理MySQL連接池和事務處理。

核心特性

連接池管理: 使用mysql.createPool()創建連接池，提高性能
異步操作: 基于Promise封裝，支持async/await語法
事務支持: 完整的事務生命周期管理（開啟、提交、回滾）
錯誤處理: 完善的異常捕獲和處理機制

關鍵代碼解析

// 連接池初始化
function DbBase(options) {this.pool = mysql.createPool(options);
}// 核心查詢方法
DbBase.prototype.Run = async function (sql, params, conn) {if (conn) {// 使用指定連接（事務場景）return new Promise((resolve, reject) => {conn.query(sql, params, (err, result) => {if (err) {console.log(err);reject(err);} else {resolve(result);}});});} else {// 使用連接池return new Promise((resolve, reject) => {this.pool.query(sql, params, (err, result) => {if (err) {console.log(err);reject(err);} else {resolve(result);}});});}
};

事務處理機制

事務處理是這個ORM框架的亮點之一，實現了完整的事務生命周期：

DbBase.prototype.RunTransaction = async function (fn) {let connection;try {// 1. 獲取連接connection = await new Promise((resolve, reject) => {this.pool.getConnection((err, conn) => {if (err) reject(err);else resolve(conn);});});// 2. 開啟事務await new Promise((resolve, reject) => {connection.beginTransaction(err => {if (err) reject(err);else resolve();});});// 3. 執行業務邏輯const result = await fn(connection);// 4. 提交事務await new Promise((resolve, reject) => {connection.commit(err => {if (err) {connection.rollback(() => {reject(err);});} else {resolve(result);}});});return result;} catch (error) {// 5. 異常回滾if (connection) {await new Promise((resolve, reject) => {connection.rollback(() => {connection.release();reject(error);});});}} finally {// 6. 釋放連接if (connection) {connection.release();}}
};

2. 查詢構建器 (QueryBuilder.js)

查詢構建器采用鏈式調用模式，提供了靈活的SQL構建能力。

核心特性

鏈式調用: 支持method chaining模式
參數化查詢: 防SQL注入
分頁支持: 內置分頁功能
靈活的條件構建: 支持多種WHERE條件

使用示例

// 基礎查詢
const query = new QueryBuilder().select(['id', 'name', 'email']).from('users').where('status', 'active').where('age', '>', 18).orderBy('created_at', 'DESC').paginate(1, 10);const {sql, parameters} = query.build();

分頁功能實現

paginate(page, perPage) {if(page <= 1) page = 1;const offset = (page - 1) * perPage;return this.limit(offset, perPage);
}

3. 數據集操作層 (dbSet.js)

dbSet是ORM框架的核心，實現了完整的CRUD操作和數據驗證功能。

核心功能

CRUD操作: Create、Read、Update、Delete
字段驗證: 類型、長度、必填、默認值驗證
自動主鍵: 支持自增主鍵
視圖支持: 區分表和視圖的操作權限

字段定義與驗證

// 字段定義
dbSet.prototype.AddField = function (fieldName, fieldType, length = 0, required = false, isNull = true, defaultValue = null) {this.fields[fieldName] = { fieldName, fieldType, length, required, isNull, defaultValue };
}// 字段驗證邏輯
dbSet.prototype.FieldVerify = function (data) {Object.keys(this.fields).forEach(key => {var field = this.fields[key];var fieldValue = data[field.fieldName];// 必填驗證if (field.required && !(field.fieldName in data)) throw new Error(`必須包含字段'${field.fieldName}'`);// 默認值設置if (field.defaultValue != null && fieldValue == null) data[field.fieldName] = field.defaultValue;});// 類型驗證、長度驗證等...
};

CRUD操作實現

添加數據

dbSet.prototype.Add = async function (data, conn) {if (this.isview) {throw new Error(`視圖${this.tableName}不能添加數據`);}this.FieldVerify(data);var { keys, values, _values } = this.GetDataContent(data);var sql = `insert into \`${this.tableName}\`(${keys}) values(${_values})`;return new Promise((resolve, reject) => {this.db.Run(sql, values, conn).then(res => {resolve(res.insertId);}).catch(err => {reject(err);});});
}

查詢數據

dbSet.prototype.GetList = async function (query, conn) {var { sql, parameters } = query.build();return new Promise((resolve, reject) => {this.db.Run(sql, parameters, conn).then(res => {resolve(res);}).catch(err => {reject(err);})})
}

性能優化特性

連接復用查詢

dbSet.prototype.GetTable = async function(query) {// 使用同一個連接進行列表和計數查詢，節約連接池開銷let connection;try {connection = await new Promise((resolve, reject) => {this.db.pool.getConnection((err, conn) => {if (err) reject(err);else resolve(conn);});});var list = await this.GetList(query, connection);var count = await this.GetCount(query, connection);return {list, count};} finally {if (connection) connection.release();}
}

4. 數據庫上下文 (dbContext.js)

數據庫上下文是整個ORM框架的入口點，負責初始化數據庫連接和實體映射。

function dbContext() {// 數據庫連接配置this.db = new DbBase({host: '127.0.0.1',port: '3306',user: 'user',password: '123456',database: 'test'});// 實體映射this.test = new dbSet("test", this.db);this.test.AddField("name", "string", 3, true, false, "123456");
}

實戰測試案例

基礎CRUD操作測試

var dbContext = require('./entitys/dbContext');
var _db = new dbContext();// 添加數據
var res = await _db.test.Add({name: "測試用戶"
});
console.log("新增ID:", res);// 查詢數據
var query = _db.test.Query();
query.where("id", 5);
query.limit(100);
var result = await _db.test.GetTable(query);
console.log("查詢結果:", result);

事務操作測試

// 事務示例
await _db.db.RunTransaction(async (conn) => {// 在事務中執行多個操作var res1 = await _db.test.Add({name: "事務測試1"}, conn);var res2 = await _db.test.Add({name: "事務測試2"}, conn);// 如果任何操作失敗，整個事務會自動回滾
});