1# module.json5配置文件 2<!--Kit: Ability Kit--> 3<!--Subsystem: BundleManager--> 4<!--Owner: @wanghang904--> 5<!--Designer: @hanfeng6--> 6<!--Tester: @kongjing2--> 7<!--Adviser: @Brilliantry_Rui--> 8 9## 配置文件示例 10 11通过一个示例,整体了解module.json5配置文件。 12<!--RP1--> 13```json 14{ 15 "module": { 16 "name": "entry", 17 "type": "entry", 18 "description": "$string:module_desc", 19 "srcEntry": "./ets/entryability/EntryAbility.ets", 20 "mainElement": "EntryAbility", 21 "deviceTypes": [ 22 "default", 23 "tablet" 24 ], 25 "deliveryWithInstall": true, 26 "installationFree": false, 27 "pages": "$profile:main_pages", 28 "virtualMachine": "ark", 29 "appStartup": "$profile:app_startup_config", 30 "metadata": [ 31 { 32 "name": "string", 33 "value": "string", 34 "resource": "$profile:distributionFilter_config" 35 } 36 ], 37 "abilities": [ 38 { 39 "name": "EntryAbility", 40 "srcEntry": "./ets/entryability/EntryAbility.ets", 41 "description": "$string:EntryAbility_desc", 42 "icon": "$media:layered_image", 43 "label": "$string:EntryAbility_label", 44 "startWindow": "$profile:start_window", 45 "startWindowIcon": "$media:icon", 46 "startWindowBackground": "$color:start_window_background", 47 "exported": true, 48 "skills": [ 49 { 50 "entities": [ 51 "entity.system.home" 52 ], 53 "actions": [ 54 "ohos.want.action.home" 55 ] 56 } 57 ], 58 "continueType": [ 59 "continueType1" 60 ], 61 "continueBundleName": [ 62 "com.example.myapplication1", 63 "com.example.myapplication2" 64 ] 65 } 66 ], 67 "requestPermissions": [ 68 { 69 "name": "ohos.permission.ACCESS_BLUETOOTH", 70 "reason": "$string:reason", 71 "usedScene": { 72 "abilities": [ 73 "FormAbility" 74 ], 75 "when": "inuse" 76 } 77 } 78 ], 79 "querySchemes": [ 80 "app1Scheme", 81 "app2Scheme" 82 ], 83 "routerMap": "$profile:router_map", 84 "appEnvironments": [ 85 { 86 "name": "name1", 87 "value": "value1" 88 } 89 ], 90 "hnpPackages": [ 91 { 92 "package": "hnpsample.hnp", 93 "type": "public" 94 } 95 ], 96 "fileContextMenu": "$profile:menu", 97 "crossAppSharedConfig": "$profile:shared_config" 98 } 99} 100``` 101<!--RP1End--> 102 103## 配置文件标签 104 105module.json5配置文件包含以下标签。 106 107 108 **表1** module.json5配置文件标签说明 109 110| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 111| -------- | -------- | -------- | -------- | 112| name | 标识当前Module的名称,确保该名称在整个应用中唯一。命名规则如下 :<br/>- 由字母、数字和下划线组成,且必须以字母开头。<br/>- 最大长度128字节。<br/>应用升级时允许修改该名称,但需要应用适配Module相关数据目录的迁移,详见[文件管理接口](../reference/apis-core-file-kit/js-apis-file-fs.md)。 | 字符串 | 该标签不可缺省。 | 113| type | 标识当前Module的类型。支持的取值如下:<br/>- entry:应用的主模块。<br/>- feature:应用的动态特性模块。<br/>- har:静态共享包模块。<br/>- shared:动态共享包模块。 | 字符串 | 该标签不可缺省。 | 114| srcEntry | 标识AbilityStage组件的代码路径,详情参考[AbilityStage组件容器](../application-models/abilitystage.md),取值为长度不超过127字节的字符串。 | 字符串 | 该标签可缺省,缺省值为空。 | 115| description | 标识当前Module的描述信息,开发者可以通过该标签描述当前模块的功能与作用,取值为长度不超过255字节的字符串,可以采用字符串资源索引格式。 | 字符串 | 该标签可缺省,缺省值为空。 | 116| <!--DelRow-->process | 标识当前Module的进程名,取值为长度不超过31字节的字符串。如果在HAP标签下配置了process,则该Module的所有UIAbility、DataShareExtensionAbility、ServiceExtensionAbility都运行在该进程中。<br/>**说明:**<br/>开启[多实例特权](../../device-dev/subsystems/subsys-app-privilege-config-guide.md#可由设备厂商配置的特权)生效,三方应用配置不生效。 | 字符串 | 该标签可缺省,缺省为app.json5文件下app标签下的bundleName。 | 117| mainElement | 标识当前Module的入口UIAbility名称,取值为长度不超过255字节的字符串。<br/>**说明:**<br/>如果在[abilities](#abilities标签)中配置了多个入口[UIAbility](../application-models/uiability-overview.md),则桌面图标、名称和启动入口以该标签配置为准。如果该标签缺省或未匹配到,则按照ASCII字典序对UIAbility的name标签正序排序,返回第一个作为桌面图标、名称和启动入口。 | 字符串 | 该标签可缺省,缺省值为空。 | 118| [deviceTypes](#devicetypes标签) | 标识当前Module可以运行在哪类设备上。<br/>**说明:**<br/>当存在多个模块时,各模块的配置可以不同,但都必须包含将要安装的设备类型,以确保正常运行。 | 字符串数组 | 该标签不可缺省。 | 119| deliveryWithInstall | 标识当前Module是否在用户主动安装的时候安装,即该Module对应的HAP/HSP是否跟随应用一起安装。<br/>- true:跟随应用一起安装。<br/>- false:不跟随应用一起安装。<!--RP11--><!--RP11End--> | 布尔值 | 当前Module类型为HAP或HSP时,该标签不可缺省。 | 120| installationFree | 标识当前Module是否支持免安装特性。<br/>- true:表示支持免安装特性,且符合免安装约束。<br/>- false:表示不支持免安装特性。 | 布尔值 | 该标签可缺省。该标签在编译构建时自动生成,手动配置不生效。<br/>**说明:**<br/>当[bundleType](./app-configuration-file.md#配置文件标签)为原子化服务时,该标签自动配置为true。反之,该标签自动配置为false。 | 121| virtualMachine | 标识当前Module运行的目标虚拟机类型,供云端分发使用,如应用市场和分发中心。如果目标虚拟机类型为ArkTS引擎,则其值为“ark+版本号”。 | 字符串 | 该标签可缺省,手动配置不生效,由编译构建时自动生成。 | 122| [pages](#pages标签) | 标识当前Module的profile资源,用于列举每个页面信息,取值为长度不超过255字节的字符串。 | 字符串 | 该标签可缺省,缺省值为空。 | 123| [metadata](#metadata标签) | 标识当前Module的自定义元信息,可通过资源引用的方式配置[distributionFilter](#distributionfilter标签)、[shortcuts](#shortcuts标签)等信息。只对当前Module、UIAbility、ExtensionAbility生效。 | 对象数组 | 该标签可缺省,缺省值为空。 | 124| [abilities](#abilities标签) | 标识当前Module中UIAbility的配置信息,只对当前UIAbility生效。 | 对象数组 | 该标签可缺省,缺省值为空。 | 125| [extensionAbilities](#extensionabilities标签) | 标识当前Module中ExtensionAbility的配置信息,只对当前ExtensionAbility生效。 | 对象数组 | 该标签可缺省,缺省值为空。 | 126| <!--DelRow-->[definePermissions](#definepermissions标签) | 标识系统资源hap定义的权限,不支持应用自定义权限。 | 对象数组 | 该标签可缺省,缺省值为空。 | 127| [requestPermissions](../security/AccessToken/declare-permissions.md#在配置文件中声明权限)| 标识当前应用运行时需向系统申请的权限集合。 | 对象数组 | 该标签可缺省,缺省值为空。 | 128| [testRunner](#testrunner标签) | 标识用于测试当前Module的测试框架的配置。详情请参考[启动测试框架命令](../tools/aa-tool.md#启动测试框架命令test)。 | 对象 | 该标签可缺省,缺省值为空。 | 129| [atomicService](#atomicservice标签)| 标识当前应用是原子化服务时,有关原子化服务的相关配置。| 对象 | 该标签可缺省,缺省值为空。 | 130| [dependencies](#dependencies标签)| 标识当前模块运行时依赖的共享库列表。| 对象数组 | 该标签可缺省,缺省值为空。手动配置不生效,由编译构建时自动生成。 | 131| targetModuleName | 标识当前包所指定的目标Module。取值为长度不超过128字节的字符串,不支持中文。配置该标签的Module具有overlay特性。仅在动态共享包(HSP)中适用。 |字符串|该标签可缺省,缺省值为空。| 132| targetPriority | 标识当前Module的优先级,取值范围为1~100。配置targetModuleName标签之后,才需要配置该标签。仅在动态共享包(HSP)中适用。 |整型数值|该标签可缺省,缺省值为1。| 133| [proxyData](#proxydata标签) | 标识当前Module提供的数据代理列表。| 对象数组 | 该标签可缺省,缺省值为空。| 134| isolationMode | 标识当前Module的多进程配置项。支持的取值如下:<br/>- nonisolationFirst:优先在非独立进程中运行。<br/>- isolationFirst:优先在独立进程中运行。<br/>- isolationOnly:只在独立进程中运行。<br/>- nonisolationOnly:只在非独立进程中运行。<br/>**说明:**<br/>1.仅2in1和tablet设备支持将当前Module设置为独立进程。<br/>2.该标签仅对HAP生效。 |字符串|该标签可缺省,缺省值为nonisolationFirst。| 135| generateBuildHash |标识当前HAP/HSP是否由打包工具生成哈希值。当配置为true时,如果系统OTA升级时应用versionCode保持不变,可根据哈希值判断应用是否需要升级。<br/>该标签仅在[app.json5文件](./app-configuration-file.md)中的generateBuildHash标签为false时使能。<br/>**说明:**<br/>该标签仅对预置应用生效。|布尔值|该标签可缺省,缺省值为false。| 136| compressNativeLibs | 在打包hap时,该标签标识libs库是否以压缩存储的方式打包到HAP。<br/>- true:libs库以压缩方式存储。<br/>- false:libs库以不压缩方式存储。 | 布尔值 | 该标签可缺省,在打包hap时缺省值为false。 | 137| extractNativeLibs | 标识应用安装时,libs库是否解压到应用安装目录。当compressNativeLibs和extractNativeLibs都配置为false时,应用以不解压libs库的方式进行安装;其他场景,应用以解压libs库的方式进行安装。<br/>**说明:**<br/>从API version 20开始,支持该标签。 | 布尔值 | 该标签可缺省,缺省值为true。 | 138| libIsolation | 在libs目录下是否生成模块名称目录存储so,用于区分同一应用中不同HAP的.so文件,以防止.so文件冲突。<br/>- true:当前HAP的.so文件会储存在libs目录中以Module名命名的路径下。<br/>- false:当前HAP的.so文件会直接储存在libs目录中。 | 布尔值 | 该标签可缺省,缺省值为false。 | 139| [fileContextMenu](#filecontextmenu标签) | 标识当前HAP的右键菜单配置项,是一个profile文件资源。取值为长度不超过255字节的字符串。<br/>**说明:**<br/>仅在PC/2in1设备上生效。<br/>仅允许在entry类型模块中配置。 | 字符串 | 该标签可缺省,缺省值为空。 | 140| querySchemes | 标识允许当前应用进行跳转查询的URL schemes,只允许entry类型模块配置,最多50个,每个字符串取值不超过128字节。 | 字符串数组 | 该标签可缺省,缺省值为空。 | 141| [routerMap](#routermap标签) | 标识当前模块配置的路由表路径。取值为长度不超过255字节的字符串。 | 字符串 | 该标签可缺省,缺省值为空。 | 142| [appEnvironments](#appenvironments标签) | 标识当前模块配置的应用环境变量,只允许entry和feature模块配置。 | 对象数组 | 该标签可缺省,缺省值为空。 | 143| appStartup | 标识当前Module[启动框架](../application-models/app-startup.md)配置路径,只允许entry类型模块配置。<br>从API version 18开始,新增支持在HSP、HAR中配置。<br>从API version 20开始,新增支持在feature类型的Module中配置。 | 字符串 | 该标签可缺省,缺省值为空。 | 144| [hnpPackages](#hnppackages标签) | 标识当前应用包含的Native软件包信息。只允许entry类型模块配置。 | 对象数组 | 该标签可缺省,缺省值为空。 | 145| [systemTheme](#systemtheme标签) | 标识当前使用的系统主题配置项。只允许entry类型模块配置。取值为不超过255字节的字符串。<br/>**说明:** <br/>从API version 20开始,支持该标签。 | 字符串 | 该标签可缺省,缺省值为空。 | 146| abilitySrcEntryDelegator | 标识当前Module需要重定向到的UIAbility的名称,与abilityStageSrcEntryDelegator标签组合使用,共同指定重定向的目标对象。<br/>**说明:**<br/>1.从API version 17开始,支持该标签。<br/>2.当UIAbility是通过[startAbilityByCall](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md#startabilitybycall)接口启动时,该标签不生效。<br/>3.不支持在HAR的配置文件中配置该标签,也不支持重定向到HAR的UIAbility。 | 字符串 | 该标签可缺省,缺省值为空。 | 147| abilityStageSrcEntryDelegator | 标识当前Module需要重定向到的UIAbility对应的Module名称(不可为当前Module名称),与abilitySrcEntryDelegator标签组合使用,共同指定重定向的目标对象。<br/>**说明:**<br/>1.从API version 17开始,支持该标签。<br/>2.当UIAbility是通过[startAbilityByCall](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md#startabilitybycall)接口启动时,该标签不生效。<br/>3.不支持在HAR的配置文件中配置该标签,也不支持重定向到HAR的UIAbility。 | 字符串 | 该标签可缺省,缺省值为空。 | 148| crossAppSharedConfig | 标识应用间共享配置的配置文件名。取值为不超过255字节的字符串。用于发布配置给其他应用读取,在应用安装时生效,应用卸载时失效。详细使用方式见[共享配置使用](../database/share-config.md#配置发布方)。<br/>**说明:**<br/>从API version 20开始,支持该标签。 | 字符串 | 该标签可缺省,缺省值为空。 | 149| formWidgetModule | 在[独立卡片包](../form/arkts-ui-widget-creation.md#方式二独立包方式创建卡片)中,应用包需要配置该标签,用来关联卡片包。取值为卡片包的模块名称,对应卡片包module.json5中的name标签。具体使用方式请参考[FormExtensionAbility配置](../form/arkts-ui-widget-configuration.md#formextensionability配置)。<br/>**说明:**<br/> 1. 从API version 20开始,支持该标签。<br/> 2. 仅在独立卡片包的应用包中,该标签配置生效,且要求对应的卡片包模块必须配置formExtensionModule标签。 | 字符串 | 该标签可缺省,缺省值为空。 | 150| formExtensionModule | 在[独立卡片包](../form/arkts-ui-widget-creation.md#方式二独立包方式创建卡片)中,卡片包需要配置该标签,用来关联应用包。取值为应用包的模块名称,对应应用包module.json5中的name标签。具体使用方式请参考[独立卡片包配置](../form/arkts-ui-widget-configuration.md#独立卡片包配置)。<br/>**说明:**<br/>1. 从API version 20开始,支持该标签。<br/>2. 仅在独立卡片包的卡片包中,该标签配置生效,且要求对应的应用包模块必须配置formWidgetModule标签。 | 字符串 | 该标签可缺省,缺省值为空。 | 151<!--RP6--><!--RP6End--> 152 153## deviceTypes标签 154 155 **表2** deviceTypes标签说明 156<!--RP2--> 157| 设备类型 | 枚举值 | 说明 | 158| -------- | -------- | -------- | 159| 平板 | tablet | - | 160| 智慧屏 | tv | - | 161| 智能手表 | wearable | 系统能力较丰富的手表,具备电话功能。 | 162| 车机 | car | - | 163| PC/2in1 | 2in1 | 即PC设备,主要交互方式以多窗口、多任务及键盘鼠标操作为主,充分发挥设备的生产力属性。在OpenHarmony文档中,所有“2in1”均代表“PC/2in1”。| 164| 默认设备 | default | 支持使用所有系统能力的设备。 | 165<!--RP2End--> 166 167deviceTypes示例: 168 169 170```json 171{ 172 "module": { 173 "name": "myHapName", 174 "type": "feature", 175 "deviceTypes" : [ 176 "tablet" 177 ] 178 } 179} 180``` 181 182 183## pages标签 184 185该标签是一个profile文件资源,用于指定描述页面信息的配置文件。 186 187 188```json 189{ 190 "module": { 191 // ... 192 "pages": "$profile:main_pages", // 通过profile下的资源文件配置 193 } 194} 195``` 196 197在开发视图的resources/base/profile下面定义配置文件main_pages.json,其中文件名"main_pages"可自定义,需要和pages标签指定的信息对应。配置文件中列举了当前应用组件中的页面信息,包含页面的路由信息和显示窗口相关的配置。 198 199 **表3** pages标签说明 200 201| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 202| -------- | -------- | -------- | -------- | 203| src | 标识当前Module中所有页面的路由信息,包括页面路径和页面名称。其中,页面路径是以当前Module的src/main/ets为基准。该标签取值为一个字符串数组,其中每个元素表示一个页面。 | 字符串数组 | 该标签不可缺省。 | 204| window | 标识用于定义与显示窗口相关的配置。 | 对象 | 该标签可缺省,缺省值为空。 | 205 206 207 **表4** window标签说明 208 209| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 210| -------- | -------- | -------- | -------- | 211| designWidth | 标识页面设计基准宽度。以此为基准,根据实际设备宽度来缩放元素大小。 | 数值 | 可缺省,缺省值为720px。 | 212| autoDesignWidth | 标识页面设计基准宽度是否自动计算。当配置为true时,designWidth将会被忽略,设计基准宽度由设备宽度与屏幕密度计算得出。当配置为false时,设计基准宽度为designWidth。 | 布尔值 | 可缺省,缺省值为false。 | 213 214```json 215{ 216 "src": [ 217 "pages/index/mainPage", 218 "pages/second/payment", 219 "pages/third/shopping_cart", 220 "pages/four/owner" 221 ], 222 "window": { 223 "designWidth": 720, 224 "autoDesignWidth": false 225 } 226} 227``` 228 229 230## metadata标签 231 232该标签标识HAP的自定义元信息,标签值为数组类型,包含name、value、resource三个子标签。 233 234**表5** metadata标签说明 235 236| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 237| -------- | -------- | -------- | -------- | 238| name | 标识数据项的名称,取值为长度不超过255字节的字符串。 | 字符串 | 该标签可缺省,缺省值为空。 | 239| value | 标识数据项的值,取值为长度不超过255字节的字符串。 | 字符串 | 该标签可缺省,缺省值为空。 | 240| resource | 标识了用户自定义数据,取值为长度不超过255字节的字符串,内容为该数据的资源索引,例如配置成$profile:shortcuts_config,表示指向了/resources/base/profile/shortcuts_config.json配置文件。| 字符串 | 该标签可缺省,缺省值为空。 | 241 242```json 243{ 244 "module": { 245 "metadata": [{ 246 "name": "module_metadata", 247 "value": "a test demo for module metadata", 248 "resource": "$profile:shortcuts_config" 249 }] 250 } 251} 252``` 253 254## abilities标签 255 256abilities标签描述UIAbility组件的配置信息,标签值为数组类型,该标签下的配置只对当前UIAbility生效。 257 258 **表6** abilities标签说明 259 260| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 261| -------- | -------- | -------- | -------- | 262| name | 标识当前UIAbility组件的名称,确保该名称在整个应用中唯一。取值为长度不超过127字节的字符串,以字母开头,可包含字母、数字、下划线(_)或点号(.)。 | 字符串 | 该标签不可缺省。 | 263| srcEntry | 标识当前UIAbility的代码路径,取值为长度不超过127字节的字符串。 | 字符串 | 该标签不可缺省。 | 264| [launchType](../application-models/uiability-launch-type.md) | 标识当前UIAbility组件的启动模式,支持的取值如下:<br/>- multiton:多实例模式,每次启动创建一个新实例。<br/>- singleton:单实例模式,仅第一次启动创建新实例。<br/>- specified:指定实例模式,运行时由开发者决定是否创建新实例。<br/>- standard:multiton的曾用名,效果与多实例模式一致。 | 字符串 | 该标签可缺省,该标签缺省为“singleton”。 | 265| description | 标识当前UIAbility组件的描述信息,开发者可以通过该标签描述当前组件的功能与作用,取值为长度不超过255字节的字符串。建议采用描述信息的资源索引,以支持多语言。 | 字符串 | 该标签可缺省,缺省值为空。 | 266| icon | 标识当前UIAbility组件的[图标](layered-image.md),取值为图标资源文件的索引。 | 字符串 | 该标签可缺省,缺省值为空。 | 267| label | 标识当前UIAbility组件对用户显示的[名称](layered-image.md),取值为字符串资源的索引,以支持多语言,长度不超过255字节的字符串。 | 字符串 | 该标签可缺省,缺省值为空。 | 268| permissions | 标识当前UIAbility组件的权限信息。其他应用访问该UIAbility时,需要申请相应的权限。<br/>一个数组元素为一个权限名称,不超过255字节,取值请参考[应用权限列表](../security/AccessToken/app-permissions.md)。 | 字符串数组 | 该标签可缺省,缺省值为空。 | 269| [metadata](#metadata标签) |标识当前UIAbility组件的元信息,典型使用场景详见[窗口元数据配置中的metadata标签](../windowmanager/window-config-m.md#metadata标签)。 | 对象数组 | 该标签可缺省,缺省值为空。 | 270| exported | 标识当前UIAbility组件是否可以被其他应用拉起。<br/>- true:表示可以被其他应用拉起(入口UIAbility建议配置为true)。<br/>- false:只能由同应用或者具有ohos.permission.START_INVISIBLE_ABILITY权限(该权限仅系统应用支持申请)的应用拉起。<br/> 例如,配置为false时,桌面具备该权限,桌面图标、快捷方式或push通知消息可以拉起当前UIAbility组件,但aa命令行工具没有权限无法拉起。| 布尔值 | 该标签可缺省,缺省值为false。 | 271| continuable | 标识当前UIAbility组件是否支持跨端迁移。<br/>- true:表示支持迁移。<br/>- false:表示不支持迁移。 | 布尔值 | 该标签可缺省,缺省值为false。 | 272| [skills](#skills标签) | 标识当前UIAbility组件能够接收的[Want](../application-models/want-overview.md)特征集,为数组格式。<br/>配置规则:<br/>- 对于Entry类型的HAP,应用可以配置多个具有入口能力的skills标签(即配置了ohos.want.action.home和entity.system.home)。<br/>- 对于Feature类型的HAP,只有应用可以配置具有入口能力的skills标签,服务不允许配置。 | 对象数组 | 该标签可缺省,缺省值为空。 | 273| backgroundModes | 标识当前UIAbility组件的[长时任务](../task-management/continuous-task.md)集合,指定用于满足特定类型的长时任务。<br/>长时任务类型有如下:<br/>- dataTransfer:数据传输。<br/>- audioPlayback:音视频播放。<br/>- audioRecording:录制。<br/>- location:定位导航。<br/>- bluetoothInteraction:蓝牙相关业务。<br/>- multiDeviceConnection:多设备互联。<br/>- wifiInteraction:WLAN相关业务(仅对系统应用开放)。<br/>- voip:音视频通话。<br/>- taskKeeping:计算任务(仅对PC/2in1设备开放)。 | 字符串数组 | 该标签可缺省,缺省值为空。 | 274| [startWindow](#startwindow标签) | 标识当前UIAbility组件启动页面profile资源,取值为长度不超过255字节的字符串,如果配置了该标签,startWindowIcon和startWindowBackground标签均不生效。<!--RP4--><br/>**说明:** <br/>从API version 20开始,支持使用该标签配置增强启动页。<!--RP4End--> | 字符串 | 该标签可缺省,缺省值为空。 | 275| startWindowIcon | 标识当前UIAbility组件启动页面图标资源文件的索引,取值为长度不超过255字节的字符串。 | 字符串 | 该标签不可缺省。 | 276| startWindowBackground | 标识当前UIAbility组件启动页面背景颜色资源文件的索引,取值为长度不超过255字节的字符串。<br/>取值示例:$color:red。| 字符串 | 该标签不可缺省。 | 277| removeMissionAfterTerminate | 标识当前UIAbility组件销毁后,是否从任务列表中移除任务。<br/>- true表示销毁后移除任务。<br/>- false表示销毁后不移除任务。<br/>**说明:**<br/>2in1设备和平板设备的自由多窗模式下配置不生效,默认移除任务。 | 布尔值 | 该标签可缺省,缺省值为false。 | 278| orientation | 标识当前UIAbility组件启动时的方向,支持配置枚举,或启动方向资源索引。<br/>**启动方向枚举支持的取值如下:**<br/>- unspecified:未指定方向,由系统自动判断显示方向。<br/>- landscape:横屏。<br/>- portrait:竖屏。<br/>- follow_recent:跟随背景窗口的旋转模式。<br/>- landscape_inverted:反向横屏。<br/>- portrait_inverted:反向竖屏。<br/>- auto_rotation:随传感器旋转。<br/>- auto_rotation_landscape:传感器横屏旋转,包括横屏和反向横屏。<br/>- auto_rotation_portrait:传感器竖屏旋转,包括竖屏和反向竖屏。<br/>- auto_rotation_restricted:传感器开关打开,方向可随传感器旋转。<br/>- auto_rotation_landscape_restricted:传感器开关打开,方向可随传感器旋转为横屏, 包括横屏和反向横屏。<br/>- auto_rotation_portrait_restricted:传感器开关打开,方向随可传感器旋转为竖屏, 包括竖屏和反向竖屏。<br/>- locked:传感器开关关闭,方向锁定。<br/>- auto_rotation_unspecified:受开关控制和由系统判定的自动旋转模式。<br/>- follow_desktop:跟随桌面的旋转模式。<br/> **配置启动方向的资源索引时**,取值为长度不超过255字节的字符串,配置示例:$string:orientation。<br/> **说明:**<br/> - 从API version 14开始,支持配置启动方向资源索引。 | 字符串 | 该标签可缺省,缺省值为unspecified。 | 279| supportWindowMode | 标识当前UIAbility组件所支持的窗口模式。支持的取值如下:<br/>- fullscreen:全屏模式。<br/>- split:分屏模式。<br/>- floating:悬浮窗模式。<br/>此外,还可以通过metadata配置窗口模式,具体的配置规则和优先级请参考[metadata](#metadata标签)。 | 字符串数组 | 该标签可缺省,缺省值为<br/>["fullscreen", "split", "floating"]。 | 280| <!--DelRow-->priority | 标识当前UIAbility组件的优先级。[隐式查询](../application-models/explicit-implicit-want-mappings.md)时,优先级越高,UIAbility在返回列表越靠前。取值范围0~10,数值越大,优先级越高。<br/>**说明:**<br/>三方应用的配置不生效,当前配置仅在系统应用中有效。 | 整型数值 | 该标签可缺省,缺省值为0。 | 281| maxWindowRatio | 标识当前UIAbility组件支持的最大的宽高比。该标签最小取值为0。 | 数值 | 该标签可缺省,缺省值为平台支持的最大的宽高比。 | 282| minWindowRatio | 标识当前UIAbility组件支持的最小的宽高比。该标签最小取值为0。 | 数值 | 该标签可缺省,缺省值为平台支持的最小的宽高比。 | 283| maxWindowWidth | 标识当前UIAbility组件支持的最大的窗口宽度,宽度单位为vp。<br/>最小取值为minWindowWidth,最大取值为平台支持的最大窗口宽度。窗口尺寸可以参考[窗口大小限制](../windowmanager/window-overview.md#约束与限制)。 | 数值 | 该标签可缺省,缺省值为平台支持的最大的窗口宽度。 | 284| minWindowWidth | 标识当前UIAbility组件支持的最小的窗口宽度, 宽度单位为vp。<br/>最小取值为平台支持的最小窗口宽度,最大取值为maxWindowWidth。窗口尺寸可以参考[窗口大小限制](../windowmanager/window-overview.md#约束与限制)。 | 数值 | 该标签可缺省,缺省值为平台支持的最小的窗口宽度。 | 285| maxWindowHeight | 标识当前UIAbility组件支持的最大的窗口高度, 高度单位为vp。<br/>最小取值为minWindowHeight,最大取值为平台支持的最大窗口高度。 窗口尺寸可以参考[窗口大小限制](../windowmanager/window-overview.md#约束与限制)。| 数值 | 该标签可缺省,缺省值为平台支持的最大的窗口高度。 | 286| minWindowHeight | 标识当前UIAbility组件支持的最小的窗口高度, 高度单位为vp。<br/>最小取值为平台支持的最小窗口高度,最大取值为maxWindowHeight。窗口尺寸可以参考[窗口大小限制](../windowmanager/window-overview.md#约束与限制)。| 数值 | 该标签可缺省,缺省值为平台支持的最小的窗口高度。 | 287| <!--DelRow-->excludeFromMissions | 标识当前UIAbility组件是否在最近任务列表中显示。<br/>- true:表示不在任务列表中显示。<br/>- false:表示在任务列表中显示。<br/>**说明:**<br/>三方应用的配置不生效,当前配置仅在系统应用中有效,若要使系统应用配置生效,需申请应用特权AllowAbilityExcludeFromMissions,详见[应用特权配置指导](../../device-dev/subsystems/subsys-app-privilege-config-guide.md)。| 布尔值 | 该标签可缺省,缺省值为false。 | 288| recoverable | 标识当前UIAbility组件是否支持在检测到应用故障后,恢复到应用原界面。<br/>- true:支持检测到出现故障后,恢复到原界面。<br/>- false:不支持检测到出现故障后,恢复到原界面。 | 布尔值 | 该标签可缺省,缺省值为false。 | 289| <!--DelRow-->unclearableMission | 标识当前UIAbility组件是否支持从最近任务列表中移除。<br/>- true:表示在任务列表中不可移除。<br/>- false:表示在任务列表中可以移除。<br/>**说明:**<br/>三方应用的配置不生效,当前配置仅在系统应用中有效,若要使系统应用配置生效,需申请应用特权AllowMissionNotCleared,详见[应用特权配置指导](../../device-dev/subsystems/subsys-app-privilege-config-guide.md)。 | 布尔值 | 该标签可缺省,缺省值为false。 | 290| isolationProcess | 标识组件能否运行在独立的进程中。<br/>- true:表示能运行在独立的进程中。<br/>- false:表示不能运行在独立的进程中。<br/>**说明:**<br/>仅2in1和tablet设备支持将UIAbility设置为独立进程。 | 布尔值 | 该标签可缺省,缺省值为false。 | 291| excludeFromDock | 标识当前UIAbility组件是否支持从dock区域隐藏图标。<br/>- true:表示在dock区域隐藏。<br/>- false:表示不能在dock区域隐藏。 | 布尔值 | 该标签可缺省,缺省值为false。 | 292| preferMultiWindowOrientation | 标识当前UIAbility组件多窗布局方向:<br/>- default:缺省值,参数不配置默认值,建议其他应用类配置。<br/>- portrait:多窗布局方向为竖向,建议竖向游戏类应用配置。<br/>- landscape:多窗布局方向为横向,配置后支持横屏悬浮窗和上下分屏,建议横向游戏类应用配置。<br/>- landscape_auto:多窗布局动态可变为横向,需要配合API enableLandScapeMultiWindow/disableLandScapeMultiWindow使用,建议视频类应用配置。 | 字符串 | 该标签可缺省,缺省值为default。 | 293| continueType | 标识当前UIAbility组件的跨端迁移类型。 | 字符串数组 | 该标签可缺省,缺省值为当前组件的名称。 | 294| continueBundleName | 标识当前应用支持跨端迁移的其它应用名称列表。<br/>**说明:**<br/>不能配置为本应用包名,仅为了做异包名迁移使用。<br/>从API version 13开始,支持该标签。 | 字符串数组 | 该标签可缺省,缺省值为空。 | 295| process | 标识组件的进程标签。<br/>**说明:**<br/>仅在[2in1](./module-configuration-file.md#devicetypes标签)设备上生效,UIAbility组件和type为embeddedUI的ExtensionAbility组件标签一致时运行在同一个进程中。从API version 14开始,支持该标签。 | 字符串 | 该标签可缺省,缺省值为空。 | 296 297abilities示例: 298 299<!--RP3--> 300```json 301{ 302 "abilities": [{ 303 "name": "EntryAbility", 304 "srcEntry": "./ets/entryability/EntryAbility.ets", 305 "launchType":"singleton", 306 "description": "$string:description_main_ability", 307 "icon": "$media:layered_image", 308 "label": "$string:EntryAbility_label", 309 "permissions": [], 310 "metadata": [], 311 "exported": true, 312 "continuable": true, 313 "skills": [{ 314 "actions": ["ohos.want.action.home"], 315 "entities": ["entity.system.home"], 316 "uris": [] 317 }], 318 "backgroundModes": [ 319 "dataTransfer" 320 ], 321 "startWindow": "$profile:start_window", 322 "startWindowIcon": "$media:icon", 323 "startWindowBackground": "$color:red", 324 "removeMissionAfterTerminate": true, 325 "orientation": "$string:orientation", 326 "supportWindowMode": ["fullscreen", "split", "floating"], 327 "maxWindowRatio": 3.5, 328 "minWindowRatio": 0.5, 329 "maxWindowWidth": 2560, 330 "minWindowWidth": 1400, 331 "maxWindowHeight": 300, 332 "minWindowHeight": 200, 333 "excludeFromMissions": false, 334 "unclearableMission": false, 335 "excludeFromDock": false, 336 "preferMultiWindowOrientation": "default", 337 "isolationProcess": false, 338 "continueType": [ 339 "continueType1", 340 "continueType2" 341 ], 342 "continueBundleName": [ 343 "com.example.myapplication1", 344 "com.example.myapplication2" 345 ], 346 "process": ":processTag" 347 }] 348} 349``` 350<!--RP3End--> 351 352## skills标签 353 354该标签标识UIAbility组件或者ExtensionAbility组件能够接收的[Want](../application-models/want-overview.md)的特征。 355 356 **表7** skills标签说明 357 358| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 359| -------- | -------- | -------- | -------- | 360| actions | 标识能够接收的Action值集合,取值通常为系统预定义的action值,也允许自定义。<br>一个skill中不建议配置多个action,否则可能导致无法匹配预期场景。详情请参考[常见action与entities](../application-models/actions-entities.md)。 | 字符串数组 | 该标签可缺省,缺省值为空。 | 361| entities | 标识能够接收的Entity值的集合。<br>一个skill中不建议配置多个entity,否则可能导致无法匹配预期场景。详情请参考[常见action与entities](../application-models/actions-entities.md)。 | 字符串数组 | 该标签可缺省,缺省值为空。 | 362| uris | 标识与Want中URI(Uniform Resource Identifier)相匹配的集合。 | 对象数组 | 该标签可缺省,缺省值为空。 | 363| permissions | 标识当前UIAbility或ExtensionAbility组件的权限信息。其他应用访问该组件时,需要申请相应的权限。<br/>一个数组元素为一个权限名称,不超过255字节,取值请参考[应用权限列表](../security/AccessToken/app-permissions.md)。 | 字符串数组 | 该标签可缺省,缺省值为空。 | 364| domainVerify | 标识是否开启<!--RP7-->[域名校验](../application-models/app-linking-startup.md#实现原理)<!--RP7End-->。<br/>- true:表示开启域名校验。<br/>- false:表示不开启域名校验。 | 布尔值 | 该标签可缺省,缺省值为false。 | 365 366 367 **表8** uris标签说明 368 369> **说明:** 370> 371> 以下字符串类型的标签不支持使用资源索引的方式($string)配置。 372 373| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 374| -------- | -------- | -------- | -------- | 375| scheme | 标识URI的协议名部分,常见的有http、https、file、ftp等。<br/>**说明:**<br/>从API 18开始,该标签在参与隐式Want匹配时不区分大小写。| 字符串 | uris中仅配置type时可以缺省,缺省值为空,否则不可缺省。 | 376| host | 标识URI的主机地址部分,该标签只有当scheme配置时才生效。常见的方式:<br/>- 域名方式,如example.com。<br/>- IP地址方式,如10.10.10.1。<br/>**说明:**<br/>从API 18开始,该标签在参与隐式Want匹配时不区分大小写。 | 字符串 | 该标签可缺省,缺省值为空。 | 377| port | 标识URI的端口部分。如http默认端口为80,https默认端口是443,ftp默认端口是21。该标签只有当scheme和host都配置时才生效。 | 字符串 | 该标签可缺省,缺省值为空。 | 378| path \| pathStartWith \| pathRegex | 标识URI的路径部分,path、pathStartWith和pathRegex配置时三选一。path标识URI与want中的路径部分全匹配,pathStartWith标识URI与want中的路径部分允许前缀匹配,pathRegex标识URI与want中的路径部分允许正则匹配。该标签只有当scheme和host都配置时才生效。 | 字符串 | 该标签可缺省,缺省值为空。 | 379| type | 标识与Want相匹配的数据类型,使用MIME(Multipurpose Internet Mail Extensions)类型规范和[UniformDataType](../reference/apis-arkdata/js-apis-data-uniformTypeDescriptor.md)类型规范。可以与scheme同时配置,也可以单独配置。 | 字符串 | 该标签可缺省,缺省值为空。 | 380| utd | 标识与Want相匹配的[标准化数据类型](../reference/apis-arkdata/js-apis-data-uniformTypeDescriptor.md),适用于分享等场景。 | 字符串 | 该标签可缺省,缺省值为空。 | 381| maxFileSupported | 对于指定类型的文件,标识一次能接收或打开的最大数量,适用于分享等场景,需要与utd配合使用。| 整数 | 该标签可缺省,缺省值为0。| 382| linkFeature | 标识URI提供的功能类型(如文件打开、分享、导航等),用于实现应用间跳转。取值为长度不超过127字节的字符串,不支持中文。同一Bundle中声明的linkFeature数量不能超过150个。详情见[linkFeature标签说明](../application-models/app-uri-config.md#linkfeature标签说明)。 | 字符串 | 该标签可缺省,缺省值为空。| 383 384skills示例: 385 386 387```json 388{ 389 "abilities": [ 390 { 391 "skills": [ 392 { 393 "actions": [ 394 "ohos.want.action.home" 395 ], 396 "entities": [ 397 "entity.system.home" 398 ], 399 "uris": [ 400 { 401 "scheme":"http", 402 "host":"example.com", 403 "port":"80", 404 "path":"path", 405 "type": "text/*", 406 "linkFeature": "Login" 407 } 408 ], 409 "permissions": [], 410 "domainVerify": false 411 } 412 ] 413 } 414 ] 415} 416``` 417 418## extensionAbilities标签 419 420描述extensionAbilities的配置信息,标签值为数组类型,该标签下的配置只对当前extensionAbilities生效。 421 422 **表9** extensionAbilities标签说明 423 424| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 425| -------- | -------- | -------- | -------- | 426| name | 标识当前ExtensionAbility组件的名称,确保该名称在整个应用中唯一,取值为长度不超过127字节的字符串。 | 字符串 | 该标签不可缺省。 | 427| srcEntry | 标识当前ExtensionAbility组件所对应的代码路径,取值为长度不超过127字节的字符串。 | 字符串 | 该标签不可缺省。 | 428| description | 标识当前ExtensionAbility组件的描述,开发者可以通过该标签描述当前组件的功能与作用,取值为长度不超过255字节的字符串,可以是对描述内容的资源索引,用于支持多语言。 | 字符串 | 该标签可缺省,缺省值为空。 | 429| icon | 标识当前ExtensionAbility组件的图标,取值为资源文件的索引。 | 字符串 | 该标签可缺省,缺省值为空。 | 430| label | 标识当前ExtensionAbility组件对用户显示的名称,取值为该名称的资源索引,以支持多语言,字符串长度不超过255字节。 | 字符串 | 该标签可缺省,缺省值为空。 | 431| type | 标识当前ExtensionAbility组件的类型,支持的取值如下:<br/>- form:卡片的ExtensionAbility。<br/>- workScheduler:延时任务的ExtensionAbility。<br/>- inputMethod:输入法的ExtensionAbility。<!--Del--><br/>- service:后台运行的service组件。<!--DelEnd--><br/>- accessibility:辅助能力的ExtensionAbility。<!--Del--><br/>- fileAccess:公共数据访问的ExtensionAbility,允许应用程序提供文件和文件夹给文件管理类应用展示。<br/>- dataShare:数据共享的ExtensionAbility。<br/>- staticSubscriber:静态广播的ExtensionAbility。<!--DelEnd--><br/>- wallpaper:壁纸的ExtensionAbility。<br/>- backup:数据备份的ExtensionAbility。<br/>- enterpriseAdmin:[企业设备管理](../mdm/mdm-kit-admin.md)的ExtensionAbility。企业设备管理应用必须拥有此类型的ExtensionAbility。<!--Del--><br/>- window:该ExtensionAbility会在启动过程中创建一个window,为开发者提供界面开发。开发者开发出来的界面将通过UIExtensionComponent控件组合到其他应用的窗口中。<!--DelEnd--><br/>- thumbnail:获取文件缩略图的ExtensionAbility,开发者可以对自定义文件类型的文件提供缩略。<br/>- preview:该ExtensionAbility会将文件解析后在一个窗口中显示,开发者可以通过将此窗口组合到其他应用窗口中。<br/>- print:打印框架的ExtensionAbility。<br/>- push:推送的ExtensionAbility。<br/>- driver:驱动框架的ExtensionAbility。应用配置了driver类型的ExtensionAbility后会被视为驱动应用,驱动应用在安装、卸载和恢复时不会区分用户,且创建新用户时也会安装设备上已有的驱动应用。例如,创建子用户时会默认安装主用户已有的驱动应用,在子用户上卸载驱动应用时,主用户上对应的驱动应用也会同时被卸载。<br/>- remoteNotification:远程通知的ExtensionAbility。<br/>- remoteLocation:远程定位的ExtensionAbility。<br/>- voip:网络音视频通话的ExtensionAbility。<br/>- action:自定义操作业务模板的ExtensionAbility,为开发者提供基于UIExtension的自定义操作业务模板。<!--Del--><br/>- adsService:广告业务的ExtensionAbility,提供广告业务框架。<!--DelEnd--><br/>- embeddedUI:嵌入式UI扩展能力,提供跨进程界面嵌入的能力。<br/>- insightIntentUI:为开发者提供能被小艺意图调用,以窗口形态呈现内容的扩展能力。<br/>- ads:广告业务的ExtensionAbility,与AdComponent控件组合使用,将广告页面展示到其他应用中。仅支持设备厂商使用。<br/>- photoEditor:图片编辑业务的ExtensionAbility,为开发者提供基于UIExtension的图片编辑业务模版。<br/>- appAccountAuthorization:应用账号授权扩展能力的ExtensionAbility,用于处理账号授权请求,比如账号登录授权。<br/>- autoFill/password:用于账号和密码自动填充业务的ExtensionAbility,支持数据的保存、填充能力。<br/>- hms/account:应用账号管理能力的ExtensionAbility。<!--Del--><br/>- sysDialog/atomicServicePanel:提供构建原子化服务服务面板的基础能力的ExtensionAbility,使用时基于UIExtensionAbility实现。<br/>- sysDialog/userAuth:本地用户鉴权的ExtensionAbility。<br/>- sysDialog/common:通用弹窗的ExtensionAbility。<br/>- sysDialog/power:关机重启弹窗的ExtensionAbility。<br/>- sysDialog/print:打印模态弹窗的ExtensionAbility。<br/>- sysDialog/meetimeCall:畅连通话的ExtensionAbility。<br/>- sysDialog/meetimeContact:畅连联系人的ExtensionAbility。<br/>- sysPicker/meetimeMessage:畅连消息的ExtensionAbility。<br/>- sysPicker/meetimeContact:畅连联系人列表的ExtensionAbility。<br/>- sysPicker/meetimeCallLog:畅连通话记录列表的ExtensionAbility。<br/>- sysPicker/share:系统分享的ExtensionAbility。<br/>- sysPicker/mediaControl:投播组件的ExtensionAbility。<br/>- sysPicker/photoPicker:三方应用通过对应的UIExtensionType拉起图库picker界面。<br/>- sysPicker/filePicker:文件下载弹窗的ExtensionAbility。<br/>- sysPicker/audioPicker:音频管理弹窗的ExtensionAbility。<br/>- sysPicker/photoEditor:图片编辑弹窗的ExtensionAbility。<br/>- sys/commonUI:非通用的ExtensionAbility,提供业务属性强相关的嵌入式显示或弹框。<!--DelEnd--><br/>- autoFill/smart:用于情景化场景自动填充业务的ExtensionAbility,支持数据的保存、填充能力。<!--Del--><br/>- uiService:弹窗服务组件,在启动过程中会创建window,并支持双向通信。<!--DelEnd--> <!--RP9--><!--RP9End--><br/>- recentPhoto:最近照片推荐的ExtensionAbility。<br/>- fence:地理围栏的ExtensionAbility。<br/>- callerInfoQuery:企业联系人查询的ExtensionAbility。<br/>- assetAcceleration:资源预下载的ExtensionAbility。<br/>- formEdit:卡片编辑的ExtensionAbility。<br/>- distributed:分布式扩展的ExtensionAbility。<br/>- liveForm:互动卡片的[ExtensionAbility](../reference/apis-form-kit/js-apis-app-form-LiveFormExtensionAbility.md)。从API version 20开始,支持该标签。<br/>- appService:为应用提供后台服务相关扩展能力[AppServiceExtensionAbility](../reference/apis-ability-kit/js-apis-app-ability-appServiceExtensionAbility.md),包括后台服务的创建、销毁、连接、断开等生命周期回调。从API version 20开始,支持该标签。<!--Del--><br/>- awc/webpage:通用网页浏览的ExtensionAbility。<br/>- awc/newsfeed:信息流资讯业务的ExtensionAbility。<br/>- selection:划词扩展的[ExtensionAbility](../reference/apis-basic-services-kit/js-apis-selectionInput-selectionExtensionAbility-sys.md)。从API version 20开始,支持该标签。<br/>**说明:**<br/>其中service、adsService、staticSubscriber、window、sys/commonUI、fileAccess、selection、sysDialog类型、sysPicker类型、dataShare类型和uiService类型,三方应用的配置不生效,当前配置仅在系统应用中有效。<!--DelEnd--> | 字符串 | 该标签不可缺省。 | 432| permissions | 标识当前ExtensionAbility组件的权限信息。当其他应用访问该ExtensionAbility时,需要申请相应的权限。<br/>一个数组元素为一个权限名称。不超过255字节,取值请参考[应用权限列表](../security/AccessToken/app-permissions.md)。 | 字符串数组 | 该标签可缺省,缺省值为空。 | 433| appIdentifierAllowList | 标识允许启动此ExtensionAbility的应用程序列表。<br/>一个数组元素为一个应用程序的appIdentifier,appIdentifier信息可参考[什么是appIdentifier](../quick-start/common_problem_of_application.md#什么是appidentifier)。<br/>**说明:**<br/>仅当ExtensionAbility组件的type为appService时支持配置该标签。<br/>从API version 20开始,支持该标签。 | 字符串数组 | 该标签可缺省,缺省值为空。 | 434| readPermission | 标识读取当前ExtensionAbility组件数据所需的权限,取值为长度不超过255字节的字符串。仅当ExtensionAbility组件的type为dataShare时支持配置该标签。 | 字符串 | 该标签可缺省,缺省值为空。 | 435| writePermission | 标识向当前ExtensionAbility组件写数据所需的权限,取值为长度不超过255字节的字符串。仅当ExtensionAbility组件的type为dataShare时支持配置该标签。 | 字符串 | 该标签可缺省,缺省值为空。 | 436| uri | 标识当前ExtensionAbility组件提供的数据URI,取值为长度不超过255字节的字符数组,用反向域名的格式表示。<br/>**说明:**<br/>该标签在type为dataShare类型的ExtensionAbility时,不可缺省。 | 字符串 | 该标签可缺省,缺省值为空。 | 437|skills | 标识当前ExtensionAbility组件能够接收的[Want](../application-models/want-overview.md)的特征集。<br/>配置规则:entry包可以配置多个具有入口能力的skills标签(配置了ohos.want.action.home和entity.system.home)的ExtensionAbility,其中第一个配置了skills标签的ExtensionAbility中的label和icon作为服务或应用的label和icon。<br/>**说明:**<br/>服务的Feature包不支持配置具有入口能力的skills标签。<br/>应用的Feature包支持配置具有入口能力的skills标签。 | 数组 | 该标签可缺省,缺省值为空。 | 438| [metadata](#metadata标签) | 标识当前ExtensionAbility组件的元信息。<br/>**说明:**<br/>该标签在type为form时,不可缺省,且必须存在一个name为ohos.extension.form的对象值,其对应的resource值不能缺省,为服务卡片的二级资源引用。 | 对象数组 | 该标签可缺省,缺省值为空。 | 439| exported | 标识当前ExtensionAbility组件是否可以被其他应用调用。<br/>- true:表示可以被其他应用调用。<br/>- false:表示不可以被其他应用调用,包括无法被aa工具命令拉起应用。 | 布尔值 | 该标签可缺省,缺省值为false。 | 440| extensionProcessMode | 标识当前ExtensionAbility组件的多进程实例模型,当前只对UIExtensionAbility以及从UIExtensionAbility扩展的ExtensionAbility生效。<br/>- instance:表示该ExtensionAbility每个实例一个进程。<br/>- type:表示该ExtensionAbility实例都运行在同一个进程里,与其他ExtensionAbility分离进程。<br/>- bundle:表示该ExtensionAbility实例都运行在应用统一进程里,与其他配置了bundle模型的ExtensionAbility共进程。<!--RP10--><!--RP10End--> | 字符串 | 该标签可缺省,缺省值为空。 | 441| dataGroupIds | 标识当前ExtensionAbility组件的dataGroupId集合。如果当前ExtensionAbility组件所在的应用在应用市场申请的证书里groupIds也申请了某个dataGroupId,那么当前ExtensionAbility组件可以和应用共享这一个dataGroupId生成的目录,所以ExtensionAbility组件的dataGroupId需要是应用的签名证书中groupIds标签里配置的才能生效。 且该标签仅在当前ExtensionAbility组件存在独立的沙箱目录时生效。<!--RP8--><!--RP8End--> | 字符串数组 | 该标签可缺省,缺省值为空。 | 442| process | 标识组件的进程标签,只有type为embeddedUI时可以配置该标签。<br/>**说明:**<br/>仅在[2in1](./module-configuration-file.md#devicetypes标签)设备上生效,UIAbility组件和ExtensionAbility组件标签一致时运行在同一个进程中。从API version 14开始,支持该标签。 | 字符串 | 该标签可缺省,缺省值为空。 | 443| isolationProcess | 标识ExtensionAbility组件能否运行在独立的进程中。<br/>- true:表示能运行在独立的进程中。<br/>- false:表示不能运行在独立的进程中。<br/>**说明:**<br/>仅当ExtensionAbility组件的type为"sys/commonUI"时该标签配置生效,且仅支持由系统应用配置type为"sys/commonUI"。<br/>从API version 20开始,支持该标签。 | 布尔值 | 该标签可缺省,缺省值为false。 | 444 445extensionAbilities示例: 446 447 448```json 449{ 450 "extensionAbilities": [ 451 { 452 "name": "FormName", 453 "srcEntry": "./form/MyForm.ts", 454 "icon": "$media:icon", 455 "label" : "$string:extension_name", 456 "description": "$string:form_description", 457 "type": "form", 458 "permissions": ["ohos.permission.ACCESS_BLUETOOTH"], 459 "readPermission": "", 460 "writePermission": "", 461 "exported": true, 462 "uri":"scheme://authority/path/query", 463 "skills": [{ 464 "actions": [], 465 "entities": [], 466 "uris": [], 467 "permissions": [] 468 }], 469 "metadata": [ 470 { 471 "name": "ohos.extension.form", 472 "resource": "$profile:form_config", 473 } 474 ], 475 "extensionProcessMode": "instance", 476 "dataGroupIds": [ 477 "testGroupId1" 478 ] 479 } 480 ] 481} 482``` 483 484## shortcuts标签 485 486shortcuts标识应用的快捷方式信息。标签值为数组,包含四个子标签shortcutId、label、icon、wants。 487 488[metadata](#metadata标签)中指定shortcut信息,其中: 489 490- name:指定shortcuts的名称,使用ohos.ability.shortcuts作为shortcuts信息的标识。 491 492- resource:指定shortcuts信息的资源位置。 493 494**表10** shortcuts标签说明 495 496| 属性名称 | 含义 | 类型 | 是否可缺省 | 497| -------- | -------- | -------- | -------- | 498| shortcutId | 标识快捷方式的ID,取值为长度不超过63字节的字符串。**不支持通过资源索引的方式($string)配置该标签。** | 字符串 | 该标签不可缺省。 | 499| label | 标识快捷方式的标签信息,即快捷方式对外显示的文字描述信息。取值为长度不超过255字节的字符串,可以是描述性内容,也可以是标识label的资源索引。 | 字符串 | 该标签可缺省,缺省值为空。 | 500| icon | 标识快捷方式的图标,取值为资源文件的索引。 | 字符串 | 该标签可缺省,缺省值为空。 | 501| visible | 标识快捷方式是否显示,取值为true时显示快捷方式,取值为false时不显示快捷方式。<br/>**说明:**<br/>1.从API version 20开始,支持该标签。<br/> | 布尔值 | 该标签可缺省,缺省为true。 | 502| [wants](#wants标签) | 标识快捷方式内定义的目标wants信息集合,在调用launcherBundleManager的startShortcut接口时,会拉起wants标签里的第一个目标组件,推荐只配置一个wants元素。 | 对象 | 该标签可缺省,缺省为空。 | 503 504 5051. 在/resources/base/profile/目录下配置shortcuts_config.json配置文件。 506 507 ```json 508 { 509 "shortcuts": [ 510 { 511 "shortcutId": "id_test1", 512 "label": "$string:shortcut", 513 "icon": "$media:aa_icon", 514 "visible": true, 515 "wants": [ 516 { 517 "bundleName": "com.ohos.hello", 518 "moduleName": "entry", 519 "abilityName": "EntryAbility", 520 "parameters": { 521 "testKey": "testValue" 522 } 523 } 524 ] 525 } 526 ] 527 } 528 ``` 529 5302. 在module.json5配置文件的abilities标签中,针对需要添加快捷方式的UIAbility进行配置metadata标签,使shortcut配置文件对该UIAbility生效。 531 532 ```json 533 { 534 "module": { 535 // ... 536 "abilities": [ 537 { 538 "name": "EntryAbility", 539 "srcEntry": "./ets/entryability/EntryAbility.ets", 540 // ... 541 "skills": [ 542 { 543 "entities": [ 544 "entity.system.home" 545 ], 546 "actions": [ 547 "ohos.want.action.home" 548 ] 549 } 550 ], 551 "metadata": [ 552 { 553 "name": "ohos.ability.shortcuts", 554 "resource": "$profile:shortcuts_config" 555 } 556 ] 557 } 558 ] 559 } 560 } 561 ``` 562### wants标签 563 564此标签用于标识快捷方式内定义的目标wants信息集合。 565 566**表11** wants标签说明 567 568| 属性名称 | 含义 | 类型 | 是否可缺省 | 569| -------- | -------- | -------- | -------- | 570| bundleName | 表示快捷方式的目标包名。 | 字符串 | 该标签不可缺省。 | 571| moduleName | 表示快捷方式的目标模块名。 | 字符串 | 该标签可缺省。 | 572| abilityName| 表示快捷方式的目标组件名。 | 字符串 | 该标签不可缺省。 | 573| parameters | 表示拉起快捷方式时的自定义数据,仅支持配置字符串类型的数据。其中键值均最大支持1024长度的字符串。 | 对象 | 该标签可缺省。 | 574 575data标签示例: 576 577```json 578{ 579 "wants": [ 580 { 581 "bundleName": "com.ohos.hello", 582 "moduleName": "entry", 583 "abilityName": "EntryAbility", 584 "parameters": { 585 "testKey": "testValue" 586 } 587 } 588 ] 589} 590``` 591 592## distributionFilter标签 593 594该标签用于定义HAP对应的细分设备规格的分发策略,以便在应用市场进行云端分发应用包时做精准匹配。 595 596> **说明:** 597> 该标签从API10及以后版本开始生效,API9及以前版本使用distroFilter标签。 598 599- **适用场景:** 当一个工程中存在多个Entry,且多个Entry配置的deviceTypes存在交集时,则需要通过该标签进行区分。比如下面的两个Entry都支持tablet类型,就需要通过该标签进行区分。 600 ```json 601 // entry1支持的设备类型 602 { 603 "module": { 604 "name": "entry1", 605 "type": "entry", 606 "deviceTypes" : [ 607 "tv", 608 "tablet" 609 ] 610 } 611 } 612 ``` 613 ```json 614 // entry2支持的设备类型 615 { 616 "module": { 617 "name": "entry2", 618 "type": "entry", 619 "deviceTypes" : [ 620 "car", 621 "tablet" 622 ] 623 } 624 } 625 ``` 626 627- **配置规则:** 该标签支持配置四个属性,包括屏幕形状([screenShape](#screenshape标签))、窗口分辨率([screenWindow](#screenwindow标签))、屏幕像素密度([screenDensity](#screendensity标签) )、设备所在国家与地区([countryCode](#countrycode标签))。详见下表。 628 629 在分发应用包时,通过deviceTypes与这四个属性的匹配关系,唯一确定一个用于分发到设备的HAP。 630 631 * 如果需要配置该标签,则至少包含一个属性。 632 * 如果一个Entry中配置了任意一个或多个属性,则其他Entry也必须包含相同的属性。 633 * `screenShape`和`screenWindow`属性仅适用于轻量级智能穿戴设备。 634 635- **配置方式:** 该标签需要配置在/resources/base/profile资源目录下,并在metadata的resource标签中引用。 636 637 638**表12** distributionFilter标签配置说明 639 640| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 641| -------- | -------- | -------- | -------- | 642| [screenShape](#screenshape标签) | 标识屏幕形状的支持策略。 | 对象数组 | 该标签可缺省,缺省值为空。 | 643| [screenWindow](#screenwindow标签) | 标识应用运行时的窗口分辨率的支持策略。| 对象数组 | 该标签可缺省,缺省值为空。 | 644| [screenDensity](#screendensity标签) | 标识屏幕的像素密度(dpi:Dot Per Inch)的支持策略。 | 对象数组 | 该标签可缺省,缺省值为空。 | 645| [countryCode](#countrycode标签) | 标识国家与地区的支持策略,取值参考ISO-3166-1标准。支持多个国家和地区枚举定义。 | 对象数组 | 该标签可缺省,缺省值为空。 | 646 647### screenShape标签 648 649**表13** screenShape标签说明 650 651| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 652| -------- | -------- | -------- | -------- | 653| policy | 标识条件属性的过滤规则。<br/>- exclude:表示需要排除的value属性。<br/>- include:表示需要包含的value属性。 | 字符串 | 该标签不可缺省。 | 654| value | 支持的取值为circle(圆形)、rect(矩形)。例如,针对智能穿戴设备,可为圆形表盘和矩形表盘分别提供不同的HAP。 | 字符串数组 | 该标签不可缺省。 | 655 656### screenWindow标签 657 658**表14** screenWindow标签说明 659 660| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 661| -------- | -------- | -------- | -------- | 662| policy | 标识条件属性的过滤规则。当前取值仅支持“include”。<br/>- include:表示需要包含的value属性。 | 字符串 | 该标签不可缺省。 | 663| value | 单个字符串的取值格式为“宽 \* 高”,取值为整数像素值,例如“454 \* 454”。 | 字符串数组 | 该标签不可缺省。 | 664 665### screenDensity标签 666 667**表15** screenDensity标签说明 668 669| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 670| -------- | -------- | -------- | -------- | 671| policy | 标识条件属性的过滤规则。<br/>- exclude:表示需要排除的value属性。<br/>- include:表示需要包含的value属性。 | 字符串 | 该标签不可缺省。 | 672| value | 标识屏幕的像素密度(dpi :Dot Per Inch)。支持的取值如下:<br/>- sdpi:表示小规模的屏幕密度(Small-scale Dots per Inch),适用于dpi取值为(0,120]的设备。<br/>- mdpi:表示中规模的屏幕密度(Medium-scale Dots Per Inch),适用于dpi取值为(120,160]的设备。<br/>- ldpi:表示大规模的屏幕密度(Large-scale Dots Per Inch),适用于dpi取值为(160,240]的设备。<br/>- xldpi:表示大规模的屏幕密度(Extra Large-scale Dots Per Inch),适用于dpi取值为(240,320]的设备。<br/>- xxldpi:表示大规模的屏幕密度(Extra Extra Large-scale Dots Per Inch),适用于dpi取值为(320,480]的设备。<br/>- xxxldpi:表示大规模的屏幕密度(Extra Extra Extra Large-scale Dots Per Inch),适用于dpi取值为(480, 640]的设备。 | 字符串数组 | 该标签不可缺省。 | 673 674### countryCode标签 675 676**表16** countryCode标签说明 677 678| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 679| -------- | -------- | -------- | -------- | 680| policy | 标识条件属性的过滤规则。<br/>- exclude:表示需要排除的value属性。<br/>- include:表示需要包含的value属性。 | 字符串 | 该标签不可缺省。 | 681| value | 标识应用需要分发的国家地区码。 | 字符串数组 | 该标签不可缺省。 | 682 683 684示例如下: 685 6861. 在开发视图的resources/base/profile下定义配置文件,文件名为distributionFilter_config.json,文件名可以自定义。 687 ```json 688 { 689 "distributionFilter": { 690 "screenShape": { 691 "policy": "include", 692 "value": [ 693 "circle", 694 "rect" 695 ] 696 }, 697 "screenWindow": { 698 "policy": "include", 699 "value": [ 700 "454*454", 701 "466*466" 702 ] 703 }, 704 "screenDensity": { 705 "policy": "exclude", 706 "value": [ 707 "ldpi", 708 "xldpi" 709 ] 710 }, 711 "countryCode": { // 支持在中国分发 712 "policy": "include", 713 "value": [ 714 "CN" 715 ] 716 } 717 } 718 } 719 ``` 720 721 7222. 在module.json5配置文件的module标签中定义metadata信息。 723 724 725 ```json 726 { 727 "module": { 728 // ... 729 "metadata": [ 730 { 731 "name": "ohos.module.distribution", 732 "resource": "$profile:distributionFilter_config", 733 } 734 ] 735 } 736 } 737 ``` 738 739 740## testRunner标签 741 742此标签用于支持对测试框架的配置。 743 744**表17** testRunner标签说明 745 746| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 747| -------- | -------- | -------- | -------- | 748| name | 标识测试框架对象名称,取值为长度不超过255字节的字符串。 | 字符串 | 不可缺省。 | 749| srcPath | 标识测试框架代码路径,取值为长度不超过255字节的字符串。 | 字符串 | 不可缺省。 | 750 751testRunner标签示例: 752 753 754```json 755{ 756 "module": { 757 // ... 758 "testRunner": { 759 "name": "myTestRunnerName", 760 "srcPath": "etc/test/TestRunner.ts" 761 } 762 } 763} 764``` 765 766## atomicService标签 767 768此标签用于支持对原子化服务的配置。此标签仅在app.json中将bundleType设置为atomicService时生效。 769 770**表18** atomicService标签说明 771 772| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 773| -------- | -------- | -------- | -------- | 774| preloads | 标识原子化服务中预加载列表。 | 对象数组 | 该标签可缺省,缺省值为空。 | 775| resizeable | 标识原子化服务是否支持自适应窗口大小显示。当标签配置成true时,平板横屏模式切换或者折叠屏展开关闭,会自适应屏幕窗口的宽高,使得屏幕显示正常。<br/>**说明:**<br/>1.从API version 20开始,支持该标签。<br/>2.如果已经适配了平板横屏及折叠屏展开态显示,建议将该标签设置为true。<br/>- true:表示原子化服务可以自适应窗口大小。<br/>- false:表示原子化服务不可以自适应窗口大小。 | 布尔值 | 可缺省,缺省值为false。 | 776 777 778**表19** preloads标签说明 779 780| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 781| -------- | -------- | -------- | -------- | 782| moduleName | 标识原子化服务中当前模块被加载时,需预加载的模块名。不能配置自身modulename,且必须有对应的模块,取值为长度不超过31字节的字符串。 | 字符串 | 该标签不可缺省。 | 783 784 785atomicService标签示例: 786 787```json 788{ 789 "module": { 790 "atomicService": { 791 "preloads":[ 792 { 793 "moduleName":"feature" 794 } 795 ], 796 "resizeable": true 797 } 798 } 799} 800``` 801 802## dependencies标签 803 804此标签标识模块运行时依赖的共享库列表。 805 806**表20** dependencies标签说明 807 808| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 809| ----------- | ------------------------------ | -------- | ---------- | 810| bundleName | 标识当前模块依赖的共享包包名。取值为长度7~128字节的字符串。 | 字符串 | 该标签可缺省,缺省值为空。 | 811| moduleName | 标识当前模块依赖的共享包模块名。取值为长度不超过31字节的字符串。 | 字符串 | 该标签不可缺省。 | 812| versionCode | 标识当前模块依赖的共享包的版本号。取值范围为0~2147483647。 | 数值 | 该标签可缺省,缺省值为空。 | 813 814dependencies标签示例: 815 816```json 817{ 818 "module": { 819 "dependencies": [ 820 { 821 "bundleName":"com.share.library", 822 "moduleName": "library", 823 "versionCode": 10001 824 } 825 ] 826 } 827} 828``` 829 830## proxyData标签 831 832此标签标识模块提供的数据代理列表,仅限entry和feature配置。 833 834**表21** proxyData标签说明 835| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 836| ----------- | ------------------------------ | -------- | ---------- | 837| uri | 标识用于访问该数据代理的URI,不同的数据代理配置的URI不可重复,且需要满足`datashareproxy://当前应用包名/xxx`的格式。取值为长度不超过255字节的字符串。 | 字符串 | 该标签不可缺省。 | 838| requiredReadPermission | 标识从该数据代理中读取数据所需要的权限。若不配置,则其他应用无法使用该代理。非系统应用配置的权限的等级需为system_basic或system_core,系统应用配置的权限的等级没有限制。权限等级可以参考[权限列表](../security/AccessToken/app-permissions.md)。取值为长度不超过255字节的字符串。 | 字符串 | 该标签可缺省,缺省值为空。 | 839| requiredWritePermission | 标识向该数据代理中写入数据所需要的权限。若不配置,则其他应用无法使用该代理。非系统应用配置的权限的等级需为system_basic或system_core,系统应用配置的权限的等级没有限制。权限等级可以参考[权限列表](../security/AccessToken/app-permissions.md)。取值为长度不超过255字节的字符串。 | 字符串 | 该标签可缺省,缺省值为空。 | 840| [metadata](#metadata标签) | 标识该数据代理的元信息,只支持配置name和resource标签。 | 对象 | 该标签可缺省,缺省值为空。 | 841 842proxyData标签示例: 843 844```json 845{ 846 "module": { 847 "proxyData": [ 848 { 849 "uri":"datashareproxy://com.ohos.datashare/event/Meeting", 850 "requiredReadPermission": "ohos.permission.ACCESS_BLUETOOTH", 851 "requiredWritePermission": "ohos.permission.ACCESS_BLUETOOTH", 852 "metadata": { 853 "name": "datashare_metadata", 854 "resource": "$profile:datashare" 855 } 856 } 857 ] 858 } 859} 860``` 861 862## routerMap标签 863 864此标签标识模块配置的路由表的路径。 865 866routerMap配置文件描述模块的路由表信息,routerMap标签的值为数组类型。 867 868**表22** routerMap标签说明 869 870| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 871| -------- | -------- | -------- | -------- | 872| name | 标识跳转页面的名称。取值为长度不超过1023字节的字符串。 | 字符串 | 该标签不可缺省。 | 873| pageSourceFile| 标识页面在模块内的路径。取值为长度不超过255字节的字符串。 | 字符串 | 该标签不可缺省。 | 874| buildFunction | 标识被@Builder修饰的函数,该函数描述页面的UI。取值为长度不超过1023字节的字符串。 | 字符串 | 该标签不可缺省。 | 875| [data](#data标签) | 标识字符串类型的自定义数据,开发者自行扩展能力,可以通过[HapModuleInfo对象](../reference/apis-ability-kit/js-apis-bundleManager-hapModuleInfo.md)中routerMap集合对象下的data获取标签内容,该标签已由系统解析,无需开发者自行解析。 每个自定义数据字符串取值不超过128字节。 | 对象 | 该标签可缺省,缺省值为空。 | 876| [customData](#customdata标签) | 标识任意类型的自定义数据,开发者自行扩展能力,可以通过[HapModuleInfo对象](../reference/apis-ability-kit/js-apis-bundleManager-hapModuleInfo.md)中routerMap集合对象下的customData获取标签内容,开发者需要调用JSON.parse函数解析出具体内容。总长度不超过4096字节。 | 对象 | 该标签可缺省,缺省值为空。 | 877 878示例如下: 879 8801. 在开发视图的resources/base/profile下面定义配置文件,文件名可以自定义,例如:router_map.json。 881 882 ```json 883 { 884 "routerMap": [ 885 { 886 "name": "DynamicPage1", 887 "pageSourceFile": "src/main/ets/pages/pageOne.ets", 888 "buildFunction": "myFunction", 889 "customData": { 890 "stringKey": "data1", 891 "numberKey": 123, 892 "booleanKey": true, 893 "objectKey": { 894 "name": "test" 895 }, 896 "arrayKey": [ 897 { 898 "id": 123 899 } 900 ] 901 } 902 }, 903 { 904 "name": "DynamicPage2", 905 "pageSourceFile": "src/main/ets/pages/pageTwo.ets", 906 "buildFunction": "myBuilder", 907 "data": { 908 "key1": "data1", 909 "key2": "data2" 910 } 911 } 912 ] 913 } 914 ``` 915 9162. 在module.json5配置文件的module标签中定义`routerMap`标签,指向定义的路由表配置文件,例如:`"routerMap": "$profile:router_map"`。 917 918### data标签 919 920此标签用于支持在路由表中配置自定义的字符串数据。 921 922data标签示例: 923 924```json 925{ 926 "routerMap": [ 927 { 928 "name": "DynamicPage", 929 "pageSourceFile": "src/main/ets/pages/pageOne.ets", 930 "buildFunction": "myBuilder", 931 "data": { 932 "key1": "data1", 933 "key2": "data2" 934 } 935 } 936 ] 937} 938``` 939 940### customData标签 941 942此标签用于支持在路由表中配置自定义数据。 943customData对象内部,可以配置任意类型的自定义数据。 944 945customData标签示例: 946 947```json 948{ 949 "routerMap": [ 950 { 951 "name": "DynamicPage", 952 "pageSourceFile": "src/main/ets/pages/pageOne.ets", 953 "buildFunction": "myBuilder", 954 "customData": { 955 "stringKey": "data1", 956 "numberKey": 123, 957 "booleanKey": true, 958 "objectKey": { 959 "name": "test" 960 }, 961 "arrayKey": [ 962 { 963 "id": 123 964 } 965 ] 966 } 967 } 968 ] 969} 970``` 971 972## appEnvironments标签 973 974此标签标识模块配置的应用环境变量。 975 976**表23** appEnvironments标签说明 977 978| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 979| -------- | -------- | -------- | -------- | 980| name | 标识环境变量的变量名称。取值为长度不超过4096字节的字符串。 | 字符串 | 该标签可缺省,缺省值为空。 | 981| value | 标识环境变量的值。取值为长度不超过4096字节的字符串。 | 字符串 | 该标签可缺省,缺省值为空。 | 982 983appEnvironments标签示例: 984 985```json 986{ 987 "module": { 988 "appEnvironments": [ 989 { 990 "name":"name1", 991 "value": "value1" 992 } 993 ] 994 } 995} 996``` 997 998 999## hnpPackages标签 1000 1001该标签标识应用包含的Native软件包信息。 1002 1003**表24** hnpPackages标签说明 1004 1005| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 1006| -------- | -------- | -------- | -------- | 1007| package | 标识Native软件包名称。 | 字符串 | 该标签不可缺省。 | 1008| type | 标识Native软件包类型。支持的取值如下:<br/>- public:公有类型。<br/>- private:私有类型。 | 字符串 | 该标签不可缺省。 | 1009 1010hnpPackages示例: 1011 1012 1013```json 1014{ 1015 "module" : { 1016 "hnpPackages": [ 1017 { 1018 "package": "hnpsample.hnp", 1019 "type": "public" 1020 } 1021 ] 1022 } 1023} 1024``` 1025 1026## fileContextMenu标签 1027 1028该标签标识当前HAP的右键菜单配置项,是一个profile文件资源,用于指定描述应用注册右键菜单配置文件。仅在PC/2in1设备上生效。仅允许在entry类型模块中配置。 1029 1030fileContextMenu标签示例 1031 1032```json 1033{ 1034 "module": { 1035 // ... 1036 "fileContextMenu": "$profile:menu" // 通过profile下的资源文件配置 1037 } 1038} 1039``` 1040 1041在开发视图的resources/base/profile下面定义配置文件menu.json,其中文件名“menu.json”可自定义,需要和fileContextMenu标签指定的信息对应。配置文件中描述了当前应用注册的右键菜单的项目和响应行为。 1042配置文件根节点名称为fileContextMenu,为对象数组,标识当前module注册右键菜单的数量。(单模块和单应用注册数量不能超过5个,配置超过数量当前只解析随机5个) 1043 1044**表25** fileContextMenu标签配置说明 1045 1046| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 1047| -------- | -------- | -------- | -------- | 1048| abilityName | 表示当前右键菜单对应的需要拉起的ability名称。 | 字符串 | 不可缺省。 | 1049| menuItem | 右键菜单显示的信息。命名建议:<br/>原则一:[动作]+[应用名],中文示例:用{App}打开、用{App} ({Plugin}插件) 打开;英文示例:Open with {App}、Open with {App} ({Plugin})。<br/>原则二:[动作]+[目的],示例:压缩为{文件名}、压缩至{路径}、用{App}转换为{格式}。 | 资源id | 不可缺省。 | 1050| menuHandler | 一个ability可以创建多个右键菜单, 该标签与右键菜单显示项一一对应,用于区分用户拉起的不同右键菜单项。开发者可自定义该标签取值,确保该标签在整个ability中唯一。在用户点击右键菜单拉起应用时,会作为参数传递给应用。 | 字符串 | 不可缺省。 | 1051| menuContext | 定义展示该菜单项需要的上下文,可以支持多种情况,类型为数组。 | 对象数组 | 不可缺省。 | 1052 1053**表26** menuContext标签配置说明 1054 1055| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 1056| -------- | -------- | -------- | -------- | 1057| menuKind | 表示单击如下类型时会触发右键菜单。取值范围如下:<br/>- 0:空白处<br/>- 1:文件<br/>- 2:文件夹<br/>- 3:文件和文件夹 | 数值 | 不可缺省。 | 1058| menuRule | 表示采用什么方式选择文件或文件夹时,会触发右键菜单。取值范围如下:<br/>- single:单选<br/>- multi:多选<br/>- both:单选或多选 | 字符串 | 仅当menuKind为1或2时,才会读取该标签,此时不可缺省。 | 1059| fileSupportType | 表示当选中的文件列表里包含指定的文件类型时,显示右键菜单。<br/>当该标签取值为["*"]时,将会读取fileNotSupportType标签。<br/>当该标签取值为[]时,将不做任何处理。 | 字符串数组 | 仅当menuKind为1时,才会读取该标签,此时不可缺省。 | 1060| fileNotSupportType | 表示当选中的文件列表里包含这些文件类型时,不显示该右键菜单。<br/>仅当menuKind为1、且fileSupportType为["*"]时,才会读取该标签。 | 字符串数组 | 可缺省,缺省值为空。 | 1061 1062resources/base/profile路径下的menu.json资源文件示例如下: 1063```json 1064{ 1065 "fileContextMenu": [ 1066 { 1067 "abilityName": "EntryAbility", 1068 "menuItem": "$string:module_desc", 1069 "menuHandler": "openCompress", 1070 "menuContext": [ 1071 { 1072 "menuKind": 0 1073 }, 1074 { 1075 "menuKind": 1, 1076 "menuRule": "both", 1077 "fileSupportType": [ 1078 ".rar", 1079 ".zip" 1080 ], 1081 "fileNotSupportType": [ 1082 "" 1083 ] 1084 }, 1085 { 1086 "menuKind": 2, 1087 "menuRule": "single" 1088 }, 1089 { 1090 "menuKind": 3 1091 } 1092 ] 1093 } 1094 ] 1095} 1096``` 1097 1098**响应行为** 1099 1100应用进行右键扩展菜单注册后,在文件管理器通过右键操作拉起菜单,该菜单中会有“更多”选项。单击“更多”选项后,会出现注册后的menuItem列表,单击任意一个选项后,文件管理器默认通过startAbility的方式拉起三方应用,除了指定三方应用的包名和ability名之外,want中的parameter中,也会传入如下标签: 1101 1102**表27** want中parameter标签说明 1103 1104| 参数名 | 值 | 类型 | 1105| -------- | -------- | -------- | 1106| menuHandler | 对应注册配置文件中menuHandler的值。 | 字符串 | 1107| uriList | 用户在具体文件上触发右键的uri值,如果空白处响应,此值为空,单个文件响应,数组长度1,多个文件响应则传入对应所有文件的uri值。 | 字符串数组 | 1108 1109## startWindow标签 1110 1111该标签指向一个profile文件资源,用于指定UIAbility组件启动页面的配置文件,在开发视图的resources/base/profile下面定义配置文件start_window.json,如果配置了该标签,startWindowIcon和startWindowBackground标签将不生效。<!--RP4--><br/>**说明:** <br/>从API version 20开始,支持使用该标签配置增强启动页。<!--RP4End--> 1112 1113**表28** startWindow标签配置说明 1114 1115| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 1116| -------- | -------- | -------- | -------- | 1117| startWindowType | 标识当前UIAbility组件是否隐藏启动页。<br/>当前仅支持在2in1设备或平板设备的自由多窗模式下使用。<br/>不同取值含义如下:<br/>\- "REQUIRED_SHOW":强制显示启动页。不受[Ability管理服务(即StartOptions中hideStartWindow标签)](../reference/apis-ability-kit/js-apis-app-ability-startOptions.md#startoptions)的影响。<br/>\- "REQUIRED_HIDE":强制隐藏启动页。不受[Ability管理服务(即StartOptions中hideStartWindow标签)](../reference/apis-ability-kit/js-apis-app-ability-startOptions.md#startoptions)的影响。<br/>\- "OPTIONAL_SHOW":可选显示,默认行为为显示启动页,如果[Ability管理服务(即StartOptions中hideStartWindow标签)](../reference/apis-ability-kit/js-apis-app-ability-startOptions.md#startoptions)设置隐藏启动页,则隐藏启动页。<br/>\- 如未配置该标签,默认取值为"REQUIRED_SHOW",即强制显示启动页。<br/>从API version 20开始支持该标签。 | 字符串 | 可缺省,缺省值为REQUIRED_SHOW。 | 1118| startWindowAppIcon | 标识当前UIAbility组件启动页面图标资源文件的索引,取值为长度不超过255字节的字符串。<br/><!--RP12-->从API version 20开始支持该标签。<!--RP12End-->| 字符串 | 可缺省,缺省值为空。 | 1119| startWindowIllustration | 标识当前UIAbility组件启动页面插画资源文件的索引,取值为长度不超过255字节的字符串。<br/><!--RP12-->从API version 20开始支持该标签。<!--RP12End--> | 字符串 | 可缺省,缺省值为空。 | 1120| startWindowBrandingImage | 标识当前UIAbility组件启动页面品牌标识资源文件的索引,取值为长度不超过255字节的字符串。<br/><!--RP12-->从API version 20开始支持该标签。<!--RP12End--> | 字符串 | 可缺省,缺省值为空。 | 1121| startWindowBackgroundColor | 标识当前UIAbility组件启动页面背景颜色资源文件的索引,取值为长度不超过255字节的字符串。<br/><!--RP12-->从API version 20开始支持该标签。<!--RP12End--> | 字符串 | 不可缺省。 | 1122| startWindowBackgroundImage | 标识当前UIAbility组件启动页面背景图片资源文件的索引,取值为长度不超过255字节的字符串。<br/><!--RP12-->从API version 20开始支持该标签。<!--RP12End--> | 字符串 | 可缺省,缺省值为空。 | 1123| startWindowBackgroundImageFit | 标识当前UIAbility组件启动页面背景图像适应方式,支持的取值如下:<br/>- Contain:按照宽高比进行缩小或放大,图片完全显示在显示边界内。<br/>- Cover:按照宽高比进行缩小或放大,图片两边都大于或等于显示边界。<br/>- Auto:自适应显示。<br/>- Fill:不按照宽高比进行放大或缩小,图片充满显示边界。<br/>- ScaleDown:按照宽高比显示,图片缩小或保持不变。<br/>- None:保持原有尺寸显示。<br/><!--RP12-->从API version 20开始支持该标签。<!--RP12End--> | 字符串 | 可缺省,缺省值为Cover。 | 1124<!--RP13--><!--RP13End--> 1125 1126resources/base/profile路径下的start_window.json资源文件示例如下: 1127<!--RP14--> 1128```json 1129{ 1130 "startWindowType": "REQUIRED_SHOW", 1131 "startWindowAppIcon": "$media:start_window_app_icon", 1132 "startWindowIllustration": "$media:start_window_illustration", 1133 "startWindowBrandingImage": "$media:start_window_branding_image", 1134 "startWindowBackgroundColor": "$color:start_window_back_ground_color", 1135 "startWindowBackgroundImage": "$media:start_window_back_ground_image", 1136 "startWindowBackgroundImageFit": "Cover" 1137} 1138``` 1139<!--RP14End--> 1140 1141## systemTheme标签 1142 1143该标签指向一个profile文件资源,用于指定当前应用使用的系统主题配置文件。从API version 20开始,支持该标签。 1144 1145systemTheme标签示例: 1146 1147```json 1148{ 1149 "module": { 1150 // ... 1151 "systemTheme": "$profile:theme_config", // 通过profile下的资源文件配置 1152 } 1153} 1154``` 1155 1156在开发视图的resources/base/profile下面定义配置文件theme_config.json,其中文件名“theme_config.json”可自定义为“theme_config”开头文件名,例如"theme_config"、"theme_config_1"。需要和systemTheme标签指定的信息对应。配置文件中标识当前应用使用的系统主题。 1157 1158 **表29** theme_config.json配置说明 1159 1160 1161| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 1162| -------- | -------- | -------- | -------- | 1163| systemTheme | 标识当前应用使用的系统主题,取值为引用系统主题名称的枚举。枚举支持的取值如下:<br/>- $ohos:theme:ohos_theme 系统默认的主题| 字符串 | 该标签不可缺省。 | 1164 1165resources/base/profile路径下的theme_config.json资源文件示例如下: 1166```json 1167{ 1168 "systemTheme": "$ohos:theme:ohos_theme" 1169} 1170``` 1171 1172<!--RP5--><!--RP5End--> 1173 1174<!--Del--> 1175## definePermissions标签 1176 1177该标签仅支持系统资源hap定义权限,不支持应用自定义权限。权限定义方式参见[系统资源权限定义](https://gitee.com/openharmony/utils_system_resources/blob/master/systemres/main/config.json)。 1178 1179**表30** definePermissions标签说明 1180 1181| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 1182| -------- | -------- | -------- | -------- | 1183| name | 标识权限的名称,该标签最大长度为255字节。 | 字符串 | 不可缺省。 | 1184| grantMode | 标识权限的授予方式,支持如下两种授予模式如下:<br/>- system_grant:安装后系统自动授予该权限。<br/>- user_grant:使用时动态申请,用户授权后才可使用。 | 字符串 | 可缺省,缺省值为system_grant。 | 1185| availableLevel | 标识权限限制类别,可选值如下:<br/>- system_core:系统核心权限。<br/>- system_basic:系统基础权限。<br/>- normal:普通权限。所有应用允许申请的权限。 | 字符串 | 可缺省,缺省值为normal。 | 1186| provisionEnable | 标识权限是否支持证书方式申请权限,包括高级别的权限。配置为true表示开发者可以通过证书方式申请权限。配置为false表示开发者不可以通过证书方式申请权限。 | 布尔值 | 可缺省,缺省值为true。 | 1187| distributedSceneEnabled | 标识权限是否支持分布式场景下使用该权限。配置为true表示开发者可以在分布式场景下使用该权限。配置为false表示开发者不可以在分布式场景下使用该权限。 | 布尔值 | 可缺省,缺省值为false。 | 1188| label | 标识权限的简短描述,配置为对描述内容的资源索引。 | 字符串 | 可缺省,缺省值为空。 | 1189| description | 标识权限的详细描述,可以是字符串,或者是对描述内容的资源索引。 | 字符串 | 可缺省,缺省值为空。 | 1190 1191definePermissions标签示例: 1192 1193```json 1194{ 1195 "module" : { 1196 "definePermissions": [ 1197 { 1198 "name": "ohos.permission.ACCESS_BLUETOOTH", 1199 "grantMode": "system_grant", 1200 "availableLevel": "system_core", 1201 "provisionEnable": true, 1202 "distributedSceneEnable": false, 1203 "label": "$string:EntryAbility_label" 1204 } 1205 ] 1206 } 1207} 1208``` 1209<!--DelEnd-->