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

我不是女神ヾ 2022-09-02 04:05 478阅读 0赞

**目录**

一、简介

1.1 结构

1.2 编辑视图

二、配置文件详细介绍

2.1 app

2.2 deviceConfig

2.3 module

三、精选好文

--------------------

## 一、简介 ##

### 1.1 结构 ###

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

![config.json.png][]

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

###  ###

### 1.2 编辑视图 ###

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

![image.png][image.png 1]

**可视化编辑视图：**

![image.png][image.png 2]

##  ##

## 二、配置文件详细介绍 ##

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

> [https://developer.harmonyos.com/cn/docs/documentation/doc-guides/basic-config-file-elements-0000000000034463][https_developer.harmonyos.com_cn_docs_documentation_doc-guides_basic-config-file-elements-0000000000034463]

### 2.1 app ###

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

1 "app": {
    2    "bundleName": "com.example.demo",
    3    "vendor": "example",
    4    "version": {
    5      "code": 1000000,
    6      "name": "1.0.0"
    7    }
    8  }

<table> 
 <thead> 
 <tr> 
 <th>属性名称</th> 
 <th>子属性名称</th> 
 <th>含义</th> 
 <th>数据类型</th> 
 <th>是否可缺省</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>bundleName</td> 
 <td>-</td> 
 <td>表示应用的包名，用于标识应用的唯一性。</td> 
 <td>字符串</td> 
 <td>否</td> 
 </tr> 
 <tr> 
 <td>vendor</td> 
 <td>-</td> 
 <td>表示对应用开发厂商的描述。字符串长度不超过255字节。</td> 
 <td>字符串</td> 
 <td>可缺省，缺省值为空。</td> 
 </tr> 
 <tr> 
 <td>version</td> 
 <td>-</td> 
 <td>表示应用的版本信息。</td> 
 <td>对象</td> 
 <td>否</td> 
 </tr> 
 <tr> 
 <td></td> 
 <td>code</td> 
 <td>表示应用的版本号，仅用于HarmonyOS管理该应用，不对应用的终端用户呈现。 | 数值 | 否</td> 
 <td>数值</td> 
 <td>否</td> 
 </tr> 
 <tr> 
 <td></td> 
 <td>name</td> 
 <td>表示应用的版本号，用于向应用的终端用户呈现。小于127个字节。</td> 
 <td>字符串</td> 
 <td>否</td> 
 </tr> 
 </tbody> 
</table>

### 2.2 deviceConfig ###

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

1"deviceConfig": {}

### 2.3 module ###

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

1"module": {
     2    "package": "com.example.demo",
     3    "name": ".MyApplication",
     4    "mainAbility": "com.example.demo.MainAbility",
     5    "deviceType": [
     6      "phone"
     7    ],
     8    "distro": {
     9      "deliveryWithInstall": true,
    10      "moduleName": "entry",
    11      "moduleType": "entry",
    12      "installationFree": true
    13    },
    14    "abilities": [
    15      {
    16        "skills": [
    17          {
    18            "entities": [
    19              "entity.system.home"
    20            ],
    21            "actions": [
    22              "action.system.home"
    23            ]
    24          }
    25        ],
    26        "orientation": "unspecified",
    27        "name": "com.example.demo.MainAbility",
    28        "icon": "$media:icon",
    29        "description": "$string:mainability_description",
    30        "label": "$string:entry_MainAbility",
    31        "type": "page",
    32        "launchType": "standard"
    33      }
    34    ]
    35  }

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

**abilities -> skills**

<table> 
 <thead> 
 <tr> 
 <th>属性名称</th> 
 <th>子属性名称</th> 
 <th>含义</th> 
 <th>数据类型</th> 
 <th>是否可缺省</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>skills</td> 
 <td>-</td> 
 <td>表示Ability能够接收的Intent的特征</td> 
 <td>对象数组</td> 
 <td>是</td> 
 </tr> 
 <tr> 
 <td></td> 
 <td>entities</td> 
 <td>表示能够接收的Intent的Ability的类别（如视频、桌面应用等），可以包含一个或多个entity。</td> 
 <td>字符串数组</td> 
 <td>是</td> 
 </tr> 
 <tr> 
 <td></td> 
 <td>actions</td> 
 <td>表示能够接收的Intent的action值，可以包含一个或多个action。</td> 
 <td>字符串数组</td> 
 <td>是</td> 
 </tr> 
 </tbody> 
</table>

## 三、精选好文 ##

[HarmonyOS（鸿蒙）DevEco Studio开发环境搭建][HarmonyOS_DevEco Studio]

[HarmonyOS（鸿蒙）开发一文入门][HarmonyOS]

[两个案例五分钟轻松入门Harmony（鸿蒙）开发][Harmony]

[armonyOS与Android的全面对比][armonyOS_Android]

[HarmonyOS（鸿蒙）全网最全资源汇总，吐血整理，赶紧收藏！][HarmonyOS 1]

[HarmonyOS（鸿蒙）—— Ability与页面][HarmonyOS_ Ability]

[config.json.png]: /images/20220829/b8432854da684d31ae23102ab2c7939c.png
[image.png]: /images/20220829/e6f8800aa07946b8beb4462828d4c8ee.png
[image.png 1]: /images/20220829/8136294599cb45e68dec67dae9d02af1.png
[image.png 2]: /images/20220829/94960da0da784e9c90635d738107c893.png
[https_developer.harmonyos.com_cn_docs_documentation_doc-guides_basic-config-file-elements-0000000000034463]: https://developer.harmonyos.com/cn/docs/documentation/doc-guides/basic-config-file-elements-0000000000034463
[HarmonyOS_DevEco Studio]: https://blog.csdn.net/qq_41125219/article/details/118980608?spm=1001.2014.3001.5501
[HarmonyOS]: https://blog.csdn.net/qq_41125219/article/details/119012509?spm=1001.2014.3001.5501
[Harmony]: https://blog.csdn.net/qq_41125219/article/details/119090348?spm=1001.2014.3001.5501
[armonyOS_Android]: https://blog.csdn.net/qq_41125219/article/details/119066740?spm=1001.2014.3001.5501
[HarmonyOS 1]: https://blog.csdn.net/qq_41125219/article/details/119121522?spm=1001.2014.3001.5501
[HarmonyOS_ Ability]: https://blog.csdn.net/qq_41125219/article/details/119192989?spm=1001.2014.3001.5501