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