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