app.json5 Configuration File

Configuration File Example

This topic gives an overview of the app.json5 configuration file. To start with, let’s go through an example of what this file contains.

{
  "app": {
    "bundleName": "com.application.myapplication",
    "vendor": "example",
    "versionCode": 1000000,
    "versionName": "1.0.0",
    "icon": "$media:layered-image",
    "label": "$string:app_name",
    "description": "$string:description_application",
    "minAPIVersion": 9,
    "targetAPIVersion": 9,
    "apiReleaseType": "Release",
    "debug": false,
    "car": {
      "minAPIVersion": 8
    },
    "targetBundleName": "com.application.test",
    "targetPriority": 50,
    "appEnvironments": [
      {
        "name":"name1",
        "value": "value1"
      }
    ],
    "maxChildProcess": 5,
    "multiAppMode": {
      "multiAppModeType": "multiInstance",
      "maxCount": 5
    },
    "hwasanEnabled": false,
    "ubsanEnabled": false,
    "cloudFileSyncEnabled": false,
    "configuration": "$profile:configuration",
    "assetAccessGroups": [
      "com.ohos.photos",
      "com.ohos.screenshot",
      "com.ohos.note"
    ]
  },
}

Tags in the Configuration File

As shown above, the app.json5 file contains several tags.

Table 1 Tags in the app.json5 file

icon

Application icon and the index to the layered icon configuration files.

The configuration of layered icons is as follows:

1. Place the foreground and background resources of the icon in the AppScope/resources/base/media directory, or use the default foreground and background resources in the directory.

2. The media directory contains the layered-image.json file, which references foreground and background resources. For details, see Icon Resource Specifications.

Example of the layered-image.json file:

{
  "layered-image":
    {
      "background":"$media:background," // Background resource
      "foreground":"$media:foreground" // Foreground resource
    }    
}

Example of the icon structure:

{
  "app":{
    "icon":"$media:layered-image"
  }
}

appEnvironments

The appEnvironments tag represents the application environment variables. Applications may depend on some third-party libraries, which may use some custom environment variables. To avoid changing the implementation logic of the third-party libraries, you can set custom environment variables in the project configuration file for use during application running.

Table 2 appEnvironments

Example of the appEnvironments structure:

{
  "app": {
    "appEnvironments": [
      {
        "name":"name1",
        "value": "value1"
      }
    ]
  }
}

multiAppMode

The multiAppMode tag represents the multi-app mode of the application.

Table 3 multiAppMode

Example of the multiAppMode structure:

{
  "app": {
    "multiAppMode": {
      "multiAppModeType": "appClone",
      "maxCount": 5
    }
  }
}

configuration

This tag is a profile file resource that used to specify the configuration file that describes the application font size changes with the system.

Example of the configuration structure:

{
  "app": {
    "configuration": "$profile:configuration"  
  }
}

Define the configuration.json file under AppScope/resources/base/profile in the development view. The file name (configuration in this example) can be customized, but must be consistent with the information specified by the configuration tag. The file lists the attributes that enable the application font size to change with the system.

Table 4 configuration

Example of the configuration structure:

{
  "configuration": {
    "fontSizeScale": "followSystem",
    "fontSizeMaxScale": "3.2"
  }
}

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Quick Start

harmony 鸿蒙Creating an Application Clone

harmony 鸿蒙Structure of the app Tag

harmony 鸿蒙Overview of Application Configuration Files in FA Model

harmony 鸿蒙Overview of Application Configuration Files in Stage Model

harmony 鸿蒙Application Installation, Uninstall, and Update

harmony 鸿蒙Application Package Overview

harmony 鸿蒙Application Package Structure in FA Model

harmony 鸿蒙Application Package Structure in Stage Model

harmony 鸿蒙ArkTS Coding Style Guide