配置文件的元素

此部分提供配置文件“config.json”中所有属性的详细解释。

DevEco Studio提供了两种编辑“config.json”文件的方式。在“config.json”的编辑窗口中，可在右上角切换代码编辑视图或可视化编辑视图。

图1 config.json文件的可视化编辑视图

配置文件的内部结构

“config.json”由“app”、“deviceConfig”和“module”三个部分组成，缺一不可。配置文件的内部结构说明参见表1。

app对象的内部结构

app对象包含应用的全局配置信息，内部结构说明参见表2。

app示例：

"app": {
    "bundleName": "com.huawei.hiworld.example", 
    "vendor": "huawei", 
    "version": {
        "code": 2, 
        "name": "2.0"
    }
    "apiVersion": {
        "compatible": 3, 
        "target": 3,
        "releaseType": "Beta1"
    }
}

deviceConfig对象的内部结构

deviceConfig包含在具体设备上的应用配置信息，可以包含default、phone、tablet、tv、car、wearable、liteWearable和smartVision等属性。default标签内的配置是适用于所有设备通用，其他设备类型如果有特殊的需求，则需要在该设备类型的标签下进行配置。内部结构说明参见表3。

default、phone、tablet、tv、car、wearable、liteWearable和smartVision等对象的内部结构说明，可参见表4。

deviceConfig示例：

 "deviceConfig": {
    "default": {
        "process": "com.huawei.hiworld.example", 
        "supportBackup": false,
        "network": {
            "cleartextTraffic": true, 
            "securityConfig": {
                "domainSettings": {
                    "cleartextPermitted": true, 
                    "domains": [
                        {
                            "subDomains": true, 
                            "name": "example.ohos.com"
                        }
                    ]
                }
            }
        }
    }
}

module对象的内部结构

module对象包含HAP包的配置信息，内部结构说明参见表7。

module示例：

"module": {    "mainAbility": "MainAbility",    "package": "com.example.myapplication.entry",     "name": ".MyOHOSAbilityPackage",     "description": "$string:description_application",     "supportedModes": [        "drive"    ],     "deviceType": [        "car"    ],     "distro": {        "deliveryWithInstall": true,         "moduleName": "ohos_entry",         "moduleType": "entry"    },     "abilities": [        ...    ],     "shortcuts": [        ...    ],    "js": [        ...    ],     "reqPermissions": [        ...    ],     "defPermissions": [        ...    ],    "colorMode": "light"}

distro示例：

"distro": {    "deliveryWithInstall": true,     "moduleName": "ohos_entry",     "moduleType": "entry",    "installationFree": true}

metaData示例：

"metaData": {    "parameters" : [{        "name" : "string",        "type" : "Float",        "description" : "$string:parameters_description"    }],    "results" : [{        "name" : "string",        "type" : "Float",        "description" : "$string:results_description"    }],    "customizeData" : [{        "name" : "string",        "value" : "string",        "extra" : "$string:customizeData_description"    }]}

abilities示例：

"abilities": [    {        "name": ".MainAbility",        "description": "himusic main ability",        "icon": "$media:ic_launcher",        "label": "HiMusic",        "launchType": "standard",        "orientation": "unspecified",        "permissions": [        ],         "visible": true,        "skills": [            {                "actions": [                    "action.system.home"                ],                "entities": [                    "entity.system.home"                ]            }        ],        "configChanges": [            "locale",             "layout",             "fontSize",             "orientation"        ],         "type": "page"    },    {        "name": ".PlayService",        "description": "himusic play ability",        "icon": "$media:ic_launcher",        "label": "HiMusic",        "launchType": "standard",        "orientation": "unspecified",        "visible": false,        "skills": [            {                "actions": [                    "action.play.music",                    "action.stop.music"                ],                "entities": [                    "entity.audio"                ]            }        ],        "type": "service",        "backgroundModes": [            "audioPlayback"        ]    },    {        "name": ".UserADataAbility",        "type": "data",        "uri": "dataability://com.huawei.hiworld.himusic.UserADataAbility",        "visible": true    }]

skills示例：

"skills": [    {        "actions": [            "action.system.home"        ],         "entities": [            "entity.system.home"        ],        "uris": [            {                 "scheme": "http",                 "host": "www.xxx.com",                 "port": "8080",                 "path": "query/student/name",                 "type": "text/*"             }         ]    }]

js示例：

"js": [    {        "name": "default",         "pages": [                        "pages/index/index",            "pages/detail/detail"        ],                 "window": {            "designWidth": 750,            "autoDesignWidth": false        },        "type": "form"    }]

shortcuts示例：

"shortcuts": [    {        "shortcutId": "id",        "label": "$string:shortcut",        "intents": [            {                "targetBundle": "com.huawei.hiworld.himusic",                "targetClass": "com.huawei.hiworld.himusic.entry.MainAbility"            }        ]    }]

forms示例：

"forms": [    {        "name": "Form_Js",        "description": "It's Js Form",        "type": "JS",        "jsComponentName": "card",        "colorMode": "auto",        "isDefault": true,        "updateEnabled": true,        "scheduledUpdateTime": "11:00",        "updateDuration": 1,        "defaultDimension": "2*2",        "supportDimensions": [            "2*2",            "2*4",            "4*4"        ]    },    {        "name": "Form_Java",        "description": "It's Java Form",        "type": "Java",        "colorMode": "auto",        "isDefault": false,        "updateEnabled": true,        "scheduledUpdateTime": "21:05",        "updateDuration": 1,        "defaultDimension": "1*2",        "supportDimensions": [            "1*2"        ],        "landscapeLayouts": [            "$layout:ability_form"        ],        "portraitLayouts": [            "$layout:ability_form"        ],        "formConfigAbility": "ability://com.example.myapplication.fa/.MainAbility",        "metaData": {            "customizeData": [                {                    "name": "originWidgetName",                    "value": "com.huawei.weather.testWidget"                }            ]        }    }]

HAP与HAR的配置文件的合并

如果应用模块中调用了HAR，在编译构建HAP时，需要将HAP的“config.json”文件与一个或多个HAR的“config.json”文件，合并为一个“config.json”文件。在合并过程中，不同文件的同一个标签的取值可能发生冲突，此时，需要通过配置mergeRule来解决冲突。

配置文件合并规则

HAP与HAR的“config.json”文件合并时，需要将HAR的配置信息全部合并到HAP的配置文件。合并规则参见表15。

HAP的优先级总是高于HAR。当HAP依赖于多个HAR时，先加载的HAR的优先级高于后加载的HAR，按照HAR的加载顺序依次合并到HAP文件。

mergeRule对象的使用

mergeRule通常在HAP的“config.json”文件中使用，可以在“abilities”、“defPermissions”、 “reqPermissions”、“js”等属性中添加。不同属性的合并策略，详见表16。

注意

• HAR配置文件中不能包含“action.system.home”和“entity.system.home”配置项，否则会导致编译报错。
• abilities对象中“name”字段的取值，必须为完整的类名，否则会导致合并出错。

mergeRule的使用示例：

在下面的示例中，HAP与HAR中的Ability的“name”取值相同，需要对两者“config.json”文件中的Ability进行合并。由于两个文件中的部分字段（例如“launchType”）存在冲突，需要在HAP的“abilities”标签下添加“mergeRule”。

1. 合并前HAP的

   “config.json”

   文件，如下所示：

   其中，remove表示合并后需要移除的子标签，replace表示合并后需要替换的子标签（HAP替换HAR）。

   "abilities": [    {        "mergeRule": {            "remove": ["orientation"],            "replace": ["launchType"]        }        "name": "com.harmony.myapplication.entry.MainAbility",        "type": "page",        "launchType": "standard",        "visible": false    }],
   

2. 合并前HAR的

   “config.json”

   文件，如下所示：

   "abilities": [    {        "name": "com.harmony.myapplication.entry.MainAbility",        "type": "page",        "launchType": "singleton",        "orientation": "portrait",        "visible": false    }],
   

3. 将上述两个

   “config.json”

   文件按照mergeRule进行合并，处理完成后mergeRule字段也会被移除。合并后的结果文件，如下所示：

   "abilities": [    {        "name": "com.harmony.myapplication.entry.MainAbility",        "type": "page",        "launchType": "standard",        "visible": false    }],
   

bundleName占位符的使用

HAR的“config.json”文件中多处需要使用包名，例如自定义权限、自定义action等场景，但是包名只有当HAR编译到HAP时才能确定下来。在编译之前，HAR中的包名可以采用占位符来表示，采用{bundleName}形式。

支持bundleName占位符的标签有actions、entities、permissions、readPermission、writePermission、defPermissions.name、uri。

使用示例：

1. HAR中自定义action时，使用{bundleName}来代替包名。如下所示：

   "skills": [    {        "actions": [            "{bundleName}.ACTION_PLAY"        ],        "entities": [            "{bundleName}.ENTITY_PLAY"        ],    }],
   

2. 将HAP编译到bundleName为

   “com.huawei.hiworld”

   的HAP包后，原来的{bundleName}将被替换为HAP的实际包名。替换后的结果如下所示：

   "app": {    "bundleName": "com.huawei.hiworld",    ……},"module": {    "abilities": [        {            "skills": [                {                    "actions": [                        "com.huawei.hiworld.ACTION_PLAY"                    ],                    "entities": [                        "com.huawei.hiworld.ENTITY_PLAY"                    ],                }            ],