HarmonyOS应用开发:module.json5配置文件规范

9 篇文章 0 订阅
9 篇文章 0 订阅

配置文件示例

先通过一个示例,整体认识一下module.json5配置文件。

{
  "module": {
    "name": "entry",
    "type": "entry",
    "description": "$string:module_desc",
    "mainElement": "EntryAbility",
    "deviceTypes": [
      "default",
      "tablet"
    ],
    "deliveryWithInstall": true,
    "installationFree": false,
    "pages": "$profile:main_pages",
    "virtualMachine": "ark",
    "appStartup": "$profile:app_startup_config",
    "metadata": [
      {
        "name": "string",
        "value": "string",
        "resource": "$profile:distributionFilter_config"
      }
    ],
    "abilities": [
      {
        "name": "EntryAbility",
        "srcEntry": "./ets/entryability/EntryAbility.ets",
        "description": "$string:EntryAbility_desc",
        "icon": "$media:icon",
        "label": "$string:EntryAbility_label",
        "startWindowIcon": "$media:icon",
        "startWindowBackground": "$color:start_window_background",
        "exported": true,
        "skills": [
          {
            "entities": [
              "entity.system.home"
            ],
            "actions": [
              "ohos.want.action.home"
            ]
          }
        ],
        "continueType": [
          "continueType1"
        ]
      }
    ],
    "definePermissions": [
      {
        "name": "ohos.abilitydemo.permission.PROVIDER",
        "grantMode": "system_grant",
        "availableLevel": "system_core",
        "provisionEnable": true,
        "distributedSceneEnable": false,
        "label": "$string:EntryAbility_label"
      }
    ],
    "requestPermissions": [
      {
        "name": "ohos.abilitydemo.permission.PROVIDER",
        "reason": "$string:reason",
        "usedScene": {
          "abilities": [
            "FormAbility"
          ],
          "when": "inuse"
        }
      }
    ],
    "targetModuleName": "feature",
    "targetPriority": 50,
    "querySchemes": [
      "app1Scheme",
      "app2Scheme"
    ],
    "routerMap": "$profile:router_map",
    "appEnvironments": [
      {
        "name": "name1",
        "value": "value1"
      }
    ],
    "fileContextMenu": "$profile:menu"
  }
}
json

配置文件标签

module.json5配置文件包含以下标签。

表1 module.json5配置文件标签说明

属性名称含义数据类型是否可缺省
name标识当前Module的名称,确保该名称在整个应用中唯一。取值为长度不超过31字节的字符串,不支持中文。
应用升级时允许修改该名称,但需要应用适配Module相关数据目录的迁移,详见文件管理接口
字符串该标签不可缺省。
type标识当前Module的类型。支持的取值如下:
- entry:应用的主模块。
- feature:应用的动态特性模块。
- har:静态共享包模块。
- shared:动态共享包模块。
字符串该标签不可缺省。
srcEntry标识当前Module所对应的代码路径,取值为长度不超过127字节的字符串。字符串该标签可缺省,缺省值为空。
description标识当前Module的描述信息,取值为长度不超过255字节的字符串,可以采用字符串资源索引格式。字符串该标签可缺省,缺省值为空。
process标识当前Module的进程名,取值为长度不超过31字节的字符串。如果在HAP标签下配置了process,则该应用的所有UIAbility、DataShareExtensionAbility、ServiceExtensionAbility都运行在该进程中。
说明:
仅支持系统应用配置,三方应用配置不生效。
字符串该标签可缺省,缺省为app.json5文件下app标签下的bundleName。
mainElement标识当前Module的入口UIAbility名称或者ExtensionAbility名称,取值为长度不超过255字节的字符串。字符串该标签可缺省,缺省值为空。
deviceTypes标识当前Module可以运行在哪类设备上。字符串数组该标签不可缺省。
deliveryWithInstall标识当前Module是否在用户主动安装的时候安装,即该Module对应的HAP是否跟随应用一起安装。
- true:主动安装时安装。
- false:主动安装时不安装。
布尔值该标签不可缺省。
installationFree标识当前Module是否支持免安装特性。
- true:表示支持免安装特性,且符合免安装约束。
- false:表示不支持免安装特性。
说明:
bundleType为原子化服务时,该字段需要配置为true。反之,该字段需要配置为false。
布尔值该标签不可缺省。
virtualMachine标识当前Module运行的目标虚拟机类型,供云端分发使用,如应用市场和分发中心。如果目标虚拟机类型为ArkTS引擎,则其值为“ark+版本号”。字符串该标签由IDE构建HAP的时候自动插入。
pages标识当前Module的profile资源,用于列举每个页面信息,取值为长度不超过255字节的字符串。字符串在有UIAbility的场景下,该标签不可缺省。
metadata标识当前Module的自定义元信息,可通过资源引用的方式配置distributionFiltershortcuts等信息。只对当前Module、UIAbility、ExtensionAbility生效。对象数组该标签可缺省,缺省值为空。
abilities标识当前Module中UIAbility的配置信息,只对当前UIAbility生效。对象数组该标签可缺省,缺省值为空。
extensionAbilities标识当前Module中ExtensionAbility的配置信息,只对当前ExtensionAbility生效。对象数组该标签可缺省,缺省值为空。
definePermissions标识系统资源hap定义的权限,不支持应用自定义权限。对象数组该标签可缺省,缺省值为空。
requestPermissions标识当前应用运行时需向系统申请的权限集合。对象数组该标签可缺省,缺省值为空。
testRunner标识用于测试当前Module的测试框架的配置。对象该标签可缺省,缺省值为空。
atomicService标识当前应用是原子化服务时,有关原子化服务的相关配置。对象该标签可缺省,缺省值为空。
dependencies标识当前模块运行时依赖的共享库列表。对象数组该标签可缺省,缺省值为空。
targetModuleName标识当前包所指定的目标module,确保该名称在整个应用中唯一。取值为长度不超过31字节的字符串,不支持中文。配置该字段的Module具有overlay特性。仅在动态共享包(HSP)中适用。字符串该标签可缺省,缺省值为空。
targetPriority标识当前Module的优先级,取值范围为1~100。配置targetModuleName字段之后,才需要配置该字段。仅在动态共享包(HSP)中适用。整型数值该标签可缺省,缺省值为1。
proxyData标识当前Module提供的数据代理列表。对象数组该标签可缺省,缺省值为空。
isolationMode标识当前Module的多进程配置项。支持的取值如下:
- nonisolationFirst:优先在非独立进程中运行。
- isolationFirst:优先在独立进程中运行。
- isolationOnly:只在独立进程中运行。
- nonisolationOnly:只在非独立进程中运行。
字符串该标签可缺省,缺省值为nonisolationFirst。
generateBuildHash标识当前HAP/HSP是否由打包工具生成哈希值。当配置为true时,如果系统OTA升级时应用versionCode保持不变,可根据哈希值判断应用是否需要升级。
该字段仅在app.json5文件中的generateBuildHash字段为false时使能。
说明:
该字段仅对预置应用生效。
布尔值该标签可缺省,缺省值为false。
compressNativeLibs标识libs库是否以压缩存储的方式打包到HAP。
- true:libs库以压缩方式存储。
- false:libs库以不压缩方式存储。
布尔值该标签可缺省,缺省值为false。
libIsolation用于区分同应用不同HAP下的.so文件,以防止.so冲突。
- true:当前HAP的.so文件会储存在libs目录中以Module名命名的路径下。
- false:当前HAP的.so文件会直接储存在libs目录中。
布尔值该标签可缺省,缺省值为false。
fileContextMenu标识当前HAP的右键菜单配置项。取值为长度不超过255字节的字符串。字符串该标签可缺省,缺省值为空。
querySchemes标识允许当前应用进行跳转查询的URL schemes,只允许entry类型模块配置,最多50个,每个字符串取值不超过128字节。字符串数组该标签可缺省,缺省值为空。
routerMap标识当前模块配置的路由表路径。取值为长度不超过255字节的字符串。字符串该标签可缺省,缺省值为空。
appEnvironments标识当前模块配置的应用环境变量,只允许entry和feature模块配置。对象数组该标签可缺省,缺省值为空。
appStartup标识当前Module启动框架配置路径,仅在Entry中生效。字符串该标签可缺省,缺省值为空。

deviceTypes标签

表2 deviceTypes标签说明

设备类型枚举值说明
平板tablet-
智慧屏tv-
智能手表wearable系统能力较丰富的手表,具备电话功能。
车机car-
2in12in1融合了屏幕触控和键鼠操作的二合一设备。
默认设备default能够使用全部系统能力的设备。

deviceTypes示例:

{
  "module": {
    "name": "myHapName",
    "type": "feature",
    "deviceTypes" : [
       "tablet"
    ]
  }
}
json

pages标签

该标签是一个profile文件资源,用于指定描述页面信息的配置文件。

{
  "module": {
    // ...
    "pages": "$profile:main_pages", // 通过profile下的资源文件配置
  }
}
json

在开发视图的resources/base/profile下面定义配置文件main_pages.json,其中文件名"main_pages"可自定义,需要和pages标签指定的信息对应。配置文件中列举了当前应用组件中的页面信息,包含页面的路由信息和显示窗口相关的配置。

表3 pages标签说明

属性名称含义数据类型是否可缺省
src标识当前Module中所有页面的路由信息,包括页面路径和页面名称。其中,页面路径是以当前Module的src/main/ets为基准。该标签取值为一个字符串数组,其中每个元素表示一个页面。字符串数组该标签不可缺省。
window标识用于定义与显示窗口相关的配置。对象该标签可缺省,缺省值为空。

表4 window标签说明

属性名称含义数据类型是否可缺省
designWidth标识页面设计基准宽度。以此为基准,根据实际设备宽度来缩放元素大小。数值可缺省,缺省值为720px。
autoDesignWidth标识页面设计基准宽度是否自动计算。当配置为true时,designWidth将会被忽略,设计基准宽度由设备宽度与屏幕密度计算得出。布尔值可缺省,缺省值为false。
{
  "src": [
    "pages/index/mainPage",
    "pages/second/payment",
    "pages/third/shopping_cart",
    "pages/four/owner"
  ],
  "window": {
    "designWidth": 720,
    "autoDesignWidth": false
  }
}
json

metadata标签

该标签标识HAP的自定义元信息,标签值为数组类型,包含name、value、resource三个子标签。

表5 metadata标签说明

属性名称含义数据类型是否可缺省
name标识数据项的名称,取值为长度不超过255字节的字符串。字符串该标签可缺省,缺省值为空。
value标识数据项的值,取值为长度不超过255字节的字符串。字符串该标签可缺省,缺省值为空。
resource标识定义用户自定义数据格式,取值为长度不超过255字节的字符串,内容为标识该数据的资源索引。字符串该标签可缺省,缺省值为空。

resource属性值使用“$profile:文件名”的方式指定文件所在位置,$profile表示资源的路径为工程中的/resources/base/profile目录下。例如$profile:shortcuts_config指定了/resources/base/profile/shortcuts_config.json文件。

{
  "module": {
    "metadata": [{
      "name": "module_metadata",
      "value": "a test demo for module metadata",
      "resource": "$profile:shortcuts_config"
    }],

    "abilities": [{
      "metadata": [{
        "name": "ability_metadata",
        "value": "a test demo for ability",
        "resource": "$profile:config_file"
      },
      {
        "name": "ability_metadata_2",
        "value": "a string test",
        "resource": "$profile:config_file"
      }],
    }],

    "extensionAbilities": [{
      "metadata": [{
        "name": "extensionAbility_metadata",
        "value": "a test for extensionAbility",
        "resource": "$profile:config_file"
      },
      {
        "name": "extensionAbility_metadata_2",
        "value": "a string test",
        "resource": "$profile:config_file"
      }],
    }]
  }
}
json

abilities标签

abilities标签描述UIAbility组件的配置信息,标签值为数组类型,该标签下的配置只对当前UIAbility生效。

表6 abilities标签说明

属性名称含义数据类型是否可缺省
name标识当前UIAbility组件的名称,确保该名称在整个应用中唯一。取值为长度不超过127字节的字符串,不支持中文。字符串该标签不可缺省。
srcEntry标识入口UIAbility的代码路径,取值为长度不超过127字节的字符串。字符串该标签不可缺省。
launchType标识当前UIAbility组件的启动模式,支持的取值如下:
- multiton:多实例模式,每次启动创建一个新实例。
- singleton:单实例模式,仅第一次启动创建新实例。
- specified:指定实例模式,运行时由开发者决定是否创建新实例。
字符串该标签可缺省,该标签缺省为“singleton”。
description标识当前UIAbility组件的描述信息,取值为长度不超过255字节的字符串。要求采用描述信息的资源索引,以支持多语言。字符串该标签可缺省,缺省值为空。
icon标识当前UIAbility组件的图标,取值为图标资源文件的索引。字符串该标签可缺省,缺省值为空。
如果UIAbility被配置为MainElement,该标签必须配置。
label标识当前UIAbility组件对用户显示的名称,要求采用该名称的资源索引,以支持多语言。取值为长度不超过255字节的字符串。字符串该标签可缺省,缺省值为空。
如果UIAbility被配置为MainElement,该标签必须配置。
permissions标识当前UIAbility组件自定义的权限信息。当其他应用访问该UIAbility时,需要申请相应的权限信息。
一个数组元素为一个权限名称。通常采用反向域名格式(不超过255字节),取值为系统预定义的权限。
字符串数组该标签可缺省,缺省值为空。
metadata标识当前UIAbility组件的元信息。对象数组该标签可缺省,缺省值为空。
exported标识当前UIAbility组件是否可以被其他应用调用。
- true:表示可以被其他应用调用。
- false:表示不可以被其他应用调用,包括无法被aa工具命令拉起应用。
布尔值该标签可缺省,缺省值为false。
continuable标识当前UIAbility组件是否支持跨端迁移。
- true:表示支持迁移。
- false:表示不支持迁移。
布尔值该标签可缺省,缺省值为false。
skills标识当前UIAbility组件或ExtensionAbility组件能够接收的Want特征集,为数组格式。
配置规则:
- 对于Entry类型的HAP,应用可以配置多个具有入口能力的skills标签(即配置了ohos.want.action.home和entity.system.home)。
- 对于Feature类型的HAP,只有应用可以配置具有入口能力的skills标签,服务不允许配置。
对象数组该标签可缺省,缺省值为空。
backgroundModes标识当前UIAbility组件的长时任务集合,指定用于满足特定类型的长时任务。
长时任务类型有如下:
- dataTransfer:通过网络/对端设备进行数据下载、备份、分享、传输等。
- audioPlayback:音频播放。
- audioRecording:录音。
- location:定位、导航。
- bluetoothInteraction:蓝牙扫描、连接、传输(穿戴)。
- multiDeviceConnection:多设备互联。
- wifiInteraction:Wi-Fi扫描、连接、传输(克隆多屏)。
- voip:音视频电话、VoIP。
- taskKeeping:计算。
字符串数组该标签可缺省,缺省值为空。
startWindowIcon标识当前UIAbility组件启动页面图标资源文件的索引,取值为长度不超过255字节的字符串。字符串该标签不可缺省。
startWindowBackground标识当前UIAbility组件启动页面背景颜色资源文件的索引,取值为长度不超过255字节的字符串。
取值示例:$color:red。
字符串该标签不可缺省。
removeMissionAfterTerminate标识当前UIAbility组件销毁后,是否从任务列表中移除任务。
- true表示销毁后移除任务。
- false表示销毁后不移除任务。
布尔值该标签可缺省,缺省值为false。
orientation标识当前UIAbility组件启动时的方向。支持的取值如下:
- unspecified:未指定方向,由系统自动判断显示方向。
- landscape:横屏。
- portrait:竖屏。
- follow_recent:跟随背景窗口的旋转模式。
- landscape_inverted:反向横屏。
- portrait_inverted:反向竖屏。
- auto_rotation:随传感器旋转。
- auto_rotation_landscape:传感器横屏旋转,包括横屏和反向横屏。
- auto_rotation_portrait:传感器竖屏旋转,包括竖屏和反向竖屏。
- auto_rotation_restricted:传感器开关打开,方向可随传感器旋转。
- auto_rotation_landscape_restricted:传感器开关打开,方向可随传感器旋转为横屏, 包括横屏和反向横屏。
- auto_rotation_portrait_restricted:传感器开关打开,方向随可传感器旋转为竖屏, 包括竖屏和反向竖屏。
- locked:传感器开关关闭,方向锁定。
- auto_rotation_unspecified:受开关控制和由系统判定的自动旋转模式。
- follow_desktop:跟随桌面的旋转模式。
字符串该标签可缺省,缺省值为unspecified。
supportWindowMode标识当前UIAbility组件所支持的窗口模式。支持的取值如下:
- fullscreen:全屏模式。
- split:分屏模式。
- floating:悬浮窗模式。
字符串数组该标签可缺省,缺省值为
[“fullscreen”, “split”, “floating”]。
priority标识当前UIAbility组件的优先级。隐式查询时,优先级越高,UIAbility在返回列表越靠前。取值范围0~10,数值越大,优先级越高。
说明:
仅支持系统应用配置,三方应用配置不生效。
整型数值该标签可缺省,缺省值为0。
maxWindowRatio标识当前UIAbility组件支持的最大的宽高比。该标签最小取值为0。数值该标签可缺省,缺省值为平台支持的最大的宽高比。
minWindowRatio标识当前UIAbility组件支持的最小的宽高比。该标签最小取值为0。数值该标签可缺省,缺省值为平台支持的最小的宽高比。
maxWindowWidth标识当前UIAbility组件支持的最大的窗口宽度,宽度单位为vp。
最小取值为minWindowWidth,最大取值为平台支持的最大窗口宽度。窗口尺寸可以参考窗口大小限制
数值该标签可缺省,缺省值为平台支持的最大的窗口宽度。
minWindowWidth标识当前UIAbility组件支持的最小的窗口宽度, 宽度单位为vp。
最小取值为平台支持的最小窗口宽度,最大取值为maxWindowWidth。窗口尺寸可以参考窗口大小限制
数值该标签可缺省,缺省值为平台支持的最小的窗口宽度。
maxWindowHeight标识当前UIAbility组件支持的最大的窗口高度, 高度单位为vp。
最小取值为minWindowHeight,最大取值为平台支持的最大窗口高度。 窗口尺寸可以参考窗口大小限制
数值该标签可缺省,缺省值为平台支持的最大的窗口高度。
minWindowHeight标识当前UIAbility组件支持的最小的窗口高度, 高度单位为vp。
最小取值为平台支持的最小窗口高度,最大取值为maxWindowHeight。窗口尺寸可以参考窗口大小限制
数值该标签可缺省,缺省值为平台支持的最小的窗口高度。
excludeFromMissions标识当前UIAbility组件是否在最近任务列表中显示。
- true:表示不在任务列表中显示。
- false:表示在任务列表中显示。
说明:
仅支持系统应用配置,且需申请应用特权AllowAbilityExcludeFromMissions,三方应用配置不生效,详见应用特权配置指导
布尔值该标签可缺省,缺省值为false。
recoverable标识当前UIAbility组件是否支持在检测到应用故障后,恢复到应用原界面。
- true:支持检测到出现故障后,恢复到原界面。
- false:不支持检测到出现故障后,恢复到原界面。
布尔值该标签可缺省,缺省值为false。
unclearableMission标识当前UIAbility组件是否支持从最近任务列表中移除。
- true:表示在任务列表中不可移除。
- false:表示在任务列表中可以移除。
说明:
单独配置该字段不可生效,需要申请对应的AllowMissionNotCleared特权之后,该字段才能生效。
布尔值该标签可缺省,缺省值为false。
isolationProcess标识组件能否运行在独立的进程中。
- true:表示能运行在独立的进程中。
- false:表示不能运行在独立的进程中。
布尔值该标签可缺省,缺省值为false。
excludeFromDock标识当前UIAbility组件是否支持从dock区域隐藏图标。
- true:表示在dock区域隐藏。
- false:表示不能在dock区域隐藏。
布尔值该标签可缺省,缺省值为false。
preferMultiWindowOrientation标识当前UIAbility组件多窗布局方向:
- default:缺省值,参数不配置默认值,建议其他应用类配置。
- portrait:多窗布局方向为竖向,建议竖向游戏类应用配置。
- landscape:多窗布局方向为横向,配置后支持横屏悬浮窗和上下分屏,建议横向游戏类应用配置。
- landscape_auto:多窗布局动态可变为横向,需要配合API enableLandScapeMultiWindow/disableLandScapeMultiWindow使用,建议视频类应用配置。
字符串该标签可缺省,缺省值为default。
continueType标识当前UIAbility组件的跨端迁移类型。字符串数组该标签可缺省,缺省值为当前组件的名称。

abilities示例:

{
  "abilities": [{
    "name": "EntryAbility",
    "srcEntry": "./ets/entryability/EntryAbility.ets",
    "launchType":"singleton",
    "description": "$string:description_main_ability",
    "icon": "$media:icon",
    "label": "Login",
    "permissions": [],
    "metadata": [],
    "exported": true,
    "continuable": true,
    "skills": [{
      "actions": ["ohos.want.action.home"],
      "entities": ["entity.system.home"],
      "uris": []
    }],
    "backgroundModes": [
      "dataTransfer",
      "audioPlayback",
      "audioRecording",
      "location",
      "bluetoothInteraction",
      "multiDeviceConnection",
      "wifiInteraction",
      "voip",
      "taskKeeping"
    ],
    "startWindowIcon": "$media:icon",
    "startWindowBackground": "$color:red",
    "removeMissionAfterTerminate": true,
    "orientation": " ",
    "supportWindowMode": ["fullscreen", "split", "floating"],
    "maxWindowRatio": 3.5,
    "minWindowRatio": 0.5,
    "maxWindowWidth": 2560,
    "minWindowWidth": 1400,
    "maxWindowHeight": 300,
    "minWindowHeight": 200,
    "excludeFromMissions": false,
    "unclearableMission": false,
    "excludeFromDock": false,
    "preferMultiWindowOrientation": "default",
    "isolationProcess": false,
    "continueType": [
      "continueType1",
      "continueType2"
    ]
  }]
}
json

skills标签

该标签标识UIAbility组件或者ExtensionAbility组件能够接收的Want的特征。

表7 skills标签说明

属性名称含义数据类型是否可缺省
actions标识能够接收的Action值集合,取值通常为系统预定义的action值,也允许自定义。字符串数组该标签可缺省,缺省值为空。
entities标识能够接收的Entity值的集合。字符串数组该标签可缺省,缺省值为空。
uris标识与Want中URI(Uniform Resource Identifier)相匹配的集合。对象数组该标签可缺省,缺省值为空。
permissions标识当前UIAbility组件自定义的权限信息。当其他应用访问该UIAbility时,需要申请相应的权限信息。
一个数组元素为一个权限名称。通常采用反向域名格式(不超过255字节),取值为系统预定义的权限。
字符串数组该标签可缺省,缺省值为空。
domainVerify标识是否开启域名校验。布尔值该标签可缺省,缺省值为false。

表8 uris标签说明

属性名称含义数据类型是否可缺省
scheme标识URI的协议名部分,常见的有http、https、file、ftp等。字符串uris中仅配置type时可以缺省,缺省值为空,否则不可缺省。
host标识URI的主机地址部分,该字段在scheme存在时才有意义。常见的方式:
- 域名方式,如example.com。
- IP地址方式,如10.10.10.1。
字符串该标签可缺省,缺省值为空。
port标识URI的端口部分。如http默认端口为80,https默认端口是443,ftp默认端口是21。该字段在scheme和host都存在时才有意义。字符串该标签可缺省,缺省值为空。
path | pathStartWith | pathRegex标识URI的路径部分,path、pathStartWith和pathRegex配置时三选一。path标识URI与want中的路径部分全匹配,pathStartWith标识URI与want中的路径部分允许前缀匹配,pathRegex标识URI与want中的路径部分允许正则匹配。该字段在scheme和host都存在时才有意义。字符串该标签可缺省,缺省值为空。
type标识与Want相匹配的数据类型,使用MIME(Multipurpose Internet Mail Extensions)类型规范。可与scheme同时配置,也可以单独配置。字符串该标签可缺省,缺省值为空。
utd标识与Want相匹配的标准化数据类型,适用于分享等场景。字符串该标签可缺省,缺省值为空。
maxFileSupported对于指定类型的文件,标识一次能接收或打开的最大数量,适用于分享等场景,需要与utd配合使用。整数该标签可缺省,缺省值为0。
linkFeature标识URI提供的功能类型(如文件打开、分享、导航等),用于实现应用间跳转。取值为长度不超过127字节的字符串,不支持中文。字符串该标签可缺省,缺省值为空。

skills示例:

{
  "abilities": [
    {
      "skills": [
        {
          "actions": [
            "ohos.want.action.home"
          ],
          "entities": [
            "entity.system.home"
          ],
          "uris": [
            {
              "scheme":"http",
              "host":"example.com",
              "port":"80",
              "path":"path",
              "type": "text/*",
              "linkFeature": "login"
            }
          ],
          "permissions": [],
          "domainVerify": false
        }
      ]
    }
  ]
}
json

extensionAbilities标签

描述extensionAbilities的配置信息,标签值为数组类型,该标签下的配置只对当前extensionAbilities生效。

表9 extensionAbilities标签说明

属性名称含义数据类型是否可缺省
name标识当前ExtensionAbility组件的名称,确保该名称在整个应用中唯一,取值为长度不超过127字节的字符串。字符串该标签不可缺省。
srcEntry标识当前ExtensionAbility组件所对应的代码路径,取值为长度不超过127字节的字符串。字符串该标签不可缺省。
description标识当前ExtensionAbility组件的描述,取值为长度不超过255字节的字符串,可以是对描述内容的资源索引,用于支持多语言。字符串该标签可缺省,缺省值为空。
icon标识当前ExtensionAbility组件的图标,取值为资源文件的索引。如果ExtensionAbility组件被配置为MainElement,该标签必须配置。字符串该标签可缺省,缺省值为空。
label标识当前ExtensionAbility组件对用户显示的名称,取值为该名称的资源索引,以支持多语言,字符串长度不超过255字节。如果ExtensionAbility被配置当前Module的mainElement时,该标签必须配置,且要确保应用内唯一。字符串该标签可缺省,缺省值为空。
type标识当前ExtensionAbility组件的类型,支持的取值如下:
- form:卡片的ExtensionAbility。
- workScheduler:延时任务的ExtensionAbility。
- inputMethod:输入法的ExtensionAbility。
- service:后台运行的service组件。
- accessibility:辅助能力的ExtensionAbility。
- fileAccess:公共数据访问的ExtensionAbility,允许应用程序提供文件和文件夹给文件管理类应用展示。
- dataShare:数据共享的ExtensionAbility。
- staticSubscriber:静态广播的ExtensionAbility。
- wallpaper:壁纸的ExtensionAbility。
- backup:数据备份的ExtensionAbility。
- window:该ExtensionAbility会在启动过程中创建一个window,为开发者提供界面开发。开发者开发出来的界面将通过UIExtensionComponent控件组合到其他应用的窗口中。
- thumbnail:获取文件缩略图的ExtensionAbility,开发者可以对自定义文件类型的文件提供缩略。
- preview:该ExtensionAbility会将文件解析后在一个窗口中显示,开发者可以通过将此窗口组合到其他应用窗口中。
- print:打印框架的ExtensionAbility。
- push:推送的ExtensionAbility。
- driver:驱动框架的ExtensionAbility。
- remoteNotification:远程通知的ExtensionAbility。
- remoteLocation:远程定位的ExtensionAbility。
- voip:网络音视频通话的ExtensionAbility。
- action:自定义操作业务模板的ExtensionAbility,为开发者提供基于UIExtension的自定义操作业务模板
- adsService:广告业务的ExtensionAbility,提供广告业务框架。
- embeddedUI:嵌入式UI扩展能力,提供跨进程界面嵌入的能力。
- ads:广告业务的ExtensionAbility,与AdComponent控件组合使用,将广告页面展示到其他应用中。仅支持设备厂商使用。
- appAccountAuthorization:应用帐号授权扩展能力的ExtensionAbility,用于处理帐号授权请求,比如帐号登录授权。
- autoFill/password:用于账号和密码自动填充业务的ExtensionAbility,支持数据的保存、填充能力。
- hms/account:应用帐号管理能力的ExtensionAbility。
- sysDialog/atomicServicePanel:提供构建原子化服务服务面板的基础能力的ExtensionAbility,使用时基于UIExtensionAbility实现。
- sysDialog/userAuth:本地用户鉴权的ExtensionAbility。
- sysDialog/common:通用弹窗的ExtensionAbility。
- sysDialog/power:关机重启弹窗的ExtensionAbility。
- sysDialog/print:打印模态弹窗的ExtensionAbility。
- sysDialog/meetimeCall:畅连通话的ExtensionAbility。
- sysDialog/meetimeContact:畅连联系人的ExtensionAbility。
- sysPicker/meetimeMessage:畅连消息的ExtensionAbility。
- sysPicker/meetimeContact:畅连联系人列表的ExtensionAbility。
- sysPicker/meetimeCallLog:畅连通话记录列表的ExtensionAbility。
- sysPicker/share:系统分享的ExtensionAbility。
- sysPicker/mediaControl:投播组件的ExtensionAbility。
- sysPicker/photoPicker:三方应用通过对应的UIExtensionType拉起图库picker界面。
- sysPicker/filePicker:文件下载弹窗的ExtensionAbility。
- sys/commonUI:非通用的ExtensionAbility,提供业务属性强相关的嵌入式显示或弹框。
- autoFill/smart:用于情景化场景自动填充业务的ExtensionAbility,支持数据的保存、填充能力。
说明:
其中service、adsService、sys/commonUI、fileAccess、sysDialog类型、sysPicker类型和dataShare类型,仅支持系统应用配置,三方应用配置不生效。
字符串该标签不可缺省。
permissions标识当前ExtensionAbility组件自定义的权限信息。当其他应用访问该ExtensionAbility时,需要申请相应的权限信息。
一个数组元素为一个权限名称。通常采用反向域名格式(最大255字节),取值为系统预定义的权限
字符串数组该标签可缺省,缺省值为空。
readPermission标识读取当前ExtensionAbility组件数据所需的权限,取值为长度不超过255字节的字符串。仅当ExtensionAbility组件的type为dataShare时支持配置该标签。字符串该标签可缺省,缺省值为空。
writePermission标识向当前ExtensionAbility组件写数据所需的权限,取值为长度不超过255字节的字符串。仅当ExtensionAbility组件的type为dataShare时支持配置该标签。字符串该标签可缺省,缺省值为空。
uri标识当前ExtensionAbility组件提供的数据URI,取值为长度不超过255字节的字符数组,用反向域名的格式表示。
说明:
该标签在type为dataShare类型的ExtensionAbility时,不可缺省。
字符串该标签可缺省,缺省值为空。
skills标识当前ExtensionAbility组件能够接收的Want的特征集。
配置规则:entry包可以配置多个具有入口能力的skills标签(配置了ohos.want.action.home和entity.system.home)的ExtensionAbility,其中第一个配置了skills标签的ExtensionAbility中的label和icon作为服务或应用的label和icon。
说明:
服务的Feature包不能配置具有入口能力的skills标签。
应用的Feature包可以配置具有入口能力的skills标签。
数组该标签可缺省,缺省值为空。
metadata标识当前ExtensionAbility组件的元信息。对象该标签可缺省,缺省值为空。
exported标识当前ExtensionAbility组件是否可以被其他应用调用。
- true:表示可以被其他应用调用。
- false:表示不可以被其他应用调用,包括无法被aa工具命令拉起应用。
布尔值该标签可缺省,缺省值为false。
extensionProcessMode标识当前ExtensionAbility组件的多进程实例模型,当前只对UIExtensionAbility以及从UIExtensionAbility扩展的ExtensionAbility生效。
- instance:表示该ExtensionAbility每个实例一个进程。
- type:表示该ExtensionAbility实例都运行在同一个进程里,与其他ExtensionAbility分离进程。
- bundle:表示该ExtensionAbility实例都运行在应用统一进程里,与其他配置了bundle模型的ExtensionAbility共进程。
字符串该标签可缺省,缺省值为空。
dataGroupIds标识当前ExtensionAbility组件的dataGroupId集合。如果当前ExtensionAbility组件所在的应用在HarmonyAppProvision配置文件的data-group-ids字段中也声明了某个dataGroupId,那么当前ExtensionAbility组件可以和应用共享这一个dataGroupId生成的目录,所以ExtensionAbility组件的dataGroupId需要是应用的HarmonyAppProvision配置文件的data-group-ids字段里配置的才能生效。 且该字段仅在当前ExtensionAbility组件存在独立的沙箱目录时生效。字符串数组该标签可缺省,缺省值为空。

extensionAbilities示例:

{
  "extensionAbilities": [
    {
      "name": "FormName",
      "srcEntry": "./form/MyForm.ts",
      "icon": "$media:icon",
      "label" : "$string:extension_name",
      "description": "$string:form_description",
      "type": "form",
      "permissions": ["ohos.abilitydemo.permission.PROVIDER"],
      "readPermission": "",
      "writePermission": "",
      "exported": true,
      "uri":"scheme://authority/path/query",
      "skills": [{
        "actions": [],
        "entities": [],
        "uris": [],
        "permissions": []
      }],
      "metadata": [
        {
          "name": "ohos.extension.form",
          "resource": "$profile:form_config",
        }
      ],
      "extensionProcessMode": "instance",
      "dataGroupIds": [
        "testGroupId1"
      ]
    }
  ]
}
json

requestPermissions标签

该标签标识应用运行时需向系统申请的权限集合,权限设置方式参见申请应用权限

说明:

  • 在requestPermissions标签中配置的权限项将在应用级别生效,即该权限适用于整个应用程序。
  • 如果应用需要订阅自己发布的事件,而且应用在extensionAbilities标签中的permissions字段中设置了访问该应用所需要的权限,那么应用也需要在requestPermissions标签中注册相关权限才能收到该事件。
  • 生态治理中,要求受限的权限必须要校验usedScene,但是在HAR/HSP中没有usedScene/ability,会影响构建出包,所以HAR/HSP包中不再校验这个逻辑。

表10 requestPermissions标签说明

属性名称含义数据类型是否可缺省
name标识需要使用的权限名称。字符串该标签不可缺省。
reason标识申请权限的原因,取值需要采用资源引用格式,以适配多语种。字符串该标签可缺省,缺省值为空。
说明:
当申请的权限为user_grant权限时,该字段必填,否则不允许在应用市场上架。
usedScene标识权限使用的场景,包含abilities和when两个子标签。
- abilities:可以配置为多个UIAbility或者ExtensionAbility名称的字符串数组。
- when:表示调用时机,支持的取值包括inuse(使用时)和always(始终)。
对象该标签可缺省,缺省值为空。
说明:
HAR/HSP的场景下对于受限的权限不再校验usedScene权限。当申请的权限为user_grant权限时,abilities标签在hap中必填,when标签可选。

requestPermissions示例:

{
  "module" : {
    "requestPermissions": [
      {
        "name": "ohos.abilitydemo.permission.PROVIDER",
        "reason": "$string:reason",
        "usedScene": {
          "abilities": [
            "EntryFormAbility"
          ],
          "when": "inuse"
        }
      }
    ]
  }
}
json

shortcuts标签

shortcuts标识应用的快捷方式信息。标签值为数组,包含四个子标签shortcutId、label、icon、wants。

metadata中指定shortcut信息,其中:

  • name:指定shortcuts的名称,使用ohos.ability.shortcuts作为shortcuts信息的标识。

  • resource:指定shortcuts信息的资源位置。

表11 shortcuts标签说明

属性名称含义类型是否可缺省
shortcutId标识快捷方式的ID,取值为长度不超过63字节的字符串。字符串该标签不可缺省。
label标识快捷方式的标签信息,即快捷方式对外显示的文字描述信息。取值为长度不超过255字节的字符串,可以是描述性内容,也可以是标识label的资源索引。字符串该标签可缺省,缺省值为空。
icon标识快捷方式的图标,取值为资源文件的索引。字符串该标签可缺省,缺省值为空。
wants标识快捷方式内定义的目标wants信息集合,在调用launcherBundleManager的startShortcut接口时,会拉起wants标签里的第一个目标组件,推荐只配置一个wants元素。对象该标签可缺省,缺省为空。
  1. 在/resources/base/profile/目录下配置shortcuts_config.json配置文件。

    {
      "shortcuts": [
        {
          "shortcutId": "id_test1",
          "label": "$string:shortcut",
          "icon": "$media:aa_icon",
          "wants": [
            {
              "bundleName": "com.ohos.hello",
              "moduleName": "entry",
              "abilityName": "EntryAbility",
              "parameters": {
                "testKey": "testValue"
              }
            }
          ]
        }
      ]
    }
    json
  2. 在module.json5配置文件的abilities标签中,针对需要添加快捷方式的UIAbility进行配置metadata标签,使shortcut配置文件对该UIAbility生效。

wants标签

此标签用于标识快捷方式内定义的目标wants信息集合。

表11-1 wants标签说明

属性名称含义类型是否可缺省
bundleName表示快捷方式的目标包名。字符串该标签不可缺省。
moduleName表示快捷方式的目标模块名。字符串该标签不可缺省。
abilityName表示快捷方式的目标组件名。字符串该标签不可缺省。
parameters表示拉起快捷方式时的自定义数据,仅支持配置字符串类型的数据。其中键值均最大支持1024长度的字符串。对象该标签可缺省。

data标签示例:

distributionFilter标签

该标签用于定义HAP对应的细分设备规格的分发策略,以便在应用市场进行云端分发应用包时做精准匹配。

说明: 该标签从API10及以后版本开始生效,API9及以前版本使用distroFilter标签。

  • 适用场景: 当一个工程中存在多个Entry,且多个Entry配置的deviceTypes存在交集时,则需要通过该标签进行区分。比如下面的两个Entry都支持tablet类型,就需要通过该标签进行区分。

    // entry1支持的设备类型
    {
      "module": {
        "name": "entry1",
        "type": "entry",
        "deviceTypes" : [
          "tv",
          "tablet"
        ]
      }
    }
    json
    // entry2支持的设备类型
    {
      "module": {
        "name": "entry2",
        "type": "entry",
        "deviceTypes" : [
          "car",
          "tablet"
        ]
      }
    }
    json
  • 配置规则: 该标签支持配置四个属性,包括屏幕形状(screenShape)、窗口分辨率(screenWindow)、屏幕像素密度(screenDensity )、设备所在国家与地区(countryCode),详见下表。

    在分发应用包时,通过deviceTypes与这四个属性的匹配关系,唯一确定一个用于分发到设备的HAP。

    • 如果需要配置该标签,则至少包含一个属性。
    • 如果一个Entry中配置了任意一个或多个属性,则其他Entry也必须包含相同的属性。
    • screenShape和screenWindow属性仅用于轻量级智能穿戴设备。
  • 配置方式: 该标签需要配置在/resources/base/profile资源目录下,并在metadata的resource字段中引用。

表12 distributionFilter标签配置说明

属性名称含义数据类型是否可缺省
screenShape标识屏幕形状的支持策略。对象数组该标签可缺省,缺省值为空。
screenWindow标识应用运行时的窗口分辨率的支持策略。对象数组该标签可缺省,缺省值为空。
screenDensity标识屏幕的像素密度(dpi:Dot Per Inch)的支持策略。对象数组该标签可缺省,缺省值为空。
countryCode标识国家与地区的支持策略,取值参考ISO-3166-1标准。支持多个国家和地区枚举定义。对象数组该标签可缺省,缺省值为空。

screenShape标签

表13 screenShape标签说明

属性名称含义数据类型是否可缺省
policy标识条件属性的过滤规则。
- exclude:表示需要排除的value属性。
- include:表示需要包含的value属性。
字符串该标签不可缺省。
value支持的取值为circle(圆形)、rect(矩形)。例如,针对智能穿戴设备,可为圆形表盘和矩形表盘分别提供不同的HAP。字符串数组该标签不可缺省。

screenWindow标签

表14 screenWindow标签说明

属性名称含义数据类型是否可缺省
policy标识条件属性的过滤规则。当前取值仅支持“include”。
- include:表示需要包含的value属性。
字符串该标签不可缺省。
value单个字符串的取值格式为“宽 * 高”,取值为整数像素值,例如“454 * 454”。字符串数组该标签不可缺省。

screenDensity标签

表15 screenDensity标签说明

属性名称含义数据类型是否可缺省
policy标识条件属性的过滤规则。
- exclude:表示需要排除的value属性。
- include:表示需要包含的value属性。
字符串该标签不可缺省。
value标识屏幕的像素密度(dpi :Dot Per Inch)。支持的取值如下:
- sdpi:表示小规模的屏幕密度(Small-scale Dots per Inch),适用于dpi取值为(0,120]的设备。
- mdpi:表示中规模的屏幕密度(Medium-scale Dots Per Inch),适用于dpi取值为(120,160]的设备。
- ldpi:表示大规模的屏幕密度(Large-scale Dots Per Inch),适用于dpi取值为(160,240]的设备。
- xldpi:表示大规模的屏幕密度(Extra Large-scale Dots Per Inch),适用于dpi取值为(240,320]的设备。
- xxldpi:表示大规模的屏幕密度(Extra Extra Large-scale Dots Per Inch),适用于dpi取值为(320,480]的设备。
- xxxldpi:表示大规模的屏幕密度(Extra Extra Extra Large-scale Dots Per Inch),适用于dpi取值为(480, 640]的设备。
字符串数组该标签不可缺省。

countryCode标签

表16 countryCode标签说明

属性名称含义数据类型是否可缺省
policy标识条件属性的过滤规则。
- exclude:表示需要排除的value属性。
- include:表示需要包含的value属性。
字符串该标签不可缺省。
value标识应用需要分发的国家地区码。字符串数组该标签不可缺省。

示例如下:

  1. 在开发视图的resources/base/profile下面定义配置文件distributionFilter_config.json,文件名可以自定义。

    {
      "distributionFilter": {
        "screenShape": {
          "policy": "include",
          "value": [
            "circle",
            "rect"
          ]
        },
        "screenWindow": {
          "policy": "include",
          "value": [
            "454*454",
            "466*466"
          ]
        },
        "screenDensity": {
          "policy": "exclude",
          "value": [
            "ldpi",
            "xldpi"
          ]
        },
        "countryCode": { // 支持在中国分发
          "policy": "include",
          "value": [
            "CN"
          ]
        }
      }
    }
    json
  2. 在module.json5配置文件的module标签中定义metadata信息。

    {
      "module": {
        // ...
        "metadata": [
          {
            "name": "ohos.module.distribution",
            "resource": "$profile:distributionFilter_config",
          }
        ]
      }
    }
    json

testRunner标签

此标签用于支持对测试框架的配置。

表17 testRunner标签说明

属性名称含义数据类型是否可缺省
name标识测试框架对象名称,取值为长度不超过255字节的字符串。字符串不可缺省。
srcPath标识测试框架代码路径,取值为长度不超过255字节的字符串。字符串不可缺省。

testRunner标签示例:

{
  "module": {
    // ...
    "testRunner": {
      "name": "myTestRunnerName",
      "srcPath": "etc/test/TestRunner.ts"
    }
  }
}
json

atomicService标签

此标签用于支持对原子化服务的配置。此标签仅在app.json中bundleType指定为atomicService时使能。

表18 atomicService标签说明

属性名称含义数据类型是否可缺省
preloads标识原子化服务中预加载列表。对象数组该标签可缺省,缺省值为空。

表19 preloads标签说明

属性名称含义数据类型是否可缺省
moduleName标识原子化服务中当前模块被加载时,需预加载的模块名。不能配置自身modulename,且必须有对应的模块,取值为长度不超过31字节的字符串。字符串该标签不可缺省。

atomicService标签示例:

{
  "module": {
    "atomicService": {
      "preloads":[
        {
          "moduleName":"feature"
        }
      ]
    }
  }
}
json

dependencies标签

此标签标识模块运行时依赖的共享库列表。

表20 dependencies标签说明

属性名称含义数据类型是否可缺省
bundleName标识当前模块依赖的共享包包名。取值为长度7~128字节的字符串。字符串该标签可缺省,缺省值为空。
moduleName标识当前模块依赖的共享包模块名。取值为长度不超过31字节的字符串。字符串该标签不可缺省。
versionCode标识当前共享包的版本号。取值范围为0~2147483647。数值该标签可缺省,缺省值为空。

dependencies标签示例:

{
  "module": {
    "dependencies": [
      {
        "bundleName":"com.share.library",
        "moduleName": "library",
        "versionCode": 10001
      }
    ]
  }
}
json

proxyData标签

此标签标识模块提供的数据代理列表,仅限entry和feature配置。

表21 proxyData标签说明

属性名称含义数据类型是否可缺省
uri标识用于访问该数据代理的URI,不同的数据代理配置的URI不可重复,且需要满足datashareproxy://当前应用包名/xxx的格式。取值为长度不超过255字节的字符串。字符串该标签不可缺省。
requiredReadPermission标识从该数据代理中读取数据所需要的权限,若不配置,则其他应用无法使用该代理。非系统应用配置的权限的等级需为system_basic或system_core,系统应用配置的权限的等级没有限制。权限等级可以参考权限列表。取值为长度不超过255字节的字符串。字符串该标签可缺省,缺省值为空。
requiredWritePermission标识向该数据代理中写入数据所需要的权限,若不配置,则其他应用无法使用该代理。非系统应用配置的权限的等级需为system_basic或system_core,系统应用配置的权限的等级没有限制。权限等级可以参考权限列表。取值为长度不超过255字节的字符串。字符串该标签可缺省,缺省值为空。
metadata标识该数据代理的元信息,只支持配置name和resource字段。对象该标签可缺省,缺省值为空。

proxyData标签示例:

{
  "module": {
    "proxyData": [
      {
        "uri":"datashareproxy://com.ohos.datashare/event/Meeting",
        "requiredReadPermission": "ohos.permission.GET_BUNDLE_INFO",
        "requiredWritePermission": "ohos.permission.GET_BUNDLE_INFO",
        "metadata": {
          "name": "datashare_metadata",
          "resource": "$profile:datashare"
        }
      }
    ]
  }
}
json

routerMap标签

此标签标识模块配置的路由表的路径。

routerMap配置文件描述模块的路由表信息,routerMap标签值为数组类型。

表22 routerMap标签说明

属性名称含义数据类型是否可缺省
name标识跳转页面的名称。取值为长度不超过1023字节的字符串。字符串该标签不可缺省。
pageSourceFile标识页面在模块内的路径。取值为长度不超过31字节的字符串。字符串该标签不可缺省。
buildFunction标识被@Builder修饰的函数,该函数描述页面的UI。取值为长度不超过1023字节的字符串。字符串该标签不可缺省。
data标识自定义数据。 每个自定义数据字符串取值不超过128字节。对象该标签可缺省,缺省值为空。

示例如下:

  1. 在开发视图的resources/base/profile下面定义配置文件,文件名可以自定义,例如:router_map.json。

    {
      "routerMap": [
        {
          "name": "DynamicPage1",
          "pageSourceFile": "src/main/ets/pages/pageOne.ets",
          "buildFunction": "myFunction"
        },
        {
          "name": "DynamicPage2",
          "pageSourceFile": "src/main/ets/pages/pageTwo.ets",
          "buildFunction": "myBuilder",
          "data": {
            "key1": "data1",
            "key2": "data2"
          }
        }
      ]
    }
    json
  2. 在module.json5配置文件的module标签中定义routerMap字段,指向定义的路由表配置文件,例如:"routerMap": "$profile:router_map"

data标签

此标签用于支持在路由表中配置自定义数据。 data对象内部,可以填入字符串类型的自定义数据。

data标签示例:

{
  "routerMap": [
    {
      "name": "DynamicPage",
      "pageSourceFile": "src/main/ets/pages/pageOne.ets",
      "buildFunction": "myBuilder",
      "data": {
        "key1": "data1",
        "key2": "data2"
      }
    }
  ]
}
json

appEnvironments标签

此标签标识模块配置的应用环境变量。

表23 appEnvironments标签说明

属性名称含义数据类型是否可缺省
name标识环境变量的变量名称。取值为长度不超过4096字节的字符串。字符串该标签可缺省,缺省值为空。
value标识环境变量的值。取值为长度不超过4096字节的字符串。字符串该标签可缺省,缺省值为空。

appEnvironments标签示例:

{
  "module": {
    "appEnvironments": [
      {
        "name":"name1",
        "value": "value1"
      }
    ]
  }
}
json

definePermissions标签

该标签仅支持系统资源hap定义权限,不支持应用自定义权限。权限定义方式参见系统资源权限定义

表24 definePermissions标签说明

属性名称含义数据类型是否可缺省
name标识权限的名称,该标签最大长度为255字节。字符串不可缺省。
grantMode标识权限的授予方式,支持如下两种授予模式如下:
- system_grant:安装后系统自动授予该权限。
- user_grant:使用时动态申请,用户授权后才可使用。
字符串可缺省,缺省值为system_grant。
availableLevel标识权限限制类别,可选值如下:
- system_core:系统核心权限。
- system_basic:系统基础权限。
- normal:普通权限。所有应用允许申请的权限。
字符串可缺省,缺省值为normal。
provisionEnable标识权限是否支持证书方式申请权限,包括高级别的权限。配置为true标识开发者可以通过provision方式申请权限。布尔值可缺省,缺省值为true。
distributedSceneEnabled标识权限是否支持分布式场景下使用该权限。布尔值可缺省,缺省值为false。
label标识权限的简短描述,配置为对描述内容的资源索引。字符串可缺省,缺省值为空。
description标识权限的详细描述,可以是字符串,或者是对描述内容的资源索引。字符串可缺省,缺省值为空。

definePermissions标签示例:

{
  "module" : {
    "definePermissions": [
    {
      {
        "name": "ohos.abilitydemo.permission.PROVIDER",
        "grantMode": "system_grant",
        "availableLevel": "system_core",
        "provisionEnable": true,
        "distributedSceneEnable": false,
        "label": "$string:EntryAbility_label"
        }
      }
    ]
  }
}
json

fileContextMenu标签

该标签用来标识当前HAP的右键菜单配置项,是一个profile文件资源,用于指定描述应用注册右键菜单配置文件。

fileContextMenu标签示例

{
  "module": {
    // ...
    "fileContextMenu": "$profile:menu" // 通过profile下的资源文件配置
  }
}
json

在开发视图的resources/base/profile下面定义配置文件menu.json,其中文件名“menu.json”可自定义,需要和fileContextMenu标签指定的信息对应。配置文件中描述了当前应用注册的右键菜单的项目和响应行为。 配置文件根节点名称为fileContextMenu,为对象数组,标识当前module注册右键菜单的数量。(单模块和单应用注册数量不能超过5个,配置超过数量当前只解析随机5个)

表25 fileContextMenu标签配置说明

属性名称含义数据类型是否可缺省
abilityName表示当前右键菜单对应的需要拉起的ability名称。字符串不可缺省
menuItem右键菜单显示的信息。资源id不可缺省
menuHandler一个ability可以创建多个右键菜单, 用该字段来区分用户拉起的不同右键菜单项。该字段在用户点击右键菜单执行时,会作为参数传递给右键菜单应用。字符串不可缺省
menuContext定义展示该菜单项需要的上下文,可以支持多种情况,类型为数组。对象数组不可缺省

表26 menuContext标签配置说明

属性名称含义数据类型是否可缺省
menuKind表示什么情况下触发该右键菜单:0:空白处 1:文件 2: 文件夹 3:文件和文件夹。数值不可缺省
menuRule用来表示是单选/多选下选择单个文件/文件夹,或者两种情况都显示。单选:single, 多选:multi 单选+多选:both(全小写)。字符串不可缺省,当menuKind为1或2读取
fileSupportType当选中的文件列表里包含这些文件类型时,显示该右键菜单。字符串数组不可缺省,仅menuKind为1时候读取,为*才读取fileNotSupportType字段,如果为具体值,不读取fileNotSupportType字段,如果为空,这条策略废弃
fileNotSupportType当选中的文件列表里包含这些文件类型时,不显示该右键菜单。字符串数组仅menuKind为1,且fileSupportType为*才读取该字段

fileContextMenu配置文件示例

{
  "fileContextMenu": [
    {
      "abilityName": "EntryAbility",
      "menuItem": "$string:module_desc",
      "menuHandler": "openCompress",
      "menuContext": [
        {
          "menuKind": 0
        },
        {
          "menuKind": 1,
          "menuRule": "both",
          "fileSupportType": [
            ".rar",
            ".zip"
          ],
          "fileNotSupportType": [
            ""
          ]
        },
        {
          "menuKind": 2,
          "menuRule": "single"
        },
        {
          "menuKind": 3
        }
      ]
    }
  ]
}
json

响应行为

进行右键注册后,在文件管理器的右键菜单的更多选项中,会出现配置menuItem的值的子列表,当用户在文管右键点击后,文管默认通过startAbility的方式拉起三方应用,除了指定三方应用的包名和ability名之外,want中的parameter中,也会传入如下字段:

表27 want中parameter字段说明

参数名类型
menuHandler对应注册配置文件中menuHandler的值。字符串
uriList用户在具体文件上触发右键的uri值,如果空白处响应,此值为空,单个文件响应,数组长度1,多个文件响应则传入对应所有文件的uri值。

最后

有很多小伙伴不知道学习哪些鸿蒙开发技术?不知道需要重点掌握哪些鸿蒙应用开发知识点?而且学习时频繁踩坑,最终浪费大量时间。所以有一份实用的鸿蒙(HarmonyOS NEXT)资料用来跟着学习是非常有必要的。 

点击领取→【纯血版鸿蒙全套最新学习资料】(安全链接,放心点击希望这一份鸿蒙学习资料能够给大家带来帮助,有需要的小伙伴自行领取~限时开源!!


 鸿蒙(HarmonyOS NEXT)最新学习路线

有了路线图,怎么能没有学习资料呢,小编也准备了一份联合鸿蒙官方发布笔记整理收纳的一套系统性的鸿蒙(OpenHarmony )学习手册(共计1236页)与鸿蒙(OpenHarmony )开发入门教学视频,内容包含:ArkTS、ArkUI、Web开发、应用模型、资源分类…等知识点。

获取以上完整版高清学习路线,请点击→纯血版全套鸿蒙HarmonyOS学习资料

这份鸿蒙(HarmonyOS NEXT)资料包含了鸿蒙开发必掌握的核心知识要点,内容包含了(ArkTS、ArkUI开发组件、Stage模型、多端部署、分布式应用开发、音频、视频、WebGL、OpenHarmony多媒体技术、Napi组件、OpenHarmony内核、(南向驱动、嵌入式等)鸿蒙项目实战等等)鸿蒙(HarmonyOS NEXT)技术知识点。


HarmonyOS Next 最新全套视频教程

 《鸿蒙 (OpenHarmony)开发基础到实战手册》

OpenHarmony北向、南向开发环境搭建

《鸿蒙开发基础》

  • ArkTS语言
  • 安装DevEco Studio
  • 运用你的第一个ArkTS应用
  • ArkUI声明式UI开发
  • .……

《鸿蒙开发进阶》

  • Stage模型入门
  • 网络管理
  • 数据管理
  • 电话服务
  • 分布式应用开发
  • 通知与窗口管理
  • 多媒体技术
  • 安全技能
  • 任务管理
  • WebGL
  • 国际化开发
  • 应用测试
  • DFX面向未来设计
  • 鸿蒙系统移植和裁剪定制
  • ……

《鸿蒙进阶实战》

  • ArkTS实践
  • UIAbility应用
  • 网络案例
  • ……

大厂面试必问面试题

鸿蒙南向开发技术

鸿蒙APP开发必备


请点击→纯血版全套鸿蒙HarmonyOS学习资料

  • 6
    点赞
  • 14
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值