HarmonyOS 项目 module.json5默认配置属性及描述

module.json5

entry>src>main>module.json5是模块的配置文件，包含当前模块的配置信息。

 

其中module对应的是模块的配置信息，一个模块对应一个打包后的hap包，hap包全称是HarmonyOS Ability Package，其中包含了ability、第三方库、资源和配置文件。其具体属性及其描述可以参照下表1。

表1 module.json5默认配置属性及描述

属性	描述
name	该标签标识当前module的名字，module打包成hap后，表示hap的名称，标签值采用字符串表示（最大长度31个字节），该名称在整个应用要唯一。
type	表示模块的类型，类型有三种，分别是entry、feature和har。
srcEntry	当前模块的入口文件路径。
description	当前模块的描述信息。
mainElement	该标签标识hap的入口ability名称或者extension名称。只有配置为mainElement的ability或者extension才允许在服务中心露出。
deviceTypes	该标签标识hap可以运行在哪类设备上，标签值采用字符串数组的表示。
deliveryWithInstall	标识当前Module是否在用户主动安装的时候安装，表示该Module对应的HAP是否跟随应用一起安装。- true：主动安装时安装。- false：主动安装时不安装。
installationFree	标识当前Module是否支持免安装特性。- true：表示支持免安装特性，且符合免安装约束。- false：表示不支持免安装特性。
pages	对应的是main_pages.json文件，用于配置ability中用到的page信息。
abilities	是一个数组，存放当前模块中所有的ability元能力的配置信息，其中可以有多个ability。

对于abilities中每一个ability的属性项，其描述信息如下表2。

表2 abilities中对象的默认配置属性及描述

属性	描述
name	该标签标识当前ability的逻辑名，该名称在整个应用要唯一，标签值采用字符串表示（最大长度127个字节）。
srcEntry	ability的入口代码路径。
description	ability的描述信息。
icon	ability的图标。该标签标识ability图标，标签值为资源文件的索引。该标签可缺省，缺省值为空。如果ability被配置为MainElement，该标签必须配置。
label	ability的标签名。
startWindowIcon	启动页面的图标。
startWindowBackground	启动页面的背景色。
visible	ability是否可以被其他应用程序调用，true表示可以被其它应用调用， false表示不可以被其它应用调用。
skills	标识能够接收的意图的action值的集合，取值通常为系统预定义的action值，也允许自定义。
entities	标识能够接收Want的Entity值的集合。
actions	标识能够接收的Want的Action值的集合，取值通常为系统预定义的action值，也允许自定义。

来源:<华为开发者学堂 (huawei.com)