先来说一下这次的封装,遵守了几个原则,其中部分思想是从python借鉴过来的:
1.简单
简单,意味着不为了微小的效率提升,而去把接口搞的复杂。因为本身数据库存储效率的瓶颈并不是那一两次内存copy,代码中随处可以看到以这个为依据的设计。
2.低学习成本
使用一套新库通常意味着投入学习成本,而这次的封装并没有像django那样实现一套完整的模型系统,也没有做soci那样的语法分析器,我选择最简单易懂的方式:做sql语句拼接器,所以对习惯了使用原生mysql api的朋友,学习成本很低
3.模块化
代码实际包括了两个模块,一个是mysql client端的封装,一个是sql的拼接器,这两个模块是完全独立的,调用者可以任意组合或者独立使用。
4.尽量使用stl以及模板,简化代码编写
最大的特点就是大量使用了stringstream进行类型转化,减少了大量的重复代码。
ok,基于以上的简单介绍,我们先来看一下
一.mysql client端的封装:
class cmysqlwrapper{ /** * @brief 获取错误信息 * * @return 错误信息 */ char* geterrmsg(); /** * @brief 连接mysql,已经支持了自动重连模式,即mysql server关闭链接会自动重连 * * @param ip ip * @param user 用户名 * @param pwd 密码(没有则传null) * @param db 库(没有则传null) * * @return 0 succ * else fail */ int open(const char* ip,const char* user,const char* pwd,const char* strdb); /** * @brief 关闭链接并释放result */ void close(); /** * @brief 执行sql语句 * * @param strsql 执行语句 * @param result 执行结果 * * @return 0 succ * else fail */ int query(const char* strsql); /** * @brief 针对read(select)相关的的query,可以支持blob了 * * @param strsql sql语句 * @param vecdata rows * * @return 0 succ * else fail */ int query(const char* strsql, vector &vecdata); /** * @brief 针对write(insert,update,delete)相关的query * * @param strsql sql语句 * @param affectrowscount 影响的行的个数 * * @return 0 succ * else fail */ int query(const char* strsql, int& affectrowscount); /** * @brief select时获取数据,记得手工析构,或者用stmysqlres * * @param result 执行结果 * * @return 0 succ * else fail */ int result(mysql_res *&result); /** * @brief 返回影响行数 * * @return >0 succ * 0 没有更新 * 0 succ * 0 没有更新 * <0 fail */ int affectedrows(); /** * @brief 主要是将blob转成字符串 * * @param src blob源 * @param len 长度 * * @return 转化后的字符串 */ string escstr(const char* src,uint32_t len); /** * @brief 将字符串中的某些字符转化(如') * * @param src 字符串 * * @return 转化后的字符串 */ string escstr(const char* src);};
代码中的注释已经描述的很清楚了,语言描述不清楚,我们直接来看一下gtest的代码:
select:string g_name = good;int g_sex = 1;string g_name_up = update;int g_sex_up = 2;test(mysql_wrapper_easy, select){ vector vecdata; string sql = select * from tb_test where name = '+g_name_up+'; int ret = g_client.query(sql.c_str(),vecdata); assert_eq(ret, 0) << g_client.geterrmsg(); foreach(vecdata, it_vec) { foreach(*it_vec, it_map) { cout
二.sql语句拼装器-sqljoin
class sqljoin{public: /** * @brief 用流处理的方式,添加一个列名 * * @param key 列名 * * @return 0 */ sqljoin& operator << (const string& key); /** * @brief 用流处理的方式,添加一个sqlpair对象 * * @param pair_data sqlpair对象 * * @return 0 */ sqljoin& operator << (const sqlpair& pair_data); /** * @brief 输出所有列名(如name, sex, age) * * @return 所有列名 */ string keys(); /** * @brief 输出所有列值(如'dante', 1, 25) * * @return 所有列值 */ string values(); /** * @brief 输入所有列名-列值,并用指定分隔符分割(如name='dante', sex=1, age=25) * * @param split_str 分割符,默认是用',',也可以用and、or之类 * * @return 所有列名-列值 */ string pairs(const string& split_str = ,); /** * @brief 清空所有数据 */ void clear();}; class sqljoin{public: /** * @brief 用流处理的方式,添加一个列名 * * @param key 列名 * * @return 0 */ sqljoin& operator << (const string& key); /** * @brief 用流处理的方式,添加一个sqlpair对象 * * @param pair_data sqlpair对象 * * @return 0 */ sqljoin& operator << (const sqlpair& pair_data); /** * @brief 输出所有列名(如name, sex, age) * * @return 所有列名 */ string keys(); /** * @brief 输出所有列值(如'dante', 1, 25) * * @return 所有列值 */ string values(); /** * @brief 输入所有列名-列值,并用指定分隔符分割(如name='dante', sex=1, age=25) * * @param split_str 分割符,默认是用',',也可以用and、or之类 * * @return 所有列名-列值 */ string pairs(const string& split_str = ,); /** * @brief 清空所有数据 */ void clear();};
看看我们用了sqljoin之后的代码应该如何:
test(mysql_wrapper_join, insert){ clear_data(); sqljoin sql_join; sql_join << sqlpair(name, g_client.escaperealstring(g_name.c_str())) << sqlpair(sex, g_sex); stringstream ss; ss << insert into tb_test( << sql_join.keys() << ) values( << sql_join.values() << ); int affectrowsnum; int ret = g_client.executewrite(ss.str().c_str(), affectrowsnum); assert_eq(ret, 0) << g_client.geterrmsg(); expect_ge(affectrowsnum,0) << g_client.geterrmsg();}test(mysql_wrapper_join, update){ sqljoin sql_join; sql_join << sqlpair(name, g_name_up) << sqlpair(sex, g_sex_up); stringstream ss; ss << update tb_test set << sql_join.pairs() << where name=' << g_name <<';; int affectrowsnum; int ret = g_client.executewrite(ss.str().c_str(),affectrowsnum); assert_eq(ret, 0) << g_client.geterrmsg(); expect_ge(affectrowsnum,0) << g_client.geterrmsg();} test(mysql_wrapper_join, insert){ clear_data(); sqljoin sql_join; sql_join << sqlpair(name, g_client.escaperealstring(g_name.c_str())) << sqlpair(sex, g_sex); stringstream ss; ss << insert into tb_test( << sql_join.keys() << ) values( << sql_join.values() << ); int affectrowsnum; int ret = g_client.executewrite(ss.str().c_str(), affectrowsnum); assert_eq(ret, 0) << g_client.geterrmsg(); expect_ge(affectrowsnum,0) << g_client.geterrmsg();}test(mysql_wrapper_join, update){ sqljoin sql_join; sql_join << sqlpair(name, g_name_up) << sqlpair(sex, g_sex_up); stringstream ss; ss << update tb_test set << sql_join.pairs() << where name=' << g_name <<';; int affectrowsnum; int ret = g_client.executewrite(ss.str().c_str(),affectrowsnum); assert_eq(ret, 0) << g_client.geterrmsg(); expect_ge(affectrowsnum,0) << g_client.geterrmsg();}
从上面的代码可以看出,代码的可维护性和健壮性得到了很大的提升。
ok,简单的介绍就是这样,说的比较简略,大家有兴趣可以直接看代码,也欢迎给我提意见和建议。代码下载路径如下:
mysql_wrapper
明天这份代码就会作为数据库访问层正式进入生产环境的代码中,因此有什么bug我也会及时在这里更新。