基于OpenHarmony標(biāo)準(zhǔn)系統(tǒng)的C++公共基礎(chǔ)類(lèi)庫(kù)案例：SafeBlockQueue

1、程序簡(jiǎn)介

該程序是基于OpenHarmony的C++公共基礎(chǔ)類(lèi)庫(kù)的讀寫(xiě)鎖：SafeBlockQueue。

線程安全阻塞隊(duì)列SafeBlockQueue類(lèi)，提供阻塞和非阻塞版的入隊(duì)入隊(duì)和出隊(duì)接口，并提供可最追蹤任務(wù)完成狀態(tài)的的SafeBlockQueueTracking類(lèi)。

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

（1）使用SafeBlockQueue接口的案例

判斷命令行是否使用阻塞，還是非阻塞；

創(chuàng)建子線程生產(chǎn)者，使用阻塞/非阻塞方式，入隊(duì)操作；

創(chuàng)建子線程消費(fèi)者，使用阻塞/非阻塞方式，出隊(duì)操作；

主線程等待所有子線程結(jié)束

（2）使用SafeBlockQueueTracking接口的案例

判斷命令行是否使用阻塞，還是非阻塞；

創(chuàng)建子線程生產(chǎn)者，使用阻塞/非阻塞方式，入隊(duì)操作；

創(chuàng)建子線程消費(fèi)者，使用阻塞/非阻塞方式，出隊(duì)操作；

主線程等待所有子線程結(jié)束

該案例已在凌蒙派-RK3568開(kāi)發(fā)板驗(yàn)證過(guò)，如需要完整源代碼，請(qǐng)參考：

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

2、基礎(chǔ)知識(shí)

C++公共基礎(chǔ)類(lèi)庫(kù)為標(biāo)準(zhǔn)系統(tǒng)提供了一些常用的C++開(kāi)發(fā)工具類(lèi)，包括：

文件、路徑、字符串相關(guān)操作的能力增強(qiáng)接口

讀寫(xiě)鎖、信號(hào)量、定時(shí)器、線程增強(qiáng)及線程池等接口

安全數(shù)據(jù)容器、數(shù)據(jù)序列化等接口

各子系統(tǒng)的錯(cuò)誤碼相關(guān)定義

2.1、添加C++公共基礎(chǔ)類(lèi)庫(kù)依賴(lài)

修改需調(diào)用模塊的BUILD.gn，在external_deps或deps中添加如下：

ohos_shared_library("xxxxx") { ... external_deps = [ ... # 動(dòng)態(tài)庫(kù)依賴(lài)(可選) "c_utils:utils", # 靜態(tài)庫(kù)依賴(lài)(可選) "c_utils:utilsbase", # Rust動(dòng)態(tài)庫(kù)依賴(lài)(可選) "c_utils:utils_rust", ] ...}

一般而言，我們只需要填寫(xiě)"c_utils:utils"即可。

2.2、SafeBlockQueue頭文件

C++公共基礎(chǔ)類(lèi)庫(kù)的SafeBlockQueue頭文件在：//commonlibrary/c_utils/base/include/safe_block_queue.h

可在源代碼中添加如下：

#include

2.3、OHOS::SafeBlockQueue接口說(shuō)明

2.3.1、SafeBlockQueue

構(gòu)造函數(shù)。

SafeBlockQueue(int capacity)

參數(shù)說(shuō)明：

2.3.2、~SafeBlockQueue

析構(gòu)函數(shù)。

~SafeBlockQueue();

2.3.3、Push

入隊(duì)操作(阻塞版)。

void virtual Push(T const& elem);

2.3.4、PushNoWait

入隊(duì)操作(非阻塞版)。

bool virtual PushNoWait(T const& elem);

返回值說(shuō)明：

2.3.5、Pop

出隊(duì)操作(阻塞版)。

T Pop();

返回值說(shuō)明：

2.3.6、PopNotWait

出隊(duì)操作(非阻塞版)。

bool PopNotWait(T& outtask);

參數(shù)說(shuō)明：

返回值說(shuō)明：

2.3.7、Size

獲取隊(duì)列容量。

unsigned int Size();

返回值說(shuō)明：

2.3.8、IsEmpty

隊(duì)列判空。

bool IsEmpty;

返回值說(shuō)明：

2.3.9、IsFull

判斷map是否為滿。

bool IsFull();

返回值說(shuō)明：

2.4、OHOS::SafeBlockQueueTracking接口說(shuō)明

2.4.1、SafeBlockQueue

構(gòu)造函數(shù)。

SafeBlockQueue(int capacity)

參數(shù)說(shuō)明：

2.4.2、~SafeBlockQueue

析構(gòu)函數(shù)。

~SafeBlockQueue();

2.4.3、Push

入隊(duì)操作(阻塞版)。

void virtual Push(T const& elem);

2.4.4、PushNoWait

入隊(duì)操作(非阻塞版)。

bool virtual PushNoWait(T const& elem);

返回值說(shuō)明：

3、程序解析

3.1、創(chuàng)建編譯引導(dǎo)

在上一級(jí)目錄BUILD.gn文件添加一行編譯引導(dǎo)語(yǔ)句。

import("http://build/ohos.gni")
group("samples") { deps = [ "a29_utils_safeblockqueue:utils_safeblockqueue", # 添加該行 ]}

"a29_utils_safeblockqueue:utils_safeblockqueue",該行語(yǔ)句表示引入 參與編譯。

3.2、創(chuàng)建編譯項(xiàng)目

創(chuàng)建a29_utils_safeblockqueue目錄，并添加如下文件：

a29_utils_safeblockqueue├── utils_safeblockqueue_sample.cpp # .cpp源代碼├── utils_safeblockqueuetracking_sample.cpp # .cpp源代碼├── BUILD.gn # GN文件

3.3、創(chuàng)建BUILD.gn

編輯BUILD.gn文件。

import("http://build/ohos.gni")
ohos_executable("utils_safeblockqueue_test") { sources = [ "utils_safeblockqueue_sample.cpp" ] include_dirs = [ "http://commonlibrary/c_utils/base/include", "http://commonlibrary/c_utils/base:utils", "http://third_party/googletest:gtest_main", "http://third_party/googletest/googletest/include" ] external_deps = [ "c_utils:utils" ] part_name = "product_rk3568" install_enable = true}
ohos_executable("utils_safeblockqueue_tracking") { sources = [ "utils_safeblockqueuetracking_sample.cpp" ] include_dirs = [ "http://commonlibrary/c_utils/base/include", "http://commonlibrary/c_utils/base:utils", "http://third_party/googletest:gtest_main", "http://third_party/googletest/googletest/include" ] external_deps = [ "c_utils:utils" ] part_name = "product_rk3568" install_enable = true}
group("utils_safeblockqueue") { deps = [ ":utils_safeblockqueue_test", # 構(gòu)建SafeBlockQueue案例 ":utils_safeblockqueue_tracking", # 構(gòu)建SafeBlockQueueTracking案例 ]}

注意：

（1）BUILD.gn中所有的TAB鍵必須轉(zhuǎn)化為空格，否則會(huì)報(bào)錯(cuò)。如果自己不知道如何規(guī)范化，可以：

# 安裝gn工具sudo apt-get install ninja-buildsudo apt install generate-ninja# 規(guī)范化BUILD.gngn format BUILD.gn

3.4、創(chuàng)建SafeBlockQueue案例源代碼

3.4.1、創(chuàng)建SafeBlockQueue變量

#include // SafeBlockQueue的頭文件
// 定義常量const int SIZE = 5;// 定義SafeBlockQueue變量OHOS::SafeBlockQueue m_safeBlockQueue(SIZE);

3.4.2、獲知運(yùn)行阻塞/非阻塞方式

命令有1個(gè)參數(shù)，分別是：

wait：使用阻塞方式的SafeBlockQueue；

nowait：使用非阻塞方式的SafeBlockQueue；

int main(int argc, char **argv){ bool enable_wait = true; ...... // 獲取命令行參數(shù) if (argc != 2) { cout << "Usage: " << argv[0] << " " << STRING_WAIT << "/" << STRING_NOWAIT << endl; return -1; } if (strncmp(argv[1], STRING_WAIT, sizeof(STRING_WAIT)) == 0) { enable_wait = true; } else if (strncmp(argv[1], STRING_NOWAIT, sizeof(STRING_NOWAIT)) == 0) { enable_wait = false; } else { cout << "Usage: " << argv[0] << " " << STRING_WAIT << "/" << STRING_NOWAIT << endl; return -1; }}

3.4.3、創(chuàng)建線程池并設(shè)置子線程數(shù)量

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

3.4.4、啟動(dòng)2個(gè)子線程，并等待結(jié)束

調(diào)用AddTask()添加子線程，并調(diào)用Stop()等待所有子進(jìn)程結(jié)束。

// 創(chuàng)建生產(chǎn)者線程cout << get_curtime() << ", " << __func__ << ": task_product start" << endl;auto task_product = (enable_wait) ? (std::bind(product_wait, str_name)) : (std::bind(product_nowait, str_name));threads.AddTask(task_product);
// 等待SIZE秒，將SafeBlockQueue容器填滿cout << get_curtime() << ", " << __func__ << ": sleep " << SIZE << " sec" << endl;std::sleep_for(std::milliseconds(1000 * SIZE));
// 創(chuàng)建消費(fèi)者線程cout << get_curtime() << ", " << __func__ << ": consume start" << endl; auto task_consumer = (enable_wait) ? (std::bind(consume_wait, str_name)) : (std::bind(consume_nowait, str_name));threads.AddTask(task_consumer);
threads.Stop();cout << get_curtime() << ", " << __func__ << ": Queue Wait End" << endl;

3.4.5、子線程生產(chǎn)者，使用阻塞方式

static void product_wait(const string &name){ for (int i = 0; i < (2 * SIZE); i++) { cout << get_curtime() << ", " << __func__ << ": Push Start, i = " << i << endl; // 使用阻塞方式的SafeBlockQueue m_safeBlockQueue.Push(i); cout << get_curtime() << ", " << __func__ << ": Push Success, i = " << i << endl; // 等待1秒 cout << get_curtime() << ", " << __func__ << ": Sleep 1 sec " << endl; std::sleep_for(std::milliseconds(1000)); }}

3.4.6、子線程消費(fèi)者，使用阻塞方式

static void consume_wait(const string &name){ for (int i = 0; i < (2 * SIZE); i++) { cout << get_curtime() << ", " << __func__ << ": Pop Start, i = " << i << endl; // 使用阻塞方式的SafeBlockQueue int value = m_safeBlockQueue.Pop(); cout << get_curtime() << ", " << __func__ << ": Pop Success, i = " << i << ", value = " << value << endl; // 等待0.5秒 cout << get_curtime() << ", " << __func__ << ": Sleep 0.5 sec " << endl; std::sleep_for(std::milliseconds(500)); }}

3.4.7、子線程生產(chǎn)者，使用非阻塞方式

static void product_nowait(const string &name){ bool ret; for (int i = 0; i < (2 * SIZE); i++) { cout << get_curtime() << ", " << __func__ << ": Push Start, i = " << i << endl; // 使用非阻塞方式的SafeBlockQueue ret = m_safeBlockQueue.PushNoWait(i); cout << get_curtime() << ", " << __func__ << ": Push ret = " << ret << ", i = " << i << endl; // 等待1秒 cout << get_curtime() << ", " << __func__ << ": Sleep 1 sec " << endl; std::sleep_for(std::milliseconds(1000)); }}

3.4.8、子線程消費(fèi)者，使用非阻塞方式

static void consume_nowait(const string &name){ for (int i = 0; i < (SIZE * 2); i++) { // 等待有新數(shù)據(jù) int value = 0; // 使用非阻塞方式的SafeBlockQueue bool ret = m_safeBlockQueue.PopNotWait(value); cout << get_curtime() << ", " << __func__ << ": PopNotWait ret = " << ret << ", value = " << value << endl; // 等待500毫秒 std::sleep_for(std::milliseconds(500)); }}

3.5、創(chuàng)建SafeBlockQueueTracking案例源代碼

3.5.1、創(chuàng)建SafeBlockQueueTracking變量

#include // SafeBlockQueue的頭文件
// 定義常量const int SIZE = 5;// 定義SafeBlockQueue變量OHOS::SafeBlockQueueTracking m_safeBlockQueueTracking(SIZE);

3.5.2、獲知運(yùn)行阻塞/非阻塞方式

命令有1個(gè)參數(shù)，分別是：

wait：使用阻塞方式的SafeBlockQueue；

nowait：使用非阻塞方式的SafeBlockQueue；

int main(int argc, char **argv){ bool enable_wait = true; ...... // 獲取命令行參數(shù) if (argc != 2) { cout << "Usage: " << argv[0] << " " << STRING_WAIT << "/" << STRING_NOWAIT << endl; return -1; } if (strncmp(argv[1], STRING_WAIT, sizeof(STRING_WAIT)) == 0) { enable_wait = true; } else if (strncmp(argv[1], STRING_NOWAIT, sizeof(STRING_NOWAIT)) == 0) { enable_wait = false; } else { cout << "Usage: " << argv[0] << " " << STRING_WAIT << "/" << STRING_NOWAIT << endl; return -1; }}

3.5.3、創(chuàng)建線程池并設(shè)置子線程數(shù)量

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

3.5.4、啟動(dòng)2個(gè)子線程，并等待結(jié)束

調(diào)用AddTask()添加子線程，并調(diào)用Stop()等待所有子進(jìn)程結(jié)束。

// 創(chuàng)建生產(chǎn)者線程cout << get_curtime() << ", " << __func__ << ": task_product start" << endl;auto task_product = (enable_wait) ? (std::bind(product_wait, str_name)) : (std::bind(product_nowait, str_name));threads.AddTask(task_product);
// 等待SIZE秒，將SafeBlockQueue容器填滿cout << get_curtime() << ", " << __func__ << ": sleep " << SIZE << " sec" << endl;std::sleep_for(std::milliseconds(1000 * SIZE));
// 創(chuàng)建消費(fèi)者線程cout << get_curtime() << ", " << __func__ << ": consume start" << endl; auto task_consumer = (enable_wait) ? (std::bind(consume_wait, str_name)) : (std::bind(consume_nowait, str_name));threads.AddTask(task_consumer);
threads.Stop();cout<

3.5.5、子線程生產(chǎn)者，使用阻塞方式

static void product_wait(const string &name){ for (int i = 0; i < (2 * SIZE); i++) { cout << get_curtime() << ", " << __func__ << ": Push Start, i = " << i << endl; // 使用阻塞方式的SafeBlockQueueTracking m_safeBlockQueueTracking.Push(i); cout << get_curtime() << ", " << __func__ << ": Push Success, i = " << i << endl; // 等待1秒 cout << get_curtime() << ", " << __func__ << ": Sleep 1 sec " << endl; std::sleep_for(std::milliseconds(1000)); }}

3.5.6、子線程消費(fèi)者，使用阻塞方式

static void consume_wait(const string &name){ for (int i = 0; i < (2 * SIZE); i++) { cout << get_curtime() << ", " << __func__ << ": Pop Start, i = " << i << endl; // 使用阻塞方式的SafeBlockQueueTracking int value = m_safeBlockQueueTracking.Pop(); cout << get_curtime() << ", " << __func__ << ": Pop Success, i = " << i << ", value = " << value << endl; m_safeBlockQueueTracking.OneTaskDone(); cout << get_curtime() << ", " << __func__ << ": Push OneTaskDone successful" << endl; // 等待0.5秒 cout << get_curtime() << ", " << __func__ << ": Sleep 0.5 sec " << endl; std::sleep_for(std::milliseconds(500)); }
}

3.5.7、子線程生產(chǎn)者，使用非阻塞方式

static void product_nowait(const string &name){ bool ret; for (int i = 0; i < (2 * SIZE); i++) { cout << get_curtime() << ", " << __func__ << ": Push Start, i = " << i << endl; // 使用非阻塞方式的SafeBlockQueueTracking ret = m_safeBlockQueueTracking.PushNoWait(i); cout << get_curtime() << ", " << __func__ << ": Push ret = " << ret << ", i = " << i << endl; if (ret == true) { m_safeBlockQueueTracking.OneTaskDone(); cout << get_curtime() << ", " << __func__ << ": Push OneTaskDone successful" << endl; } // 等待1秒 cout << get_curtime() << ", " << __func__ << ": Sleep 1 sec " << endl; std::sleep_for(std::milliseconds(1000)); }}

3.5.8、子線程消費(fèi)者，使用非阻塞方式

static void consume_nowait(const string &name){ for (int i = 0; i < (SIZE * 2); i++) { // 等待有新數(shù)據(jù) int value = 0; // 使用非阻塞方式的SafeBlockQueueTracking bool ret = m_safeBlockQueueTracking.PopNotWait(value); cout << get_curtime() << ", " << __func__ << ": PopNotWait ret = " << ret << ", value = " << value << endl; // 等待500毫秒 std::sleep_for(std::milliseconds(500)); }
}

4、編譯步驟

進(jìn)入OpenHarmony編譯環(huán)境，運(yùn)行命令：

hb build -f

5、運(yùn)行結(jié)果

#