微信移动端数据库组件 WCDB 系列:WINQ原理篇(三)

背景

高效、完整、易用是WCDB的基本原则。前几篇文章分享了WCDB的基本用法和修复工具,接下来将更深入地聊聊WCDB在易用性上的思考和实践。

对于各类客户端数据库,似乎都绕不开拼接字符串这一步。即便在Realm这样的NoSQL的数据库中,在进行查询时,也依赖于字符串的语法:

别看小小的字符串拼接,带来的麻烦可不小:

  • 代码冗余。为了拼接出匹配的SQL语句,业务层往往要写许多胶水代码来format字符串。这些代码冗长且没有什么“营养”。
  • 难以查错。对于编译器而言,SQL只是一个字符串。这就意味着即便你只写错了一个字母,也得在代码run起来之后,通过log或断点才能发现错误。倘若SQL所在的代码文件依赖较多,即使改正一个敲错的字母,就得将整个工程重新编译一遍,简直是浪费生命。
  • SQL注入。举一个简单的例子:

这是插入消息的SQL。倘若对方发来这样的消息:');DELETE FROM message;--,那么这个插入的SQL就会被分成三段进行解析:

它会在插入一句空消息后,将message表内的所有消息删除。若App内存在这样的漏洞被坏人所用,后果不堪设想。

反注入的通常做法是,

  • 利用SQLite的绑定参数。通过绑定参数避免字符串拼接。
  • 对于不适用绑定参数的SQL,则可以将单引号替换成双单引号,避免传入的单引号提前截断SQL。

尽管反注入并不难,但要求业务开发都了解、并且在开发过程中时时刻刻都警惕着SQL注入,是不现实的。

一旦错过了在框架层统一解决这些问题的机会,后面再通过代码规范、Code Review等等人为的方式去管理,就难免会发生疏漏。

因此,WCDB的原则是,问题应当更早发现更早解决。

  • 能在编译期发现的问题,就不要拖到运行时;
  • 能在框架层解决的问题,就不要再让业务去分担。

基于这个原则,我开始进行对SQLite的接口的抽象。

SQL的组合能力

思考的过程注定不会是一片坦途,我遇到的第一个挑战就是:

问题一:SQL应该怎么抽象?

SQL是千变万化的,它可以是一个很简单的查询,例如:

这个查询只是取出message表中的所有元素。假设我们可以封装成接口:

但SQL也可以是一个很复杂的查询,例如:

这个查询包含了条件、分组、分组过滤、排序、限制、聚合函数、子查询,多表查询。什么样的接口才能兼容这样的SQL?

遇到这种两极分化的问题,我的思路通常是二八原则。即

  • 封装常用操作,覆盖80%的使用场景。
  • 暴露底层接口,适配剩余20%的特殊情况。

但更多的问题出现:

问题二:怎么定义常用操作?

  • 对于微信常用的操作,是否也适用于所有开发者?
  • 现在不使用的操作,以后是否会变成常用?

问题三:常用操作与常用操作的组合,是否仍属于常用操作?

查询某个字段的最大值或最小值,应该属于常用操作的:

假设可以封装为

但,SQL是存在组合的能力的。同时查询最大值和最小值,是否仍属于常用操作?

若以此规则,继续封装为:

显然,“常用接口”的定义在不断地扩大,接口的复杂性也在增加。以后维护起来,就会疲于加新接口,并且没有边界。

问题四:特殊场景所暴露的底层接口,应该以什么形式存在?

若底层接口还是接受字符串参数的传入,那么前面所思考的一切都是徒劳。

SQL语法规则

显然,基于上述问题,我需要一个理论基础,去支持我的封装是合理的,而不仅仅是堆砌接口。

于是,我找到造成SQL千变万化组合的根源 --- SQL语法规则:http://www.sqlite.org/lang.html

例如,这是一个SELECT语句的语法规则:

SQLite按照图示箭头流向的语法规则解析传入的SQL字符串。每个箭头都有不同的流向可选。

例如,SELECT后,可以直接接result-column,也可以插入DISTINCT或者ALL

语法规则中的每个字段都有其对应涵义,其中

  • SELECTDISTINCTALL等等大写字母是keyword,属于SQL的保留字。
  • result-column、``table-or-subqueryexpr等等小写字母是token。token可以再进一步地展开其构成的语法规则。

例如,在WHEREGROUP BYHAVINGLIMITOFFSET后所跟的参数都是expr,它的展开如下:

可以看到,expr有很多种构成方式,例如:

  • exprliteral-valueliteral-value可以进一步展开,它是纯粹的数值。
    • 如数字1、数字30、字符串"Hello"等都是literal-value,因此它们也是expr。
  • exprexpr (binary operator) expr。两个expr通过二元操作符进行连接,其结果依然属于expr
    • 如1+"Hello"。1和"Hello"都是literal-value,因此它们都是expr,通过二元操作符"+"号连接,其结果仍然是一个expr。尽管1+"Hello"看上去没有实质的意义,但它仍是SQL正确的语法。

以刚才那个复杂的SQL中的查询语句为例:

1、content IS NOT NULL,符合 expr IS NOT NULL的语法,因此其可以归并为expr

2、createTime!=modifiedTime,符合expr (binary operator) expr的语法,因此其可以归并为expr

3、type NOT BETWEEN 0 AND 2,符合 expr NOT BETWEEN expr AND expr的语法,因此其可以归并为expr

4、 1.AND 2.,符合expr (binary operator) expr的语法,因此其可以归并为expr

5、4.OR 3.,符合expr (binary operator) expr的语法,因此其可以归并为expr

最终,这么长的条件语句归并为了一个expr,符合SELECT语法规则中WHERE expr的语法,因此是正确的SQL条件语句。

也正是基于此,可以得出:只要按照SQL的语法封装,就可以保留其组合的能力,就不会错过任何接口,落入疲于加接口的陷阱。

WCDB的具体做法是:

  1. 将固定的keyword,封装为函数名,作为连接。
  2. 将可以展开的token,封装为类,并在类内实现其不同的组合。

以SELECT语句为例:

在语法规则中,WHERELIMIT等都接受expr作为参数。因此,不管SQL多么复杂,StatementSelect也只接受Expr的参数。而其组合的能力,则在Expr类内实现。

Expr通过构造函数和C++的偏特化模版,实现了从字符串和数字等进行初始化的效果。同时,通过C++运算符重载的特性,可以将SQL的运算符无损地移植到过来,使得语法上也可以更接近于SQL。

在对应函数里,再进行SQL的字符串拼接即可。同时,所有传入的字符串都会在这一层预处理,以防注入。如:

基于这个抽象方式,就可以对复杂查询中的条件语句进行重写为:

首先通过Column创建对应数据库字段的映射,再转换为Expr,调用对应封装的函数或运算符,即可完成字符串拼接操作。

这个抽象便是WCDB的语言集成查询的特性 --- WINQ(WCDB Integrated Query)。

WINQ+ORM

更进一步,由于WCDB在接口层的ORM封装,使得开发者可以直接通过className.propertyName的方式,拿到字段的映射。因此连上述的转换操作也可以省去,查询代码可以在一行代码内完成。

以下是WCDB在接口层和WINQ的支持下,对前面所提到的SQL语句的代码示例:

总结

WCDB通过WINQ抽象SQLite语法规则,使得开发者可以告别字符串拼接的胶水代码。通过和接口层的ORM结合,使得即便是很复杂的查询,也可以通过一行代码完成。并借助IDE的代码提示和编译检查的特性,大大提升了开发效率。同时还内建了反注入的保护。

(代码提示)

(编译时检查)

虽然WINQ在实现上使用了C++11特性和模版等,但在使用过程并不需要涉及。对于熟悉SQL的开发,只需按照本能即可写出SQL对应的WINQ语句。最终达到提高WCDB易用性的目的。同时,基于C++的实现也使得WINQ在性能可以期待。

后续我们还将分享WCDB在多线程管理上的思考。

原创声明,本文系作者授权云+社区-专栏发表,未经许可,不得转载。

如有侵权,请联系 yunjia_community@tencent.com 删除。

编辑于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏社区的朋友们

MySQL字符集中文乱码剖析

MySQL创建数据表时,分别采用gbk、utf8、latin1的编码方式,当不同编码方式存储相同字符时,是否会显示乱码呢?本文通过案例描述,探讨数据库中的字符串...

6220
来自专栏分布式系统进阶

Librdkafka的基础数据结构 4 --- String和ByteArray

913
来自专栏分布式系统进阶

Librdkafka对kafka topic的封装

722
来自专栏JMCui

HQL查询

       HQL(Hibernate QueryLanguage) 是面向对象的查询语言,它和SQL查询语言有些相似。 1、Select/update/de...

2183
来自专栏我是攻城师

Neo4j的查询语法笔记(二)

3734
来自专栏工科狗和生物喵

【计算机本科补全计划】Mysql 学习小计(2)

正文之前 昨天下午写了篇 Mysql学习小计,结果出乎意料的受欢迎?变相刺激了我多写点 Mysql?好吧,如尔所愿。我晚上反正还不知道学点啥,就把今天看的那个菜...

34511
来自专栏IT探索

hive使用笔记

json_tuple(json_object,'key1','key2','keyN')

701
来自专栏信安之路

sql注入学习总结

所谓SQL注入,就是通过把SQL命令插入到Web表单提交或输入域名或页面请求的查询字符串,最终达到欺骗服务器执行恶意的SQL命令。

600
来自专栏MasiMaro 的技术博文

OLEDB存取BLOB型数据

现代数据库系统除了支持一些标准的通用数据类型以外,大多数还支持一种称之为BLOB型的数据。 BLOB全称为big large object bytes, 大二...

923
来自专栏西安-晁州

mysql随笔

Mysql学习笔记 1、操作数据库 use dataBaseName  //使用数据库 show databases   //显示所有数据库 show tabl...

1870

扫码关注云+社区