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

发表于 5年以前  | 总阅读数:835 次

其实相信每个和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我也会及时在这里更新。

 相关推荐

刘强东夫妇:“移民美国”传言被驳斥

京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。

发布于:1年以前  |  808次阅读  |  详细内容 »

博主曝三大运营商,将集体采购百万台华为Mate60系列

日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。

发布于:1年以前  |  770次阅读  |  详细内容 »

ASML CEO警告:出口管制不是可行做法,不要“逼迫中国大陆创新”

据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。

发布于:1年以前  |  756次阅读  |  详细内容 »

抖音中长视频App青桃更名抖音精选,字节再发力对抗B站

今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。

发布于:1年以前  |  648次阅读  |  详细内容 »

威马CDO:中国每百户家庭仅17户有车

日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。

发布于:1年以前  |  589次阅读  |  详细内容 »

研究发现维生素 C 等抗氧化剂会刺激癌症生长和转移

近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。

发布于:1年以前  |  449次阅读  |  详细内容 »

苹果据称正引入3D打印技术,用以生产智能手表的钢质底盘

据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。

发布于:1年以前  |  446次阅读  |  详细内容 »

千万级抖音网红秀才账号被封禁

9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...

发布于:1年以前  |  445次阅读  |  详细内容 »

亚马逊股东起诉公司和贝索斯,称其在购买卫星发射服务时忽视了 SpaceX

9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。

发布于:1年以前  |  444次阅读  |  详细内容 »

苹果上线AppsbyApple网站,以推广自家应用程序

据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。

发布于:1年以前  |  442次阅读  |  详细内容 »

特斯拉美国降价引发投资者不满:“这是短期麻醉剂”

特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。

发布于:1年以前  |  441次阅读  |  详细内容 »

光刻机巨头阿斯麦:拿到许可,继续对华出口

据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。

发布于:1年以前  |  437次阅读  |  详细内容 »

马斯克与库克首次隔空合作:为苹果提供卫星服务

近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。

发布于:1年以前  |  430次阅读  |  详细内容 »

𝕏(推特)调整隐私政策,可拿用户发布的信息训练 AI 模型

据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。

发布于:1年以前  |  428次阅读  |  详细内容 »

荣耀CEO谈华为手机回归:替老同事们高兴,对行业也是好事

9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。

发布于:1年以前  |  423次阅读  |  详细内容 »

AI操控无人机能力超越人类冠军

《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。

发布于:1年以前  |  423次阅读  |  详细内容 »

AI生成的蘑菇科普书存在可致命错误

近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。

发布于:1年以前  |  420次阅读  |  详细内容 »

社交媒体平台𝕏计划收集用户生物识别数据与工作教育经历

社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”

发布于:1年以前  |  411次阅读  |  详细内容 »

国产扫地机器人热销欧洲,国产割草机器人抢占欧洲草坪

2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。

发布于:1年以前  |  406次阅读  |  详细内容 »

罗永浩吐槽iPhone15和14不会有区别,除了序列号变了

罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。

发布于:1年以前  |  398次阅读  |  详细内容 »
 相关文章
Android插件化方案 5年以前  |  237215次阅读
vscode超好用的代码书签插件Bookmarks 2年以前  |  8051次阅读
 目录