用C++封装MySQL的API的教程
其实相信每个和mysql打过交道的程序员都应该会尝试去封装一套mysql的接口，这一次的封装已经记不清是我第几次了，但是每一次我希望都能做的比上次更好，更容易使用。
先来说一下这次的封装，遵守了几个原则，其中部分思想是从python借鉴过来的：
1.简单
简单，意味着不为了微小的效率提升，而去把接口搞的复杂。因为本身数据库存储效率的瓶颈并不是那一两次内存copy，代码中随处可以看到以这个为依据的设计。
2.低学习成本
使用一套新库通常意味着投入学习成本，而这次的封装并没有像django那样实现一套完整的模型系统，也没有做soci那样的语法分析器，我选择最简单易懂的方式：做sql语句拼接器，所以对习惯了使用原生mysqlapi的朋友，学习成本很低
3.模块化
代码实际包括了两个模块，一个是mysqlclient端的封装，一个是sql的拼接器，这两个模块是完全独立的，调用者可以任意组合或者独立使用。
4.尽量使用STL以及模板，简化代码编写
最大的特点就是大量使用了stringstream进行类型转化，减少了大量的重复代码。
OK，基于以上的简单介绍，我们先来看一下
一.mysqlclient端的封装:
classCMYSQLWrapper
{
/**
*@brief获取错误信息
*
*@return错误信息
*/
char*GetErrMsg();
/**
*@brief连接MYSQL，已经支持了自动重连模式，即mysqlserver关闭链接会自动重连
*
*@paramipIP
*@paramuser用户名
*@parampwd密码(没有则传NULL)
*@paramdb库(没有则传NULL)
*
*@return0succ
*elsefail
*/
intOpen(constchar*ip,constchar*user,constchar*pwd,constchar*strDb);
/**
*@brief关闭链接并释放result
*/
voidClose();
/**
*@brief执行SQL语句
*
*@paramstrSql执行语句
*@paramresult执行结果
*
*@return0succ
*elsefail
*/
intQuery(constchar*strSql);
/**
*@brief针对Read(select)相关的的Query，可以支持blob了
*
*@paramstrSqlsql语句
*@paramvecDatarows
*
*@return0succ
*elsefail
*/
intQuery(constchar*strSql,vector<map<string,MYSQLValue>>&vecData);
/**
*@brief针对Write(insert,update,delete)相关的Query
*
*@paramstrSqlsql语句
*@paramaffectRowsCount影响的行的个数
*
*@return0succ
*elsefail
*/
intQuery(constchar*strSql,int&affectRowsCount);
/**
*@briefSelect时获取数据，记得手工析构，或者用StMYSQLRes
*
*@paramresult执行结果
*
*@return0succ
*elsefail
*/
intResult(MYSQL_RES*&result);
/**
*@brief返回影响行数
*
*@return>0succ
*0没有更新
*<0fail
*/
intAffectedRows();
/**
*@brief主要是将blob转成字符串
*
*@paramsrcblob源
*@paramlen长度
*
*@return转化后的字符串
*/
stringEscStr(constchar*src,uint32_tlen);
/**
*@brief将字符串中的某些字符转化(如')
*
*@paramsrc字符串
*
*@return转化后的字符串
*/
stringEscStr(constchar*src);
};
classCMYSQLWrapper
{
/**
*@brief获取错误信息
*
*@return错误信息
*/
char*GetErrMsg();
/**
*@brief连接MYSQL，已经支持了自动重连模式，即mysqlserver关闭链接会自动重连
*
*@paramipIP
*@paramuser用户名
*@parampwd密码(没有则传NULL)
*@paramdb库(没有则传NULL)
*
*@return0succ
*elsefail
*/
intOpen(constchar*ip,constchar*user,constchar*pwd,constchar*strDb);
/**
*@brief关闭链接并释放result
*/
voidClose();
/**
*@brief执行SQL语句
*
*@paramstrSql执行语句
*@paramresult执行结果
*
*@return0succ
*elsefail
*/
intQuery(constchar*strSql);
/**
*@brief针对Read(select)相关的的Query，可以支持blob了
*
*@paramstrSqlsql语句
*@paramvecDatarows
*
*@return0succ
*elsefail
*/
intQuery(constchar*strSql,vector<map<string,MYSQLValue>>&vecData);
/**
*@brief针对Write(insert,update,delete)相关的Query
*
*@paramstrSqlsql语句
*@paramaffectRowsCount影响的行的个数
*
*@return0succ
*elsefail
*/
intQuery(constchar*strSql,int&affectRowsCount);
/**
*@briefSelect时获取数据，记得手工析构，或者用StMYSQLRes
*
*@paramresult执行结果
*
*@return0succ
*elsefail
*/
intResult(MYSQL_RES*&result);
/**
*@brief返回影响行数
*
*@return>0succ
*0没有更新
*<0fail
*/
intAffectedRows();
/**
*@brief主要是将blob转成字符串
*
*@paramsrcblob源
*@paramlen长度
*
*@return转化后的字符串
*/
stringEscStr(constchar*src,uint32_tlen);
/**
*@brief将字符串中的某些字符转化(如')
*
*@paramsrc字符串
*
*@return转化后的字符串
*/
stringEscStr(constchar*src);
};
代码中的注释已经描述的很清楚了，语言描述不清楚，我们直接来看一下gtest的代码:
select:
stringg_name="good";
intg_sex=1;
stringg_name_up="update";
intg_sex_up=2;
TEST(mysql_wrapper_easy,select)
{
vector<map<string,MYSQLValue>>vecData;
stringsql="select*fromtb_testwherename='"+g_name_up+"'";
intret=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;
}
}
}
intmain(intargc,char**argv)
{
intret=g_client.Open("localhost","dantezhu",NULL,"soci");
//intret=g_client.Open("127.0.0.1","dantezhu",NULL,"soci");
if(ret)
{
cout<<ret<<","<<g_client.GetErrMsg()<<endl;
return-1;
}
::testing::InitGoogleTest(&argc,argv);
returnRUN_ALL_TESTS();
}
stringg_name="good";
intg_sex=1;
stringg_name_up="update";
intg_sex_up=2;
TEST(mysql_wrapper_easy,select)
{
vector<map<string,MYSQLValue>>vecData;
stringsql="select*fromtb_testwherename='"+g_name_up+"'";
intret=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;
}
}
}
intmain(intargc,char**argv)
{
intret=g_client.Open("localhost","dantezhu",NULL,"soci");
//intret=g_client.Open("127.0.0.1","dantezhu",NULL,"soci");
if(ret)
{
cout<<ret<<","<<g_client.GetErrMsg()<<endl;
return-1;
}
::testing::InitGoogleTest(&argc,argv);
returnRUN_ALL_TESTS();
}
insert:
TEST(mysql_wrapper_easy,insert)
{
clear_data();
stringstreamss;
ss
<<"insertintotb_test(name,sex)values('"
<<g_client.EscStr(g_name.c_str())
<<"',"
<<g_sex
<<");";
intaffectRowsNum;
intret=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();
stringstreamss;
ss
<<"insertintotb_test(name,sex)values('"
<<g_client.EscStr(g_name.c_str())
<<"',"
<<g_sex
<<");";
intaffectRowsNum;
intret=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
classSQLJoin
{
public:
/**
*@brief用流处理的方式，添加一个列名
*
*@paramkey列名
*
*@return0
*/
SQLJoin&operator<<(conststring&key);
/**
*@brief用流处理的方式，添加一个SQLPair对象
*
*@parampair_dataSQLPair对象
*
*@return0
*/
SQLJoin&operator<<(constSQLPair&pair_data);
/**
*@brief输出所有列名（如name,sex,age）
*
*@return所有列名
*/
stringkeys();
/**
*@brief输出所有列值（如'dante',1,25）
*
*@return所有列值
*/
stringvalues();
/**
*@brief输入所有列名-列值，并用指定分隔符分割（如name='dante',sex=1,age=25）
*
*@paramsplit_str分割符，默认是用','，也可以用and、or之类
*
*@return所有列名-列值
*/
stringpairs(conststring&split_str=",");
/**
*@brief清空所有数据
*/
voidclear();
};
classSQLJoin
{
public:
/**
*@brief用流处理的方式，添加一个列名
*
*@paramkey列名
*
*@return0
*/
SQLJoin&operator<<(conststring&key);
/**
*@brief用流处理的方式，添加一个SQLPair对象
*
*@parampair_dataSQLPair对象
*
*@return0
*/
SQLJoin&operator<<(constSQLPair&pair_data);
/**
*@brief输出所有列名（如name,sex,age）
*
*@return所有列名
*/
stringkeys();
/**
*@brief输出所有列值（如'dante',1,25）
*
*@return所有列值
*/
stringvalues();
/**
*@brief输入所有列名-列值，并用指定分隔符分割（如name='dante',sex=1,age=25）
*
*@paramsplit_str分割符，默认是用','，也可以用and、or之类
*
*@return所有列名-列值
*/
stringpairs(conststring&split_str=",");
/**
*@brief清空所有数据
*/
voidclear();
};
看看我们用了SQLJoin之后的代码应该如何:
TEST(mysql_wrapper_join,insert)
{
clear_data();
SQLJoinsql_join;
sql_join
<<SQLPair("name",g_client.EscapeRealString(g_name.c_str()))
<<SQLPair("sex",g_sex);
stringstreamss;
ss
<<"insertintotb_test("
<<sql_join.keys()
<<")values("
<<sql_join.values()
<<")";
intaffectRowsNum;
intret=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)
{
SQLJoinsql_join;
sql_join
<<SQLPair("name",g_name_up)
<<SQLPair("sex",g_sex_up);
stringstreamss;
ss
<<"updatetb_testset"
<<sql_join.pairs()
<<"wherename='"
<<g_name
<<"';";
intaffectRowsNum;
intret=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();
SQLJoinsql_join;
sql_join
<<SQLPair("name",g_client.EscapeRealString(g_name.c_str()))
<<SQLPair("sex",g_sex);
stringstreamss;
ss
<<"insertintotb_test("
<<sql_join.keys()
<<")values("
<<sql_join.values()
<<")";
intaffectRowsNum;
intret=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)
{
SQLJoinsql_join;
sql_join
<<SQLPair("name",g_name_up)
<<SQLPair("sex",g_sex_up);
stringstreamss;
ss
<<"updatetb_testset"
<<sql_join.pairs()
<<"wherename='"
<<g_name
<<"';";
intaffectRowsNum;
intret=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我也会及时在这里更新。