HarmonyOS应用配置文件config.json

系统 OpenHarmony
 一个工程中的配置文件有两种,一种是主模块entry的配置文件config.json,另一种是应用程序环境的配置文件build.gradle。

[[417431]]

想了解更多内容,请访问:

51CTO和华为官方合作共建的鸿蒙技术社区

https://harmonyos.51cto.com

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

1.config.json

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

HarmonyOS应用配置文件config.json-鸿蒙HarmonyOS技术社区

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

(1)app属性对象的内部结构说明如下:

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

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

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

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

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

  1. "app": { 
  2.  
  3. ​    "bundleName""com.huawei.hiworld.example",  
  4.  
  5. ​    "vendor""huawei",  
  6.  
  7. ​    "version": { 
  8.  
  9. ​        "code": 2,  
  10.  
  11. ​        "name""2.0" 
  12.  
  13. ​    }, 
  14.  
  15. ​    "apiVersion": { 
  16.  
  17. ​        "compatible": 3,  
  18.  
  19. ​        "target": 3, 
  20.  
  21. ​        "releaseType""Beta1" 
  22.  
  23. ​    } 
  24.  

(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等对象的内部结构说明如下所示:

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

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

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

  1. "deviceConfig": { 
  2.  
  3. ​    "default": { 
  4.  
  5. ​        "process""com.huawei.hiworld.example",  
  6.  
  7. ​        "supportBackup"false
  8.  
  9. ​        "network": { 
  10.  
  11. ​            "cleartextTraffic"true,  
  12.  
  13. ​            "securityConfig": { 
  14.  
  15. ​                "domainSettings": { 
  16.  
  17. ​                    "cleartextPermitted"true,  
  18.  
  19. ​                    "domains": [ 
  20.  
  21. ​                        { 
  22.  
  23. ​                            "subdomains"true,  
  24.  
  25. ​                            "name""example.ohos.com" 
  26.  
  27. ​                        } 
  28.  
  29. ​                    ] 
  30.  
  31. ​                } 
  32.  
  33. ​            } 
  34.  
  35. ​        } 
  36.  
  37. ​    } 
  38.  

(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的统一资源标识符。格式为:

HarmonyOS应用配置文件config.json-鸿蒙HarmonyOS技术社区

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的特征。

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属性对象定义示例如下所示:

  1. "module": { 
  2.  
  3. ​    "mainAbility""MainAbility"
  4.  
  5. ​    "package""com.example.myapplication.entry",  
  6.  
  7. ​    "name"".MyOHOSAbilityPackage",  
  8.  
  9. ​    "description""$string:description_application",  
  10.  
  11. ​    "supportedModes": [ 
  12.  
  13. ​        "drive" 
  14.  
  15. ​    ],  
  16.  
  17. ​    "deviceType": [ 
  18.  
  19. ​        "car" 
  20.  
  21. ​    ],  
  22.  
  23. ​    "distro": { 
  24.  
  25. ​        "deliveryWithInstall"true,  
  26.  
  27. ​        "moduleName""ohos_entry",  
  28.  
  29. ​        "moduleType""entry" 
  30.  
  31. ​    },  
  32.  
  33. ​    "abilities": [ 
  34.  
  35. ​        ... 
  36.  
  37. ​    ],  
  38.  
  39. ​    "shortcuts": [ 
  40.  
  41. ​        ... 
  42.  
  43. ​    ], 
  44.  
  45. ​    "js": [ 
  46.  
  47. ​        ... 
  48.  
  49. ​    ],  
  50.  
  51. ​    "reqPermissions": [ 
  52.  
  53. ​        ... 
  54.  
  55. ​    ],  
  56.  
  57. ​    "defPermissions": [ 
  58.  
  59. ​        ... 
  60.  
  61. ​    ], 
  62.  
  63. ​    "colorMode""light" 
  64.  

想了解更多内容,请访问:

51CTO和华为官方合作共建的鸿蒙技术社区

https://harmonyos.51cto.com

 

责任编辑:jianghua 来源: 鸿蒙社区
相关推荐

2021-07-13 05:47:40

GroovyJSON软件开发

2023-04-07 09:20:55

2010-02-24 14:10:54

WCF修改App.co

2015-06-17 14:18:50

ASP.NET

2009-07-29 14:23:08

ASP.NET配置文件

2011-04-19 14:35:58

ASP.NETWeb.config

2023-08-07 15:18:29

游戏开发鸿蒙Arkts

2010-03-18 18:17:01

Python 配置文件

2011-09-08 16:07:13

Widget配置文件

2010-02-23 14:17:20

WCF配置文件

2009-09-14 09:17:43

.settings配置

2022-01-11 17:23:12

配置Node.jsNode

2022-05-20 07:36:02

LiveTerm工具

2011-01-13 16:27:26

Linux配置文件

2011-01-19 14:00:21

2022-12-26 11:24:28

鸿蒙Stage模型

2010-12-28 16:35:32

Outlook 配置文

2023-08-04 08:19:02

2010-03-29 10:26:06

Nginx配置文件

2009-06-23 18:19:32

单元测试Hibernate配置
点赞
收藏

51CTO技术栈公众号