本文分享自华为云社区《深入理解harmonyos uiability：生命周期、windowstage与启动模式探析》，作者：柠檬味拥抱。

uiability组件概述

uiability组件是harmonyos中一种包含ui界面的应用组件，主要用于与用户进行交互。每个uiability组件实例对应最近任务列表中的一个任务，可以包含多个页面来实现不同功能模块。

声明配置

为了使用uiability，首先需要在module.json5配置文件的abilities标签中声明uiability的相关信息，包括名称、入口、描述、图标等。

{
  "module": {
    // ...
    "abilities": [
      {
        "name": "entryability", // uiability组件的名称
        "srcentrance": "./ets/entryability/entryability.ts", // uiability组件的代码路径
        "description": "$string:entryability_desc", // uiability组件的描述信息
        "icon": "$media:icon", // uiability组件的图标
        "label": "$string:entryability_label", // uiability组件的标签
        "startwindowicon": "$media:icon", // uiability组件启动页面图标资源文件的索引
        "startwindowbackground": "$color:start_window_background", // uiability组件启动页面背景颜色资源文件的索引
        // ...
      }
    ]
  }
}

uiability组件生命周期

uiability组件的生命周期包括四个状态：create、foreground、background、destroy。在不同状态之间转换时，系统会调用相应的生命周期回调函数。

create状态

create状态表示uiability实例创建完成时触发，系统调用oncreate()回调。在该回调中可以进行应用初始化操作，如变量定义、资源加载等，为后续的ui界面展示做准备。

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

export default class entryability extends uiability {
    oncreate(want, launchparam) {
        // 应用初始化
    }
    // ...
}

windowstagecreate和windowstagedestroy状态

在uiability实例创建完成后，在进入foreground之前，系统会创建一个windowstage。windowstage创建完成后会触发onwindowstagecreate()回调，可以在该回调中设置ui界面加载和订阅windowstage的事件。

import uiability from '@ohos.app.ability.uiability';
import window from '@ohos.window';

export default class entryability extends uiability {
    onwindowstagecreate(windowstage: window.windowstage) {
        // 设置windowstage的事件订阅（获焦/失焦、可见/不可见）

        // 设置ui界面加载
        windowstage.loadcontent('pages/index', (err, data) => {
            // ...
        });
    }
    // ...
}

// 对应onwindowstagecreate回调，在uiability实例销毁之前，会先进入onwindowstagedestroy回调，可以在该回调中释放ui界面资源。
export default class entryability extends uiability {
    // ...

    onwindowstagedestroy() {
        // 释放ui界面资源
    }
}

foreground和background状态

foreground和background状态分别在uiability实例切换至前台和切换至后台时触发，对应于onforeground()和onbackground()回调。在onforeground()中可以申请系统需要的资源，而在onbackground()中可以释放ui界面不可见时无用的资源。

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

export default class entryability extends uiability {
    onforeground() {
        // 申请系统需要的资源，或者重新申请在onbackground中释放的资源
    }

    onbackground() {
        // 释放ui界面不可见时无用的资源，或者在此回调中执行较为耗时的操作，例如状态保存等
    }
}

destroy状态

destroy状态在uiability实例销毁时触发，可以在ondestroy()回调中进行系统资源的释放、数据的保存等操作。

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

export default class entryability extends uiability {
    ondestroy() {
        // 系统资源的释放、数据的保存等
    }
}

uiability组件启动模式

uiability的启动模式有三种：singleton（单实例模式）、standard（标准实例模式）、specified（指定实例模式）。

singleton启动模式

singleton启动模式为单实例模式，是默认的启动模式。每次调用startability()方法时，如果应用进程中该类型的uiability实例已经存在，则复用该实例。系统中只存在唯一一个该uiability实例。

{
  "module": {
    // ...
    "abilities": [
      {
        "launchtype": "singleton",
        // ...
      }
    ]
  }
}

standard启动模式

standard启动模式为标准实例模式，每次调用startability()方法时，都会在应用进程中创建一个新的该类型uiability实例。在最近任务列表中可以看到多个该类型的uiability实例。

{
  "module": {
    // ...
    "abilities": [
      {
        "launchtype": "standard",
        // ...
      }
    ]
  }
}

specified启动模式

specified启动模式为指定实例模式，允许为uiability实例创建一个唯一的key，后续每次调用startability()方法时，都会询问应用使用哪个key对应的uiability实例来响应请求。

{
  "module": {
    // ...
    "abilities": [
      {
        "launchtype": "specified",
        // ...
      }
    ]
  }
}

在指定实例模式下，需要在启动uiability时传入自定义参数，如"instancekey"，用于区分uiability实例。

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) => {
    // ...
});

在被调用方uiability的abilitystage中，通过onacceptwant()生命周期回调返回一个字符串key标识，用于匹配已创建的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 '';
    }
}

例如，在文档应用中，可以将文件路径作为一个key标识，实现每次新建文档都创建一个新的uiability实例，而打开已保存的文档时重用相应的uiability实例。

以上就是harmonyos uiability组件的概述、声明配置、生命周期、以及启动模式的详细介绍。通过了解这些知识点，开发者可以更好地利用uiability组件构建丰富的harmonyos应用。

harmonyos uiability组件进阶

windowstage和ui界面

在harmonyos中，uiability组件的界面展示主要通过windowstage和ui界面来实现。windowstage代表着uiability的窗口舞台，而ui界面则通过加载相应的页面来完成展示。

windowstage的创建和销毁

在uiability实例创建完成后，在进入foreground状态之前，系统会创建一个windowstage。在onwindowstagecreate()回调中，可以设置uiability要加载的页面，并订阅windowstage的事件。

import uiability from '@ohos.app.ability.uiability';
import window from '@ohos.window';

export default class entryability extends uiability {
    onwindowstagecreate(windowstage: window.windowstage) {
        // 设置windowstage的事件订阅（获焦/失焦、可见/不可见）

        // 设置ui界面加载
        windowstage.loadcontent('pages/index', (err, data) => {
            // ...
        });
    }

    // ...
}

对应的，在uiability实例销毁之前，会先进入onwindowstagedestroy()回调，可以在该回调中释放ui界面资源。

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

export default class entryability extends uiability {
    // ...

    onwindowstagedestroy() {
        // 释放ui界面资源
    }
}

ui界面的加载

在onwindowstagecreate()回调中，通过loadcontent()方法设置uiability要加载的页面。这里的页面路径可以是相对路径，也可以是绝对路径。

import uiability from '@ohos.app.ability.uiability';
import window from '@ohos.window';

export default class entryability extends uiability {
    onwindowstagecreate(windowstage: window.windowstage) {
        // 设置windowstage的事件订阅（获焦/失焦、可见/不可见）

        // 设置ui界面加载
        windowstage.loadcontent('pages/index', (err, data) => {
            // ...
        });
    }

    // ...
}

生命周期状态说明

uiability的生命周期包括create、foreground、background、destroy四个状态，如下图所示。

生命周期示例

下面以一个简单的示例说明uiability的生命周期状态变化：

import uiability from '@ohos.app.ability.uiability';
import window from '@ohos.window';

export default class entryability extends uiability {
    oncreate(want, launchparam) {
        // create状态
        console.info('oncreate');
    }

    onwindowstagecreate(windowstage: window.windowstage) {
        // windowstagecreate状态
        console.info('onwindowstagecreate');

        // 设置ui界面加载
        windowstage.loadcontent('pages/index', (err, data) => {
            // ...
        });
    }

    onforeground() {
        // foreground状态
        console.info('onforeground');
    }

    onbackground() {
        // background状态
        console.info('onbackground');
    }

    ondestroy() {
        // destroy状态
        console.info('ondestroy');
    }
}

在应用加载过程中，oncreate()回调表示create状态，之后进入foreground状态前会触发onwindowstagecreate()回调，然后在切换至后台和销毁时分别触发onbackground()和ondestroy()回调。

uiability组件启动模式进阶

在前面提到的uiability的启动模式中，除了基本的singleton、standard、specified启动模式外，还可以根据实际场景进行灵活的配置和使用。

使用singleton启动模式

singleton启动模式为单实例模式，默认情况下的启动模式。每次调用startability()方法时，如果应用进程中已存在该类型的uiability实例，则系统会复用该实例。系统中只存在唯一一个该uiability实例。

在`module.json5

`配置文件中的"abilities"标签下的"launchtype"字段配置为"singleton"即可。

{
    "module": {
        // ...
        "abilities": [
            {
                "launchtype": "singleton",
                // ...
            }
        ]
    }
}

使用standard启动模式

standard启动模式为标准实例模式，每次调用startability()方法时，都会在应用进程中创建一个新的该类型uiability实例。在最近任务列表中可以看到有多个该类型的uiability实例。

在module.json5配置文件中的"abilities"标签下的"launchtype"字段配置为"standard"即可。

{
    "module": {
        // ...
        "abilities": [
            {
                "launchtype": "standard",
                // ...
            }
        ]
    }
}

使用specified启动模式

specified启动模式为指定实例模式，允许在uiability实例创建之前为其创建一个唯一的字符串key。每次调用startability()方法时，会询问应用使用哪个key对应的uiability实例来响应请求。如果匹配有该uiability实例的key，则直接拉起与之绑定的uiability实例，否则创建一个新的uiability实例。

在module.json5配置文件中的"abilities"标签下的"launchtype"字段配置为"specified"即可。

{
    "module": {
        // ...
        "abilities": [
            {
                "launchtype": "specified",
                // ...
            }
        ]
    }
}

指定实例模式的使用场景

specified启动模式适用于一些特殊场景，例如文档应用中每次新建文档希望都能新建一个文档实例，而重复打开一个已保存的文档时希望打开的都是同一个文档实例。

在使用指定实例模式时，需要在uiability实例创建之前为其创建一个唯一的字符串key。在启动uiability时，通过自定义参数传递这个key，用于匹配已创建的uiability实例。

例如，有两个uiability：entryability和funcability，其中funcability配置为specified启动模式。在entryability中调用startability()方法启动funcability时，需要在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) => {
    // ...
});

在被调用方uiability的abilitystage中，通过onacceptwant()生命周期回调返回一个字符串key标识，用于匹配已创建的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 '';
    }
}

例如，在文档应用中，可以对不同的文档实例内容绑定不同的key值。每次新建文档时，可以传入不同的新key值（如将文件的路径作为一个key标识），此时abilitystage中启动uiability时都会创建一个新的uiability实例。而当新建的文档保存之后，回到桌面，或者新打开一个已保存的文档，再次打开该已保存的文档时，abilitystage中再次启动该uiability时，打开的仍然是之前原来已保存的文档界面。

// 在文档应用中，可以对不同的文档实例内容绑定不同的key值
// 当每次新建文档时，传入不同的新key值（如可以将文件的路径作为一个key标识）
// 此时abilitystage中启动uiability时都会创建一个新的uiability实例
// 而当新建的文档保存之后，回到桌面，或者新打开一个已保存的文档，再次打开该已保存的文档时，
// abilitystage中再次启动该uiability时，打开的仍然是之前原来已保存的文档界面

这样，通过指定实例模式的配置，可以实现更加灵活和符合业务场景的uiability启动方式。

结语

通过本文，我们详细介绍了harmonyos uiability组件的生命周期、windowstage的创建和销毁、ui界面的加载，以及uiability的启动模式。通过了解这些知识点，开发者可以更好地利用uiability组件构建丰富的harmonyos应用。同时，对于启动模式的理解和灵活运用，可以根据不同业务场景选择合适的模式，提升应用的用户体验。希望本文对于harmonyos开发者能够提供有益的参考和帮助。

点击关注，第一时间了解华为云新鲜技术~