基于OpenHarmony标准系统的C++公共基础类库案例：SafeQueue

1、程序简介

该程序是基于OpenHarmony的C++公共基础类库的线程安全队列：SafeQueue。

线程安全队列，是在dequeue的基础上封装std::lock_guard，以此实现线程的相关操作。根据继承SafeQueueInner抽象类，并对dequeue的pop方法的重写，可以实现SafeStack和SafeQueue的相关方法。

本案例主要完成如下工作：

创建2个子线程，1个线程负责入队操作，1个线程负责出队操作

子线程入队操作，每1秒做1次入队操作，循环5次

子线程入队操作，每0.5秒做1次出队操作，循环5次

该案例已在凌蒙派-RK3568开发板验证过，如需要完整源代码，请参考：

https://gitee.com/Lockzhiner-Electronics/lockzhiner-rk3568-openharmony/tree/master/samples/a27_utils_safequeue

2、基础知识

C++公共基础类库为标准系统提供了一些常用的C++开发工具类，包括：

文件、路径、字符串相关操作的能力增强接口

读写锁、信号量、定时器、线程增强及线程池等接口

安全数据容器、数据序列化等接口

各子系统的错误码相关定义

2.1、添加C++公共基础类库依赖

修改需调用模块的BUILD.gn，在external_deps或deps中添加如下：

ohos_shared_library("xxxxx") { ... external_deps = [ ... # 动态库依赖(可选) "c_utils:utils", # 静态库依赖(可选) "c_utils:utilsbase", # Rust动态库依赖(可选) "c_utils:utils_rust", ] ...}

一般而言，我们只需要填写"c_utils:utils"即可。

2.2、SafeQueue头文件

C++公共基础类库的SafeQueue头文件在：//commonlibrary/c_utils/base/include/safe_queue.h

可在源代码中添加如下：

#include

2.3、OHOS::SafeQueueInner接口说明

2.3.1、SafeQueueInner

构造函数。

SafeQueueInner();

2.3.2、~SafeQueueInner()

析构函数。

~SafeQueueInner();

2.3.3、Erase

移除某个元素。

void Erase(T& object);

参数说明：

参数名称	类型	参数说明
object	T	需要移除的元素

2.3.4、Empty

队列判空。

bool Empty();

返回值说明：

类型	返回值说明
bool	true表示成功，false表示失败

2.3.5、Clear

清空队列元素。

void Clear();

2.3.6、Size

获取队列的容量。

int Size();

返回值说明：

类型	返回值说明
int	返回队列的容量

2.3.7、Push

入队操作。

void Push(const T& pt);

参数说明：

参数名称	类型	参数说明
pt	T	需要入队的元素

2.3.8、DoPush

Push底层调用DoPush，需要重写。

virtual void DoPush(const T& pt) = 0;

参数说明：

参数名称	类型	参数说明
pt	T	需要入队的元素

2.3.9、Pop

出队操作。

bool Pop(T& pt);

参数说明：

参数名称	类型	参数说明
pt	T	需要出队的元素

返回值说明：

类型	返回值说明
bool	true表示空，false表示非空

2.3.10、DoPop

出队操作。

virtual bool DoPop(T& pt) = 0;

参数说明：

参数名称	类型	参数说明
pt	T	需要出队的元素

返回值说明：

类型	返回值说明
bool	true表示空，false表示非空

2.4、OHOS::SafeQueue接口说明

SafeQueue继承SafeQueueInner，实现DoPush()和DoPop()。

class SafeQueue : public SafeQueueInner

2.4.1、DoPush

入队操作。

void DoPush(const T& pt);

参数说明：

参数名称	类型	参数说明
pt	T	需要入队的元素

2.4.2、DoPop

出队操作。

bool DoPop(T& pt);

参数说明：

参数名称	类型	参数说明
pt	T	需要出队的元素

返回值说明：

类型	返回值说明
bool	true表示空，false表示非空

3、程序解析

3.1、创建编译引导

在上一级目录BUILD.gn文件添加一行编译引导语句。

import("//build/ohos.gni")
group("samples") { deps = [ "a27_utils_safequeue:utils_safequeue", # 添加该行 ]}

"a27_utils_safequeue:utils_safequeue",该行语句表示引入 参与编译。

3.2、创建编译项目

创建a27_utils_safequeue目录，并添加如下文件：

a27_utils_safequeue├── utils_safequeue_sample.cppp # .cpp源代码├──BUILD.gn#GN文件

3.3、创建BUILD.gn

编辑BUILD.gn文件。

import("//build/ohos.gni")ohos_executable("utils_safequeue") { sources = [ "utils_safequeue_sample.cpp" ] include_dirs = [ "//commonlibrary/c_utils/base/include", "//commonlibrary/c_utils/base:utils", "//third_party/googletest:gtest_main", "//third_party/googletest/googletest/include" ] external_deps = [ "c_utils:utils" ] part_name = "product_rk3568" install_enable = true}

注意：

（1）BUILD.gn中所有的TAB键必须转化为空格，否则会报错。如果自己不知道如何规范化，可以：

# 安装gn工具sudo apt-get install ninja-buildsudo apt install generate-ninja# 规范化BUILD.gngn format BUILD.gn

3.4、创建源代码

3.4.1、创建SafeMap

#include // SafeQueue的头文件
// 定义队列变量static OHOS::SafeQueue m_safeQueue;

3.4.2、创建线程池并设置

int main(int argc, char **argv){ OHOS::ThreadPool threads("threads"); string str_name; ...... threads.SetMaxTaskNum(128); threads.Start(2); ......}

3.4.3、启动2个子线程，并等待结束

调用AddTask()添加子线程，并调用Stop()等待所有子进程结束。

// 开启子线程，使用Pushstr_name = "Thread_SafeQueue_Push";auto task_push = std::bind(funcSafeQueuePush, str_name);threads.AddTask(task_push);
// 开启子线程，使用Popstr_name = "Thread_SafeQueue_Pop";auto task_pop = std::bind(funcSafeQueuePop, str_name);threads.AddTask(task_pop);
// 设置结束，并等待结束threads.Stop();cout << "Threads Stop" << endl;

3.4.4、子线程入队操作

static void funcSafeQueuePush(const string &name){ for (int i = 0; i < 5; i++) { // 入队操作 cout << name << ", Push Start and i = " << i << endl; m_safeQueue.Push(i); cout << name << ", Push Successful and i = " << i << " and value = " << i << endl; // 睡眠1秒 cout << name << ", Sleep 1 sec" << endl; std::sleep_for(std::milliseconds(1000)); }}

3.4.5、子线程出队操作

static void funcSafeQueuePop(const string &name){ bool ret; int value; for (int i = 0; i < 5; i++) { // 出队操作 cout << name << ", Pop Start and i = " << i << endl; ret = m_safeQueue.Pop(value); cout << name << ", Pop Successful and i = " << i << " and ret = " << ret << " and value = " << value << endl; // 睡眠0.5秒 cout << name << ", Sleep 0.5 sec" << endl; std::sleep_for(std::milliseconds(500)); }
}

4、编译步骤

进入OpenHarmony编译环境，运行命令：

hb build -f

5、运行结果

# utils_safequeueThread_SafeQueue_Push, Push Start and i = 0Thread_SafeQueue_Push, Push Successful and i = 0 and value = 0Thread_SafeQueue_Push, Sleep 1 secThread_SafeQueue_Pop, Pop Start and i = 0Thread_SafeQueue_Pop, Pop Successful and i = 0 and ret = 1 and value = 0Thread_SafeQueue_Pop, Sleep 0.5 secThread_SafeQueue_Pop, Pop Start and i = 1Thread_SafeQueue_Pop, Pop Successful and i = 1 and ret = 0 and value = 0Thread_SafeQueue_Pop, Sleep 0.5 secThread_SafeQueue_Push, Push Start and i = 1Thread_SafeQueue_Push, Push Successful and i = 1 and value = 1Thread_SafeQueue_Push, Sleep 1 secThread_SafeQueue_Pop, Pop Start and i = 2Thread_SafeQueue_Pop, Pop Successful and i = 2 and ret = 1 and value = 1Thread_SafeQueue_Pop, Sleep 0.5 secThread_SafeQueue_Pop, Pop Start and i = 3Thread_SafeQueue_Pop, Pop Successful and i = 3 and ret = 0 and value = 1Thread_SafeQueue_Pop, Sleep 0.5 secThread_SafeQueue_Push, Push Start and i = 2Thread_SafeQueue_Push, Push Successful and i = 2 and value = 2Thread_SafeQueue_Push, Sleep 1 secThread_SafeQueue_Pop, Pop Start and i = 4Thread_SafeQueue_Pop, Pop Successful and i = 4 and ret = 1 and value = 2Thread_SafeQueue_Pop, Sleep 0.5 secThread_SafeQueue_Push, Push Start and i = 3Thread_SafeQueue_Push, Push Successful and i = 3 and value = 3Thread_SafeQueue_Push, Sleep 1 secThread_SafeQueue_Push, Push Start and i = 4Thread_SafeQueue_Push, Push Successful and i = 4 and value = 4Thread_SafeQueue_Push, Sleep 1 secThreads Stop#