基于OpenHarmony標準系統(tǒng)的C++公共基礎類庫案例：SafeStack

1、程序簡介

該程序是基于OpenHarmony的C++公共基礎類庫的線程安全隊列：SafeQueue。

線程安全隊列，是在dequeue的基礎上封裝std::lock_guard，以此實現線程的相關操作。根據繼承SafeQueueInner抽象類，并對dequeue的pop方法的重寫，可以實現SafeStack和SafeQueue的相關方法。

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

創(chuàng)建2個子線程，1個線程負責入隊操作，1個線程負責出隊操作

子線程入隊操作，每1秒做1次入隊操作，循環(huán)5次

子線程入隊操作，每2秒做1次出隊操作，循環(huán)5次

該案例已在凌蒙派-RK3568開發(fā)板驗證過，如需要完整源代碼，請參考：

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

2、基礎知識

C++公共基礎類庫為標準系統(tǒng)提供了一些常用的C++開發(fā)工具類，包括：

文件、路徑、字符串相關操作的能力增強接口

讀寫鎖、信號量、定時器、線程增強及線程池等接口

安全數據容器、數據序列化等接口

各子系統(tǒng)的錯誤碼相關定義

2.1、添加C++公共基礎類庫依賴

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

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

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

2.2、SafeStack頭文件

C++公共基礎類庫的SafeStack頭文件在：//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);

參數說明：

2.3.4、Empty

隊列判空。

bool Empty();

返回值說明：

2.3.5、Clear

清空隊列元素。

void Clear();

2.3.6、Size

獲取隊列的容量。

int Size();

返回值說明：

2.3.7、Push

入隊操作。

void Push(const T& pt);

參數說明：

2.3.8、DoPush

Push底層調用DoPush，需要重寫。

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

參數說明：

2.3.9、Pop

出隊操作。

bool Pop(T& pt);

參數說明：

返回值說明：

2.3.10、DoPop

出隊操作。

virtual bool DoPop(T& pt) = 0;

參數說明：

返回值說明：

2.4、OHOS::SafeStack接口說明

SafeSafeStack繼承SafeQueueInner，實現DoPush()和DoPop()。

class SafeStack : public SafeQueueInner

2.4.1、DoPush

入隊操作。

void DoPush(const T& pt);

參數說明：

2.4.2、DoPop

出隊操作。

bool DoPop(T& pt);

參數說明：

返回值說明：

3、程序解析

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

在上一級目錄BUILD.gn文件添加一行編譯引導語句。

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

"a28_utils_safestack:utils_safestack",該行語句表示引入 參與編譯。

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

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

a28_utils_safestack├── utils_safestack_sample.cppp # .cpp源代碼├── BUILD.gn # GN文件

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

編輯BUILD.gn文件。

import("http://build/ohos.gni")ohos_executable("utils_safestack") { sources = [ "utils_safestack_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}

注意：

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

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

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

3.4.1、創(chuàng)建SafeStack

#include // SafeStack的頭文件
// 定義棧變量static OHOS::SafeStack m_safeStack;

3.4.2、創(chuàng)建線程池并設置

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_SafeStack_Push";auto task_push = std::bind(funcSafeStackPush, str_name);threads.AddTask(task_push);
// 開啟子線程，使用Popstr_name = "Thread_SafeStack_Pop";auto task_pop = std::bind(funcSafeStackPop, str_name);threads.AddTask(task_pop);
// 設置結束，并等待結束threads.Stop();cout << "Threads Stop" << endl;

3.4.4、子線程入隊操作

static void funcSafeStackPush(const string &name){ for (int i = 0; i < 5; i++) { // 入隊操作 cout << name << ", Push Start and i = " << i << endl; m_safeStack.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 funcSafeStackPop(const string &name){ bool ret; int value; for (int i = 0; i < 5; i++) { // 出隊操作 cout << name << ", Pop Start and i = " << i << endl; ret = m_safeStack.Pop(value); if (ret) { cout << name << ", Pop Successful and i = " << i << " and ret = " << ret << " and value = " << value << endl; } else { cout << name << ", Pop Failed and i = " << i << endl; } // 睡眠0.5秒 cout << name << ", Sleep 0.5 sec" << endl; std::sleep_for(std::milliseconds(500)); }
}

4、編譯步驟

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

hb build -f

5、運行結果

# utils_safestackThread_SafeStack_Push, Push Start and i = 0Thread_SafeStack_Push, Push Successful and i = 0 and value = 0Thread_SafeStack_Push, Sleep 1 secThread_SafeStack_Pop, Pop Start and i = 0Thread_SafeStack_Pop, Pop Successful and i = 0 and ret = 1 and value = 0Thread_SafeStack_Pop, Sleep 2 secThread_SafeStack_Push, Push Start and i = 1Thread_SafeStack_Push, Push Successful and i = 1 and value = 1Thread_SafeStack_Push, Sleep 1 secThread_SafeStack_Pop, Pop Start and i = 1Thread_SafeStack_Pop, Pop Successful and i = 1 and ret = 1 and value = 1Thread_SafeStack_Pop, Sleep 2 secThread_SafeStack_Push, Push Start and i = 2Thread_SafeStack_Push, Push Successful and i = 2 and value = 2Thread_SafeStack_Push, Sleep 1 secThread_SafeStack_Push, Push Start and i = 3Thread_SafeStack_Push, Push Successful and i = 3 and value = 3Thread_SafeStack_Push, Sleep 1 secThread_SafeStack_Pop, Pop Start and i = 2Thread_SafeStack_Pop, Pop Successful and i = 2 and ret = 1 and value = 3Thread_SafeStack_Pop, Sleep 2 secThread_SafeStack_Push, Push Start and i = 4Thread_SafeStack_Push, Push Successful and i = 4 and value = 4Thread_SafeStack_Push, Sleep 1 secThread_SafeStack_Pop, Pop Start and i = 3Thread_SafeStack_Pop, Pop Successful and i = 3 and ret = 1 and value = 4Thread_SafeStack_Pop, Sleep 2 secThread_SafeStack_Pop, Pop Start and i = 4Thread_SafeStack_Pop, Pop Successful and i = 4 and ret = 1 and value = 2Thread_SafeStack_Pop, Sleep 2 secThreads Stop#