HarmonyOS工程目录结构
·

HarmonyOS 工程目录结构因开发语言和模型不同而有差异。包含 ArkTS(Stage模型)、C++(Stage模型) 和 JS(FA模型) 三种工程的目录结构。
一、ArkTS工程目录结构(Stage模型)
ArkTS Stage 模型支持 API Version 10 及以上版本。
应用级目录
| 目录/文件 | 说明 |
|---|---|
| AppScope > app.json5 | 应用的全局配置信息 |
| build-profile.json5 | 应用级配置信息,包括签名、产品配置等 |
| code-linter.json5 | 配置代码检查规则,包括代码检查范围、生效的规则等 |
| hvigorfile.ts | 应用级编译构建任务脚本 |
| oh-package.json5 | 描述全局配置,如:依赖覆盖(overrides)、依赖关系重写(overrideDependencyMap)和参数化配置(parameterFile)等 |
| oh-package-lock.json5 | 用于锁定应用级依赖的版本,以及缓存依赖的元数据信息 |
entry 模块(应用/元服务模块,编译构建生成一个 HAP)
| 目录/文件 | 说明 |
|---|---|
| src > main > ets | 用于存放 ArkTS 源码 |
| src > main > ets > entryability | 应用/元服务的入口 |
| src > main > ets > entrybackupability | 用于提供扩展备份恢复能力 |
| src > main > ets > pages | 应用/元服务包含的页面 |
| src > main > resources | 用于存放应用/元服务模块所用到的资源文件,如图形、多媒体、字符串、布局文件等 |
| src > main > module.json5 | Stage 模型模块配置文件,主要包含 HAP 的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息 |
| src > mock | 配置测试框架的 Mock 能力 |
| src > ohosTest | 存放 Instrument Test 测试类 |
| src > test | 存放 Local Test 测试类 |
| build-profile.json5 | 当前的模块信息、编译信息配置项,包括 buildOption、targets 配置等 |
| hvigorfile.ts | 模块级编译构建任务脚本 |
| obfuscation-rules.txt | 混淆规则文件。混淆开启后,在使用 Release 模式进行编译时,会对代码进行编译、混淆及压缩处理,保护代码资产 |
| oh-package.json5 | 描述三方包的包名、版本、入口文件(类型声明文件)和依赖项等信息 |
| oh_modules | 用于存放三方库依赖信息,包含应用/元服务所依赖的第三方库文件 |
资源目录
| 资源目录 | 资源文件说明 |
|---|---|
| base > element | 包括字符串、整型数、颜色、样式等资源的 json 文件。每个资源均由 json 格式进行定义,例如: • boolean.json:布尔型• color.json:颜色• float.json:浮点型• intarray.json:整型数组• integer.json:整型• pattern.json:样式• plural.json:复数形式• strarray.json:字符串数组• string.json:字符串值 |
| base > media | 多媒体文件,如图形、视频、音频等文件,支持的文件格式包括:.png、.gif、.mp3、.mp4 等 |
| rawfile | 用于存储任意格式的原始资源文件。rawfile 不会根据设备的状态去匹配不同的资源,需要指定文件路径和文件名进行引用 |
二、C++工程目录结构(Stage模型)
C++ Stage 模型支持 API Version 10 以上版本,支持使用 ArkTS 和 C++ 进行开发。
entry 模块(应用模块,编译构建生成一个 HAP)
| 目录/文件 | 说明 |
|---|---|
| libs > {abi} | 用于存放 .so 文件,此目录下 .so 文件默认打包到产物包中。其中,{abi} 为设备 CPU 架构类型(如 arm64-v8a) |
| src > main > cpp > types | 用于存放 C++ 的 API 接口描述文件 |
| src > main > cpp > types > libentry > index.d.ts | 描述 C++ API 接口行为,如接口名、入参、返回参数等 |
| src > main > cpp > types > libentry > oh-package.json5 | 配置 .so 三方包声明文件的入口及包名 |
| src > main > cpp > CMakeLists.txt | CMake 配置文件,提供 CMake 构建脚本 |
| src > main > cpp > napi_init.cpp | 定义 C++ API 接口的文件 |
| src > main > ets | 用于存放 ArkTS 源码 |
| src > main > resources | 用于存放应用所用到的资源文件,如图形、多媒体、字符串、布局文件等 |
| src > main > module.json5 | Stage 模块配置文件,主要包含 HAP 的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息 |
| build-profile.json5 | 当前的模块信息、编译信息配置项,包括 buildOption、targets 配置等 |
| hvigorfile.ts | 模块级编译构建任务脚本 |
| obfuscation-rules.txt | 混淆规则文件 |
| oh-package.json5 | 描述三方包的包名、版本、入口文件(类型声明文件)和依赖项等信息 |
| oh-package-lock.json5 | 用于锁定当前模块依赖的版本,以及缓存依赖的元数据信息 |
| oh_modules | 用于存放三方库依赖信息 |
应用级目录
| 目录/文件 | 说明 |
|---|---|
| build-profile.json5 | 应用级配置信息,包括签名、产品配置等 |
| code-linter.json5 | 配置代码检查规则 |
| hvigorfile.ts | 应用级编译构建任务脚本 |
| oh-package.json5 | 描述全局配置 |
| oh-package-lock.json5 | 用于锁定应用级依赖的版本 |
资源目录
与 ArkTS 工程一致(base > element、base > media、rawfile)。
三、JS工程目录结构(FA模型)
JS 工程只支持 FA 模型。
entry 模块(应用/元服务模块,编译构建生成一个 HAP)
| 目录/文件 | 说明 |
|---|---|
| src > main > js | 用于存放 js 源码 |
| src > main > js > MainAbility | 应用/元服务的入口 |
| src > main > js > MainAbility > i18n | 用于配置不同语言场景资源内容,比如应用文本词条、图片路径等资源 |
| src > main > js > MainAbility > pages | MainAbility 包含的页面 |
| src > main > js > MainAbility > app.js | 承载 Ability 生命周期 |
| src > main > resources | 用于存放应用/元服务所用到的资源文件 |
| src > main > config.json | 模块配置文件,主要包含 HAP 的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息 |
| build-profile.json5 | 当前的模块信息、编译信息配置项 |
| hvigorfile.ts | 模块级编译构建任务脚本 |
| oh-package.json5 | 配置三方包声明文件的入口及包名 |
应用级目录
| 目录/文件 | 说明 |
|---|---|
| build-profile.json5 | 应用级配置信息,包括签名、产品配置等 |
| hvigorfile.ts | 应用级编译构建任务脚本 |
资源目录
与 ArkTS 工程一致(base > element、base > media、rawfile)。
如果刚开始做 HarmonyOS 开发,建议先熟悉 ArkTS(Stage) 的目录结构,这是当前主流。需要 C++ 能力时再对照 C++ 工程的差异点(主要是 cpp 目录和 libs/{abi})。JS(FA)模型属于历史遗留,新项目不建议使用。
更多推荐


所有评论(0)