用C++封装MySQL的API的教程


Posted in Python onMay 06, 2015

其实相信每个和mysql打过交道的程序员都应该会尝试去封装一套mysql的接口,这一次的封装已经记不清是我第几次了,但是每一次我希望都能做的比上次更好,更容易使用。

先来说一下这次的封装,遵守了几个原则,其中部分思想是从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<map<string, MYSQLValue> > &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   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);
};
 
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<map<string, MYSQLValue> > &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   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<map<string,MYSQLValue> > 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 << it_map->first << ",";
   if (it_map->first == "sex")
   {
    cout << it_map->second.as<uint32_t>();
   }
   else
   {
    cout << it_map->second.data();
   }
   cout << "," << it_map->second.size() << endl;
  } 
 }
}
int main(int argc, char **argv)
{
 int ret = g_client.Open("localhost","dantezhu",NULL,"soci");
 //int ret = g_client.Open("127.0.0.1","dantezhu",NULL,"soci");
 if (ret)
 {
  cout << ret << "," << g_client.GetErrMsg() << endl;
  return -1;
 }
 ::testing::InitGoogleTest(&argc, argv);
 return RUN_ALL_TESTS();
}
 
string g_name = "good";
int g_sex = 1;
 
string g_name_up = "update";
int g_sex_up = 2;
 
TEST(mysql_wrapper_easy, select)
{
 vector<map<string,MYSQLValue> > 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 << it_map->first << ",";
   if (it_map->first == "sex")
   {
    cout << it_map->second.as<uint32_t>();
   }
   else
   {
    cout << it_map->second.data();
   }
   cout << "," << it_map->second.size() << endl;
  } 
 }
}
int main(int argc, char **argv)
{
 int ret = g_client.Open("localhost","dantezhu",NULL,"soci");
 //int ret = g_client.Open("127.0.0.1","dantezhu",NULL,"soci");
 if (ret)
 {
  cout << ret << "," << g_client.GetErrMsg() << endl;
  return -1;
 }
 ::testing::InitGoogleTest(&argc, argv);
 return RUN_ALL_TESTS();
}

insert:
TEST(mysql_wrapper_easy, insert)
{
 clear_data();
 stringstream ss;
 ss 
  << "insert into tb_test(name,sex) values('"
  << g_client.EscStr(g_name.c_str())
  << "',"
  << g_sex
  << ");";

 int affectRowsNum;
 int ret = g_client.Query(ss.str().c_str(), affectRowsNum);
 ASSERT_EQ(ret, 0) << g_client.GetErrMsg();

 EXPECT_GE(affectRowsNum,0) << g_client.GetErrMsg();
}
 
TEST(mysql_wrapper_easy, insert)
{
 clear_data();
 stringstream ss;
 ss 
  << "insert into tb_test(name,sex) values('"
  << g_client.EscStr(g_name.c_str())
  << "',"
  << g_sex
  << ");";
 
 int affectRowsNum;
 int ret = g_client.Query(ss.str().c_str(), affectRowsNum);
 ASSERT_EQ(ret, 0) << g_client.GetErrMsg();
 
 EXPECT_GE(affectRowsNum,0) << g_client.GetErrMsg();
}

可以看出,对于mysql的收发包已经很简洁了,但是sql语句的拼装却显得十分臃肿。所以这个时候sql语句拼装器-SQLJoin闪亮登场!
二.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我也会及时在这里更新。

Python 相关文章推荐
浅谈Python基础之I/O模型
May 11 Python
Python正则表达式分组概念与用法详解
Jun 24 Python
Python进阶之递归函数的用法及其示例
Jan 31 Python
Python 单元测试(unittest)的使用小结
Nov 14 Python
Python3 导入上级目录中的模块实例
Feb 16 Python
python3.6使用tkinter实现弹跳小球游戏
May 09 Python
Python3并发写文件与Python对比
Nov 20 Python
使用Keras中的ImageDataGenerator进行批次读图方式
Jun 17 Python
GitHub上值得推荐的8个python 项目
Oct 30 Python
python实现ping命令小程序
Dec 28 Python
python 常用的异步框架汇总整理
Jun 18 Python
python 管理系统实现mysql交互的示例代码
Dec 06 Python
使用wxPython获取系统剪贴板中的数据的教程
May 06 #Python
用Python遍历C盘dll文件的方法
May 06 #Python
使用Python压缩和解压缩zip文件的教程
May 06 #Python
Python发送以整个文件夹的内容为附件的邮件的教程
May 06 #Python
在Linux中通过Python脚本访问mdb数据库的方法
May 06 #Python
python中黄金分割法实现方法
May 06 #Python
使用rpclib进行Python网络编程时的注释问题
May 06 #Python
You might like
声音就能俘获人心,蕾姆,是哪个漂亮小姐姐配音呢?
2020/03/03 日漫
php绘图中显示不出图片的原因及解决
2014/03/05 PHP
php将字符串转化成date存入数据库的两种方式
2014/04/28 PHP
无需数据库在线投票调查php代码
2016/07/20 PHP
PHP高效获取远程图片尺寸和大小的实现方法
2017/10/20 PHP
RR vs IO BO3 第一场2.13
2021/03/10 DOTA
js jquery获取随机生成id的服务器控件的三种方法
2013/07/11 Javascript
JS数组的赋值介绍
2014/03/10 Javascript
node.js中的fs.fchown方法使用说明
2014/12/16 Javascript
jQuery实现固定在网页顶部的菜单效果代码
2015/09/02 Javascript
jQuery实现单击弹出Div层窗口效果(可关闭可拖动)
2015/09/19 Javascript
谈一谈JS消息机制和事件机制的理解
2016/04/14 Javascript
实例详解jQuery的无new构建
2016/08/02 Javascript
理解 javascript 中的函数表达式与函数声明
2017/07/07 Javascript
通过源码分析Vue的双向数据绑定详解
2017/09/24 Javascript
判断div滑动到底部的scroll实例代码
2017/11/15 Javascript
微信小程序 scroll-view 水平滚动实现过程解析
2019/10/12 Javascript
vue项目中使用bpmn为节点添加颜色的方法
2020/04/30 Javascript
[03:37]2015国际邀请赛第四日现场精彩集锦
2015/08/08 DOTA
Python获取Linux系统下的本机IP地址代码分享
2014/11/07 Python
浅谈Python中copy()方法的使用
2015/05/21 Python
python 实现数组list 添加、修改、删除的方法
2018/04/04 Python
Python使用Pickle库实现读写序列操作示例
2018/06/15 Python
Django在Model保存前记录日志实例
2020/05/14 Python
Python自动化xpath实现自动抢票抢货
2020/09/19 Python
马来西亚最好的婴儿商店:Motherhood
2017/09/14 全球购物
俄罗斯披萨、寿司和面食送货到家服务:2 Берега
2019/12/15 全球购物
俄罗斯在线购买飞机票、火车票、巴士票网站:Tutu.ru
2020/03/16 全球购物
求职者应聘的自我评价
2013/10/16 职场文书
会计人员岗位职责
2014/03/19 职场文书
建筑工地门卫岗位职责
2014/04/30 职场文书
社会公德演讲稿
2014/05/20 职场文书
四风问题班子对照检查材料
2014/09/27 职场文书
2015年社区工作总结
2015/04/08 职场文书
2015年网络管理员工作总结
2015/05/21 职场文书
2016年“11.11”光棍节活动总结
2016/04/05 职场文书