HarmonyOS应用配置文件config.json 原创 精华

  一个工程中的配置文件有两种，一种是主模块entry的配置文件config.json，另一种是应用程序环境的配置文件build.gradle。其中config.json至少有2个，一个位于entry下，另一个位于应用根目录下。每增加一个feature模块，也会相应增加一个build.gradle文件。

1. config.json

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

   “config.json”由“app”、“deviceConfig”和“module”三个部分组成，各部分含义如下表所示。

属性名称	含义	数据类型	是否可缺省
app	表示应用的全局配置信息。同一个应用的不同HAP包的“app”配置必须保持一致。	对象	否
deviceConfig	表示应用在具体设备上的配置信息。	对象	否
module	表示HAP包的配置信息。该标签下的配置只对当前HAP包生效。	对象	否

  （1）app属性对象的内部结构说明如下：

​ bundleName: 表示应用的包名，用于标识应用的唯一性。包名是由字母、数字、下划线（_）和点号（.）组成的字符串，必须以字母开头。支持的字符串长度为7~127字节。通常采用反域名形式表示。

​ vendor: 表示对应用开发厂商的描述。字符串长度不超过255字节。

​ version: 表示应用的版本信息。

​ apiVersion：（可不设置）表示应用依赖的HarmonyOS的API版本。compatible表示应用运行需要的API最小版本。取值为大于零的整数。（一旦添加了APIVersion属性，则该子属性不可缺省）。target表示应用运行需要的API目标版本。取值为大于零的整数。可缺省。releaseType表示应用运行需要的API目标版本的类型。取值为“CanaryN”（受限发布的版本）、“BetaN”（公开发布的Beta版本）或者“Release”（公开发布的正式版本），其中，N代表大于零的整数。

app属性定义示例如下所示：

"app": {

​    "bundleName": "com.huawei.hiworld.example", 

​    "vendor": "huawei", 

​    "version": {

​        "code": 2, 

​        "name": "2.0"

​    },

​    "apiVersion": {

​        "compatible": 3, 

​        "target": 3,

​        "releaseType": "Beta1"

​    }

}

  （2）deviceConfig属性对象设置包含在具体设备上的应用配置信息，可以包含default、phone、tablet、tv、car、wearable、liteWearable和smartVision等属性。default标签内的配置是适用于所有设备通用，其他设备类型如果有特殊的需求，则需要在该设备类型的标签下通过default（所有设备）、phone（手机）、tablet（平板）、tv（智慧屏）、car（车机）、wearable（智能穿戴设备）、liteWearable（轻量级智能穿戴设备）和smartVision（智能摄像头）等子属性对象进行配置。如果没有对设备的特殊需求，可以设置该属性对象为空，即"deviceConfig": {}。deviceConfig属性对象的内部属性结构说明如下：

属性名称	含义	数据类型	是否可缺省
default	表示所有设备通用的应用配置信息。	对象	否
phone	表示手机类设备的应用信息配置。	对象	可缺省，缺省为空
tablet	表示平板的应用配置信息。	对象	可缺省，缺省为空。
tv	表示智慧屏特有的应用配置信息。	对象	可缺省，缺省为空。
car	表示车机特有的应用配置信息。	对象	可缺省，缺省为空。
wearable	表示智能穿戴特有的应用配置信息。	对象	可缺省
liteWearable	表示轻量级智能穿戴特有的应用配置信息。	对象	可缺省
smartVision	表示智能摄像头特有的应用配置信息。	对象	可缺省

  default、phone、tablet、tv、car、wearable、liteWearable和smartVision等对象的内部结构说明如下所示：

属性名称	含义	数据类型	是否可缺省
jointUserId	表示应用的共享userid。 通常情况下，不同的应用运行在不同的进程中，应用的资源是无法共享。如果开发者的多个应用之间需要共享资源，则可以通过相同的jointUserId值实现，前提是这些应用的签名相同。 该标签仅对系统应用生效，且仅适用于手机、平板、智慧屏、车机、智能穿戴。 该字段在API Version 3及更高版本不再支持配置。	字符串	可缺省，缺省为空。
process	表示应用或者Ability的进程名。 如果在deviceConfig标签下配置了process标签，则该应用的所有Ability都运行在这个进程中。 如果在abilities标签下也为某个Ability配置了process标签，则该Ability就运行在这个进程中。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。	字符串	可缺省，缺省为应用的软件包名。
supportBackup	表示应用是否支持备份和恢复。如果配置为“false”，则不支持为该应用执行备份或恢复操作。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。	布尔类型	可缺省，缺省为“false”。
compressNativeLibs	表示libs库是否以压缩存储的方式打包到HAP包。如果配置为“false”，则libs库以不压缩的方式存储，HAP包在安装时无需解压libs，运行时会直接从HAP内加载libs库。 该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。	布尔类型	可缺省，缺省为“true”。
network	表示网络安全性配置。该标签允许应用通过配置文件的安全声明来自定义其网络安全，无需修改应用代码。	对象	可缺省，缺省为空。

  其中network对象的内部属性结构说明如下：

属性名称	含义	数据类型	是否可缺省
cleartextTraffic	表示是否允许应用使用明文网络流量（例如，明文HTTP）。 · true：允许应用使用明文流量的请求。 · false：拒绝应用使用明文流量的请求。	布尔类型	可缺省，缺省为“false”。
securityConfig	表示应用的网络安全配置信息。	对象	可缺省，缺省为空。

  securityConfig对象的内部属性结构说明如下：

属性名称	子属性名称	含义	数据类型	是否可缺省
domainSettings	-	表示自定义的网域范围的安全配置，支持多层嵌套，即一个domainSettings对象中允许嵌套更小网域范围的domainSettings对象**。**	对象	可缺省，缺省为空。
cleartextPermitted	表示自定义的网域范围内是否允许明文流量传输。当cleartextTraffic和securityConfig同时存在时，自定义网域是否允许明文流量传输以cleartextPermitted的取值为准。 · true：允许明文流量传输。 · false：拒绝明文流量传输。	布尔类型	否
domains	表示域名配置信息，包含两个参数：subdomains和name。 · subdomains（布尔类型）：表示是否包含子域名。如果为 “true”，此网域规则将与相应网域及所有子网域（包括子网域的子网域）匹配。否则，该规则仅适用于精确匹配项。 · name（字符串）：表示域名名称。	对象数组	否

  deviceConfig属性定义示例如下所示，该示例中主要对应用的进程名、是否支持备份、网络安全进行配置。

"deviceConfig": {

​    "default": {

​        "process": "com.huawei.hiworld.example", 

​        "supportBackup": false,

​        "network": {

​            "cleartextTraffic": true, 

​            "securityConfig": {

​                "domainSettings": {

​                    "cleartextPermitted": true, 

​                    "domains": [

​                        {

​                            "subdomains": true, 

​                            "name": "example.ohos.com"

​                        }

​                    ]

​                }

​            }

​        }

​    }

}

  （3）module属性对象包含HAP包的配置信息，其常用子属性对象及含义说明如下：

  1）mainAbility: 表示HAP包的入口ability名称。

   2）package: 表示HAP的包结构名称，在应用内应保证唯一性。反向域名格式。

   3）name: 表示HAP的类名。采用反向域名方式表示，前缀需要与同级的package标签指定的包名一致，也可采用“.”开头的命名方式。字符串长度不超过255字节。

  4）description: 表示HAP的描述信息。字符串长度不超过255字节。如果字符串超出长度或者需要支持多语言，可以采用资源索引的方式添加描述内容。

  5）supportedModes: 表示应用支持的运行模式。当前只定义了驾驶模式（drive）。该标签仅适用于车机。

  6）deviceType: 表示允许Ability运行的设备类型。系统预定义的设备类型包括：phone（手机）、tablet（平板）、tv（智慧屏）、car（车机）、wearable（智能穿戴）、liteWearable（轻量级智能穿戴）等。

  7）distro: 表示HAP发布的具体描述。

   deliveryWithInstall:表示当前HAP是否支持随应用安装。true：支持随应用安装。false：不支持随应用安装（可能导致最终应用上架应用市场异常）。

   moduleName: 表示当前HAP的名称。

  moduleType: 表示当前HAP的类型，包括两种类型：entry和feature。

  8）abilities: 表示当前模块内的所有Ability的配置信息。采用对象数组格式，其中每个元素表示一个Ability对象。其内部子属性说明如下：

  name：表示Ability名称。取值可采用反向域名方式表示，由包名和类名组成。

  description：表示对Ability的描述。取值可以是描述性内容，也可以是对描述性内容的资源索引，以支持多语言。

  icon：表示Ability图标资源文件的索引。如果在该Ability的“skills”属性中，“actions”的取值包含 “action.system.home”，“entities”取值中包含“entity.system.home”，则该Ability的icon将同时作为应用的icon。如果存在多个符合条件的Ability，则取位置靠前的Ability的icon作为应用的icon。

  label：表示Ability对用户显示的名称。取值可以是Ability名称，也可以是对该名称的资源索引，以支持多语言。如果在该Ability的“skills”属性中，“actions”的取值包含 “action.system.home”，“entities”取值中包含“entity.system.home”，则该Ability的label将同时作为应用的label。如果存在多个符合条件的Ability，则取位置靠前的Ability的label作为应用的label。

  uri：表示Ability的统一资源标识符。格式为：

•   launchType：表示Ability的启动模式，支持“standard”、“singleMission”和“singleton”三种模式：

•   standard：表示该Ability可以有多实例。“standard”模式适用于大多数应用场景。

•   singleMission：表示此Ability在每个任务栈中只能有一个实例。

•   singleton：表示该Ability在所有任务栈中仅可以有一个实例。例如，具有全局唯一性的呼叫来电界面即采用“singleton”模式。

  shortcuts: （可缺省）表示应用的快捷方式信息。采用对象数组格式，其中的每个元素表示一个快捷方式对象。

  visible：表示Ability是否可以被其他应用调用。

• true：可以被其他应用调用。

• false：不能被其他应用调用。

  permissions：表示其他应用的Ability调用此Ability时需要申请的权限。通常采用反向域名格式，取值可以是系统预定义的权限，也可以是开发者自定义的权限。如果是自定义权限，取值必须与“defPermissions”标签中定义的某个权限的“name”标签值一致。

  skills：表示Ability能够接收的Intent的特征。

属性 名称	子属性名称	含义	数据类型	是否可缺省
actions	-	表示能够接收的Intent的action值，可以包含一个或多个action。	字符串数组	可缺省
entities	-	表示能够接收的Intent的Ability的类别（如视频、桌面应用等），可以包含一个或多个entity。可自定义。	字符串数组	可缺省
uris	-	表示能够接收的Intent的uri，可以包含一个或多个uri。	对象数组	可缺省
scheme	表示uri的scheme值。	字符串	不可缺省
host	表示uri的host值。	字符串	可缺省
port	表示uri的port值。	字符串	可缺省
path	表示uri的path值。	字符串	可缺省
type	表示uri的type值。	字符串	可缺省

   deviceCapability：表示Ability运行时要求设备具有的能力，采用字符串数组的格式表示。

  metaData：表示Ability的元信息。

•   调用Ability时调用参数的元信息，例如：参数个数和类型。

•   Ability执行完毕返回值的元信息，例如：返回值个数和类型。

  type：表示Ability的类型。取值范围如下：

•    page：表示基于Page模板开发的FA，用于提供与用户交互的能力。

•   service：表示基于Service模板开发的PA，用于提供后台运行任务的能力。

•   data：表示基于Data模板开发的PA，用于对外部提供统一的数据访问抽象。

•   CA：表示支持其他应用以窗口方式调起该Ability。

  orientation：示该Ability的显示模式。该标签仅适用于page类型的Ability。取值范围如下：

•   unspecified：由系统自动判断显示方向。

•   landscape：横屏模式。

•   portrait：竖屏模式。

•   followRecent：跟随栈中最近的应用。

  backgroundModes：表示后台服务的类型，可以为一个服务配置多个后台服务类型。该标签仅适用于service类型的Ability。取值范围如下：

  dataTransfer：通过网络/对端设备进行数据下载、备份、分享、传输等业务。

•   audioPlayback：音频输出业务。

•   audioRecording：音频输入业务。

•   pictureInPicture：画中画、小窗口播放视频业务。

•   voip：音视频电话、VOIP业务。

•   location：定位、导航业务。

•   bluetoothInteraction：蓝牙扫描、连接、传输业务。

•   wifiInteraction：WLAN扫描、连接、传输业务。

•   screenFetch：录屏、截屏业务。

•   multiDeviceConnection：多设备互联业务。

  readPermission：表示读取Ability的数据所需的权限。该标签仅适用于data类型的Ability。取值为长度不超过255字节的字符串。

  writePermission：表示向Ability写数据所需的权限。该标签仅适用于data类型的Ability。取值为长度不超过255字节的字符串。

  mission：表示Ability指定的任务栈。该标签仅适用于page类型的Ability。默认情况下应用中所有Ability同属一个任务栈。

  targetAbility：表示当前Ability重用的目标Ability。该标签仅适用于page类型的Ability。如果配置了targetAbility属性，则当前Ability（即别名Ability）的属性中仅name、icon、label、visible、permissions、skills生效，其它属性均沿用targetAbility中的属性值。目标Ability必须与别名Ability在同一应用中，且在配置文件中目标Ability必须在别名之前进行声明。

  multiUserShared：表示Ability是否支持多用户状态进行共享，该标签仅适用于data类型的Ability。配置为“true”时，表示在多用户下只有一份存储数据。需要注意的是，该属性会使visible属性失效。

  supportPipMode：表示Ability是否支持用户进入PIP模式（用于在页面最上层悬浮小窗口，俗称“画中画”，常见于视频播放等场景）。该标签仅适用于page类型的Ability。

  formsEnabled：表示Ability是否支持卡片（forms）功能。该标签仅适用于page类型的Ability。

•   true：支持卡片能力。

•   false：不支持卡片能力。

  resizeable：表示Ability是否支持多窗口特性。

  forms：表示服务卡片的属性。该标签仅当“formsEnabled”为“true”时，才能生效。该属性有一系列子属性详细设置卡片的类型、主题样式、外观规格等；

  9）js: （可缺省）表示基于JS UI框架开发的JS模块集合，其中的每个元素代表一个JS模块的信息。

  10）reqPermissions: 表示应用运行时向系统申请的权限。

  11）defPermissions: 表示应用定义的权限。应用调用者必须申请这些权限，才能正常调用该应用。

  12）colorMode:表示应用自身的颜色模式。

•   dark：表示按照深色模式选取资源。

•   light：表示按照浅色模式选取资源。

•   auto：表示跟随系统的颜色模式值选取资源。

  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"

}