HarmonyOS应用开发学习笔记 包名、icon图标，应用名修改 UIAbility组件介绍、UIAbility启动模式、UIAbility组件基本用法_hap修改包名

目前HarmonyOS应用主推的是Stage模型开发

一、Stage模型基本概念

1、应用包名、应用图标的修改

工程的AppScope目录下的app.json5配置文件中可修改包名、应用图标、应用名称等信息

二 、UIAbility组件概述

• UIAbility组件是一种包含UI界面的应用组件，主要用于和用户交互。
• UIAbility组件是系统调度的基本单元，为应用提供绘制界面的窗口；一个UIAbility组件中可以通过多个页面来实现一个功能模块。每一个UIAbility组件实例，都对应于一个最近任务列表中的任务。

UIAbility声明:UIAbility编辑完成后，还需要在module.json5上声明，才能使用

    "abilities": [
    {
        "name": "EntryAbility", // UIAbility组件的名称
        "srcEntry": "./ets/entryability/EntryAbility.ts", // UIAbility组件的代码路径
        "description": "$string:EntryAbility_desc",// UIAbility组件的描述信息
        "icon": "$media:icon",// UIAbility组件的图标
        "label": "$string:EntryAbility_label",// UIAbility组件的标签
        "startWindowIcon" : "$media:icon",// UIAbility组件启动页面图标资源文件的索引
        // UIAbility组件启动页面背景颜色资源文件的索引
        "startWindowBackground" : "$color:start_window_background",
        "exported": true,
        "skills": [
          {
            "entities": [
              "entity.system.home"
            ],
            "actions": [
              "action.system.home"
            ]
          }
        ]
      }]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

三、UIAbility组件生命周期

• 当用户打开、切换和返回到对应应用时，应用中的UIAbility实例会在其生命周期的不同状态之间转换。
• UIAbility类提供了一系列回调，通过这些回调可以知道当前UIAbility实例的某个状态发生改变，会经过UIAbility实例的创建和销毁，或者UIAbility实例发生了前后台的状态切换
• UIAbility的生命周期包括Create、Foreground、Background、Destroy四个状态，如下图所示。
  

应用的UIAbility实例已创建，该UIAbility配置为单实例模式，再次调用startAbility()方法启动该UIAbility实例，此时只会进入该UIAbility的onNewWant()回调，不会进入其onCreate()和onWindowStageCreate()生命周期回调。

export default class Entry  extends UIAbility {


  //Ability从后台到前台的回调
  onNewWant() {
    
  }

  //Ability 创建的时候
  onCreate(want, launchParam) {

  }
  //Ability 销毁的时候
  onDestroy() {
   
  }
  //Ability加载视图UI的时候
  onWindowStageCreate(windowStage: window.WindowStage) {

  }

  //Ability解绑视图UI的时候
  onWindowStageDestroy() {
    
  }
  //Ability展示到最前端（最上层）的时候
  onForeground() {

  }
  //返回到桌面，Ability 退后到后台的时候
  onBackground() {

  }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

四、UIAbility组件启动模式

三种启动模式

配置方式
如果需要使用singleton启动模式，在module.json5配置文件中的"launchType"字段配置为"singleton"即可

{
  "module": {
    // ...
    "abilities": [
      {
        "launchType": "singleton", //singleton 、standard、specified
        // ...
      }
    ]
  }
}
1
2
3
4
5
6
7
8
9
10
11

specified 的使用
在EntryAbility中，调用startAbility()方法时，在want参数中，增加一个自定义参数来区别UIAbility实例，例如增加一个"instanceKey"自定义参数。

// 在启动指定实例模式的UIAbility时，给每一个UIAbility实例配置一个独立的Key标识
// 例如在文档使用场景中，可以用文档路径作为Key标识
function getInstance() {
    // ...
}

let want = {
    deviceId: '', // deviceId为空表示本设备
    bundleName: 'com.example.myapplication',
    abilityName: 'FuncAbility',
    moduleName: 'module1', // moduleName非必选
    parameters: { // 自定义信息
        instanceKey: getInstance(),
    },
}
// context为调用方UIAbility的AbilityContext
this.context.startAbility(want).then(() => {
    // ...
}).catch((err) => {
    // ...
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

由于FuncAbility的启动模式配置为了指定实例启动模式，在FuncAbility启动之前，会先进入其对应的AbilityStage的onAcceptWant()生命周期回调中，解析传入的want参数，获取"instanceKey"自定义参数。根据业务需要通过AbilityStage的onAcceptWant()生命周期回调返回一个字符串Key标识。如果返回的Key对应一个已启动的UIAbility，则会将之前的UIAbility拉回前台并获焦，而不创建新的实例，否则创建新的实例并启动。

import AbilityStage from '@ohos.app.ability.AbilityStage';

export default class MyAbilityStage extends AbilityStage {
    onAcceptWant(want): string {
        // 在被调用方的AbilityStage中，针对启动模式为specified的UIAbility返回一个UIAbility实例对应的一个Key值
        // 当前示例指的是module1 Module的FuncAbility
        if (want.abilityName === 'FuncAbility') {
            // 返回的字符串Key标识为自定义拼接的字符串内容
            return `ControlModule_EntryAbilityInstance_${want.parameters.instanceKey}`;
        }

        return '';
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

五、UIAbility组件基本用法

1、指定UIAbility的启动页面

在启动UIAbility后，需要加载页面，通onWindowStageCreate(windowStage:Window.WindowStage)方法指定加载页面

  //Ability加载视图UI的时候
  onWindowStageCreate(windowStage: window.WindowStage) {
    windowStage.loadContent('pages/Index', (err, data) => {
      if (err.code) {
        return;
      }
    });
  }
1
2
3
4
5
6
7
8

2、Ability启动方法

    let want = {
      // Want参数信息
    };
    this.context.startAbility(want);
1
2
3
4

获取上下文

• 在UIAbility中可以通过this.context获取UIAbility实例的上下文信息

let context = this.context;

• 页面中获取UIAbility实例的上下文信息，包括导入依赖资源context模块和在组件中定义一个context变量两个部分。

import common from ‘@ohos.app.ability.common’;
……
private context = getContext(this) as common.UIAbilityContext;

六、UIAbility组件与UI的数据同步

官网文档
比较重要的内容，另起一章。

七、UIAbility组件间交互（设备内）

官网文档
比较重要的内容，另起一章。