【HarmonyOS之旅】HarmonyOS开发基础知识(一)

目录

1 -> 应用基础知识

1.1 -> 用户应用程序

1.2 -> 用户应用程序包结构

1.3 -> Ability

1.4 -> 库文件

1.5 -> 资源文件

1.6 -> 配置文件

1.7 -> pack.info

1.8 -> HAR

2 -> 配置文件简介

2.1 -> 配置文件的组成

3 -> 配置文件说明(JS/ArkTS)

3.1 -> 配置文件的内部结构

3.2 -> app对象的内部结构

3.3 -> deviceConfig对象的内部结构

3.4 -> module对象的内部结构

1 -> 应用基础知识

1.1 -> 用户应用程序

用户应用程序泛指运行在设备的操作系统之上，为用户提供特定服务的程序，简称“应用”。

在HarmonyOS上运行的应用，有两种形态：

• 传统方式的需要安装的应用。
• 提供特定功能，免安装的应用(即元服务)。

在HarmonyOS文档中，如无特殊说明，“应用”所指代的对象包括上述两种形态。

1.2 -> 用户应用程序包结构

HarmonyOS的用户应用程序包以APP Pack(Application Package)形式发布，它是由一个或多个HAP(HarmonyOS Ability Package)以及描述每个HAP属性的pack.info组成。HAP是Ability的部署包，HarmonyOS应用代码围绕Ability组件展开。

一个HAP是由代码、资源、第三方库及应用配置文件组成的模块包，可分为entry和feature两种模块类型。

• entry：应用的主模块。一个APP中，对于同一设备类型，可以有一个或多个entry类型的HAP，来支持该设备类型中不同规格(如API版本、屏幕规格等)的具体设备。如果同一设备类型存在多个entry模块，则必须配置distroFilter分发规则，使得应用市场在做应用的云端分发时，对该设备类型下不同规格的设备进行精确分发。
• feature：应用的动态特性模块。一个APP可以包含一个或多个feature类型的HAP，也可以不含。只有包含Ability的HAP才能够独立运行。

1.3 -> Ability

Ability是应用所具备的能力的抽象，一个应用可以包含一个或多个Ability。Ability分为两种类型：FA(Feature Ability)和PA(Particle Ability)。FA/PA是应用的基本组成单元，能够实现特定的业务功能。FA有UI界面，而PA无UI界面。

1.4 -> 库文件

库文件是应用依赖的第三方代码(例如so、jar、bin、har等二进制文件)，存放在libs目录。

1.5 -> 资源文件

应用的资源文件(字符串、图片、音频等)存放于resources目录下，便于开发者使用和维护，详见资源文件的分类。

1.6 -> 配置文件

配置文件(config.json)是应用的Ability信息，用于声明应用的Ability，以及应用所需权限等信息，详见应用配置文件。

1.7 -> pack.info

描述应用软件包中每个HAP的属性，由IDE编译生成，应用市场根据该文件进行拆包和HAP的分类存储。HAP的具体属性包括：

• delivery-with-install：表示该HAP是否支持随应用安装。“true”表示支持随应用安装；“false”表示不支持随应用安装。
• name：HAP文件名。
• module-type：模块类型，entry或feature。
• device-type：表示支持该HAP运行的设备类型。

1.8 -> HAR

HAR(HarmonyOS Ability Resources)可以提供构建应用所需的所有内容，包括源代码、资源文件和config.json文件。HAR不同于HAP，HAR不能独立安装运行在设备上，只能作为应用模块的依赖项被引用。

2 -> 配置文件简介

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

• 应用的全局配置信息，包含应用的包名、生产厂商、版本号等基本信息。
• 应用在具体设备上的配置信息，包含应用的备份恢复、网络安全等能力。
• HAP包的配置信息，包含每个Ability必须定义的基本属性(如包名、类名、类型以及Ability提供的能力)，以及应用访问系统或其他应用受保护部分所需的权限等。

2.1 -> 配置文件的组成

配置文件“config.json”采用JSON文件格式，其中包含了一系列配置项，每个配置项由属性和值两部分构成：

• 属性：属性出现顺序不分先后，且每个属性最多只允许出现一次。
• 值：每个属性的值为JSON的基本数据类型(数值、字符串、布尔值、数组、对象或者null类型)。

3 -> 配置文件说明(JS/ArkTS)

在应用开发的工程中，需要在config.json配置文件中对应用的包结构进行声明。

3.1 -> 配置文件的内部结构

“config.json”由app，deviceConfig和module三个部分组成，缺一不可。

config.json示例：

{
  "app": {
    "bundleName": "com.example.myapplication",
    "vendor": "example",
    "version": {
      "code": 1,
      "name": "1.0"
    },
    "apiVersion": {
      "compatible": 4,
      "target": 5,
      "releaseType": "Beta1"
    }
  },
  "deviceConfig": {},
  "module": {
    "package": "com.example.myapplication.entrymodule",
    "name": ".MyApplication",
    "deviceType": [
      "default"
    ],
    "distro": {
      "moduleName": "entry",
      "moduleType": "entry"
    },
    "abilities": [
      {
        "skills": [
          {
            "entities": [
              "entity.system.home"
            ],
            "actions": [
              "action.system.home"
            ]
          }
        ],
        "name": "com.example.myapplication.entrymodule.MainAbility",
        "icon": "$media:icon",
        "description": "$string:mainability_description",
        "label": "$string:app_name",
        "type": "page",
        "launchType": "standard"
      }
    ],
    "js": [
      {
        "pages": [
          "pages/index/index"
        ],
        "name": "default",
        "window": {
          "designWidth": 720,
          "autoDesignWidth": false
        }
      }
    ]
  }
}

3.2 -> app对象的内部结构

app对象包含应用全局配置信息。

app实例：

"app": {
    "bundleName": "com.example.myapplication",
    "vendor": "example",
    "version": {
      "code": 1,
      "name": "1.0"
    },
    "apiVersion": {
      "compatible": 4,
      "target": 5,
      "releaseType": "Beta1"
    }
  }

3.3 -> deviceConfig对象的内部结构

deviceConfig包含设备上的应用配置信息，可以包含default、phone、tablet、tv、car、wearable等属性。default标签内的配置是适用于所有通用设备，其他设备类型如果有特殊的需求，则需要在该设备类型的标签下进行配置。

deviceConfig示例：

"deviceConfig": {
    "default": {
        "process": "com.example.test.example",
        "supportBackup": false,
        "network": {
            "cleartextTraffic": true,
            "securityConfig": {
                "domainSettings": {
                    "cleartextPermitted": true,
                    "domains": [
                        {
                            "subdomains": true,
                            "name": "example.ohos.com"
                        }
                    ]
                }
            }
        }
    }
}

3.4 -> module对象的内部结构

module对象包含HAP包的配置信息。

module示例：

"module": {
    "mainAbility": "MainAbility",
    "package": "com.example.myapplication.entry",
    "name": ".MyOHOSAbilityPackage",
    "description": "$string:description_application",
    "supportModes": [
        "drive"
    ],
    "deviceType": [
        "default"
    ],
    "distro": {
        "moduleName": "ohos_entry",
        "moduleType": "entry"
    },
    "abilities": [
        ...
    ],
    "shortcuts": [
        ...
    ],
    "js": [
        ...
    ],
    "reqPermissions": [
        ...
    ],
    "colorMode": "light"
}

distro示例：

"distro": {
    "moduleName": "ohos_entry",
    "moduleType": "entry",
    "installationFree": true,
    "deliveryWithInstall": true
}

metaData示例：

"metaData": {
    "parameters" : [{
        "name" : "string",
        "type" : "Float",
        "description" : "$string:parameters_description"
    }],
    "results" : [{
        "name" : "string",
        "type" : "Float",
        "description" : "$string:results_description"
    }],
    "customizeData" : [{
        "name" : "string",
        "value" : "string",
        "extra" : "$string:customizeData_description"
    }]
}

abilities示例：

"abilities": [
    {
        "name": ".MainAbility",
        "description": "test main ability",
        "icon": "$media:ic_launcher",
        "label": "$media:example",
        "launchType": "standard",
        "orientation": "unspecified",
        "permissions": [
        ], 
        "visible": true,
        "skills": [
            {
                "actions": [
                    "action.system.home"
                ],
                "entities": [
                    "entity.system.home"
                ]
            }
        ],
        "configChanges": [
            "locale", 
            "layout", 
            "fontSize", 
            "orientation"
        ], 
        "type": "page"
    },
    {
        "name": ".PlayService",
        "description": "example play ability",
        "icon": "$media:ic_launcher",
        "label": "$media:example",
        "launchType": "standard",
        "orientation": "unspecified",
        "visible": false,
        "skills": [
            {
                "actions": [
                    "action.play.music",
                    "action.stop.music"
                ],
                "entities": [
                    "entity.audio"
                ]
            }
        ],
        "type": "service",
        "backgroundModes": [
            "audioPlayback"
        ]
    },
    {
        "name": ".UserADataAbility",
        "type": "data",
        "uri": "dataability://com.example.world.test.UserADataAbility",
        "visible": true
    }
]

skills示例：

"skills": [
    {
        "actions": [
            "action.system.home"
        ], 
        "entities": [
            "entity.system.home"
        ],
        "uris": [
            {
                 "scheme": "http",
                 "host": "www.example.com",
                 "port": "8080",
                 "path": "query/student/name",
                 "type": "text/*"
             }
         ]
    }
]

js示例：

"js": [
    {
        "name": "default", 
        "pages": [            
            "pages/index/index",
            "pages/detail/detail"
        ],         
        "window": {
            "designWidth": 720,
            "autoDesignWidth": false
        },
        "type": "form"
    }
]

shortcuts示例：

"shortcuts": [
    {
        "shortcutId": "id",
        "label": "$string:shortcut",
        "intents": [
            {
                "targetBundle": "com.example.world.test",
                "targetClass": "com.example.world.test.entry.MainAbility"
            }
        ]
    }
]

forms示例：

"forms": [
    {
        "name": "Form_Js",
        "description": "It's Js Form",
        "type": "JS",
        "jsComponentName": "card",
        "colorMode": "auto",
        "isDefault": true,
        "updateEnabled": true,
        "scheduledUpdateTime": "11:00",
        "updateDuration": 1,
        "defaultDimension": "2*2",
        "supportDimensions": [
            "2*2",
            "2*4",
            "4*4"
        ]
    },
    {
        "name": "Form_Js",
        "description": "It's JS Form",
        "type": "Js",
        "colorMode": "auto",
        "isDefault": false,
        "updateEnabled": true,
        "scheduledUpdateTime": "21:05",
        "updateDuration": 1,
        "defaultDimension": "1*2",
        "supportDimensions": [
            "1*2"
        ],
        "landscapeLayouts": [
            "$layout:ability_form"
        ],
        "portraitLayouts": [
            "$layout:ability_form"
        ],
        "formConfigAbility": "ability://com.example.myapplication.fa/.MainAbility",
        "metaData": {
            "customizeData": [
                {
                    "name": "originWidgetName",
                    "value": "com.example.weather.testWidget"
                }
            ]
        }
    }
]

distroFilter示例：

"distroFilter":  {
    "apiVersion": {
        "policy": "include",
        "value": [4,5]
    },
    "screenShape": {
        "policy": "include",
        "value": ["circle","rect"]
    },
    "screenWindow": {
        "policy": "include",
        "value": ["454*454","466*466"]
    },
    "screenDensity":{
        "policy": "exclude",
        "value": ["ldpi","xldpi"]
    },
    "countryCode": {
        "policy":"include",
        "value":["CN", "HK"]
    }
}

commonEvents示例：

"commonEvents": [
    {
        "name":"MainAbility",
        "permission": "string",
        "data":[
            "string",
            "string"
        ],
        "events": [
            "string",
            "string"
        ]
    }
]

感谢各位大佬支持！！！

互三啦！！！