学习实践：使用模式，原则实现一个C++数据库访问类

最新推荐文章于 2023-11-28 21:01:09 发布
最新推荐文章于 2023-11-28 21:01:09 发布
阅读量3.6k 收藏 4
点赞数
文章标签： 数据库 c++ 智能指针 自动化测试 mysql
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xumingxsh/article/details/38663279
版权
本文介绍了如何使用设计模式和原则实现一个C++数据库访问类，详细讨论了接口设计，包括接口概述、具体接口及其使用案例。同时，文章深入探讨了实现细节，如可变参数处理和互斥锁的运用，以及HiDBImpl和HiDB的实现过程。最后，作者分享了一些后记和总结。
摘要由CSDN通过智能技术生成

一、概述

在我参与的多个项目中，大家使用libMySQL操作MySQL数据库，而且是源码级复用，在多个项目中相同或相似的源码，这样的复用方式给开发带来了不便。
libMySQL的使用比较麻烦，很容易出错。
基于以上原因，我写了一个动态链接库，将对libMySQL的操作封装起来，以二进制复用代替源码级复用；要提供线程安全的接口，用户无需关系是否加锁这样细节性的问题，减少出错及死锁的机会，当然也要允许用户自己选择是否线程安全的访问数据库；要简化访问数据库的流程，接口越简单越好。

我从2011年开始写这个库，我给它起名字叫HiDB。HiDB从2011年到现在，经历了一个由简到繁又有繁到简的过程，中间也包含了自己对程序理解的变化。
很多的考虑看起来很细碎，例如代码的注释风格（选择我们一贯的注释风格还是doxygen的注释风格，代码大全中也讲到了注释风格。是否需要借鉴）；代码的命名规范（匈牙利命名法还是Java，C#的命名法，还有很多开源项目的命名规范）；C++设计新思维中讲到Policy classes，是否可以应用到这个库中；Effective C++中讲的接口与实现分离。
这些年自己考虑过的一些东西包括注释风格的选择（我们一贯的注释，doxygen的注释风格，代码大全中也讲到了注释风格），出错时是使用错误码报出错误还是使用异常报出错误？C++设计新思维中讲的Policy classes，Effective C++中讲的接口与实现分析（Impl）

二、接口

（一）接口概述

首先确定一下HiDB的接口。该库对外显示为一个HiDB类，该类应该包含的接口包括：
1： 用户选择线程安全还是非线程安全
2： 打开数据库连接
3： 关闭数据库连接
4： 执行insert，update等非查询操作的接口（ExecuteNoQuery）
5： 获得查询结果第一行第一列的接口（ExecuteScaler）
6： 获得一次查询的所有记录（多行多列）的接口（ExecuteQuery）
7： 执行事务的接口（OnTransaction）

所有的接口都在产生异常时抛出，需要对异常做一个封装，这个异常中最好能标识出异常产生的位置，异常的编号，异常的描述，引起异常的SQL语句。我设计的异常如下： 

   
   
   

    
    
    

     
     
     /** @brief 数据库操作异常 */
    
    
    

    
    
    

     
     
     class HI_DB_EXPORT HiDBException
    
    
    

    
    
    

     
     
     {
       
    
    
    

    
    
    

     
     
     public:
    
    
    

    
    
    

     
     
     	HiDBException();
    
    
    

    
    
    

     
     
     public:
    
    
    

    
    
    

     
     
     	std::string ToSrting();
    
    
    

    
    
    

     
     
     public:
    
    
    

    
    
    

     
     
     	std::string		m_sql;			/**<  本次操作的SQL语句 */
    
    
    

    
    
    

     
     
     	std::string		m_descript;		/**<  异常描述 */
    
    
    

    
    
    

     
     
     	std::string		m_position;		/**<  异常位置 */
    
    
    

    
    
    

     
     
     	long			m_errorId;		/**<  异常编号 */
    
    
    

    
    
    

     
     
     	HiDBType		m_dbTyp;		/**<  数据库类型 */
    
    
    

    
    
    

     
     
     };


为了方便的抛出异常，我提供了一个宏（这个宏只有HiDB库使用） 
   
   
   

    
    
    

     
     
     /** @brief 异常语句宏 */
    
    
    

    
    
    

     
     
     #define HiDBHelperOnError(ps, script,sql, id) \
    
    
    

    
    
    

     
     
     	HiDBException exception;\
    
    
    

    
    
    

     
     
     	exception.m_position = ps;\
    
    
    

    
    
    

     
     
     	exception.m_descript = script;\
    
    
    

    
    
    

     
     
     	exception.m_sql = sql;\
    
    
    

    
    
    

     
     
     	exception.m_errorId = id;\
    
    
    

    
    
    

     
     
     	throw exception;\
    
    
    

    
    
    

     
     
     	//return false;

提供该宏，除了简化用户输入外，还有一个想法就是如果用户不想使用异常，可以修改该宏，例如返回false。

熟悉ADO.NET的朋友应该可以看出这些接口是借鉴了ADO.NET的。

（二）具体接口

<1> 构造函数
本来在《C++设计新思维》中，有个Policy classes，适合这种根据用户需要提供安全或非安全接口的需求，但是Policy classes适合模板，不适合非模板，所以在这儿就没有使用，只是在构造函数中添加了一个布尔参数isUsingLock，如果为true则提供线程安全接口，否则接口是非线程安全的。
HiDB打算在将来除支持MySQL外，还支持其他数据库，所以在构造函数中，除isUsingLock外，还有一个选择数据库类型的接口。
将数据库类型写成枚举，则枚举为： 

   
   
   

    
    
    

     
     
     /** @brief 数据库类型 */
    
    
    

    
    
    

     
     
     enum HiDBType
    
    
    

    
    
    

     
     
     {
       
    
    
    

    
    
    

     
     
     	HiDBType_Invail,	/**<  无效类型 */
    
    
    

    
    
    

     
     
     	HiDBType_MySQL,	/**<  MySQL */
    
    
    

    
    
    

     
     
     };


构造函数的声明就明确下来了：
  
  
  
  

   
   
   

    
    
       /**
   
   
   

   
   
   

    
    
    	*   @brief 构造函数
   
   
   

   
   
   

    
    
    	*	@param[in] type			数据库类型
   
   
   

   
   
   

    
    
    	*	@param[in] isUsingLock	是否需要使用互斥锁
   
   
   

   
   
   

    
    
    	*/
   
   
   

   
   
   

    
    
    	HiDB(HiDBType type = HiDBType_MySQL, bool isUsingLock = false);

<2>打开数据库连接
打开数据库连接比较简单： 

   
   
   

    
    
    

     
     
     	/**
    
    
    

    
    
    

     
     
     	*   @brief 打开数据库连接
    
    
    

    
    
    

     
     
     	*	@param[in] conn			数据库连接字符串
    
    
    

    
    
    

     
     
     	*   @retval true：成功，false；失败
    
    
    

    
    
    

     
     
     	*   @par 实例：
    
    
    

    
    
    

     
     
     	*   @code
    
    
    

    
    
    

     
     
     	*	HiDB db;
    
    
    

    
    
    

     
     
     	*	if (db.Open("host=127.0.0.1;port=3306;dbname=test;user=root;pwd=root;charset=gbk;"))
    
    
    

    
    
    

     
     
     	*	{
       
    
    
    

    
    
    

     
     
     	*		// 打开成功
    
    
    

    
    
    

     
     
     	*	}
    
    
    

    
    
    

     
     
     	*	else
    
    
    

    
    
    

     
     
     	*	{
       
    
    
    

    
    
    

     
     
     	*		// 打开失败
    
    
    

    
    
    

     
     
     	*	}
    
    
    

    
    
    

     
     
     	*   @endcode
    
    
    

    
    
    

     
     
     	*/
    
    
    

    
    
    

     
     
     	bool Open(const char* conn) throw (HiDBException);

该接口的conn参数是一个字符串，这样字符串就具有扩展性，可以针对不同的数据库，进行不同的处理（这一点感觉不是很好，但是能提供接口的稳定性）。不同数据库，需要满足特定的格式，在MySQL中，要使用类似于“host=127.0.0.1;port=3306;dbname=test;user=root;pwd=root;charset=gbk;”的格式。
<3> 关闭数据库连接 
   
   
   

    
    
    

     
     
     	/**
    
    
    

    
    
    

     
     
     	*   @brief 关闭据库连接
    
    
    

    
    
    

     
     
     	*/
    
    
    

    
    
    

     
     
     	void Close(void);

<4> IsOpen接口
这个接口是延伸出来的，既然有open，close，提供一个IsOpen好像也是应该的，让用户了解当前的打开状态。 

   
   
   

    
    
    

     
     
     	/**
    
    
    

    
    
    

     
     
     	*   @brief 数据库连接是否打开
    
    
    

    
    
    

     
     
     	*/
    
    
    

    
    
    

     
     
     	bool IsOpen();

<5> 执行非查询语句接口
执行SQL语句的接口，应该可以接收可变参数，除可变参数外，还应该有一个包含sql语句的字符串参数，所以接口定义如下： 

    
    
    

     
     
     

      
      
      	/**
     
     
     

     
     
     

      
      
      	*   @brief 执行SQL语句，并不返回结果
     
     
     

     
     
     

      
      
      	*	@param[in] conn			SQL语句
     
     
     

     
     
     

      
      
      	*   @retval true：成功，false；失败
     
     
     

     
     
     

      
      
      	*   @par 实例：
     
     
     

     
     
     

      
      
      	*   @code
     
     
     

     
     
     

      
      
      	*	HiDB db;
     
     
     

     
     
     

      
      
      	*	if (db.ExecuteNoQuery("UPDATE table SET Paramer1='%s' 
     
     
     

     
     
     

      
      
      	*		and Paramer2='%s' OR Paramer3=%d", "test1", "test2", 3))
     
     
     

     
     
     

      
      
      	*	{
        
     
     
     

     
     
     

      
      
      	*		// 执行成功
     
     
     

     
     
     

      
      
      	*	}
     
     
     

     
     
     

      
      
      	*	else
     
     
     

     
     
     

      
      
      	*	{
        
     
     
     

     
     
     

      
      
      	*		// 执行失败
     
     
     

     
     
     

      
      
      	*	}
     
     
     

     
     
     

      
      
      	*   @endcode
     
     
     

     
     
     

      
      
      	*/
     
     
     

     
     
     

      
      
      	bool ExecuteNoQuery(const char* sql, ...) throw (HiDBException);

<6>  获得查询结果第一行第一列的接口
该接口的参数与执行非查询语句的接口一致，但是返回值应该为字符串，如果执行失败，则应该返回空字符串。触发异常时，抛出 HiDBException异常。 

   
   
   

    
    
    

     
     
        /**
    
    
    

    
    
    

     
     
     	*   @brief 执行SQL语句，返回一个结果
    
    
    

    
    
    

     
     
     	*	@param[in] sql			SQL语句
    
    
    

    
    
    

     
     
     	*   @retval 获得的数据，如果为空，则失败
    
    
    

    
    
    

     
     
     	*/
    
    
    

    
    
    

     
     
     	std::string ExecuteScalar(const char* sql, ...) throw (HiDBException);

<7>  获得一次查询的所有记录（多行多列）的接口
该接口的参数与执行非查询语句的接口一致。
返回结果应该是包含多行多列的一个数据集，在ADO.NET中有DataTable，在这儿，我们可以用stl中的vector存储多行，map存储每行数据的多列。
多以需要定义一个数据集： 
   
   
   

    
    
    

     
     
     #ifndef HiDBTable
    
    
    

    
    
    

     
     
     
    
    
    

    
    
    

     
     
     typedef std::map<std::string, std::string> HiDBMap;
    
    
    

    
    
    

     
     
     
    
    
    

    
    
    

     
     
     /** @brief 查询结果 */
    
    
    

    
    
    

     
     
     typedef std::
最低0.47元/天 解锁文章
荣-
关注
C++ Qt 项目设计：数据库管理系统设计与实战
探索C++编程的奥秘，分享深入的技术见解和实践，旨在激发读者创造力与解决问题的思维。
05-25 5162
跨平台C++ Qt数据库管理系统设计与实战：从理论到实践的全面解析
16.2：C++面向对象设计模式的分类和使用！（课程共6200字，0段代码举例）
小兔子平安
08-03 51
通过本课程的学习，我们深入理解了C++面向对象设计模式的分类和使用。设计模式提供了一套经过验证的解决方案，帮助我们解决常见的软件设计问题。然而，我们需要注意设计模式的适用性、过度使用、模式之间的关联以及与其他编程原则的结合。只有在深入理解和灵活应用设计模式的基础上，我们才能构建高质量、可维护和可扩展的软件系统。
c++数据库操作类（很好用）
10-08
C++中进行数据开发的时候，可以直接用此代码，会减少很多工作量
C++学习笔记 类的成员函数，数据成员的访问控制，公共，私有，保护。
javasalatu
12-28 373
pubulic： 公有成员：（外部接口） 所有任何外部函数都可以访问公有数据成员和函数成员； private： 私有成员：只允许本类的成员函数可以访问，而类外部的任何函数都不能访问。 紧跟在类声明后面的是private数据成员和函数成员。 protected：和private 类似，但是在派生类中能访问。 protected 成员可以在派上类中使用，但是private只能是...
c++ 数据库操作类
02-27
这个类封装了数据库的 连接 增删改查等功能。希望能帮到你.
我的数据库访问类源代码
08-18
在我参与的多个项目中，大家使用libMySQL操作MySQL数据库，而且是源码即复用，在多个项目中有多套相同或相似的源码，这样的复用方式给开发带来了不变，而且libMySQL的使用比较麻烦，要应对很多的细节，很容易出错。 我要写一个动态链接库，将对libMySQL的操作封装起来，以二进制复用代替源码级复用；要提供线程安全的接口，用户无需关系是否加锁这样细节性的问题，减少出错及死锁的机会，当然也要允许用户自己选择是否线程安全的访问数据库；要简化访问数据库的流程，接口越简单越好。 我从2011年开始写这个库，我给它起名字叫HiDB。
数据库访问类的编写
weixin_34092455的博客
08-17 153
数据库连接类的使用： using System; using System.Data; using System.Configuration; using System.Web; using System.Web.Security; using System.Web.UI; using System.Web.UI.WebControls; using System.Web.UI.W...
C++实现一个小型的学生管理系统 源代码
11-24
这个项目对于学习C++编程和理解面向对象设计原则是一个很好的实践。在实际开发过程中，还可以考虑优化性能、提升用户体验，例如使用数据库存储数据，或者采用图形用户界面（GUI）以提供更直观的操作方式。
23种设计模式之C++实践（一）
最新发布
weixin_50749380的博客
11-28 1344
23种设计模式之C++实践（一）：单例模式、简单工厂模式、工厂方法模式、抽象工厂模式、原型模式、建造者模式。
数据库操作、访问封装类
01-22
C++使用ADO操作访问数据库的封装类 对连接数据库，获得记录集，执行命令进行了封装讲解， 在本人博客中有配套博文详细介绍： http://blog.csdn.net/MingoJiang
CTP接口（含c++示例）
08-08
The standard API of CTP futures transaction is called C++, which is changed to C#.
数据库连接及操作类
qq_30725967的博客
12-22 365
using System.Configuration;//需要在“引用”中也添加 using System.Data.SqlClient;//SQL数据 using System.Data; using System; using System.Windows.Forms; namespace WeightSystem { public class DbHelperSQL { // public ...
c mysql query 错误,C ++ executeQuery（）错误显示表中的MySQL数据
weixin_27427619的博客
01-19 196
I need some help. I had this code (below), to add data to a MySQL table and then return that same table. The code is doing fine, when I run it it adds the column to the MySQL table BUT it stops, with ...
SQLite数据库C_C++接口（保姆级API应用 1.4W字）（全网最详细介绍，学完必掌握）
qq_25218501的博客
08-29 3659
三种查询方式总结 回调函数查询内存开销小，但查询效率相对较低；全缓冲查询的查询效率高，但是内存消耗大；字节缓冲查询兼具查询效率和低开销。（优先使用第三种查询方法） sqlite实现C语言自定义函数封装 由于数据库提供的API接口过于复杂，使用的过程顺序也很繁琐，所以对于原生态的API在实际工作开发中，会进行一层封装，减少调用传参，减少调用次数，增加代码可读性，提高开发效率。 可封装如下：包括创建数据库、建表、插入数据、查询数据、删除数据
事务transaction 详解
xLplus的博客
02-22 1006
在计算机领域里面 事务是一个很重要的概念 百度百科 在计算机术语中是指访问并可能更新数据库中各种数据项的一个程序执行单元(unit)。事务通常由高级数据库操纵语言或编程语言（如SQL，C++或Java）书写的用户程序的执行所引起，并用形如begin transaction和end transaction语句（或函数调用）来界定。事务由事务开始(begin transaction)和事务结束(...
SOCI、LiteSQL、POCO数据库访问类库对比
热门推荐
风水月的专栏
03-26 1万+
最近在做视频的开发，其中视频的设备接入管理服务器、流媒体管理服务器、中心服务器都涉及到了数据库的操作，同时需要兼容大多数版本的数据库，包括mysql、sqlite、oracle。公司原来使用的是ado来进行数据库的开发的， 但是考虑到目前需要兼容linux，目前使用Poco框架封装的数据库模块进行开发。 根据项目情况我对soci、litesql、poco这三个框架进行了简单的学习来确定选
2020.2.10C++学习笔记——C++操作Mysql事务机制（回滚）
CQ的学习笔记
02-10 2155
C++学习笔记——C++操作Mysql事务机制（回滚） Mysql的事务机制（transaction） MySQL 事务主要用于处理操作量大，复杂度高的数据。数据库操作语句构成事务。在 MySQL 中只有使用了 Innodb 数据库引擎的数据库或表才支持事务。事务处理可以用来维护数据库的完整性，保证成批的 SQL 语句要么全部执行，要么全部不执行。事务一般用来管理 insert,update,de...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值