1. 方案簡介

本方案為類人臉門禁機的產品級解決方案，已為用戶構建一個帶調度框架的UI應用工程；準備好我司的easyeai-api鏈接調用；準備好UI的開發環境。具備低模塊耦合度的特點。其目的在于方便用戶快速拓展自定義的業務功能模塊，以及快速更換UI皮膚。

2. 快速上手

2.1 開發環境準備

如果您初次閱讀此文檔，請閱讀《入門指南/開發環境準備/Easy-Eai編譯環境準備與更新》，并按照其相關的操作，進行編譯環境的部署。

在PC端Ubuntu系統中執行run腳本，進入EASY-EAI編譯環境，具體如下所示。

cd ~/develop_environment ./run.sh

2.2 源碼下載以及實例編譯

在EASY-EAI編譯環境下創建存放源碼倉庫的管理目錄：

cd /opt mkdir EASY-EAI-Toolkit cd EASY-EAI-Toolkit

通過git工具，在管理目錄內克隆遠程倉庫

git clone https://github.com/EASY-EAI/EASY-EAI-Toolkit-C-UiSolution.git

注：

* 此處可能會因網絡原因造成卡頓，請耐心等待。

* 如果實在要在gitHub網頁上下載，也要把整個倉庫下載下來，不能單獨下載本實例對應的目錄。

進入到對應的例程目錄執行編譯操作，具體命令如下所示：

cd EASY-EAI-Toolkit-C-UiSolution/qSolu-facialGate/ ./build.sh

注：

* 由于依賴庫部署在板卡上，因此交叉編譯過程中必須保持adb連接。

2.3 模型獲取

【百度網盤】

鏈接：https://pan.baidu.com/s/1mrhVHxHWJ8cY9Fl9k5KtYg

提取碼：0k7j

本方案用到兩個模型：face_detect.model和face_recognition.model

直接把模型下載到本地Windows主機，復制

進入PC端Ubuntu創建存放model目錄：

cd /opt mkdir model

然后把模型從本地Windows主機粘貼到PC端Ubuntu中：

2.4 方案部署

使用下方命令再次回到開發實例目錄

cd /opt/EASY-EAI-Toolkit-C-UiSolution/qSolu-facialGate/

然后，通過執行以下命令，將編譯結果手動部署到板卡中。

cp Release/qSolu-* /mnt/userdata/apps/facialGate cp QResource/audio -r /mnt/userdata/apps/facialGate

最后，將準備好的模型部署到板卡中（注意：模型要放到編譯結果的同一目錄中），執行命令如下所示。

cp /opt/model/face_detect.model /mnt/userdata/apps/facialGate cp /opt/model/face_recognition.model /mnt/userdata/apps/facialGate

2.5 示例方案運行

通過按鍵Ctrl+Shift+T創建一個新窗口，執行adb shell命令，進入板卡運行環境。

adb shell

進入板卡后，定位到例程部署的位置：

cd /userdata/apps/facialGate

運行例程命令如下所示：

./qSolu-facialGate

2.6 運行效果

運行打印：

液晶顯示屏上會顯示如下畫面：

點擊“歡迎”按鈕，可以呼出或者關閉鍵盤。

在對準攝像頭時，點擊注冊，即可完成人臉錄入，錄入后回到待機頁面。

當用戶再次對準攝像頭，即可識別相關的用戶信息，如下圖所示：

3. QtCreator配置

3.1 運行qtcreator

在EASY-EAI編譯環境中的任意位置，通過下方命令，后臺打開qtcreator：

qtcreator &

注：若虛擬機配置較低，打開qtcreator可能要等待10幾秒。

3.2 打開Qt工程

3.3 配置遠程調試參數

注：進行遠程調試前，首先要用build.sh腳本把相關的資源拷貝到【開發板】相對應的目錄上，否則會因缺少文件導致運行異常。

3.4 遠程運行Qt應用

3.5 調試打印輸出&遠程停止應用進程

3.6 修改應用編譯輸出位置

注：任何修改*.pro或者*.pri的操作，都要clean掉Makefile后，再重新編譯。

4. 設計講解

本章節側重于講解代碼組織架構，以便于對代碼的輔助閱讀和理解，因此不涉及具體的操作指導和詳盡的代碼內容解析。若需要進行上手操作的調試和開發，可直接參考“開發指南”章節。

4.1 設計目的

本方案為產品級別的解決方案，需要調度種類繁多的各種資源，而且為了應對不同用戶各自豐富多樣的需求，則需要對功能模塊進行解耦。故而針對該種情況設計了一套模塊調度框架。

4.2 模塊靜態關系

框架概覽 & 源碼目錄分布

源碼目錄說明：

4.3 模塊動態交互

模板間的交互分為兩種，一種是非界面模塊間的交互，另一種是界面模塊間的交互。

4.3.1 非界面模塊之間的交互

非界面模塊間的交互，其特點是通過“應用調度器”進行相互調度。

4.3.2 界面間的模塊交互

界面模塊間的交互，應用了信號槽和事件機制，該種機制也是Qt為了去耦合而進行的針對性設計。而且Qt規定，非gui線程不能操作gui線程，因此從UIManager（非界面）到mainWidget（界面）的調用操作，也必須通過信號槽來完成。

4.4 模塊設計細節

4.4.1 應用調度器

EASY-EAI-Toolkit-C-UiSolution/qSolu-facialGate/QSrcCode/ui/main.cpp是程序入口，應用調度器在此處被創建，是本程序首個被創建的對象，具體代碼如下所示：

AppScheduler App;

應用調度器類的構成與功能：

class AppScheduler { public: AppScheduler(); ~AppScheduler(); int PosDataTo(Modeler mod, void *pData); private: int InitBusinessModel(); int Register(Modeler mod, BusinessCB pCBFunc); int UnRegister(Modeler mod); std::map m_BusinessModel; };

應用調度器實質上是一個回調函數映射表，在創建基礎業務功能塊時，需要把業務功能塊的回調函數注冊到應用調度器的映射中（具體的注冊代碼，會在“開發指南”章節中的“添加一個新的業務功能模塊”涉及）。

4.4.2 基礎業務功能塊

所有的業務功能塊，都要繼承于基礎業務功能塊（BaseModel）。應用調度器是各個BaseModel實例化對象之間的橋梁。

BaseModel源碼位于：

EASY-EAI-Toolkit-C-UiSolution/qSolu-facialGate/QSrcCode/business/basemodel.cpp

EASY-EAI-Toolkit-C-UiSolution/qSolu-facialGate/QSrcCode/business/basemodel.h

class BaseModel { public: explicit BaseModel(); ~BaseModel(); int SetScheduler(AppScheduler *pScheduler); /// 輸出>>>>: 向其他模塊輸出數據 virtual int SendDataToDataAnnouncement(int cmdType, int dataLen, void *data); virtual int SendDataToDataBase(int cmdType, int dataLen, void *data); virtual int SendDataToMainThread(int cmdType, int dataLen, void *data); virtual int SendDataToMsgAdapter(int cmdType, int dataLen, void *data); virtual int SendDataToUI(int tagPage, int cmdType, int dataLen, void *data); private: int SendDataTo(Modeler mod, void *pData); AppScheduler *m_pScheduler; };

BaseModel在初始化時通過SetScheduler方法向子模塊綁定應用調度器對象的指針。在程序交互的過程中通過調用SendDataTo方法向其他子模塊回調發送數據。

5. 開發指南

5.1 示例文件&目錄結構

UiSolution git倉庫僅會放置兩個解決方案。

一是最簡潔的UI調用方案，用戶可以基于此方案，快速進行需要帶界面交互的產品開發。

二是帶調度框架的UI應用方案，該方案為類人臉門禁機的產品級解決方案，其特點是模塊之間的耦合度低，用戶可以快速拓展自定義的業務功能模塊，以及快速更換UI皮膚。

5.1.1 UiSolution git倉庫目錄介紹。

UiSolution工程構成如下所示，由功能組件easyeai-api和各個解決方案構成。

功能組件的描述如下所示，easyeai-api是經過高度封裝的易用性組件接口，便于用戶直接調用板卡資源。

解決方案的描述如下所示，單個“qSolu-”開頭的目錄即為一個解決方案案例，代碼內調用“EASY EAI-API”來滿足某一實際應用場景的需求。

5.1.2 qSolu-facialGate解決方案的目錄結構

每個解決方案就是一個獨立的項目，facialGate項目內包含部分如下所示，項目使用qmake構建自動編譯部署。

具體介紹如下所示。

5.2 *.pro和*.pri文件解析

5.2.1 *.pro文件：

第一部分為輸出配置，如下所示：

配置信息如下所示。

第二部分為全局編譯選項配置，如下所示：

配置信息如下所示。

第三部分為加載自定義子模塊，如下所示：

第四部分為加載資源管理，如下所示：

第五部分為指定文件輸出目錄，如下所示：

5.2.2 api.pri文件：

本工程文件是對我司的功能組件庫的管理，若用戶有“對我司的功能組件庫進行拓展封裝”的需求，則可通過本文件來管理。（針對當前方案進行：配置EASY EAI API頭文件目錄、庫文件目錄以及配置庫鏈接參數）：

配置信息如下所示。

5.2.3 business.pri文件：

本工程文件是具體的應用業務功能管理，用戶封裝的業務功能模塊可放置此處進行管理：

配置信息如下所示。

5.2.4 common.pri文件：

本工程文件是第三方的庫的配置（針對當前方案進行：配置第三方頭文件目錄、庫文件目錄、配置第三方庫鏈接參數以及配置源碼目錄）：

配置信息如下所示。

5.2.5 ui.pri文件：

本工程文件是交互界面相關的源碼文件配置，內容如下所示：

配置項如下所示。

5.3 build.sh編譯腳本：

5.3.1 路徑定位部分

第一部分用于提取目錄用于編譯操作，內容如下所示：（進入build.sh腳本所在目錄，并且提取當前目錄絕對路徑，提取當前目錄名稱）

5.3.2 編譯參數部分

第二部分清除操作，清除目錄為Release，內容如下所示：（執行build.sh腳本時，帶入了參數“clear”，則清空編譯輸出；帶入了參數“all”，則重新編譯）

5.3.3 編譯操作

第三部分，編譯直接調用qmake，內容如下所示：（重新編譯，并生成部署目錄）

5.4 添加一個新的業務功能模塊：

以名字為“myModel”為例：

從工程目錄EASY-EAI-Toolkit-C-UiSolution/qSolu-facialGate切換到business目錄：

cd QSrcCode/business/

5.4.1 創建model源碼文件

在business目錄下執行：

mkdir myModel touch myModel/myModel.cpp touch myModel/myModel.h

在myModel.h中填入源代碼，具體操作為：

輸入命令：

vim myModel/myModel.h

在vim環境下，按“i”后，開始輸入代碼：

#ifndef __MYMODEL_H__ #define __MYMODEL_H__ #include "business/basemodel.h" /* *說明：由于每個模塊都是一個單例對象，因此： * 1,只能通過調用MyModel::createMyModel()去創建。 * 2,除了示例展示的2處new以外，其它地方不能使用new MyModel 去創建，否則會引發程序崩潰 */ class MyModel : public BaseModel { public: explicit MyModel(); ~MyModel(); static MyModel *instance() { if(m_pSelf == NULL){ once_flag oc; call_once(oc, [&] { m_pSelf = new MyModel; }); } return m_pSelf; } static void createMyModel(); private: static MyModel *m_pSelf; }; #endif // __MYMODEL_H__

輸入代碼完畢后，依次按下“Esc鍵”、“：鍵”、“w鍵”、“q鍵”、“回車鍵”保存代碼。（注意：w、q是小寫）

同myModel.h的操作方法，對myModel.cpp填入代碼：

#include "system.h" #include "myModel.h" MyModel *MyModel::m_pSelf = NULL; /* *說明：本回調為“阻塞回調”。因此有以下注意事項： * 1,返回值能夠直接在調用模塊中獲取。 * 2,通過修改輸入參數的指針指向的數據，也能進行數據取回。 * 3,若在此回調進行阻塞操作，調用模塊也會被阻塞。 */ int MyModelCallback(void *data) { /*此回調處理其他模塊送入的消息*/ return 0; } MyModel::MyModel() { /*特別注意：不建議在構造函數內部使用跨模塊調度(m_pScheduler->PosDataTo(mod,data)),目標業務模塊有可能未被注冊*/ } MyModel::~MyModel() { if(m_pSelf){ delete m_pSelf; m_pSelf = NULL; } } void MyModel::createMyModel() { if(m_pSelf == NULL){ once_flag oc; call_once(oc, [&] { m_pSelf = new MyModel; }); } }

5.4.2 修改business.pri文件

在business目錄下執行命令：

vim business.pri

同myModel.h的操作方法，添加下圖所示兩行代碼：

保存退出：

:wq

5.4.3 修改bsprotocol.h文件

在business目錄下執行命令：

vim bsprotocol.h

在模塊映射枚舉中，加入“MYMODEL”索引。

保存退出：

:wq

5.4.4 修改appscheduler.cpp文件

在business目錄下執行命令：

vim appscheduler.app

在appscheduler.cpp文件原有結構基礎上，添加以下代碼：

新增模塊的頭文件：

#include "myModel/myModel.h"

新增模塊的回調函數聲明：

extern int MyModelCallback(void *data);

在AppScheduler中創建并注冊新增模塊：

MyModel::createMyModel(); MyModel::instance()->SetScheduler(this); Register(MYMODEL, MyModelCallback);

保存退出：

:wq

5.4.5 編譯與驗證

回到工程目錄EASY-EAI-Toolkit-C-UiSolution/qSolu-facialGate中，執行命令：

./build.sh all

結果為：編譯成功，且在Release目錄中生成有myModel.o文件。則說明“myModel”業務功能被成功添加

編譯成功截圖：

myModel.o截圖：

5.5 屏蔽某個業務模塊功能：

此操作為本應用調度框架的核心設計，若項目不需要某個功能。僅需在appscheduler.cpp的構造函數中注釋掉其創建與注冊即可。除此以外無須改動任何代碼！因此本調度框架具備極強的靈活性以及低耦合度。

示例：

↓↓↓↓↓

審核編輯 黃宇