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