鸿蒙App文件结构说明

2024-07-05 11:46| 来源: 网络整理| 查看: 265

鸿蒙App文件结构说明

HarmonyOS 的应用软件包以 APP Pack（Application Package）形式发布，它是由一个或多个 HAP（HarmonyOS Ability Package）以及描述每个 HAP 属性的 pack.info 组成。HAP 是 Ability 的部署包，HarmonyOS 应用代码围绕 Ability 组件展开

• entry：应用的主模块。一个 APP 中，对于同一设备类型必须有且只有一个 entry 类型的 HAP，可独立安装运行。（安卓中的application模块） • feature：应用的动态特性模块。一个 APP 可以包含一个或多个 feature 类型的 HAP，也可以不含。只有包含 Ability 的 HAP 才能够独立运行（安卓中的library模块）

文件主结构 Ability

Ability 是应用所具备的能力的抽象，一个应用可以包含一个或多个 Ability。Ability 分为两种类型：FA（Feature Ability）和 PA（Particle Ability）。FA/PA 是应用的基本组成单元，能够实现特定的业务功能。FA 有 UI 界面，而 PA 无 UI 界面。

库文件

库文件是应用依赖的第三方代码形式，存放在 libs 目录，是.so 文件。

资源文件

应用的资源文件（字符串、图片、音频等）存放于 resources 目录下，便于开发者使用和维护，详见资源文件分类。

配置文件

配置文件 (config.json) 是应用的 Ability 信息，用于声明应用的 Ability，以及应用所需权限等信息，详见应用配置文件。

pack.info

描述应用软件包中每个 HAP 的属性，由 IDE 编译生成，应用市场根据该文件进行拆包和 HAP 的分类存储。HAP 的具体属性包括： • delivery-with-install: 用于标识该 HAP 是否需要在主动安装时进行安装。 • name：HAP 文件名。 • module-type：模块类型，entry 或 feature。 • device-type：用于标识支持该 HAP 运行的设备类型（手机、电脑、或者是车机）。

文件配置 “config.json”配置文件

• 应用的全局配置信息，包含应用的包名、生产厂商、版本号等基本信息。 • 应用在具体设备上的配置信息。 • HAP 包的配置信息，包含每个 Ability 必须定义的基本属性（如包名、类名、类型以及 Ability 提供的能力），以及应用访问系统或其他应用受保护部分所需的权限等。

配置文件的内部结构

应用的配置文件“config.json”中由“app”、“deviceConfig”和“module”三个部分组成，缺一不可。

结构

app --bundleName --vendor --version ----code ----name --apiVersion ----compatible ----target deviceConfig --default --car --tv --wearable --liteWearable --smartVision ----process ----directLaunch ----supportBackup ----compressNativeLibs ----network ------usesCleartext ------securityConfig --------domainSettings ----------cleartextPermitted ----------domains module --package --name --description --supportedModes --deviceType --distro ----deliveryWithInstall ----moduleName ----moduleType --metaData ----parameters ------description ------name ------type ----results ------description ------name ------type ----customizeData ------name ------value ------extra --abilities ----name ----description ----icon ----label ----uri ----launchType ----visible ----permissions ----skills ------actions ------entities ------uris --------scheme --------host --------port --------path --------type ----deviceCapability ----type ----orientation ----backgroundModes ----readPermission ----writePermission ----directLaunch ----configChanges ----mission ----targetAbility ----multiUserShared ----supportPipMode --js ----name ----pages ----window ------designWidth ------autoDesignWidth ----type --shortcuts ----shortcutId ----label ----intents ------targetClass ------targetBundle --defPermissions --reqPermissions

说明

app（表示应用的全局配置信息。同一个应用的不同 HAP 包的“app”配置必须保持一致。） --bundleName（表示应用的包名，用于标识应用的唯一性。支持的字符串长度为 7~127 字节） --vendor（表示对应用开发厂商的描述。字符串长度不超过 255 字节。可以为空） --version --code（表示应用的版本号，仅用于 HarmonyOS 管理该应用，对用户不可见。取值为大于零的整数。） --name（表示应用的版本号，用于向用户呈现。取值可以自定义。） --apiVersion（表示应用依赖的 HarmonyOS 的 API 版本。） --compatible（表示应用运行需要的 API 最小版本。取值为大于零的整数。） --target（表示应用运行需要的 API 目标版本。取值为大于零的整数。可缺省，缺省值为应用所在设备的当前 API 版本。） deviceConfig（表示应用在具体设备上的配置信息） --default（表示所有设备通用的应用配置信息。） --car（表示车机特有的应用配置信息。可为空） --tv（表示智慧屏特有的应用配置信息。可为空） --wearable（表示智能穿戴特有的应用配置信息。可为空） --liteWearable（表示轻量级智能穿戴特有的应用配置信息。可为空） --smartVision（表示智能摄像头特有的应用配置信息。可为空） --process（表示应用或者 Ability 的进程名。可为空） ps：如果在“deviceConfig”标签下配置了“process”标签，则该应用的所有 Ability 都运行在这个进程中。如果在“abilities”标签下也为某个 Ability 配置了“process”标签，则该 Ability 就运行在这个进程中。该标签仅适用于智慧屏、智能穿戴、车机。 --directLaunch（表示应用是否支持在设备未解锁状态直接启动，可为空，默认为false） ps：如果配置为“true”，则表示应用支持在设备未解锁状态下启动。使用场景举例：应用支持在设备未解锁情况下接听来电。该标签仅适用于智慧屏、智能穿戴、车机。 --supportBackup（表示应用是否支持备份和恢复，可为空，默认为false） ps：如果配置为“false”，则不支持为该应用执行备份或恢复操作。该标签仅适用于智慧屏、智能穿戴、车机。 --compressNativeLibs（表示 libs 库是否以压缩存储的方式打包到 HAP 包，可为空，默认为true） ps：如果配置为“false”，则 libs 库以不压缩的方式存储，HAP 包在安装时无需解压 libs，运行时会直接从 HAP内加载 libs 库。该标签仅适用于智慧屏、智能穿戴、车机。 --network（表示网络安全性配置，可为空） ps：该标签允许应用通过配置文件的安全声明来自定义其网络安全，无需修改应用代码 --usesCleartext（表示是否允许应用使用明文网络流量（例如，明文 HTTP）。默认值为“false”） --securityConfig（表示应用的网络安全配置信息。可为空） --domainSettings（表示自定义的网域范围的安全配置，可为空） ps：支持多层嵌套，即一个 domainSettings对象中允许嵌套更小网域范围的domainSettings 对象 --cleartextPermitted（表示自定义的网域范围内是否允许明文流量传输） ps：当 useCleartext 和securityConfig 同时存在时，自定义网域是否允许明文流量传输以cleartextPermitted 的取值为准 --domains（表示域名配置信息） ps：包含两个参数：subDomains 和 name。• subDomains（布尔类型）：表示是否包含子域名。如果为 “true”，此网域规则将与相应网域及所有子网域（包括子网域的子网域）匹配。否则，该规则仅适用于精确匹配项。name（字符串）：表示域名名称。 module（表示 HAP 包的配置信息。该标签下的配置只对当前 HAP 包生效） --package（表示 HAP 的包结构名称） ps：在应用内应保证唯一性。采用反向域名格式（建议与 HAP 的工程目录保持一致）。字符串长度不超过127 字节。该标签仅适用于智慧屏、智能穿戴、车机 --name（表示 HAP 的类名） ps：采用反向域名方式表示，前缀需要与同级的package 标签指定的包名一致，也可采用“.”开头的命名方式。字符串长度不超过 255 字节。该标签仅适用于智慧屏、智能穿戴、车机。 --description（表示 HAP 的描述信息，可为空） ps：字符串长度不超过 255 字节。如果字符串超出长度或者需要支持多语言，可以采用资源索引的方式添加描述内容。该标签仅适用于智慧屏、智能穿戴、车机 --supportedModes（表示应用支持的运行模式。可为空） ps：当前只定义了驾驶模式（drive）。该标签仅适用于车机 --deviceType（表示允许 Ability 运行的设备类型） ps：系统预定义的设备类型包括：tv（智慧屏）、car（车机）、wearable（智能穿戴）、liteWearable（轻量级智能穿戴）等 --distro（表示 HAP 发布的具体描述。） ps：该标签仅适用于智慧屏、智能穿戴、车机。 --deliveryWithInstall（表示当前HAP是否支持随应用安装。） --moduleName（表示当前HAP的名称） --moduleType（表示当前HAP的类型，包括两种类型：entry和feature。） --metaData（表示HAP的元信息，可为空） --parameters（表示调用Ability时所有调用参数的元信息，可为空） --description（表示对调用参数的描述，可以是表示描述内容的字符串，也可以是对描述内容的资源索引以支持多语言。可为空） --name（表示调用参数的名称，可为空） --type（表示调用参数的类型，如Integer。） --results（表示Ability返回值的元信息，可为空） --description（表示对返回值的描述，可以是表示描述内容的字符串，也可以是对描述内容的资源索引以支持多语言。可为空） --name（表示返回值的名字，可为空） --type（表示返回值的类型，如Integer。） --customizeData（表示父级组件的自定义元信息，parameters和results在module中不可配。可为空） --name（表示数据项的键名称，字符串类型（最大长度255字节），可为空） --value（表示数据项的值，字符串类型（最大长度255字节），可为空） --extra（表示用户自定义数据格式，标签值为标识该数据的资源的索引值。可为空） --abilities（表示当前模块内的所有 Ability，可为空） ps：采用对象数组格式，其中每个元素表示一个 Ability 对象 --name（表示Ability名称） ps：取值可采用反向域名方式表示，由包名和类名组成，如“com.example.myapplication.MainAbility”；也可采用“.”开头的类名方式表示，如“.MainAbility”。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 --description（表示对Ability的描述，可为空） ps：取值可以是描述性内容，也可以是对描述性内容的资源索引，以支持多语言。可为空 --icon（表示Ability图标资源文件的索引） ps：取值示例：$media:ability_icon。如果在该Ability的“skills”属性中，“actions”的取值包含 “action.system.home”，“entities”取值中包含“entity.system.home”，则该Ability的icon将同时作为应用的icon。如果存在多个符合条件的Ability，则取位置靠前的Ability的icon作为应用的icon。可为空 --label（表示Ability对用户显示的名称，可为空） ps：取值可以是Ability名称，也可以是对该名称的资源索引，以支持多语言。如果在该Ability的“skills”属性中，“actions”的取值包含 “action.system.home”，“entities”取值中包含“entity.system.home”，则该Ability的label将同时作为应用的label。如果存在多个符合条件的Ability，则取位置靠前的Ability的label作为应用的label。可为空 --uri（表示Ability的统一资源标识符，可为空） ps：格式为[scheme:][//authority][path][?query][#fragment]。可为空 --launchType（表示Ability的启动模式，可为空，默认值为standard） ps：支持“standard”和“singleton”两种模式：standard：表示该Ability可以有多实例。“standard”模式适用于大多数应用场景。singleton：表示该Ability只可以有一个实例。例如，具有全局唯一性的呼叫来电界面即采用“singleton”模式。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。可为空 --visible（表示Ability是否可以被其他应用调用。可为空，默认值为false） ps：true：可以被其他应用调用。false：不能被其他应用调用。 --permissions（表示其他应用的Ability调用此Ability时需要申请的权限，字符串数组，可为空） ps：通常采用反向域名格式，取值可以是系统预定义的权限，也可以是开发者自定义的权限。如果是自定义权限，取值必须与“defPermissions”标签中定义的某个权限的“name”标签值一致。 --skills（表示Ability能够接收的Intent的特征。对象数组，可为空） --actions（表示能够接收的Intent的action值，可以包含一个或多个action，字符串数组，可为空） ps：取值通常为系统预定义的action值，详见《API参考》中的ohos.aafwk.content.Intent类。 --entities（表示能够接收的Intent的Ability的类别（如视频、桌面应用等），可以包含一个或多个entity，字符串数组，可为空） ps：取值通常为系统预定义的类别，详见《API参考》中的ohos.aafwk.content.Intent类，也可以自定义。 --uris（表示能够接收的Intent的uri，可以包含一个或者多个uri，对象数组，可为空） --scheme（表示uri的scheme值。） --host（表示uri的host值。可为空） --port（表示uri的port值。可为空） --path（表示uri的path值。可为空） --type（表示uri的type值。可为空） --deviceCapability（表示Ability运行时要求设备具有的能力，采用字符串数组的格式表示。字符串数组，可为空） --type（表示Ability的类型） ps：page：表示基于Page模板开发的FA，用于提供与用户交互的能力。service：表示基于Service模板开发的PA，用于提供后台运行任务的能力。data：表示基于Data模板开发的PA，用于对外部提供统一的数据访问抽象。 --orientation（表示该Ability的显示模式，可为空，默认值为unspecified） ps：该标签仅适用于page类型的Ability。取值范围如下：unspecified：由系统自动判断显示方向。landscape：横屏模式。portrait：竖屏模式。followRecent：跟随栈中最近的应用。 --backgroundModes（表示后台服务的类型，可以为一个服务配置多个后台服务类型，字符串数组，可为空） ps：该标签仅适用于service类型的Ability。取值范围如下：dataTransfer：通过网络/对端设备进行数据下载、备份、分享、传输等业务。audioPlayback：音频输出业务。audioRecording：音频输入业务。pictureInPicture：画中画、小窗口播放视频业务。voip：音视频电话、VOIP业务。location：定位、导航业务。bluetoothInteraction：蓝牙扫描、连接、传输业务。wifiInteraction：WLAN扫描、连接、传输业务。screenFetch：录屏、截屏业务。 --readPermission（表示读取Ability的数据所需的权限，可为空） ps：该标签仅适用于data类型的Ability。取值为长度不超过255字节的字符串。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 --writePermission（表示向Ability写数据所需的权限，可为空） ps：该标签仅适用于data类型的Ability。取值为长度不超过255字节的字符串。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 --directLaunch（表示Ability是否支持在设备未解锁状态直接启动，可为空，默认值为false） ps：如果配置为“true”，则表示Ability支持在设备未解锁状态下启动。如果“deviceConfig”和“abilities”中同时配置了“directLaunch”，则采用Ability对应的取值；如果同时未配置，则采用系统默认值。 --configChanges（表示Ability关注的系统配置集合，字符串数组，可为空） ps：当已关注的配置发生变更后，Ability会收到onConfigurationUpdated回调。取值范围：locale：表示语言区域发生变更。layout：表示屏幕布局发生变更。fontSize：表示字号发生变更。orientation：表示屏幕方向发生变更。density：表示显示密度发生变更。 --mission（表示Ability指定的任务栈，可为空，默认值为App的包名） ps：该标签仅适用于page类型的Ability。默认情况下应用中所有Ability同属一个任务栈。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 --targetAbility（表示当前Ability重用的目标Ability，可为空，表示当前Ability不是一个别名Ability） ps：该标签仅适用于page类型的Ability。如果配置了targetAbility属性，则当前Ability（即别名Ability）的属性中仅“name”、“icon”、“label”、“visible”、“permissions”、“skills”生效，其它属性均沿用targetAbility中的属性值。目标Ability必须与别名Ability在同一应用中，且在配置文件中目标Ability必须在别名之前进行声明。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 --multiUserShared（表示Ability是否支持多用户状态进行共享，该标签仅适用于data类型的Ability，可为空，默认值为false） ps：配置为“true”时，表示在多用户下只有一份存储数据。需要注意的是，该属性会使visible属性失效。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 --supportPipMode（表示Ability是否支持用户进入PIP模式（用于在在页面最上层悬浮小窗口，俗称“画中画”，常见于视频播放等场景），可为空，默认值为false） ps：该标签仅适用于page类型的Ability。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 --js（表示基于JS UI框架开发的JS模块集合，其中的每个元素代表一个JS模块的信息。可为空） --name（表示JS Component的名字。该标签不可缺省，默认值为default） --pages（表示JS Component的页面用于列举JS Component中每个页面的路由信息[页面路径+页面名称]。该标签不可缺省，取值为数组，数组第一个元素代表JS FA首页） --window（用于定义与显示窗口相关的配置。可为空） ps：该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。 --designWidth（表示页面设计基准宽度。以此为基准，根据实际设备宽度来缩放元素大小。可为空，默认值为750px） --autoDesignWidth（表示页面设计基准宽度是否自动计算，可为空，默认值为false） ps：当配置为true时，designWidth将会被忽略，设计基准宽度由设备宽度与屏幕密度计算得出。 --type（表示JS应用的类型。取值范围如下，可为空，默认值为normal） ps：normal：标识该JS Component为应用实例。form：标识该JS Component为卡片实例。 --shortcuts（表示应用的快捷方式信息。采用对象数组格式，其中的每个元素表示一个快捷方式对象。可为空） --shortcutId（表示快捷方式的ID。字符串的最大长度为63字节。） --label（表示快捷方式的标签信息，即快捷方式对外显示的文字描述信息，可为空） ps：取值可以是描述性内容，也可以是标识label的资源索引。字符串最大长度为63字节。 --intents（表示快捷方式内定义的目标intent信息集合，每个intent可配置两个子标签，targetClass, targetBundle。可为空） --targetClass（表示快捷方式目标类名。可为空） --targetBundle（表示快捷方式目标Ability所在应用的包名。可为空） --defPermissions（表示应用定义的权限。应用调用者必须申请这些权限，才能正常调用该应用。对象数组，可为空） --reqPermissions（表示应用运行时向系统申请的权限。对象数组，可为空）资源文件 resources |---base // 默认存在的目录 | |---element | | |---string.json | |---media | | |---icon.png |---en_GB-vertical-car-mdpi // 限定词目录示例，需要开发者自行创建 | |---element | | |---string.json | |---media | | |---icon.png |---rawfile // 默认存在的目录

enter description here

资源文件使用说明：https://developer.harmonyos.com/cn/docs/documentation/doc-guides/basic-resource-file-example-0000001051733014

【本文地址】

公司简介

联系我们