如何设计一个简单的C++ ORM
2016/11/15
“没有好的接口，用C++读写数据库和写图形界面一样痛苦”
阅读这篇文章前，你最好知道什么是
Object Relation Mapping (ORM)
阅读这篇文章后，欢迎阅读下一篇 如何设计一个更好的C++ ORM
?
为什么C++要ORM
As good object-oriented developers got tired of this repetitive work,
their typical tendency towards enlightened laziness started
to manifest itself in the creation of tools to help automate
the process.When working with relational databases,
the culmination of such efforts were object/relational mapping tools.
一般的C++数据库接口，都需要手动生成SQL语句；
手动生成的查询字符串，常常会因为模型改动而失效；
查询语句/结果和C++原生数据之间的转换，每次都要手动解析；
我为什么要写ORM
C++大作业需要实现一个在线的对战游戏，其中的游戏信息需要保存到数据库里；
而我最初始的里没有使用 ORM 导致生成 SQL 语句的代码占了好大一个部分；
并且这一大堆代码里的小错误往往很难被发现；
每次修改游戏里怪物的模型都需要同步修改这些代码；
然而在修改的过程中经常因为疏漏而出现小错误；
所以，我打算让代码生成这段代码； ?
市场上的C++ ORM
大致可以分成这几类：
使用 预编译器 生成模型和操作:
使用 宏 生成模型和操作：
需要在定义模型时，通过手动插入 代码 进行注入：
QxORM(Qt风格的庞大。。)
以上的方案都使用了
Proxy Pattern
和
Adapter Pattern
实现 ORM 功能，并提供一个用于和数据库交换数据的 容器；
所以我打算封装一个直接操作 原始模型 的 ORM； ?
一个简单的设计 —— ORM Lite
关于这个设计的代码和样例 ?：
https://github.com/BOT-Man-JL…
0. 这个ORM要做什么
将对C++对象操作转化成SQL查询语句
(LINQ to SQL)；提供C++ Style接口，更方便的使用；
我的设计上大致分为6个方面：
封装SQL链接器
遍历对象内需要持久化的成员
序列化和反序列化
获取类名和各个字段的字符串
获取字段类型
将对C++对象的操作转化为SQL语句
1. 封装SQL链接器
为了让ORM支持各种数据库，
我们应该把对数据库的操作抽象为一个统一的 Execute：
class SQLConnector
{
public:
SQLConnector (const std::string &connectionString);
void Execute (...);
};2. 遍历对象内需要持久化的成员
2.1 使用 Visitor Pattern + Variadic Template 遍历
一开始，我想到的是使用
Visitor Pattern
组合
Variadic Template
进行成员的遍历；
首先，在模型处加入 __Accept 操作；
通过 VISITOR 接受不同的 Visitor 来实现特定功能；
并用 __VA_ARGS__ 传入需要持久化的成员列表：
#define ORMAP(_MY_CLASS_, ...) \
template <typename VISITOR> \
void __Accept (VISITOR &visitor) \
{ \
visitor.Visit (__VA_ARGS__); \
} \
template <typename VISITOR> \
void __Accept (VISITOR &visitor) const \
{ \
visitor.Visit (__VA_ARGS__); \
} \然后，针对不同功能，实现不同的 Visitor；
再通过统一的 Visit 接口，接受模型的变长数据成员参数；
例如 ReaderVisitor：
class ReaderVisitor
{
public:
// Data to Exchange
std::vector<std::string> serializedValues;
template <typename... Args>
inline void Visit (Args & ... args)
{
_Visit (args...);
}
protected:
template <typename T, typename... Args>
inline void _Visit (T &property, Args & ... args)
{
_Visit (property);
_Visit (args...);
}
template <typename T>
inline void _Visit (T &property) override
{
serializedValues.emplace_back (std::to_string (property));
}
template <>
inline void _Visit <std::string> (std::string &property) override
{
serializedValues.emplace_back ("'" + property + "'");
}
};Visit将操作转发给带有变长模板的_Visit；有变长模板的
_Visit将各个操作转发给处理单个数据的_Visit；处理单个数据的
_Visit将模型的数据
和Visitor一个public数据成员（serializedValues）交换；
不过，这么设计有一定的缺点：
我们需要预先定义所有的
Visitor，灵活性不够强；我们需要把和需要持久化的成员交换的数据保存到
Visitor内部，
增大了代码的耦合；
2.2 带有 泛型函数参数 的 Visitor
（使用了C++14的特性）
所以，我们可以让 Visit 接受一个泛型函数参数，用这个函数进行实际的操作；
在模型处加入的 __Accept 操作改为：
template <typename VISITOR, typename FN> \
void __Accept (const VISITOR &visitor, FN fn) \
{ \
visitor.Visit (fn, __VA_ARGS__); \
} \
template <typename VISITOR, typename FN> \
void __Accept (const VISITOR &visitor, FN fn) const \
{ \
visitor.Visit (fn, __VA_ARGS__); \
} \fn为泛型函数参数；每次调用
__Accept的时候，把fn传给visitor的Visit函数；
然后，我们可以定义一个统一的 Visitor，遍历传入的参数，并调用 fn ——
相当于将 Visitor 抽象为一个 for each 操作：
class FnVisitor
{
public:
template <typename Fn, typename... Args>
inline void Visit (Fn fn, Args & ... args) const
{
_Visit (fn, args...);
}
protected:
template <typename Fn, typename T, typename... Args>
inline void _Visit (Fn fn, T &property, Args & ... args) const
{
_Visit (fn, property);
_Visit (fn, args...);
}
template <typename Fn, typename T>
inline void _Visit (Fn fn, T &property) const
{
fn (property);
}
};最后，实际的数据交换操作通过传入特定的 fn 实现：
queryHelper.__Accept (FnVisitor (),
[&argv, &index] (auto &val)
{
DeserializeValue (val, argv[index++]);
});对比上边，这个方法实际上是在处理单个数据的
_Visit将模型的数据
传给回调函数fn；fn使用
Generic Lambda
接受不同类型的数据成员，然后再转发给其他函数（DeserializeValue）；
通过capture和需要持久化的成员交换的数据；
2.3 另一种设计——用 tuple + Refrence 遍历
（使用了C++14的特性）
虽然最后版本没有使用这个设计，不过作为一个不错的思路，我还是记下来了；?
首先，在模型处通过加入生成 tuple 的函数：
#define ORMAP(_MY_CLASS_, ...) \
inline decltype (auto) __ValTuple () \
{ \
return std::forward_as_tuple (__VA_ARGS__); \
} \
inline decltype (auto) __ValTuple () const \
{ \
return std::forward_as_tuple (__VA_ARGS__); \
} \forward_as_tuple将__VA_ARGS__传入的参数转化为引用的tuple；decltype (auto)自动推导返回值类型；
然后，定义一个 TupleVisitor：
// Using a _SizeT to specify the Index :-), Cool
template < size_t > struct _SizeT {};
template < typename TupleType, typename ActionType >
inline void TupleVisitor (TupleType &tuple, ActionType action)
{
TupleVisitor_Impl (tuple, action,
_SizeT<std::tuple_size<TupleType>::value> ());
}
template < typename TupleType, typename ActionType >
inline void TupleVisitor_Impl (TupleType &tuple, ActionType action,
_SizeT<0>)
{}
template < typename TupleType, typename ActionType, size_t N >
inline void TupleVisitor_Impl (TupleType &tuple, ActionType action,
_SizeT<N>)
{
TupleVisitor_Impl (tuple, action, _SizeT<N - 1> ());
action (std::get<N - 1> (tuple));
}其中使用了
_SizeT巧妙的进行tuple下标的判断；
最后，类似上边，实际的数据交换操作通过 TupleVisitor 完成：
auto tuple = queryHelper.__ValTuple ();
TupleVisitor (tuple, [&argv, &index] (auto &val)
{
DeserializeValue (val, argv[index++]);
});2.4 问题
使用
Variadic Template和tuple遍历数据，
其函数调用的确定，都是编译时就生成的，这会带来一定的代码空间开销；后两个方法可能在 实例化Generic Lambda 的时候，
针对 不同类型的模型的 不同数据成员类型 实例化出不同的副本，
代码大小更大；?
3. 序列化和反序列化
通过 序列化，
将 C++ 数据类型转化为字符串，用于查询；
通过 反序列化，
将查询得到的字符串，转回 C++ 的数据类型；
3.1 重载函数 _Visit
针对每种支持的数据类型重载一个 _Visit 函数，
然后对其进行相应的序列化和反序列化；
以序列化为例：
void _Visit (long &property) override
{
serializedValues.emplace_back (std::to_string (property));
}
void _Visit (double &property) override
{
serializedValues.emplace_back (std::to_string (property));
}
void _Visit (std::string &property) override
{
serializedValues.emplace_back ("'" + property + "'");
}3.2 使用 std::iostream
然而，针对每种支持的数据类型重载，这种事情在标准库里已经有人做好了；
所以，我们可以改用了 std::iostream 进行序列化和反序列化；
以反序列化为例：
template <typename T>
inline std::ostream &SerializeValue (std::ostream &os,
const T &value)
{
return os << value;
}
template <>
inline std::ostream &SerializeValue <std::string> (
std::ostream &os, const std::string &value)
{
return os << "'" << value << "'";
}4. 获取类名和各个字段的字符串
我们可以使用宏中的 # 获取传入参数的文字量；
然后将这个字符串作为 private 成员存入这个类中：
#define ORMAP(_MY_CLASS_, ...) \
constexpr static const char *__ClassName = #_MY_CLASS_; \
constexpr static const char *__FieldNames = #__VA_ARGS__; \其中
#_MY_CLASS_为类名；#__VA_ARGS__为传入可变参数的字符串；__FieldNames可以通过简单的字符串处理获得各个字段的字符串
5. 获取字段类型
在新建数据库的 Table 的时候，
我们不仅需要类名和各个字段的字符串，
还需要获得各个字段的数据类型；
5.1 使用 typeid 运行时判断
在 Visitor 遍历成员时，将每个成员的 typeid 保存起来：
template <typename T>
void _Visit (T &property) override
{
typeIds.emplace_back (typeid (T));
}运行时根据 typeid 判断类型并匹配字符串：
if (typeId == typeid (int))
typeFmt = "int";
else if (typeId == typeid (double))
typeFmt = "decimal";
else if (typeId == typeid (std::string))
typeFmt = "varchar";
else
return false;5.2 使用 <type_traits> 编译时判断
由于对象的类型在编译时已经可以确定，
所以我们可以直接使用 <type_traits> 进行编译时判断：
constexpr const char *typeStr =
(std::is_integral<T>::value &&
!std::is_same<std::remove_cv_t<T>, char>::value &&
!std::is_same<std::remove_cv_t<T>, wchar_t>::value &&
!std::is_same<std::remove_cv_t<T>, char16_t>::value &&
!std::is_same<std::remove_cv_t<T>, char32_t>::value &&
!std::is_same<std::remove_cv_t<T>, unsigned char>::value)
? "integer"
: (std::is_floating_point<T>::value)
? "real"
: (std::is_same<std::remove_cv_t<T>, std::string>::value)
? "text"
: nullptr;
static_assert (
typeStr != nullptr,
"Only Support Integral, Floating Point and std::string :-)");constexpr编译时完成推导，减少运行时开销；static_assert编译时类型检查；
6. 将对C++对象的操作转化为SQL语句
这里，我们应该提供
Fluent Interface：
auto query = mapper.Query (helper)
.Where (
Field (helper.name) == "July" &&
(Field (helper.id) <= 90 && Field (helper.id) >= 60)
)
.OrderByDescending (helper.id)
.Take (3)
.Skip (10)
.ToVector ();6.1 映射到对应的表中
对于一般的操作，通过模板类型参数，获取 __ClassName：
template <typename C>
void Insert (const C &entity)
{
auto tableName = C::__ClassName;
// ...
}带有条件的查询通过 Query<MyClass>，将自动映射到 MyClass 表中；
并返回自己的引用，实现Fluent Interface：
template <typename C>
ORQuery<C> Query (const C &queryHelper)
{
return ORQuery<C> (queryHelper, this);
}
ORQuery &Where (const Expr &expr)
{
// Parse expr
return *this;
}6.2 自动将C++表达式转为SQL表达式
首先，引入一个 Expr 类，用于保存条件表达式；
将 Expr 对象传入 ORQuery.Where，以实现条件查询：
struct Expr
{
std::vector<std::pair<const void *, std::string>> expr;
template <typename T>
Expr (const T &property,
const std::string &relOp,
const T &value)
: expr { std::make_pair (&property, relOp) }
{
// Serialize value into expr.front ().second
}
inline Expr operator && (const Expr &right)
{
// Return Composite Expression
}
// ...
}expr保存了表达式序列，包括该成员的指针和关系运算符 值的字符串；重载
&& ||实现表达式的复合条件；
不过这样的接口还不够友好；
因为如果我们要生成一个 Expr 则需要手动传入 const std::string &relOp：
mapper.Query (helper)
.Where (
Expr (helper.name, "=", std::string ("July")) &&
(Expr (helper.id, "<=", 90) && Expr (helper.id, ">=", 60))
)
// ...所以，我们在这里引入一个 Expr_Field 实现自动构造表达式：
template <typename T>
struct Expr_Field
{
const T& _property;
Expr_Field (const T &property)
: _property (property)
{}
inline Expr operator == (T value)
{ return Expr { _property, "=", std::move (value) }; }
// != > < >= <=
}
template <typename T>
Expr_Field<T> Field (T &property)
{
return Expr_Field<T> { property };
}Field函数用更短的语句，返回一个Expr_Field对象；重载
== != > < >= <=生成带有对应关系的Expr对象；
6.3 自动判断C++对象的成员字段名
由于没有想到很好的办法，所以目前使用了指针进行运行时判断：
queryHelper.__Accept (FnVisitor (),
[&property, &isFound, &index] (auto &val)
{
if (!isFound && property == &val)
isFound = true;
else if (!isFound)
index++;
});
fieldName = FieldNames[index];相当于使用 Visitor 遍历这个对象，找到对应成员的序号；
6.4 问题
之后的版本可能考虑：
支持更多的SQL操作（如跨表）；
改用语法树实现；（欢迎 Pull Request ?）
写在最后
这篇文章是我的第一篇技术类博客，写的比较浅，见谅；
你有一个苹果，我有一个苹果，我们彼此交换，每人还是一个苹果；
你有一种思想，我有一种思想，我们彼此交换，每人可拥有两种思想。
如果对以上内容及ORM Lite有什么问题，
欢迎 指点 讨论 ?：
https://github.com/BOT-Man-JL…
Delivered under MIT License © 2016, BOT Man
