代碼工程及構(gòu)建介紹
背景
ArkUI作為OpenHarmony的默認(rèn)開發(fā)框架,在本項目(ArkUI-X)中需要做到一套代碼同時支持多平臺構(gòu)建,所以會采取共倉開發(fā)的方式,部分倉直接指向OpenHarmony相關(guān)開源倉。
代碼結(jié)構(gòu)及倉庫結(jié)構(gòu)
代碼工程的目錄結(jié)構(gòu)如下:
├── arkcompiler // 方舟編譯器
├── base // 基礎(chǔ)能力
├── build // 項目構(gòu)建和配置腳本
├── build_plugins // 跨平臺構(gòu)建插件
├── commonlibrary // 公共基礎(chǔ)庫
├── community // 社區(qū)相關(guān)
├── developtools // 開發(fā)者工具
├── docs // 配套文檔
├── foundation
│ ├── appframework // 應(yīng)用框架兼容適配層
│ ├── arkui // ArkUI引擎
│ ├── communication // 通信能力
│ ├── distributeddatamgr // 分布式數(shù)據(jù)管理
│ ├── filemanagement // 文件管理
│ ├── graphic // 圖形引擎
│ └── multimedia // 多媒體
├── interface // 接口聲明
├── plugins // 插件管理與實現(xiàn)
├── prebuilts // 預(yù)編譯目錄
├── productdefine // 產(chǎn)品形態(tài)配置
├── samples // 示例代碼
├── test // 測試框架與用例
└── third_party // 三方庫
`HarmonyOS與OpenHarmony鴻蒙文檔籽料:mau123789是v直接拿`
具體的代碼結(jié)構(gòu)及指向,見下表:
目錄路徑 | 描述 | 代碼倉位置 |
---|---|---|
build | 項目構(gòu)建和配置腳本 | [OpenHarmony/build] |
build_plugins | 跨平臺構(gòu)建插件 | [ArkUI-X/build_plugins] |
samples | 應(yīng)用程序樣例 | [ArkUI-X/samples] |
community | 社區(qū)運(yùn)作管理 | [ArkUI-X/community] |
docs | 說明文檔 | [ArkUI-X/docs] |
interface/sdk | ArkUI-X SDK配置 | [ArkUI-X/interface_sdk] |
plugins | API插件管理,OpenHarmony API插件實現(xiàn) | [ArkUI-X/plugins] |
test/xts | ArkUI-X跨平臺應(yīng)用測試套件 | [ArkUI-X/xts] |
test/testfwk/arkxtest | ArkUI-X測試框架 | [ArkUI-X/arkxtest] |
developtools/ace_tools | 跨平臺命令行工具 | [ArkUI-X/cli] |
foundation/appframework | 應(yīng)用框架兼容適配層 | [ArkUI-X/app_framework] |
foundation/arkui/ace_engine/adapter/android | Android平臺適配代碼 | [ArkUI-X/arkui_for_android] |
foundation/arkui/ace_engine/adapter/ios | iOS平臺適配代碼 | [ArkUI-X/arkui_for_ios] |
foundation/arkui/ace_engine | ArkUI 引擎核心代碼 | [OpenHarmony/arkui_ace_engine] |
foundation/arkui/napi | Native API擴(kuò)展機(jī)制 | [OpenHarmony/arkui_napi] |
foundation/communication/netmanager_base | 網(wǎng)絡(luò)管理模塊 | [OpenHarmony/communication_netmanager_base] |
foundation/communication/netstack | 網(wǎng)絡(luò)協(xié)議棧 | [OpenHarmony/communication_netstack] |
foundation/graphic/graphic_2d | 2D圖形基礎(chǔ)庫 | [OpenHarmony/graphic_graphic_2d] |
foundation/filemanagement/file_api | 提供目錄和文件的訪問操作接口 | [OpenHarmony/filemanagement_file_api] |
foundation/multimedia/image_framework | 圖片編解碼功能實現(xiàn) | [OpenHarmony/multimedia_image_framework] |
developtools/ace_ets2bundle | 基于ArkTS的聲明式開發(fā)范式編譯轉(zhuǎn)換工具和跨平臺應(yīng)用構(gòu)建工具 | [OpenHarmony/ace_ets2bundle] |
developtools/ace_js2bundle | 兼容JS的類Web開發(fā)范式編譯轉(zhuǎn)換工具和跨平臺應(yīng)用構(gòu)建工具 | [OpenHarmony/ace_js2bundle] |
arkcompiler/ets_frontend | 方舟前端工具 | [OpenHarmony/arkcompiler_ets_frontend] |
arkcompiler/ets_runtime | 方舟ArkTS運(yùn)行時 | [OpenHarmony/arkcompiler_ets_runtime] |
arkcompiler/runtime_core | 方舟編譯器運(yùn)行時 | [OpenHarmony/arkcompiler_runtime_core] |
arkcompiler/toolchain | 調(diào)試調(diào)優(yōu)工具 | [OpenHarmony/arkcompiler_toolchain] |
prebuilts | 預(yù)編譯目錄,python,nodejs,clang和cmake等 | 通過腳本預(yù)下載 |
third_party | 開源第三方組件(統(tǒng)一復(fù)用OpenHarmony代碼倉) | 引用開源三方庫集合 |
commonliary/c_utils | 通用的C++功能函數(shù)和類 | [OpenHarmony/commonliary_c_utils] |
commonliary/ets_utils | 用于存放基礎(chǔ)類庫JSAPI,比如url、uri等 | [OpenHarmony/commonliary_ets_utils] |
base/hiviewdfx/hilog | 系統(tǒng)日志功能 | [OpenHarmony/hiviewdfx_hilog] |
base/web/webview | WebView組件的Native引擎 | [OpenHarmony/web_webview] |
base/global/resource_management | 全球化資源管理 | [OpenHarmony/global_resource_management] |
分支同步策略
OpenHarmony相關(guān)代碼倉,指向OpenHarmony master分支的固定tag點(diǎn),定期同步,默認(rèn)按照OpenHarmony的Weekly分支頻率進(jìn)行同步。
ArkUI引擎核心代碼倉目錄結(jié)構(gòu)
ArkUI引擎核心代碼倉 ace_engine
的目錄結(jié)構(gòu)以及每個目錄的內(nèi)容如下:
foundation/arkui/ace_engine
├── ace_config.gni // 全局配置文件
├── adapter // 平臺適配層
│ ├── android // Android平臺適配,獨(dú)立倉
│ │ ├── build
│ │ ├── capability
│ │ ├── entrance
│ │ ├── stage
│ │ └── osal
│ ├── ios // iOS平臺適配,獨(dú)立倉
│ │ ├── build
│ │ ├── capability
│ │ ├── entrance
│ │ ├── stage
│ │ └── osal
│ ├── ohos // OpenHarmony平臺適配
│ └── preview // 預(yù)覽器平臺適配
├── build // 編譯配置
│ ├── ace_gen_obj.gni
│ ├── ace_lib.gni
│ ├── BUILD.gn
│ ├── search.py
│ └── tools
├── BUILD.gn // 全局編譯配置
├── frameworks // 引擎框架層
│ ├── base // base庫
│ ├── bridge // 前端橋接
│ └── core // 引擎核心實現(xiàn)
├── interfaces // 通用對外接口
│ └── napi
│ └── kits
├── LICENSE
├── OAT.xml
├── README.md
├── README_zh.md
└── test // 測試相關(guān)
編譯構(gòu)建流程
為了支持一套代碼在OpenHarmony和其它平臺同時構(gòu)建,需要根據(jù)代碼結(jié)構(gòu)動態(tài)對編譯配置進(jìn)行調(diào)整,因為對外依賴可能不同,并且不同環(huán)境下可能依賴的外部源碼都有差異,所以必須對編譯目標(biāo)(targets)都進(jìn)行動態(tài)的定義,否則無法保持一致。
編譯入口: OpenHarmony的編譯入口為bundle.json,這里定義了子系統(tǒng)的部件以及對外的接口,放在對應(yīng)子系統(tǒng)根目錄下,ArkUI的其它平臺構(gòu)建暫不需要,使用固定模塊名“ace_packages”作為入口。
全局配置: 根目錄下的BUILD.gn以及ace_config.gni為全局的配置,其中BUILD.gn下定義了全局使用的“ace_config”、“ace_test_config”,其中ace_config.gni分別定義了以下配置:
- 全局的變量配置,如“enable_ace_debug”,通過開關(guān)進(jìn)行編譯控制。
- 全局的路徑定義,如“ace_napi“,配置路徑的變量。
- 工具鏈相關(guān)的配置,如“windows_buildtool”。
- 在“ace_config”中使用的全局宏的定義,如“ace_common_defines”。
- 生成平臺相關(guān)的配置項“ace_platforms”,這一步是動態(tài)定義目標(biāo)的關(guān)鍵,見如下代碼:
ace_platforms = [] # 通過搜索adapter下的目錄,生成所有的adapter目錄名 _ace_adapter_dir = rebase_path("$ace_root/adapter", root_build_dir) _adapters = exec_script("build/search.py", [ _ace_adapter_dir ], "list lines") # 導(dǎo)入每個adapter下的platform.gni,生成platform的定義配置,加入到ace_platforms中 foreach(item, _adapters) { import_var = {} import_var = { import("$ace_root/adapter/$item/build/platform.gni") } if (defined(import_var.platforms)) { foreach(platform, import_var.platforms) { if (defined(platform.name)) { ace_platforms += [ platform ] } } } }
平臺配置: 每個adapter下的build目錄存放平臺相關(guān)的配置
├── BUILD.gn // 入口目標(biāo)定義,如"ace_packages" ├── config.gni // 平臺配置 ├── bundle.json // 部件配置,非OpenHarmony平臺暫不需要 └── platform.gni // 平臺定義
其中,單個config.gni的配置類似如下:
defines = [ "OHOS_PLATFORM", "OHOS_STANDARD_SYSTEM", ] js_engines = [] ark_engine = { engine_name = "ark" engine_path = "jsi" engine_defines = [ "USE_ARK_ENGINE" ] } js_engines += [ ark_engine ] disable_gpu = true use_external_icu = "shared" use_curl_download = true ohos_standard_fontmgr = true sk_use_hilog = true accessibility_support = false rich_components_support = true advance_components_support = false form_components_support = false if (disable_gpu) { defines += [ "GPU_DISABLED" ] } cflags_cc = [ "-Wno-thread-safety-attributes", "-Wno-thread-safety-analysis", ] platform_deps = [ "http://foundation/arkui/ace_engine/adapter/ohos/entrance:ace_ohos_standard_entrance", "http://foundation/arkui/ace_engine/adapter/ohos/osal:ace_osal_ohos", ]
這個文件定義了該平臺的所有差異化配置,如宏、cflags、平臺特有的依賴,以及一些功能性的開關(guān)。在具體的模塊定義中,宏、cflags這一類編譯配置直接從config引入,其它差異需要定義為功能性的開關(guān),如上述的“use_curl_download”,使模塊gn及特性的定義更清晰。
動態(tài)目標(biāo)定義: 基于上述平臺的配置,就可以實現(xiàn)動態(tài)的定義目標(biāo),以base模塊為例:
import("http://build/ohos.gni") import("http://foundation/arkui/ace_engine/ace_config.gni") template("ace_base_source_set") { forward_variables_from(invoker, "*") ohos_source_set(target_name) { # 引入平臺config中的define和cflags defines += invoker.defines cflags_cc = [] cflags_cc += invoker.cflags_cc deps = [ "$ace_root/build/third_party/cJSON:third_party_cjson", "i18n:ace_base_i18n_$platform", "resource:ace_resource", ] configs = [ "$ace_root:ace_config" ] # add base source file here sources = [ "geometry/animatable_dimension.cpp", "geometry/animatable_matrix4.cpp", "geometry/matrix4.cpp", "geometry/quaternion.cpp", "geometry/transform_util.cpp", "json/json_util.cpp", "log/ace_trace.cpp", "log/dump_log.cpp", "memory/memory_monitor.cpp", "thread/background_task_executor.cpp", "utils/base_id.cpp", "utils/date_util.cpp", "utils/resource_configuration.cpp", "utils/string_utils.cpp", "utils/time_util.cpp", ] # 通過platform變量來進(jìn)行區(qū)別配置 if (platform != "windows") { # add secure c API include_dirs = [ "http://utils/native/base/include" ] sources += [ "http://utils/native/base/src/securec/memset_s.c", "http://utils/native/base/src/securec/securecutil.c", "http://utils/native/base/src/securec/secureprintoutput_a.c", "http://utils/native/base/src/securec/snprintf_s.c", "http://utils/native/base/src/securec/sprintf_s.c", "http://utils/native/base/src/securec/strcat_s.c", "http://utils/native/base/src/securec/strcpy_s.c", "http://utils/native/base/src/securec/vsnprintf_s.c", "http://utils/native/base/src/securec/vsprintf_s.c", ] } # 通過平臺的config決定是否依賴和編譯curl if (defined(config.use_curl_download) && config.use_curl_download) { configs += [ "http://third_party/curl:curl_config" ] sources += [ "$ace_root/frameworks/base/network/download_manager.cpp" ] deps += [ "http://third_party/curl:curl" ] } } } # 根據(jù)ace_platforms動態(tài)定義目標(biāo):假設(shè)里面包含三個平臺"ohos"、"windows"、"mac",則會定義三個target, # 分別為:ace_base_ohos,ace_base_windows,ace_base_mac foreach(item, ace_platforms) { ace_base_source_set("ace_base_" + item.name) { # 從platform中導(dǎo)入變量 platform = item.name defines = [] cflags_cc = [] config = { } if (defined(item.config)) { config = item.config } if (defined(config.defines)) { defines = config.defines } if (defined(config.cflags_cc)) { cflags_cc = config.cflags_cc } } }
模塊定義: 根據(jù)目錄結(jié)構(gòu),盡量分成一個個小模塊來定義,每個模塊定義明確,如果涉及平臺差異,使用上述方法定義,內(nèi)部配置差異盡量使用特性來區(qū)分
依賴關(guān)系: 依賴關(guān)系盡量清楚,按層次依賴,不可反向依賴
開發(fā)前請熟悉鴻蒙開發(fā)指導(dǎo)文檔 :
gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md
點(diǎn)擊或者復(fù)制轉(zhuǎn)到。
開發(fā)原則
- 所有功能實現(xiàn)遵循分層設(shè)計
- frameworks目錄下的所有模塊都是平臺無關(guān)的,不能依賴adapter目錄下的模塊,不能依賴除JS引擎相關(guān)的其它子系統(tǒng)
- 平臺相關(guān)的代碼都必須放到adapter目錄對應(yīng)的平臺下,如果需要在frameworks中引用相關(guān),需要進(jìn)行適當(dāng)?shù)慕涌诔橄?/li>
- 非OpenHarmony的adapter中不能依賴OpenHarmony其它子系統(tǒng)的模塊(例外:該子系統(tǒng)有跨平臺計劃并且通用)
- frameworks/core不允許依賴frameworks/bridge下的模塊
- 新增代碼不可直接依賴skia接口,使用graphic_2d提供的drawing接口
- 修改OpenHarmony倉中的內(nèi)容要保證各平臺都能編譯通過,功能正常
-
HarmonyOS
+關(guān)注
關(guān)注
79文章
1954瀏覽量
29897 -
OpenHarmony
+關(guān)注
關(guān)注
25文章
3607瀏覽量
15956 -
鴻蒙OS
+關(guān)注
關(guān)注
0文章
188瀏覽量
4346
發(fā)布評論請先 登錄
相關(guān)推薦
評論