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