关于c++:通用ORM的设计与实现

介绍

咱们通用的 ORM，基本模式都是想要脱离数据库的，简直都在编程语言层面建设模型，由程序去与数据库打交道。尽管脱离了数据库的具体操作，但咱们要建设各种模型文档，用代码去写表之间的关系等等操作，让初学者一时如坠云雾。我的想法是，将关系数据库领有的欠缺设计工具之劣势，来实现数据设计以提供构造信息，让 json 对象主动映射成为规范的 SQL 查问语句。只有咱们了解了规范的 SQL 语言，咱们就可能实现数据库查问操作。

依赖关系

本我的项目依赖 自己的 另一个我的项目 Zjson，此我的项目提供简洁、不便、高效的 Json 库。该库使用方便，是一个单文件库，只须要下载并引入我的项目即可。具体信息请移步 gitee-Zjson 或 github-Zjson。

设计思路

ZORM 数据传递采纳 json 来实现，使数据规范能从最前端到最初端达到谐和对立。此我的项目指标，岂但在要 C ++ 中应用，还要作为动态链接库与 node.js 联合用应用，因而心愿能像 javascript 一样，简洁不便的操作 json。所以后行建设了 zjson 库，作为此我的项目的后行我的项目。设计了数据库通用操作接口，实现与底层实现数据库的拆散。该接口提供了 CURD 规范拜访，以及批量插入和事务操作，根本能满足平时百分之九十以上的数据库操作。我的项目根本指标，反对 Sqlite3,Mysql,Postges 三种关系数据库，同时反对 windows、linux 和 macOS。

我的项目进度

当初曾经实现了 sqlit3 与 mysql 的所有性能，postgres 也做了技术筹备。
我抉择的技术实现形式，基本上是最底层高效的形式。sqlit3 – sqllit3.h（官网的规范 c 接口）；mysql – c api（MySQL Connector C 6.1）；postgres – pqxx。

工作列表：

• [x] Sqlite3 实现

  • [x] linux
  • [x] windows
  • [x] macos

• [x] Mysql 实现

  • [x] linux
  • [x] windows
  • [x] macos

• [] Pstgre 实现

  • [] linux
  • [] windows
  • [] macos

数据库通用接口

利用类间接操作这个通用接口，实现与底层实现数据库的拆散。该接口提供了 CURD 规范拜访，以及批量插入和事务操作，根本能满足平时百分之九十以上的数据库操作。

  class ZORM_API Idb
  {
  public:
      virtual Json select(string tablename, Json& params, vector<string> fields = vector<string>(), Json values = Json(JsonType::Array)) = 0;
      virtual Json create(string tablename, Json& params) = 0;
      virtual Json update(string tablename, Json& params) = 0;
      virtual Json remove(string tablename, Json& params) = 0;
      virtual Json querySql(string sql, Json params = Json(), Json values = Json(JsonType::Array), vector<string> fields = vector<string>()) = 0;
      virtual Json execSql(string sql, Json params = Json(), Json values = Json(JsonType::Array)) = 0;
      virtual Json insertBatch(string tablename, Json& elements, string constraint = "id") = 0;
      virtual Json transGo(Json& sqls, bool isAsync = false) = 0;
  };

实例结构

全局查问开关变量：

• DbLogClose : sql 查问语句显示开关
• parameterized : 是否应用参数化查问

Sqlite3:

    Json options;
    options.addSubitem("connString", "./db.db");    // 数据库地位
    options.addSubitem("DbLogClose", false);        // 显示查问语句
    options.addSubitem("parameterized", false);     // 不应用参数化查问
    DbBase* db = new DbBase("sqlite3", options);

Mysql:

    Json options;
    options.addSubitem("db_host", "192.168.6.6");   //mysql 服务 IP
    options.addSubitem("db_port", 3306);            // 端口
    options.addSubitem("db_name", "dbtest");        // 数据库名称
    options.addSubitem("db_user", "root");          // 注销用户名
    options.addSubitem("db_pass", "123456");        // 明码
    options.addSubitem("db_char", "utf8mb4");       // 连贯字符设定 [可选]
    options.addSubitem("db_conn", 5);               // 连接池配置 [可选]，默认为 2
    options.addSubitem("DbLogClose", true);         // 不显示查问语句
    options.addSubitem("parameterized", true);      // 应用参数化查问
    DbBase* db = new DbBase("mysql", options);

智能查问形式设计

查问保留字：page, size, sort, fuzzy, lks, ins, ors, count, sum, group

• page, size, sort, 分页排序
  在 sqlit3 与 mysql 中这比拟好实现，limit 来分页是很不便的，排序只需将参数间接拼接到 order by 后就好了。
  查问示例：

  Json p;
  p.addSubitem("page", 1);
  p.addSubitem("size", 10);
  p.addSubitem("size", "sort desc");
  (new DbBase(...))->select("users", p);
  
  生成 sql：SELECT * FROM users  ORDER BY age desc LIMIT 0,10

• fuzzy, 含糊查问切换参数，不提供时为准确匹配
  提供字段查问的准确匹配与含糊匹配的切换。

  Json p;
  p.addSubitem("username", "john");
  p.addSubitem("password", "123");
  p.addSubitem("fuzzy", 1);
  (new DbBase(...))->select("users", p);
   
  生成 sql：SELECT * FROM users  WHERE username like '%john%'  and password like '%123%'

• ins, lks, ors
  这是最重要的三种查问形式，如何找出它们之间的共同点，缩小冗余代码是要害。

  • ins, 数据库表单字段 in 查问，一字段对多个值，例：
    查问示例：

    Json p;
    p.addSubitem("ins", "age,11,22,36");
    (new DbBase(...))->select("users", p);
    
    生成 sql：SELECT * FROM users  WHERE age in (11,22,26)

  • ors, 数据库表多字段准确查问，or 连贯，多个字段对多个值，例：
    查问示例：

    Json p;
    p.addSubitem("ors", "age,11,age,36");
    (new DbBase(...))->select("users", p);
    
    生成 sql：SELECT * FROM users  WHERE  (age = 11  or age = 26)

  • lks, 数据库表多字段含糊查问，or 连贯，多个字段对多个值，例：
    查问示例：

    Json p;
    p.addSubitem("lks", "username,john,password,123");
    (new DbBase(...))->select("users", p);
    
    生成 sql：SELECT * FROM users  WHERE  (username like '%john%'  or password like '%123%')

• count, sum
  这两个统计求和，解决形式也相似，查问时个别要配合 group 与 fields 应用。

  • count, 数据库查问函数 count，行统计，例：
    查问示例：

    Json p;
    p.addSubitem("count", "1,total");
    (new DbBase(...))->select("users", p);
    
    生成 sql：SELECT *,count(1) as total  FROM users

  • sum, 数据库查问函数 sum，字段求和，例：
    查问示例：

    Json p;
    p.addSubitem("sum", "age,ageSum");
    (new DbBase(...))->select("users", p);
    
    生成 sql：SELECT username,sum(age) as ageSum  FROM users

• group, 数据库分组函数 group，例：
  查问示例：

  Json p;
  p.addSubitem("group", "age");
  (new DbBase(...))->select("users", p);
  
  生成 sql：SELECT * FROM users  GROUP BY age

不等操作符查问反对

反对的不等操作符有：>, >=, <, <=, <>, =；逗号符为分隔符，一个字段反对一或二个操作。
非凡处：应用 ”=” 能够使某个字段跳过 search 影响，让含糊匹配与准确匹配同时呈现在一个查问语句中

• 一个字段一个操作，示例：
  查问示例：

  Json p;
  p.addSubitem("age", ">,10");
  (new DbBase(...))->select("users", p);
  
  生成 sql：SELECT * FROM users  WHERE age> 10

• 一个字段二个操作，示例：
  查问示例：

  Json p;
  p.addSubitem("age", ">=,10,<=,33");
  (new DbBase(...))->select("users", p);
  
  生成 sql：SELECT * FROM users  WHERE age>= 10 and age<= 33

• 应用 ”=” 去除字段的 fuzzy 影响，示例：
  查问示例：

  Json p;
  p.addSubitem("age", "=,18");
  p.addSubitem("username", "john");
  p.addSubitem("fuzzy", "1");
  (new DbBase(...))->select("users", p);
  
  生成 sql：SELECT * FROM users  WHERE age= 18  and username like '%john%'

  具体应用办法，请参看 uint test。

单元测试

有残缺性能的单元测试用例，请参见 tests 目录下的测试用例。

测试用例运行后果样例

我的项目地址

https://gitee.com/zhoutk/zorm
或
https://github.com/zhoutk/zorm

运行办法

该我的项目在 vs2019, gcc7.5, clang12.0 下均编译运行失常。

git clone https://github.com/zhoutk/zorm
cd zorm
cmake -Bbuild .

---windows
cd build && cmake --build .

---linux & macos
cd build && make

run zorm or ctest

注在 linux 下须要后行装置 mysql 开发库, 并先手动建设数据库 dbtest。
在 ubuntu 下的命令是：apt install libmysqlclient-dev

相干我的项目

会有一系列我的项目出炉，网络服务相干，敬请期待 …

gitee-Zjson
github-Zjson