HarmonyOS（鸿蒙）——config.json详解

李子捌
1,909 阅读4分钟

「这是我参与11月更文挑战的第6天，活动详情查看：2021最后一次更文挑战」

一、简介

1.1 结构

应用的每个HAP的根目录下都存在一个“config.json”配置文件。文件内容主要涵盖以下三个方面：

如下是一个简单的HarmonyOS应用程序创建后所看到的应用代码结构，entry -> src -> main -> config.json文件。其中三个模块分别为app、deviceConfig、module（我这里展示的三块是缩放后的内容。）

2.1 编辑视图

config.json文件采用JSON文件格式，其每一项都包含都由一个属性和值组成。其中属性值不分先后顺序，但是不能重复出现，必须唯一。值为JSON的基本数据类型。HarmonyOS的DevEco Studio支持两种编辑config.json的方式，分别是代码编辑视图和可视化编辑视图。

代码编辑视图：

可视化编辑视图：

二、配置文件详细介绍

配置文件由app、deviceConfig、module三部分组成，三者均必须存在。以下会根据上面的HarmonyOS的基础HelloWorld程序分析一个最基础的config.json配置文件，如果需要十分详细的介绍，请直接去HarmonyOS的官网进行查阅，以下是直达的官网地址：

developer.harmonyos.com/cn/docs/doc…

2.1 app

app对象包含应用的全局配置信息，HarmonyOS的基础HelloWorld程序的config.json配置文件中的app部分如下所示：

 "app": {
    "bundleName": "com.example.demo",
    "vendor": "example",
    "version": {
      "code": 1000000,
      "name": "1.0.0"
    }
  }
属性名称子属性名称含义数据类型是否可缺省
bundleName-表示应用的包名，用于标识应用的唯一性。字符串否
vendor-表示对应用开发厂商的描述。字符串长度不超过255字节。字符串可缺省，缺省值为空。
version表示应用的版本信息。对象否
code表示应用的版本号，仅用于HarmonyOS管理该应用，不对应用的终端用户呈现。数值否
name表示应用的版本号，用于向应用的终端用户呈现。小于127个字节。字符串否

2.2 deviceConfig

deviceConfig包含在具体设备上的应用配置信息，可以包含default、phone、tablet、tv、car、wearable、liteWearable和smartVision等属性。default标签内的配置是适用于所有设备通用，其他设备类型如果有特殊的需求，则需要在该设备类型的标签下进行配置。HarmonyOS的基础HelloWorld程序的config.json配置文件中的deviceConfig部分如下所示：

"deviceConfig": {}

2.3 module

module对象包含HAP包的配置信息，包含每个Ability必须定义的基本属性（如包名、类名、类型以及Ability提供的能力），以及应用访问系统或其他应用受保护部分所需的权限等。HarmonyOS的基础HelloWorld程序的config.json配置文件中的module部分如下所示：

"module": {
    "package": "com.example.demo",
    "name": ".MyApplication",
    "mainAbility": "com.example.demo.MainAbility",
    "deviceType": [
      "phone"
    ],
    "distro": {
      "deliveryWithInstall": true,
      "moduleName": "entry",
      "moduleType": "entry",
      "installationFree": true
    },
    "abilities": [
      {
        "skills": [
          {
            "entities": [
              "entity.system.home"
            ],
            "actions": [
              "action.system.home"
            ]
          }
        ],
        "orientation": "unspecified",
        "name": "com.example.demo.MainAbility",
        "icon": "$media:icon",
        "description": "$string:mainability_description",
        "label": "$string:entry_MainAbility",
        "type": "page",
        "launchType": "standard"
      }
    ]
  }
属性名称子属性名称含义数据类型是否可缺省
package-表示HAP的包结构名称，在应用内应保证唯一性。采用反向域名格式（建议与HAP的工程目录保持一致）。字符串长度不超过127字节。字符串否
name-表示HAP的类名。采用反向域名方式表示，前缀需要与同级的package标签指定的包名一致，也可采用“.”开头的命名方式。字符串长度不超过255字节。字符串否
mainAbility-表示HAP包的入口ability名称。字符串page类型的Ability为否
deviceType-表示允许Ability运行的设备类型。系统预定义的设备类型包括：phone（手机）、tablet（平板）、tv（智慧屏）、car（车机）、wearable（智能穿戴）、liteWearable（轻量级智能穿戴）等。字符串数组否
distro-表示HAP发布的具体描述对象否
deliveryWithInstall表示当前HAP是否支持随应用安装。- true：支持随应用安装。 false：不支持随应用安装。布尔类型否
moduleNameHAP的名称字符串否
moduleType表示当前HAP的类型，包括两种类型：entry和feature字符串否
installationFree表示当前该FA是否支持免安装特性。- true：表示支持免安装特性，且符合免安装约束。 false：表示不支持免安装特性。布尔类型entry.hap可缺省，feature.hap不可缺省。
abilities-表示当前模块内的所有Ability。采用对象数组格式，其中每个元素表示一个Ability对象。对象数组是
skills表示Ability能够接收的Intent的特征。对象数组是
orientation表示该Ability的显示模式。该标签仅适用于page类型的Ability。取值范围如下：- unspecified：由系统自动判断显示方向。 landscape：横屏模式。- portrait：竖屏模式。 followRecent：跟随栈中最近的应用。字符串是
name表示Ability名称。取值可采用反向域名方式表示，由包名和类名组成，如“com.example.myapplication.MainAbility”；也可采用“.”开头的类名方式表示，如“.MainAbility”。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。字符串否
icon表示Ability图标资源文件的索引。取值示例：$media:ability_icon。如果在该Ability的“skills”属性中，“actions”的取值包含 “action.system.home”，“entities”取值中包含“entity.system.home”，则该Ability的icon将同时作为应用的icon。如果存在多个符合条件的Ability，则取位置靠前的Ability的icon作为应用的icon。字符串是
description表示对Ability的描述。取值可以是描述性内容，也可以是对描述性内容的资源索引，以支持多语言。字符串是
label表示Ability对用户显示的名称。取值可以是Ability名称，也可以是对该名称的资源索引，以支持多语言。字符串是
type表示Ability的类型。取值范围如下：- page：表示基于Page模板开发的FA，用于提供与用户交互的能力。 service：表示基于Service模板开发的PA，用于提供后台运行任务的能力。- data：表示基于Data模板开发的PA，用于对外部提供统一的数据访问抽象。 CA：表示支持其他应用以窗口方式调起该Ability。字符串否
launchType表示Ability的启动模式，支持“standard”、“singleMission”和“singleton”三种模式：- standard：表示该Ability可以有多实例。“standard”模式适用于大多数应用场景。 singleMission：表示此Ability在每个任务栈中只能有一个实例。- singleton：表示该Ability在所有任务栈中仅可以有一个实例。例如，具有全局唯一性的呼叫来电界面即采用“singleton”模式。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。字符串否

abilities -> skills

属性名称子属性名称含义数据类型是否可缺省
skills-表示Ability能够接收的Intent的特征对象数组是
entities表示能够接收的Intent的Ability的类别（如视频、桌面应用等），可以包含一个或多个entity。字符串数组是
actions表示能够接收的Intent的action值，可以包含一个或多个action。字符串数组是
avatar
文章
阅读
粉丝