三、HarmonyOS NEXT应用开发:ArkTS工程目录结构(Stage模型)
目录结构
ArkTS工程目录结构(Stage模型):https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/ide-project-structure-V5
├─AppScope // 存放应用全局所需要得资源文件
├─resources // 目录用于统一存放应用所需的各种资源,包括图片、音频、视频、文本等等
├─app.json5 // 应用的全局配置信息
├─entry // 应用/服务模块,编译构建生成一个HAP。
├─src
├─main
├─ets // 用于存放ArkTS源码
├─entryability // 应用/服务的入口
├─pages // 应用/服务包含的页面
├─resources // 用于存放应用/服务模块所用到的资源文件。
├─base // 图形、多媒体、字符串、布局文件等
├─en_US // 设备设置美式英文时,优先匹配此目录下资源
├─zh_CN // 设备设置美式简体中文时,优先匹配此目录下资源
├─module.json5 // Stage模型模块配置文件
├─……
├─build-profile.json5 // 当前的模块信息、编译信息配置项
├─hvigor // 配置和管理项目的构建过程
├─hvigor-config.json5 // 指定hvigor的版本、构建依赖以及构建行为的配置参数
├─oh_modules // 用于存放三方库依赖信息,包含应用/服务所依赖的第三方库文件
├─build-profile.json5 // 应用级配置信息,包括签名、产品配置等
├─hvigorfile.ts // 应用级编译构建任务脚本
├─local.properties // 配置SDK目录
├─oh-package.json5 // 描述全局配置
- AppScope
- AppScope > app.json5 应用级的配置信息
- AppScope > resources 这个目录下的base>element用于存放全局使用的基本元素,如字符串、颜色和布尔值。base>media目录则存储媒体、动画和布局等资源文件。如果模块下的resources的有同样的资源,那么就会优先使用模块下的资源,否则就使用这里的资源。
- hvigor:配置和管理项目的构建过程。
- oh_modules:这个目录用来存放第三方库依赖信息
- build-profile.json5: 这个文件位于根目录,它放置应用级配置信息,包括签名配置和产品配置。
- hvigorfile.ts 应用的编译脚本
- local.properties 配置SDK目录
- entry 这个目录是应用的入口(entry)。我们的写的应用的代码都是放在这个目录中,打包时,就会将这里的代码编译,生成HAP,即HarmonyOS Ability package鸿蒙能力包。
entry目录下的子目录及其作用
- build-profile.json5 这个是编译配置文件,它包含了当前模块的信息和编译配置选项等等。
在鸿蒙应用工程的根目录也有一个这样的文件,那个是应用级的,全局的,这个是当前模块的局部的。
- hvigorfile.ts 这是一个模块级的编译脚本。
鸿蒙应用工程根目录也有一个,那个是应用级的。
- src > main > module.json5 这个文件描述了应用的全局配置信息。
- src > main > ets 放ArkTS源代码的地方,鸿蒙应用可以使用官方的开发语言ArkTS来开发。
- src > main > ets > entryability 这个目录就是用来放所那些应用或服务的入口的,其实就是那些继承了UIAbility类的类文件。
- src > main > ets > pages 这个目录是专门用来放页面的,因为ArkTS采用了声明式UI,和android的Compose和iOS的SwiftUI都同样的产品。鸿蒙在这个目录里定义好页面,然后在src > main > ets > entryability 对应的ability加载出来。
- src > main > resources 这个目录用来放置应用用到的资源文件,如图片、多媒体、文字等,国际化也是在这里定义的。资源目录分为base基目录、qualifiers限定符目录和rawfile目录。
src > main > resources 目录及文件介绍
resources目录用于统一存放应用所需的各种资源,包括图片、音频、视频、文本等等。下面简要介绍 resources 目录的用法,首先需要了解 resources 的目录结构,如下
resources 目录下,用于存放资源的子目录有(element、media、profile)和rawfile。下面分别介绍
1、目录:src > main > resources > base
base 目录是默认提供的。在这个目录下,element子目录存放了诸如文字、颜色、布尔值等。media 和 profile 子目录存放了诸如多媒体、动画、布局等。编译时,这些资源文件都会被编译成二进制文件,并分配相应的ID。
base 目录是默认提供的。在这个目录下,element子目录存放了诸如文字、颜色、布尔值等。media 和 profile 子目录存放了诸如多媒体、动画、布局等。编译时,这些资源文件都会被编译成二进制文件,并分配相应的ID。
- media
存放媒体资源,包括图片、音频、视频等文件,支持的文件格式包括:.png、.gif、.mp3、.mp4等。该目录下的资源,需要使用$r('app.media.')
的方式引用。
注意:无需指定具体版本,系统会自动根据所处环境选择相应版本
例如上图中的img.png图片,可通过$r('app.media.img')
引用。需要注意的是$r()
的返回值即为 **Resource**
类型,因此可以直接将$r('app.media.img')
作为 Image 组件的参数,例如Image($r('app.media.img'))
。
- element
存放用于描述页面元素的尺寸、颜色、样式等的各种类型的值,每种类型的值都定义在一个相应的 JSON 文件中。例如:
● boolean.json:布尔型
● color.json:颜色
● float.json:浮点型
● intarray.json:整型数组
● integer.json:整型
● pattern.json:样式
● plural.json:复数形式
● strarray.json:字符串数组
● string.json:字符串值。
文件中的内容为键值对(name-value
)的形式。具体内容如下
{
"string": [
{
"name": "module_desc",
"value": "模块描述"
},
{
"name": "greeting",
"value": "你好"
}
]
}
{
"integer": [
{
"name": "width",
"value": 150
},
{
"name": "height",
"value": 150
}
]
}
我们可以通过 name
引用相应的 value
。具体语法为$r('app..')
。
注意:无需指定具体版本,系统会自动根据所处环境选择相应版本
例如上述的 greeting
的值,可通过$r('app.string.greeting')
引用,width
的值可通过$r('app.integer.width')
。
2、限定符目录
目录1:src > main > resources > zh_CN目录2:src > main > resources > en_US目录3.……可自行增加其他限定性目录,与base目录里的东西差不多,主要用于应用程序的国际化,可根据需求设置不同地区的语言(图片、文字等)
3、目录:src > main > resources > rawfile
用于存储任意格式的原始文件,需要注意的是rawfile不会根据设备所处的环境去匹配不同的资源。
- rawfile目录
用于存储任意格式的原始资源文件。rawfile不会根据设备的状态去匹配不同的资源,需要指定文件路径和文件名进行引用。该目录下的资源,可通过$rawfile('path/to/your/file')
的方式引用,文件的路径为相对于 rawfile 的路径。例如
上图中的icon.png,须使用
$rawfile('icon.png)
引用。需要注意的是,$rawfile()
的返回值也是Resource类型,因此其也可以直接作为 Image 组件的参数,如Image($rawfile('icon.png))
。
4、 当前的模块信息、编译信息配置项
目录1:src > main > resources > module.json5目录2:src > main > resources > base > element > string.json目录3:src > main > resources > zh_CN > element > string.json目录4:src > main > resources > en_US> element > string.json……
(1)module.json5 会引用string.json中的配置项(2)引用方式如:$string:EntryAbility_label(3)依据设备语言调用不同的设置文件,默认调用base,英文调用en_US,中文调用zh_CN等
关注我,公众号搜“Harry技术”带你看不一样的人间烟火!