OpenHarmony NAPI模塊注冊流程介紹
前言
關于NAPI接口相關知識,之前我們介紹過NAPI同步異步接口使用方法、應用啟動觸發的ArkUI ets_runtime啟動流程,從NAPI使用到整體流程給大家做了介紹,本次我們針對NAPI模塊注冊流程做深入介紹,給大家后續工作中開發、使用NAPI接口提供指導。
一、模塊注冊簡介
NAPI模塊注冊是在系統框架層 與 應用層的相互配合下完成的,下面簡要介紹一下大致流程。
首先,提供NAPI接口定義給應用層,一般是打包到SDK中,供應用開發者查詢使用;
其次,NAPI接口在框架層實現其業務邏輯代碼后,
最后,在編譯腳本中定義模塊對外接口方法,可以是靜態庫或者動態庫,也可以是可執行文件方式,當前OpenHarmony庫中NAPI模塊,大多通過動態庫方式加載。
對于應用層,首先引用需要的NAPI所在的庫名,然后通過庫名調用模塊內相應的接口;
上面我們簡要介紹了NAPI模塊注冊的流程,接下來我們對應用層如何觸發NAPI模塊加載、模塊注冊,以及系統框架層在收到加載、注冊請求后如何處理,進而調用到引擎層面。
二、注冊流程詳解
1、模塊注冊
Ability線程初始化
應用hap包安裝到設備后,啟動應用程序時,通過foundation進程fork出應用進程,應用進程的主線程,根據包中的應用類型(FA或Stage)、 UI風格(js或ets)初始化Ability,我們以FA模型、ets UI為例,展開描述。
Ability初始化時,會判斷當前Ability類型(AceAbility、PageAbility、ServiceAblity等),進而調用相應類型Ability的初始化,在AceAbility初始化時,需要先創建AceContainer,后續可以通過AceContainer獲取包信息、窗口信息。
創建AceContainer時,需要初始化UI前端,以及初始化引擎,引擎初始化時,前端會拉起js線程,進而進入UI后端引擎初始化流程。
js線程初始化
js線程進行后端引擎初始化時,首先進行js Runtime初始化,在運行環境中創建js虛擬機vm,根據虛擬機創建NativeEngine。
NativeEgine會根據后端引擎類型,調用相應的子類NativeEgine,目前標準系統支持的后端引擎:QuickJS引擎、Ark引擎,編譯選項可自定義引擎類型,此處我們以ark引擎為例講解。
應用代碼中的:
import XXX from "@ohos.xxx"
經過前端處理打包后,生成的代碼為映射為:
globalThis.requireNapi("xxx")
創建后端ark引擎時,會定義requireNapi接口,接口中通過模塊管理器加載模塊。
加載模塊時,首先從緩存中查找已加載的模塊是否匹配,首次加載的模塊緩存中是不存在的,查找失?。?br>緩存中查找失敗后,則從硬盤中加載,首次加載均是從硬盤加載。
庫加載成功后,根據已加載的nativeModule回調NAPI模塊注冊時定義的回調函數。
2、模塊選擇
模塊選擇時,首先從緩存的已加載模塊中匹配是否存在需要的模塊,若存在則直接用緩存的進行后續接口查找;
否則從硬盤中加載庫,根據注冊信息獲取模塊信息;
(1)FindNativeModuleByCache
從緩存中查找模塊時,根據import模塊名查找是否被load過(nm_modname),若查找不成功,則從硬盤中加載庫;
否則,繼續檢查模塊是否被加載過,若被加載過,則返回模塊信息,進行后續接口處理;若未被加載,則要查找的模塊插入已加載模塊鏈表尾部;進行后續從硬盤中加載庫;
(2)FindNativeModuleByDisk
從硬盤中加載庫時,首先調用GetNativeModulePath獲取對應的庫路徑,選路徑時,首先將要查找的庫名進行小寫處理,然后獲取匹配首選路徑、備選路徑(首先路徑_napi),然后依次匹配,若查找成功,則會調用dlopen打開庫,首次dlopen時,會調用庫的構造回調進行已加載模塊注冊處理,將模塊信息寫到已加載模塊鏈表中;
至此模塊注冊、查找流程結束。
總結
本文介紹了NAPI模塊注冊流程,后續大家開發中需要注意以下幾點:
1.庫名一定要小寫。
2.模塊名與庫名要一致,大小寫可不一致。
3.庫名AA、AA_napi均能匹配成功,優先匹配AA。
4.應用首次調用接口時觸發模塊注冊。