1# module.json5配置文件 2 3 4先通过一个示例，整体认识一下module.json5配置文件。 5 6```json 7{ 8 "module": { 9 "name": "entry", 10 "type": "entry", 11 "description": "$string:module_desc", 12 "mainElement": "EntryAbility", 13 "deviceTypes": [ 14 "default", 15 "tablet" 16 ], 17 "deliveryWithInstall": true, 18 "installationFree": false, 19 "pages": "$profile:main_pages", 20 "virtualMachine": "ark", 21 "metadata": [ 22 { 23 "name": "string", 24 "value": "string", 25 "resource": "$profile:distributionFilter_config" 26 } 27 ], 28 "abilities": [ 29 { 30 "name": "EntryAbility", 31 "srcEntry": "./ets/entryability/EntryAbility.ts", 32 "description": "$string:EntryAbility_desc", 33 "icon": "$media:icon", 34 "label": "$string:EntryAbility_label", 35 "startWindowIcon": "$media:icon", 36 "startWindowBackground": "$color:start_window_background", 37 "exported": true, 38 "skills": [ 39 { 40 "entities": [ 41 "entity.system.home" 42 ], 43 "actions": [ 44 "ohos.want.action.home" 45 ] 46 } 47 ] 48 } 49 ], 50 "requestPermissions": [ 51 { 52 "name": "ohos.abilitydemo.permission.PROVIDER", 53 "reason": "$string:reason", 54 "usedScene": { 55 "abilities": [ 56 "FormAbility" 57 ], 58 "when": "inuse" 59 } 60 } 61 ] 62 } 63} 64``` 65 66 67module.json5配置文件包含以下标签。 68 69 70 **表1** **module.json5配置文件配置标签说明** 71 72| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 73| -------- | -------- | -------- | -------- | 74| name | 标识当前Module的名称，标签值采用字符串表示（最大长度31个字节），该名称在整个应用要唯一，不支持中文。 | 字符串 | 该标签不可缺省。 | 75| type | 标识当前Module的类型。类型有4种，分别：<br/>- entry：应用的主模块。<br/>- feature：应用的动态特性模块。<br/>- har：静态共享包模块。<br/>- shared：动态共享包模块。 | 字符串 | 该标签不可缺省。 | 76| srcEntry | 标识当前Module所对应的代码路径，标签值为字符串（最长为127字节）。 | 字符串 | 该标签可缺省，缺省值为空。 | 77| description | 标识当前Module的描述信息，标签值是字符串类型（最长255字节）或对描述内容的字符串资源索引。 | 字符串 | 该标签可缺省，缺省值为空。 | 78| process | 标识当前Module的进程名，标签值为字符串类型（最长为31个字节）。如果在HAP标签下配置了process，该应用的所有UIAbility、DataShareExtensionAbility、ServiceExtensionAbility都运行在该进程中。<br/>**说明：**<br/>- 仅支持系统应用配置，三方应用配置不生效。 | 字符串 | 可缺省，缺省为app.json5文件下app标签下的bundleName。 | 79| mainElement | 标识当前Module的入口UIAbility名称或者ExtensionAbility名称。标签最大字节长度为255。 | 字符串 | 该标签可缺省，缺省值为空。 | 80| [deviceTypes](#devicetypes标签) | 标识当前Module可以运行在哪类设备上，标签值采用字符串数组的表示。 | 字符串数组 | 该标签不可缺省，可以为空值。 | 81| deliveryWithInstall | 标识当前Module是否在用户主动安装的时候安装，表示该Module对应的HAP是否跟随应用一起安装。<br/>- true：主动安装时安装。<br/>- false：主动安装时不安装。 | 布尔值 | 该标签不可缺省。 | 82| installationFree | 标识当前Module是否支持免安装特性。<br/>- true：表示支持免安装特性，且符合免安装约束。<br/>- false：表示不支持免安装特性。<br/>**说明：**<br/>- 当应用的entry类型Module的该字段配置为true时，该应用的feature类型的该字段也需要配置为true。<br/>- 当应用的entry类型Module的该字段配置为false时，该应用的feature类型的该字段根据业务需求配置true或false。 | 布尔值 | 该标签不可缺省。 | 83| virtualMachine | 标识当前Module运行的目标虚拟机类型，供云端分发使用，如应用市场和分发中心。<br/>该标签值为字符串。如果目标虚拟机类型为ArkTS引擎，则其值为“ark+版本号”。 | 字符串 | 该标签由IDE构建HAP的时候自动插入。 | 84| [pages](#pages标签) | 标识当前Module的profile资源，用于列举每个页面信息。该标签最大长度为255个字节。 | 字符串 | 在有UIAbility的场景下，该标签不可缺省。 | 85| [metadata](#metadata标签) | 标识当前Module的自定义元信息，标签值为数组类型，只对当前Module、UIAbility、ExtensionAbility生效。 | 对象数组 | 该标签可缺省，缺省值为空。 | 86| [abilities](#abilities标签) | 标识当前Module中UIAbility的配置信息，标签值为数组类型，只对当前UIAbility生效。 | 对象 | 该标签可缺省，缺省值为空。 | 87| [extensionAbilities](#extensionabilities标签) | 标识当前Module中ExtensionAbility的配置信息，标签值为数组类型，只对当前ExtensionAbility生效。 | 对象 | 该标签可缺省，缺省值为空。 | 88| [requestPermissions](#requestpermissions标签) | 标识当前应用运行时需向系统申请的权限集合。 | 对象 | 该标签可缺省，缺省值为空。 | 89| [testRunner](#testrunner标签) | 标识当前Module用于支持对测试框架的配置。 | 对象 | 该标签可缺省，缺省值为空。 | 90| [atomicService](#atomicservice标签)| 标识当前应用是原子化服务时，有关原子化服务的相关配置。| 对象 | 该标签可缺省，缺省值为空。 | 91| [dependencies](#dependencies标签)| 标识当前模块运行时依赖的共享库列表。| 对象数组 | 该标签可缺省，缺省值为空。 | 92 93 94## deviceTypes标签 95 96 **表2** deviceType标签配置说明 97 98| 设备类型 | 枚举值 | 说明 | 99| -------- | -------- | -------- | 100| 平板 | tablet | - | 101| 智慧屏 | tv | - | 102| 智能手表 | wearable | 系统能力较丰富的手表，具备电话功能。 | 103| 车机 | car | - | 104| 默认设备 | default | 能够使用全部系统能力的OpenHarmony设备。 | 105 106deviceTypes示例： 107 108 109```json 110{ 111 "module": { 112 "name": "myHapName", 113 "type": "feature", 114 "deviceTypes" : [ 115 "tablet" 116 ] 117 } 118} 119``` 120 121 122## pages标签 123 124该标签是一个profile文件资源，用于指定描述页面信息的配置文件。 125 126 127```json 128{ 129 "module": { 130 // ... 131 "pages": "$profile:main_pages", // 通过profile下的资源文件配置 132 } 133} 134``` 135 136在开发视图的resources/base/profile下面定义配置文件**main_pages**.json，其中文件名(**main_pages**)可自定义，需要和前文中pages标签指定的信息对应，配置文件中列举了当前应用组件中的页面信息。 137 138 139```json 140{ 141 "src": [ 142 "pages/index/mainPage", 143 "pages/second/payment", 144 "pages/third/shopping_cart", 145 "pages/four/owner" 146 ] 147} 148``` 149 150 151## metadata标签 152 153该标签标识HAP的自定义元信息，标签值为数组类型，包含name，value，resource三个子标签。 154 155 **表3** **metadata标签说明** 156 157| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 158| -------- | -------- | -------- | -------- | 159| name | 该标签标识数据项的键名称，字符串类型（最大长度255字节）。 | 字符串 | 该标签可缺省，缺省值为空。 | 160| value | 该标签标识数据项的值，标签值为字符串（最大长度255字节）。 | 字符串 | 该标签可缺省，缺省值为空。 | 161| resource | 该标签标识定义用户自定义数据格式，标签值为标识该数据的资源的索引值。该标签最大字节长度为255字节。 | 字符串 | 该标签可缺省，缺省值为空。 | 162 163 164```json 165{ 166 "module": { 167 "metadata": [{ 168 "name": "module_metadata", 169 "value": "a test demo for module metadata", 170 "resource": "$profile:shortcuts_config", 171 }], 172 173 "abilities": [{ 174 "metadata": [{ 175 "name": "ability_metadata", 176 "value": "a test demo for ability", 177 "resource": "$profile:config_file" 178 }, 179 { 180 "name": "ability_metadata_2", 181 "value": "a string test", 182 "resource": "$profile:config_file" 183 }], 184 }], 185 186 "extensionAbilities": [{ 187 "metadata": [{ 188 "name": "extensionAbility_metadata", 189 "value": "a test for extensionAbility", 190 "resource": "$profile:config_file" 191 }, 192 { 193 "name": "extensionAbility_metadata_2", 194 "value": "a string test", 195 "resource": "$profile:config_file" 196 }], 197 }] 198 } 199} 200``` 201 202 203## abilities标签 204 205abilities标签描述UIAbility组件的配置信息，标签值为数组类型，该标签下的配置只对当前UIAbility生效。 206 207**OpenHarmony中不允许应用隐藏入口图标** 208 209OpenHarmony系统对无图标应用严格管控。如果HAP中没有配置入口图标，那么系统将应用app.json中的icon作为入口图标，并显示在桌面上。<br> 210用户点击该图标，将跳转到设置应用管理中对应的应用详情页面（图1）中。<br> 211如果应用想要隐藏入口图标，需要配置AllowAppDesktopIconHide应用特权，具体配置方式参考[应用特权配置指南](../../device-dev/subsystems/subsys-app-privilege-config-guide.md)。 212 213**场景说明：** 该功能能防止一些恶意应用，故意配置无入口图标，导致用户找不到软件所在的位置，无法操作卸载应用，在一定程度上保证用户的手机安全 214 215**入口图标的设置:** 需要在配置文件（module.json5）中abilities配置下设置icon，label以及skills,而且skills的配置下的必须同时包含“ohos.want.action.home” 和 “entity.system.home”: 216``` 217{ 218 "module":{ 219 220 ... 221 222 "abilities": [{ 223 "icon": "$media:icon", 224 "label": "Login", 225 "skills": [{ 226 "actions": ["ohos.want.action.home"], 227 "entities": ["entity.system.home"], 228 "uris": [] 229 }] 230 }], 231 ... 232 233 } 234} 235``` 236 237**入口图标及入口标签的显示规则** 238* HAP中包含UIAbility 239 * 配置文件（module.json5）中abilities配置中设置了入口图标 240 * 该应用没有隐藏图标的特权 241 * 显示桌面图标为该UIAbility配置的图标 242 * 显示桌面Label为该UIAbility配置的Label（如果没有配置Label，返回包名） 243 * 显示组件名为该UIAbility的组件名 244 * 用户点击该桌面图标，页面跳转到该UIAbility首页 245 * 该应用具有隐藏图标的特权 246 * 桌面查询时不返回应用信息，不会在桌面上显示对应的图标。 247 * 配置文件（module.json5）中abilities配置中未设置入口图标 248 * 该应用没有隐藏图标的特权 249 * 显示桌面图标为app配置下的图标（app.json中icon为必填项） 250 * 显示桌面Label为app配置下的label（app.json中label为必填项） 251 * 用户点击该桌面图标，页面跳转到该应用的详情页面（图1） 252 * 该应用具有隐藏图标的特权 253 * 桌面查询时不返回应用信息，不会在桌面上显示对应的图标。 254* HAP中不包含UIAbility 255 * 该应用没有隐藏图标的特权 256 * 显示桌面图标为app配置下的图标（app.json中icon为必填项） 257 * 显示桌面Label为app配置下的label（app.json中label为必填项） 258 * 用户点击该桌面图标，页面跳转到该应用的详情页面（图1） 259 * 该应用具有隐藏图标的特权 260 * 桌面查询时不返回应用信息，不会在桌面上显示对应的图标。<br><br> 261 262应用的详情页例图 263 264 265 266 267 **表4** **abilities标签说明** 268 269| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 270| -------- | -------- | -------- | -------- | 271| name | 标识当前UIAbility组件的名称，该名称在整个应用要唯一，标签值采用字符串表示（最大长度127个字节），不支持中文。 | 字符串 | 该标签不可缺省。 | 272| srcEntry | 该标签标识入口UIAbility的代码路径，标签值为字符串（最长为127字节）。 | 字符串 | 该标签不可缺省。 | 273| [launchType](../application-models/uiability-launch-type.md) | 标识当前UIAbility组件的启动模式，可选标签值：<br/>- multiton：标准实例模式，每次启动创建一个新的实例。<br/>- singleton：单实例模式，仅第一次启动创建新实例。<br/>- specified：指定实例模式，运行时由开发者决定是否创建新实例。 | 字符串 | 可缺省，该标签缺省为“singleton”。 | 274| description | 标识当前UIAbility组件的描述信息，标签值是字符串类型（最长255字节）或对描述内容的资源索引，要求采用资源索引方式，以支持多语言。 | 字符串 | 该标签可缺省，缺省值为空。 | 275| icon | 标识当前UIAbility组件的图标，标签值为图标资源文件的索引。 | 字符串 | 该标签可缺省，缺省值为空。<br/>如果UIAbility被配置为MainElement，该标签必须配置。 | 276| label | 标识当前UIAbility组件对用户显示的名称，标签值配置为该名称的资源索引以支持多语言。<br/>如果UIAbility被配置当前Module的mainElement时，该标签必须配置，且应用内唯一。 | 字符串 | 该标签不可缺省。 | 277| permissions | 标识当前UIAbility组件自定义的权限信息。当其他应用访问该UIAbility时，需要申请相应的权限信息。<br/>一个数组元素为一个权限名称。通常采用反向域名格式（最大255字节），取值为系统预定义的权限。 | 字符串数组 | 该标签可缺省，缺省值为空。 | 278| [metadata](#metadata标签) | 标识当前UIAbility组件的元信息。 | 对象数组 | 该标签可缺省，缺省值为空。 | 279| exported | 标识当前UIAbility组件是否可以被其他应用调用。<br/>- true：表示可以被其他应用调用。<br/>- false：表示不可以被其他应用调用。 | 布尔值 | 该标签可缺省，缺省值为false。 | 280| continuable | 标识当前UIAbility组件是否可以[迁移](../application-models/hop-cross-device-migration.md)。<br/>- true：表示可以被迁移。<br/>- false：表示不可以被迁移。 | 布尔值 | 该标签可缺省，缺省值为false。 | 281| [skills](#skills标签) | 标识当前UIAbility组件或ExtensionAbility组件能够接收的[Want](../application-models/want-overview.md)的特征集，为数组格式。<br/>配置规则：<br/>- 对于Entry类型的HAP，OpenHarmony应用可以配置多个具有入口能力的skills标签（即配置了ohos.want.action.home和entity.system.home）。<br/>- 对于Feature类型的HAP，只有OpenHarmony应用可以配置具有入口能力的skills标签，OpenHarmony服务不允许配置。 | 对象数组 | 该标签可缺省，缺省值为空。 | 282| backgroundModes | 标识当前UIAbility组件的长时任务集合。指定用于满足特定类型的长时任务。<br/>长时任务类型有如下：<br/>- dataTransfer：通过网络/对端设备进行数据下载、备份、分享、传输等业务。<br/>- audioPlayback：音频输出业务。<br/>- audioRecording：音频输入业务。<br/>- location：定位、导航业务。<br/>- bluetoothInteraction：蓝牙扫描、连接、传输业务（穿戴）。<br/>- multiDeviceConnection：多设备互联业务。<br/>- wifiInteraction：Wi-Fi扫描、连接、传输业务（克隆多屏）。<br/>- voip：音视频电话，VoIP业务。<br/>- taskKeeping：计算业务。 | 字符串数组 | 该标签可缺省，缺省值为空。 | 283| startWindowIcon | 标识当前UIAbility组件启动页面图标资源文件的索引。取值示例：$media:icon。<br/>该标签最大字节长度为255。 | 字符串 | 不可缺省。 | 284| startWindowBackground | 标识当前UIAbility组件启动页面背景颜色资源文件的索引。取值示例：$color:red。<br/>改标签最大字节长度为255。 | 字符串 | 不可缺省。 | 285| removeMissionAfterTerminate | 标识当前UIAbility组件销毁后是否从任务列表中移除任务，为布尔类型：<br/>- true表示销毁后移除任务。<br/>- false表示销毁后不移除任务。 | 布尔值 | 该标签可缺省，缺省值为false。 | 286| orientation | 标识当前UIAbility组件启动时的方向。该方向的取值范围包括：<br/>- unspecified：未指定方向，由系统自动判断显示方向。<br/>- landscape：横屏。<br/>- portrait：竖屏。<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：传感器开关关闭，方向锁定。 | 字符串 | 该标签可缺省，缺省值为unspecified。 | 287| supportWindowMode | 标识当前UIAbility组件所支持的窗口模式，包含：<br/>- fullscreen：全屏模式。<br/>- split：分屏模式。<br/>- floating：悬浮窗模式。 | 字符串数组 | 该标签可缺省，缺省值为<br/>["fullscreen", "split", "floating"]。 | 288| priority | 标识当前UIAbility组件的优先级，仅支持系统应用配置，三方应用配置不生效。[隐式查询](../application-models/explicit-implicit-want-mappings.md)时，优先级越高，UIAbility在返回列表越靠前。该标签取值为integer类型，取值范围0-10。数值越大，优先级越高。 | 数值 | 该标签可缺省，缺省值为0。 | 289| maxWindowRatio | 标识当前UIAbility组件支持的最大的宽高比。该标签最小取值为0。 | 数值 | 该标签可缺省，缺省值为平台支持的最大的宽高比。 | 290| minWindowRatio | 标识当前UIAbility组件支持的最小的宽高比。该标签最小取值为0。 | 数值 | 该标签可缺省，缺省值为平台支持的最小的宽高比。 | 291| maxWindowWidth | 标识当前UIAbility组件支持的最大的窗口宽度，宽度单位为vp。该标签最小取值为0，但不能小于minWindowWidth；最大取值不能超过平台支持的最大窗口宽度。窗口尺寸可以参考：[约束与限制](../windowmanager/window-overview.md#约束与限制)。 | 数值 | 该标签可缺省，缺省值为平台支持的最大的窗口宽度。 | 292| minWindowWidth | 标识当前UIAbility组件支持的最小的窗口宽度, 宽度单位为vp。该标签最小取值为0，但不能小于平台支持的最小窗口宽度；最大取值不能大于maxWindowWidth。窗口尺寸可以参考：[约束与限制](../windowmanager/window-overview.md#约束与限制)。 | 数值 | 该标签可缺省，缺省值为平台支持的最小的窗口宽度。 | 293| maxWindowHeight | 标识当前UIAbility组件支持的最大的窗口高度, 高度单位为vp。该标签最小取值为0，但不能小于minWindowHeight；最大取值不能超过平台支持的最大窗口高度。 窗口尺寸可以参考：[约束与限制](../windowmanager/window-overview.md#约束与限制)。| 数值 | 该标签可缺省，缺省值为平台支持的最大的窗口高度。 | 294| minWindowHeight | 标识当前UIAbility组件支持的最小的窗口高度, 高度单位为vp。该标签最小取值为0，但不能小于平台支持的最小窗口高度；最大取值不能大于maxWindowHeight。窗口尺寸可以参考：[约束与限制](../windowmanager/window-overview.md#约束与限制)。| 数值 | 该标签可缺省，缺省值为平台支持的最小的窗口高度。 | 295| excludeFromMissions | 标识当前UIAbility组件是否在最近任务列表中显示。<br/>- true：表示不在任务列表中显示。<br/>- false：表示在任务列表中显示。<br/>**说明：**<br/>- 仅支持系统应用配置，三方应用配置不生效。 | 布尔值 | 该标签可缺省，缺省值为false。 | 296 297abilities示例： 298 299 300```json 301{ 302 "abilities": [{ 303 "name": "EntryAbility", 304 "srcEntry": "./ets/entryability/EntryAbility.ts", 305 "launchType":"singleton", 306 "description": "$string:description_main_ability", 307 "icon": "$media:icon", 308 "label": "Login", 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 "audioPlayback", 321 "audioRecording", 322 "location", 323 "bluetoothInteraction", 324 "multiDeviceConnection", 325 "wifiInteraction", 326 "voip", 327 "taskKeeping" 328 ], 329 "startWindowIcon": "$media:icon", 330 "startWindowBackground": "$color:red", 331 "removeMissionAfterTerminate": true, 332 "orientation": " ", 333 "supportWindowMode": ["fullscreen", "split", "floating"], 334 "maxWindowRatio": 3.5, 335 "minWindowRatio": 0.5, 336 "maxWindowWidth": 2560, 337 "minWindowWidth": 1400, 338 "maxWindowHeight": 300, 339 "minWindowHeight": 200, 340 "excludeFromMissions": false 341 }] 342} 343``` 344 345 346## skills标签 347 348该标签标识UIAbility组件或者ExtensionAbility组件能够接收的[Want](../application-models/want-overview.md)的特征。 349 350 **表5** **skills标签说明** 351 352| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 353| -------- | -------- | -------- | -------- | 354| actions | 标识能够接收的Want的[Action值的集合](../application-models/actions-entities.md)，取值通常为系统预定义的action值，也允许自定义。 | 字符串数组 | 可缺省，缺省值为空。 | 355| entities | 标识能够接收Want的[Entity值的集合](../application-models/actions-entities.md)。 | 字符串数组 | 可缺省，缺省值为空。 | 356|uris | 标识与Want中URI（Uniform Resource Identifier）相匹配的集合。 | 对象数组 | 可缺省，缺省值为空。 | 357 358 **表6** **uris对象内部结构说明** 359 360| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 361| -------- | -------- | -------- | -------- | 362| scheme | 标识URI的协议名部分，常见的有http、https、file、ftp等。 | 字符串 | uris中仅配置type时可以缺省，缺省值为空，否则不可缺省。 | 363| host | 标识URI的主机地址部分，该字段要在schema存在时才有意义。常见的方式：<br/>- 域名方式，如example.com。<br/>- IP地址方式，如10.10.10.1。 | 字符串 | 可缺省，缺省值为空。 | 364| port | 标识URI的端口部分。如http默认端口为80，https默认端口是443，ftp默认端口是21。该字段要在schema和host都存在时才有意义。 | 字符串 | 可缺省，缺省值为空。 | 365| path \| pathStartWith \| pathRegex | 标识URI的路径部分，path、pathStartWith和pathRegex配置时三选一。path标识URI与want中的路径部分全匹配，pathStartWith标识URI与want中的路径部分允许前缀匹配，pathRegex标识URI与want中的路径部分允许正则匹配。该字段要在schema和host都存在时才有意义。 | 字符串 | 可缺省，缺省值为空。 | 366| type | 标识与Want相匹配的数据类型，使用MIME（Multipurpose Internet Mail Extensions）类型规范。可与schema同时配置，也可以单独配置。 | 字符串 | 可缺省，缺省值为空。 | 367 368skills示例： 369 370 371```json 372{ 373 "abilities": [ 374 { 375 "skills": [ 376 { 377 "actions": [ 378 "ohos.want.action.home" 379 ], 380 "entities": [ 381 "entity.system.home" 382 ], 383 "uris": [ 384 { 385 "scheme":"http", 386 "host":"example.com", 387 "port":"80", 388 "path":"path", 389 "type": "text/*" 390 } 391 ] 392 } 393 ] 394 } 395 ] 396} 397``` 398 399 400## extensionAbilities标签 401 402描述extensionAbilities的配置信息，标签值为数组类型，该标签下的配置只对当前extensionAbilities生效。 403 404 **表7** **extensionAbilities标签说明** 405 406| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 407| -------- | -------- | -------- | -------- | 408| name | 标识当前ExtensionAbility组件的名称，标签值最大长度为127个字节，该名称在整个应用要唯一。 | 字符串 | 该标签不可缺省。 | 409| srcEntry | 标识当前ExtensionAbility组件所对应的代码路径，标签值最大长度为127字节。 | 字符串 | 该标签不可缺省。 | 410| description | 标识当前ExtensionAbility组件的描述，标签值最大长度为255字节，标签也可以是描述内容的资源索引，用于支持多语言。 | 字符串 | 该标签可缺省，缺省值为空。 | 411| icon | 标识当前ExtensionAbility组件的图标，标签值为资源文件的索引。如果ExtensionAbility组件被配置为MainElement，该标签必须配置。 | 字符串 | 该标签可缺省，缺省值为空。 | 412| label | 标识当前ExtensionAbility组件对用户显示的名称，标签值配置为该名称的资源索引以支持多语言。<br/>**说明：**<br/>- 如果ExtensionAbility被配置当前Module的mainElement时，该标签必须配置，且应用内唯一。 | 字符串 | 该标签不可缺省。 | 413| type | 标识当前ExtensionAbility组件的类型，取值为：<br/>- form：卡片的ExtensionAbility。<br/>- workScheduler：延时任务的ExtensionAbility。<br/>- inputMethod：输入法的ExtensionAbility。<br/>- service：后台运行的service组件。<br/>- accessibility：辅助能力的ExtensionAbility。<br/>- dataShare：数据共享的ExtensionAbility。<br/>- fileShare：文件共享的ExtensionAbility。<br/>- staticSubscriber：静态广播的ExtensionAbility。<br/>- wallpaper：壁纸的ExtensionAbility。<br/>- backup：数据备份的ExtensionAbility。<br/>- window：该ExtensionAbility会在启动过程中创建一个window，为开发者提供界面开发。开发者开发出来的界面将通过abilityComponent控件组合到其他应用的窗口中。<br/>- thumbnail：获取文件缩略图的ExtensionAbility，开发者可以对自定义文件类型的文件提供缩略。<br/>- preview：该ExtensionAbility会将文件解析后在一个窗口中显示，开发者可以通过将此窗口组合到其他应用窗口中。<br/>**说明：**<br/>- 其中service和dataShare类型，仅支持系统应用配置，三方应用配置不生效。 | 字符串 | 该标签不可缺省。 | 414| permissions | 标识当前ExtensionAbility组件自定义的权限信息。当其他应用访问该ExtensionAbility时，需要申请相应的权限信息。<br/>一个数组元素为一个权限名称。通常采用反向域名格式（最大255字节），可以是系统预定义的权限，也可以是该应用自定义的权限。如果是后者，需与defPermissions标签中定义的某个权限的name标签值一致。 | 字符串数组 | 该标签可缺省，缺省值为空。 | 415| uri | 标识当前ExtensionAbility组件提供的数据URI，为字符数组类型（最大长度255），用反向域名的格式表示。<br/>**说明：**<br/>- 该标签在type为dataShare类型的ExtensionAbility时，不可缺省。 | 字符串 | 该标签可缺省，缺省值为空。 | 416|skills | 标识当前ExtensionAbility组件能够接收的[Want](../application-models/want-overview.md)的特征集，为数组格式。<br/>配置规则：entry包可以配置多个具有入口能力的skills标签（配置了ohos.want.action.home和entity.system.home）的ExtensionAbility，其中第一个配置了skills标签的ExtensionAbility中的label和icon作为OpenHarmony服务或应用的label和icon。<br/>**说明：**<br/>- OpenHarmony服务的Feature包不能配置具有入口能力的skills标签。<br/>- OpenHarmony应用的Feature包可以配置具有入口能力的skills标签。 | 数组 | 该标签可缺省，缺省值为空。 | 417| [metadata](#metadata标签) | 标识当前ExtensionAbility组件的元信息。 | 对象 | 该标签可缺省，缺省值为空。 | 418| exported | 标识当前ExtensionAbility组件是否可以被其他应用调用，为布尔类型。<br/>- true：表示可以被其他应用调用。<br/>- false：表示不可以被其他应用调用。 | 布尔值 | 该标签可缺省，缺省值为false。 | 419 420extensionAbilities示例： 421 422 423```json 424{ 425 "extensionAbilities": [ 426 { 427 "name": "FormName", 428 "srcEntry": "./form/MyForm.ts", 429 "icon": "$media:icon", 430 "label" : "$string:extension_name", 431 "description": "$string:form_description", 432 "type": "form", 433 "permissions": ["ohos.abilitydemo.permission.PROVIDER"], 434 "readPermission": "", 435 "writePermission": "", 436 "exported": true, 437 "uri":"scheme://authority/path/query", 438 "skills": [{ 439 "actions": [], 440 "entities": [], 441 "uris": [] 442 }], 443 "metadata": [ 444 { 445 "name": "ohos.extension.form", 446 "resource": "$profile:form_config", 447 } 448 ] 449 } 450 ] 451} 452``` 453 454 455## requestPermissions标签 456 457该标签标识应用运行时需向系统申请的权限集合。 458 459> **说明：** 460> 461> - 在requestPermissions标签中配置的权限项将在应用级别生效，即该权限适用于整个应用程序。 462> - 如果应用需要订阅自己发布的事件，而且应用在extensionAbilities标签中的permissions字段中设置了访问该应用所需要的权限，那么应用也需要在requestPermissions标签中注册相关权限才能收到该事件。 463 464 **表8** **requestPermissions标签说明** 465 466| 属性 | 含义 | 类型 | 取值范围 | 默认值 | 467| -------- | -------- | -------- | -------- | -------- | 468| name | 必须，填写需要使用的权限名称。 | 字符串 | 自定义。 | 无。 | 469| reason | 可选，当申请的权限为user_grant权限时此字段必填，用于描述申请权限的原因。<br/>**说明：**<br/>- 当申请的权限为user_grant权限时，如果未填写该字段则不允许在应用市场上架，并且需要进行多语种适配。 | 字符串 | 使用string类资源引用。格式为$string: \*\*\*。 | 空。 | 470| usedScene | 可选，当申请的权限为user_grant权限时此字段必填。描述权限使用的场景由abilities和when组成。其中abilities可以配置为多个UIAbility组件，when表示调用时机。<br/>**说明：**<br/>- 默认为可选，当申请的权限为user_grant权限时，abilities标签必填，when标签可选。 | abilities：UIAbility或者ExtensionAbility名称的字符串数组<br/>when：字符串 | abilities：UIAbility或者ExtensionAbility组件的名称。<br/>when：inuse（使用时）、always（始终）。 | abilities：空。<br/>when：空。 | 471 472requestPermissions示例： 473 474 475```json 476{ 477 "module" : { 478 "requestPermissions": [ 479 { 480 "name": "ohos.abilitydemo.permission.PROVIDER", 481 "reason": "$string:reason", 482 "usedScene": { 483 "abilities": [ 484 "EntryFormAbility" 485 ], 486 "when": "inuse" 487 } 488 } 489 ] 490 } 491} 492``` 493 494 495## shortcuts标签 496 497shortcuts标识应用的快捷方式信息。标签值为数组，最多可以配置四个快捷方式。其包含四个子标签shortcutId、label、icon、wants。 498 499metadata中指定shortcut信息，其中： 500 501- name：指定shortcuts的名称。使用ohos.ability.shortcuts作为shortcuts信息的标识。 502 503- resource：指定shortcuts信息的资源位置。 504 505| 属性 | 含义 | 类型 | 默认值 | 506| -------- | -------- | -------- | -------- | 507| shortcutId | 标识快捷方式的ID。字符串的最大长度为63字节。 | 字符串 | 该标签不可缺省。 | 508| label | 标识快捷方式的标签信息，即快捷方式对外显示的文字描述信息。取值可以是描述性内容，也可以是标识label的资源索引。字符串最大长度为255字节。 | 字符串 | 该标签可缺省，缺省值为空。 | 509| icon | 标识快捷方式的图标，标签值为资源文件的索引。 | 字符串 | 该标签可缺省，缺省值为空。 | 510| [wants](../application-models/want-overview.md) | 标识快捷方式内定义的目标wants信息集合，每个wants可配置bundleName和abilityName两个子标签。<br/>bundleName：表示快捷方式的目标Bundle名称，字符串类型。<br/>abilityName：表示快捷方式的目标组件名，字符串类型。 | 对象 | 该标签可缺省，缺省为空。 | 511 512 5131. 在/resource/base/profile/目录下配置shortcuts_config.json配置文件。 514 515 ```json 516 { 517 "shortcuts": [ 518 { 519 "shortcutId": "id_test1", 520 "label": "$string:shortcut", 521 "icon": "$media:aa_icon", 522 "wants": [ 523 { 524 "bundleName": "com.ohos.hello", 525 "abilityName": "EntryAbility" 526 } 527 ] 528 } 529 ] 530 } 531 ``` 532 5332. 在module.json5配置文件的abilities标签中，针对需要添加快捷方式的UIAbility进行配置metadata标签，使shortcut配置文件对该UIAbility生效。 534 535 ```json 536 { 537 "module": { 538 // ... 539 "abilities": [ 540 { 541 "name": "EntryAbility", 542 "srcEntry": "./ets/entryability/EntryAbility.ts", 543 // ... 544 "skills": [ 545 { 546 "entities": [ 547 "entity.system.home" 548 ], 549 "actions": [ 550 "ohos.want.action.home" 551 ] 552 } 553 ], 554 "metadata": [ 555 { 556 "name": "ohos.ability.shortcuts", 557 "resource": "$profile:shortcuts_config" 558 } 559 ] 560 } 561 ] 562 } 563 } 564 ``` 565 566 567## distributionFilter标签 568 569该标签下的子标签均为可选字段，在应用市场云端分发时做精准匹配使用，distributionFilter标签用于定义HAP对应的细分设备规格的分发策略，以便在应用市场进行云端分发应用包时做精准匹配。该标签可配置的分发策略维度包括API Version、屏幕形状、屏幕尺寸、屏幕分辨率，设备的国家与地区码。在进行分发时，通过deviceType与这五个属性的匹配关系，唯一确定一个用于分发到设备的HAP。该标签需要配置在/resource/profile资源目录下。 570 571 **表9** **distributionFilter标签标签配置说明** 572 573| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 574| -------- | -------- | -------- | -------- | 575| screenShape | 标识屏幕形状的支持策略。 | 对象数组 | 该标签可缺省，缺省值为空。 | 576| screenWindow | 标识应用运行时窗口的分辨率支持策略。该字段仅支持对轻量级智能穿戴设备进行配置。 | 对象数组 | 该标签可缺省，缺省值为空。 | 577| screenDensity | 标识屏幕的像素密度（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]的设备。 | 对象数组 | 该标签可缺省，缺省值为空。 | 578| countryCode | 表示应用需要分发的国家地区码，具体值以ISO-3166-1标准为准。支持多个国家和地区枚举定义。 | 对象数组 | 该标签可缺省，缺省值为空。 | 579 580 581 **表10** **screenShape对象的内部结构** 582 583| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 584| -------- | -------- | -------- | -------- | 585| policy | 标识该子属性取值规则。配置为“exclude”或“include”。<br/>- exclude：表示需要排除的value属性。<br/>- include：表示需要包含的value属性。 | 字符串 | 该标签不可缺省。 | 586| value | 支持的取值为circle（圆形）、rect（矩形）。场景示例：针对智能穿戴设备，可为圆形表盘和矩形表盘分别提供不同的HAP。 | 字符串数组 | 该标签不可缺省。 | 587 588 **表11** **screenWindow对象的内部结构说明** 589 590| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 591| -------- | -------- | -------- | -------- | 592| policy | 标识该子属性取值规则。配置为“exclude”或“include”。<br/>- exclude：表示该字段取值不包含value枚举值匹配规则的匹配该属性。<br/>- include：表示该字段取值满足value枚举值匹配规则的匹配该属性。 | 字符串 | 该标签不可缺省。 | 593| value | 单个字符串的取值格式为“宽 \* 高”，取值为整数像素值，例如“454 \* 454”。 | 字符串数组 | 该标签不可缺省。 | 594 595 **表12** **screenDensity对象的内部结构说明** 596 597| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 598| -------- | -------- | -------- | -------- | 599| policy | 标识该子属性取值规则。配置为“exclude”或“include”。<br/>- exclude：表示需要排除的value属性。<br/>- include：表示需要包含的value属性。 | 字符串 | 该标签不可缺省。 | 600| value | 该标签标识屏幕的像素密度（dpi :Dot Per Inch）。 | 字符串数组 | 该标签不可缺省。 | 601 602 **表13** **countryCode对象的内部结构说明** 603 604| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 605| -------- | -------- | -------- | -------- | 606| policy | 标识该子属性取值规则。配置为“exclude”或“include”。<br/>- exclude：表示需要排除的value属性。<br/>- include：表示需要包含的value属性。 | 字符串 | 该标签不可缺省。 | 607| value | 标识应用需要分发的国家地区码。 | 字符串数组 | 该标签不可缺省。 | 608 609在开发视图的resources/base/profile下面定义配置文件distro_filter_config.json，文件名可以自定义。 610 611 612```json 613{ 614 "distributionFilter": { 615 "screenShape": { 616 "policy": "include", 617 "value": [ 618 "circle", 619 "rect" 620 ] 621 }, 622 "screenWindow": { 623 "policy": "include", 624 "value": [ 625 "454*454", 626 "466*466" 627 ] 628 }, 629 "screenDensity": { 630 "policy": "exclude", 631 "value": [ 632 "ldpi", 633 "xldpi" 634 ] 635 }, 636 "countryCode": { // 支持中国和香港地区分发 637 "policy": "include", 638 "value": [ 639 "CN", 640 "HK" 641 ] 642 } 643 } 644} 645``` 646 647在module.json5配置文件的module标签中定义metadata信息。 648 649 650```json 651{ 652 "module": { 653 // ... 654 "metadata": [ 655 { 656 "name": "ohos.module.distro", 657 "resource": "$profile:distro_filter_config", 658 } 659 ] 660 } 661} 662``` 663 664 665## testRunner标签 666 667此标签用于支持对测试框架的配置。 668 669 **表14** **testRunner标签说明** 670 671| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 672| -------- | -------- | -------- | -------- | 673| name | 标识测试框架对象名称。该标签最大字节长度为255个字节。 | 字符串 | 不可缺省。 | 674| srcPath | 标识测试框架代码路径。该标签最大字节长度为255个字节。 | 字符串 | 不可缺省。 | 675 676testRunner标签示例： 677 678 679```json 680{ 681 "module": { 682 // ... 683 "testRunner": { 684 "name": "myTestRunnerName", 685 "srcPath": "etc/test/TestRunner.ts" 686 } 687 } 688} 689``` 690 691## atomicService标签 692 693此标签用于支持对原子化服务的配置。此标签仅在app.json中bundleType指定为atomicService时使能。 694 695**表14** **atomicService标签说明** 696 697| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 698| -------- | -------- | -------- | -------- | 699| preloads | 标识原子化服务中预加载列表 | 对象数组 | 可缺省，缺省值为空。 | 700 701atomicService标签示例： 702 703```json 704{ 705 "module": { 706 "atomicService": { 707 "preloads":[ 708 { 709 "moduleName":"feature" 710 } 711 ] 712 } 713 } 714} 715``` 716 717## preloads标签 718 719此标签标识原子化服务中预加载列表。 720 721**表14** **preloads标签说明** 722 723| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 724| -------- | -------- | -------- | -------- | 725| moduleName | 标识原子化服务中，当前模块被加载时，需预加载的模块名 | 字符串 | 不可缺省。 | 726 727preloads标签示例： 728 729```json 730{ 731 "module": { 732 "atomicService": { 733 "preloads":[ 734 { 735 "moduleName":"feature" 736 } 737 ] 738 } 739 } 740} 741``` 742 743## dependencies标签 744 745此标签标识模块运行时依赖的共享库列表。 746 747**表14** **dependencies标签说明** 748 749| 属性名称 | 含义 | 数据类型 | 是否可缺省 | 750| -------- | -------- | -------- | -------- | 751| moduleName | 标识当前模块依赖的共享库模块名 | 字符串 | 不可缺省。 | 752 753dependencies标签示例： 754 755```json 756{ 757 "module": { 758 "dependencies": [ 759 { 760 "moduleName": "library" 761 } 762 ] 763 } 764} 765``` 766
