uni-conf-orm

***simple-opm：多数据库配置化 ORM 框架（设计与实践） 一、核心设计思路 simple-opm 的设计围绕 "解耦、通用、灵活" 三大原则，核心思路包括： 彻底 Web 框架解耦核心逻辑（参数解析、SQL 生成、数据库操作）不依赖任何 Web 框架，通过标准化参数接口（RequestParams）接收来自 HTTP 请求、CLI、测试用例等任意来源的参数，实现跨环境复用。 配置驱动开发通过 APIKey 关联实体配置（表结构、参数映射、数据库连接等），将数据操作逻辑从代码转移到配置，避免重复编写 CRUD 代码，降低维护成本。 多数据库自适应采用驱动模式支持 MySQL、MSSQL、SQLite 等数据库，每种数据库按需实现连接池（或单连接）管理，上层逻辑无需关心底层数据库差异。 分层架构设计 核心层：配置管理、参数解析、SQL 构建、数据操作 适配层：Web 框架适配器（如 Express），负责参数转换 驱动层：数据库驱动，封装连接与查询逻辑 工具层：认证、类型处理等通用工具 二、核心功能 多数据库与实例管理 支持 MySQL（连接池）、MSSQL（连接池）、SQLite（单连接）等数据库 可配置多实例（如 MySQL 主库 / 从库），实体通过dbDrive动态选择目标数据库 参数自动处理 接收路径、查询、体等多来源参数，自动映射到 SQL 参数 基于 Joi 的参数验证，支持自定义校验规则 SQL 自动生成 根据配置自动生成列表查询、分页、新增、修改等 SQL 支持条件拼接、排序、字段过滤等常用操作 Web 开发极致简化 仅需定义少量路由（如列表、分页、修改），即可覆盖绝大多数 CRUD 场景 路由与业务逻辑解耦，新增表或接口无需编写新路由，仅需扩展sqlConfig配置 安全与性能优化 基于签名的请求认证（防篡改）+ Redis 频率限制（防滥用） 数据库连接池复用（MySQL/MSSQL），减少连接开销 跨环境兼容 核心逻辑无 Web 依赖，可在 Express/Koa 等 Web 环境或 CLI / 测试脚本中使用 三、使用场景 Web 应用快速开发通过配置生成 RESTful API，仅需 3-5 行路由代码即可覆盖一个表的全套 CRUD 操作，开发者专注于sqlConfig配置，无需重复编写控制器和 SQL。 多数据库协同操作同一应用中同时操作 MySQL（用户数据）、MSSQL（订单数据）、SQLite（本地配置），框架自动处理差异。 读写分离架构读操作路由到 MySQL 从库，写操作路由到主库，通过 APIKey 配置区分，无需代码侵入。 非 Web 环境数据处理在 CLI 工具、定时任务、单元测试中直接调用框架核心，统一数据操作逻辑。 快速原型验证通过配置快速生成数据接口，验证业务逻辑，减少重复编码工作。 四、优势与灵活性 优势 说明 Web 开发效率激增 仅需定义少量通用路由（如列表、分页、修改），即可支撑多表 CRUD 操作；新增功能时无需编写路由和控制器，仅需扩展sqlConfig，减少 80% 以上重复劳动 环境无关性 核心逻辑不依赖 Web 框架，一次开发可在 Web/CLI/ 测试等场景复用 配置即代码 实体配置集中管理，修改表结构或参数规则无需改代码，重启即可生效 多数据库无缝切换 同一实体通过修改dbDrive配置，可在 MySQL/MSSQL 等数据库间切换 可扩展性 支持自定义数据库驱动（如 PostgreSQL）和 Web 适配器（如 Koa） 安全可控 签名认证防止参数篡改，频率限制保护数据库，参数验证避免注入风险 性能优化 连接池复用减少数据库连接开销，适配不同数据库的性能特性（如 SQLite 单连接） 五、使用举例 示例 1：初始化多数据库配置 javascript 运行 // opm-config.js import { configManager, Joi } from 'simple-opm';

configManager.init({ // 数据库配置（多类型+多实例） dbConfigs: { mysql: { primary: { // 主库（写） host: 'localhost', user: 'root', password: '123456', database: 'app_db', pool: { connectionLimit: 20 } // 连接池配置 }, slave: { // 从库（读） host: 'slave-host', user: 'read_user', database: 'app_db', pool: { connectionLimit: 50 } } }, sqlite: { local: { filename: './local-data.db' } // SQLite文件 } },

// 实体配置（APIKey映射） sqlConfigs: { // 用户表（读操作，使用MySQL从库） user_read: { tableName: 'users', dbDrive: { drive: 'mysql', host: 'slave' }, requireAuth: true, secretKey: 'user_read_sk_123', // 签名密钥 field: 'id, username, email', conditionSchema: { keyword: { fields: ['username', 'email'], operator: 'like' } } }, // 本地配置表（使用SQLite） local_config: { tableName: 'configs', dbDrive: { drive: 'sqlite', host: 'local' }, mutableFields: ['key', 'value'] } } }); 示例 2：Web 环境使用（Express，极少路由覆盖多表操作） javascript 运行 // app.js（仅需3行路由，支撑所有表的CRUD） import express from 'express'; import { ExpressAdapter } from 'simple-opm'; import './opm-config.js';

const app = express(); app.use(express.json());

// 创建适配器 const opmAdapter = new ExpressAdapter();

// 仅需3条路由，即可覆盖所有实体的列表、分页、修改操作 app.get('/api/list/:apikey', opmAdapter.createHandler('list')); // 列表查询 app.get('/api/page/:apikey', opmAdapter.createHandler('page')); // 分页查询 app.post('/api/modify/:apikey', opmAdapter.createHandler('modify')); // 新增/修改

app.listen(3000, () => { console.log('服务启动于 http://localhost:3000'); }); 新增表时无需修改路由：若需添加 “商品表” 接口，仅需在sqlConfigs中新增配置： javascript 运行 // opm-config.js 中新增 sqlConfigs: { // ... 原有配置 product_read: { tableName: 'products', dbDrive: { drive: 'mysql', host: 'slave' }, field: 'id, name, price', conditionSchema: { name: { fields: ['name'], operator: 'like' } } } } 直接通过/api/page/product_read即可访问商品分页接口，无需修改app.js。 示例 3：非 Web 环境使用（CLI） javascript 运行 // cli-script.js import { OPMProcessor } from 'simple-opm'; import './opm-config.js';

// 初始化处理器 const processor = new OPMProcessor();

// 新增本地配置（使用SQLite） async function addLocalConfig() { const result = await processor.process({ apiKey: 'local_config', // 对应SQLite配置 operation: 'modify', // 新增/修改操作 params: { body: { key: 'theme', value: 'dark' } // 体参数 }, auth: { signature: 'valid_signature', // 签名 auditParams: { timestamp: '1698000000' } } });

console.log('新增结果:', result); // 输出: { success: true, code: 0, affectedRows: 1, insertId: 1 } }

addLocalConfig(); 示例 4：多数据库切换与读写分离 javascript 运行 // 读操作（MySQL从库） const readResult = await processor.process({ apiKey: 'user_read', operation: 'page', params: { query: { keyword: 'admin' } } });

// 写操作（MySQL主库，假设存在user_write配置） const writeResult = await processor.process({ apiKey: 'user_write', operation: 'modify', params: { body: { username: 'newadmin', email: '[e-mail]' } } });

// 本地配置操作（SQLite） const localResult = await processor.process({ apiKey: 'local_config', operation: 'list' }); 示例 5：签名认证实现（客户端） javascript 运行 // 生成签名（客户端代码） import { createHash } from 'crypto';

// 1. 准备审计参数 const auditParams = { timestamp: Math.floor(Date.now() / 1000), // 秒级时间戳 clientId: 'web-client-1' };

// 2. 按key排序并拼接 const sortedParams = Object.entries(auditParams) .sort(([k1], [k2]) => k1.localeCompare(k2)) .map(([k, v]) => ${k}=${v}) .join('&');

// 3. 拼接APIKey的secretKey（与配置一致） const secretKey = 'user_read_sk_123'; const signStr = ${sortedParams}${secretKey};

// 4. 生成SHA256签名 const signature = createHash('sha256').update(signStr).digest('hex');

// 发送请求时携带：?timestamp=xxx&clientId=xxx&signature=xxx 六、总结 simple-opm 通过 配置驱动 和 解耦设计，实现了数据操作层的高度复用与灵活扩展。其核心价值在于： Web 开发效率革命：少量路由覆盖多表 CRUD，开发者仅需专注sqlConfig配置，告别重复的控制器与 SQL 编写工作 跨环境复用：一套代码可在 Web、CLI 等多环境运行，多数据库切换仅需修改配置 内置安全与性能优化，满足企业级应用需求 无论是快速开发原型、构建多数据库协同系统，还是实现读写分离架构，simple-opm 都能显著降低开发复杂度，让开发者聚焦业务逻辑而非重复劳动。