关于前端:OpenHarmonyUIAbility组件间交互设备内

UIAbility是系统调度的最小单元。在设施内的功能模块之间跳转时，会波及到启动特定的UIAbility，该UIAbility能够是利用内的其余UIAbility，也能够是其余利用的UIAbility（例如启动三方领取UIAbility）。

本章节将从如下场景别离介绍设施内UIAbility间的交互方式。

启动利用内的UIAbility
启动利用内的UIAbility并获取返回后果
启动其余利用的UIAbility
启动其余利用的UIAbility并获取返回后果
启动UIAbility的指定页面
通过Call调用实现UIAbility交互（仅对系统利用凋谢）

启动利用内的UIAbility

当一个利用内蕴含多个UIAbility时，存在利用内启动UIAbility的场景。例如在领取利用中从入口UIAbility启动收付款UIAbility。

假如利用中有两个UIAbility：EntryAbility和FuncAbility（能够在同一个Module中，也能够在不同的Module中），须要从EntryAbility的页面中启动FuncAbility。

1.在EntryAbility中，通过调用startAbility()办法启动UIAbility，want为UIAbility实例启动的入口参数，其中bundleName为待启动利用的Bundle名称，abilityName为待启动的UIAbility名称，moduleName在待启动的UIAbility属于不同的Module时增加，parameters为自定义信息参数。示例中的context的获取形式参见获取UIAbility的Context属性。

let wantInfo = {
    deviceId: '', // deviceId为空示意本设施
    bundleName: 'com.example.myapplication',
    abilityName: 'FuncAbility',
    moduleName: 'module1', // moduleName非必选
    parameters: { // 自定义信息
        info: '来自EntryAbility Index页面',
    },
}
// context为调用方UIAbility的AbilityContext
this.context.startAbility(wantInfo).then(() => {
    // ...
}).catch((err) => {
    // ...
})

2.在FuncAbility的生命周期回调文件中接管EntryAbility传递过去的参数。

import UIAbility from '@ohos.app.ability.UIAbility';
import Window from '@ohos.window';
export default class FuncAbility extends UIAbility {
    onCreate(want, launchParam) {
    // 接管调用方UIAbility传过来的参数
        let funcAbilityWant = want;
        let info = funcAbilityWant?.parameters?.info;
        // ...
    }
}

3.在FuncAbility业务实现之后，如须要进行以后UIAbility实例，在FuncAbility中通过调用terminateSelf()办法实现。

// context为须要进行的UIAbility实例的AbilityContext
this.context.terminateSelf((err) => {
    // ...
});

启动利用内的UIAbility并获取返回后果

在一个EntryAbility启动另外一个FuncAbility时，心愿在被启动的FuncAbility实现相干业务后，能将后果返回给调用方。例如在利用中将入口性能和帐号登录性能别离设计为两个独立的UIAbility，在帐号登录UIAbility中实现登录操作后，须要将登录的后果返回给入口UIAbility。

1.在EntryAbility中，调用startAbilityForResult()接口启动FuncAbility，异步回调中的data用于接管FuncAbility进行本身后返回给EntryAbility的信息。示例中的context的获取形式参见获取UIAbility的Context属性。

let wantInfo = {
    deviceId: '', // deviceId为空示意本设施
    bundleName: 'com.example.myapplication',
    abilityName: 'FuncAbility',
    moduleName: 'module1', // moduleName非必选
    parameters: { // 自定义信息
        info: '来自EntryAbility Index页面',
    },
}
// context为调用方UIAbility的AbilityContext
this.context.startAbilityForResult(wantInfo).then((data) => {
    // ...
}).catch((err) => {
    // ...
})

2.在FuncAbility进行本身时，须要调用terminateSelfWithResult()办法，入参abilityResult为FuncAbility须要返回给EntryAbility的信息。

const RESULT_CODE: number = 1001;
let abilityResult = {
    resultCode: RESULT_CODE,
    want: {
        bundleName: 'com.example.myapplication',
        abilityName: 'FuncAbility',
        moduleName: 'module1',
        parameters: {
            info: '来自FuncAbility Index页面',
        },
    },
}
// context为被调用方UIAbility的AbilityContext
this.context.terminateSelfWithResult(abilityResult, (err) => {
    // ...
});

3.FuncAbility进行本身后，EntryAbility通过startAbilityForResult()办法回调接管被FuncAbility返回的信息，RESULT_CODE须要与后面的数值保持一致。

const RESULT_CODE: number = 1001;
// ...
// context为调用方UIAbility的AbilityContext
this.context.startAbilityForResult(want).then((data) => {
    if (data?.resultCode === RESULT_CODE) {
        // 解析被调用方UIAbility返回的信息
        let info = data.want?.parameters?.info;
        // ...
    }
}).catch((err) => {
    // ...
})

启动其余利用的UIAbility

启动其余利用的UIAbility，通常用户只须要实现一个通用的操作（例如须要抉择一个文档利用来查看某个文档的内容信息），举荐应用隐式Want启动。零碎会依据调用方的want参数来辨认和启动匹配到的利用UIAbility。

启动UIAbility有显式Want启动和隐式Want启动两种形式。

显式Want启动：启动一个确定利用的UIAbility，在want参数中须要设置该利用bundleName和abilityName，当须要拉起某个明确的UIAbility时，通常应用显式Want启动形式。
隐式Want启动：依据匹配条件由用户抉择启动哪一个UIAbility，即不明确指出要启动哪一个UIAbility（abilityName参数未设置），在调用startAbility()办法时，其入参want中指定了一系列的entities字段（示意指标UIAbility额定的类别信息，如浏览器、视频播放器）和actions字段（示意要执行的通用操作，如查看、分享、利用详情等）等参数信息，而后由零碎去剖析want，并帮忙找到适合的UIAbility来启动。当须要拉起其余利用的UIAbility时，开发者通常不晓得用户设施中利用的装置状况，也无奈确定指标利用的bundleName和abilityName，通常应用隐式Want启动形式。

本章节次要解说如何通过隐式Want启动其余利用的UIAbility。

1.将多个待匹配的文档利用装置到设施，在其对应UIAbility的module.json5配置文件中，配置skills的entities字段和actions字段。

{
  "module": {
    "abilities": [
      {
        // ...
        "skills": [
          {
            "entities": [
              // ...
              "entity.system.default"
            ],
            "actions": [
              // ...
              "ohos.want.action.viewData"
            ]
          }
        ]
      }
    ]
  }
}

2.在调用方want参数中的entities和action须要被蕴含在待匹配UIAbility的skills配置的entities和actions中。零碎匹配到合乎entities和actions参数条件的UIAbility后，会弹出抉择框展现匹配到的UIAbility实例列表供用户抉择应用。示例中的context的获取形式参见获取UIAbility的Context属性。

let wantInfo = {
    deviceId: '', // deviceId为空示意本设施
    // 如果心愿隐式仅在特定的捆绑包中进行查问，请勾销上面的正文。
    // bundleName: 'com.example.myapplication',
    action: 'ohos.want.action.viewData',
    // entities能够被省略。
    entities: ['entity.system.default'],
}
// context为调用方UIAbility的AbilityContext
this.context.startAbility(wantInfo).then(() => {
    // ...
}).catch((err) => {
    // ...
})

成果示意如下图所示，点击“关上PDF文档”时，会弹出抉择框供用户抉择。

3.在文档利用应用实现之后，如须要进行以后UIAbility实例，通过调用terminateSelf()办法实现。

// context为须要进行的UIAbility实例的AbilityContext
this.context.terminateSelf((err) => {
    // ...
});

启动其余利用的UIAbility并获取返回后果

当应用隐式Want启动其余利用的UIAbility并心愿获取返回后果时，调用方须要应用startAbilityForResult()办法启动指标UIAbility。例如主利用中须要启动三方领取并获取领取后果。

1.在领取利用对应UIAbility的module.json5配置文件中，配置skills的entities字段和actions字段。

{
  "module": {
    "abilities": [
      {
        // ...
        "skills": [
          {
            "entities": [
              // ...
              "entity.system.default"
            ],
            "actions": [
              // ...
              "ohos.want.action.editData"
            ]
          }
        ]
      }
    ]
  }
}

2.调用方应用startAbilityForResult()办法启动领取利用的UIAbility，在调用方want参数中的entities和action须要被蕴含在待匹配UIAbility的skills配置的entities和actions中。异步回调中的data用于后续接管领取UIAbility进行本身后返回给调用方的信息。零碎匹配到合乎entities和actions参数条件的UIAbility后，会弹出抉择框展现匹配到的UIAbility实例列表供用户抉择应用。

let wantInfo = {
    deviceId: '', // deviceId为空示意本设施
    // uncomment line below if wish to implicitly query only in the specific bundle.
    // bundleName: 'com.example.myapplication',
    action: 'ohos.want.action.editData',
    // entities can be omitted.
    entities: ['entity.system.default'],
}
// context为调用方UIAbility的AbilityContext
this.context.startAbilityForResult(wantInfo).then((data) => {
    // ...
}).catch((err) => {
    // ...
})

3.在领取UIAbility实现领取之后，须要调用terminateSelfWithResult()办法实现进行本身，并将abilityResult参数信息返回给调用方。

const RESULT_CODE: number = 1001;
let abilityResult = {
    resultCode: RESULT_CODE,
    want: {
        bundleName: 'com.example.myapplication',
        abilityName: 'EntryAbility',
        moduleName: 'entry',
        parameters: {
            payResult: 'OKay',
        },
    },
}
// context为被调用方UIAbility的AbilityContext
this.context.terminateSelfWithResult(abilityResult, (err) => {
    // ...
});

4.在调用方startAbilityForResult()办法回调中接管领取利用返回的信息，RESULT_CODE须要与后面terminateSelfWithResult()返回的数值保持一致。

const RESULT_CODE: number = 1001;
let want = {
  // Want参数信息
};
// context为调用方UIAbility的AbilityContext
this.context.startAbilityForResult(want).then((data) => {
    if (data?.resultCode === RESULT_CODE) {
        // 解析被调用方UIAbility返回的信息
        let payResult = data.want?.parameters?.payResult;
        // ...
    }
}).catch((err) => {
    // ...
})

启动UIAbility的指定页面

一个UIAbility能够对应多个页面，在不同的场景下启动该UIAbility时须要展现不同的页面，例如从一个UIAbility的页面中跳转到另外一个UIAbility时，心愿启动指标UIAbility的指定页面。本文次要解说指标UIAbility首次启动和指标UIAbility非首次启动两种启动指定页面的场景，以及在解说启动指定页面之前会解说到在调用方如何指定启动页面。

调用方UIAbility指定启动页面

调用方UIAbility启动另外一个UIAbility时，通常须要跳转到指定的页面。例如FuncAbility蕴含两个页面（Index对应首页，Second对应性能A页面），此时须要在传入的want参数中配置指定的页面门路信息，能够通过want中的parameters参数减少一个自定义参数传递页面跳转信息。示例中的context的获取形式参见获取UIAbility的Context属性。

let wantInfo = {
    deviceId: '', // deviceId为空示意本设施
    bundleName: 'com.example.myapplication',
    abilityName: 'FuncAbility',
    moduleName: 'module1', // moduleName非必选
    parameters: { // 自定义参数传递页面信息
        router: 'funcA',
    },
}
// context为调用方UIAbility的AbilityContext
this.context.startAbility(wantInfo).then(() => {
    // ...
}).catch((err) => {
    // ...
})

指标UIAbility首次启动

指标UIAbility首次启动时，在指标UIAbility的onWindowStageCreate()生命周期回调中，解析EntryAbility传递过去的want参数，获取到须要加载的页面信息url，传入windowStage.loadContent()办法。

import UIAbility from '@ohos.app.ability.UIAbility'
import Window from '@ohos.window'
export default class FuncAbility extends UIAbility {
    funcAbilityWant;
    onCreate(want, launchParam) {
        // 接管调用方UIAbility传过来的参数
        this.funcAbilityWant = want;
    }
    onWindowStageCreate(windowStage: Window.WindowStage) {
        // Main window is created, set main page for this ability
        let url = 'pages/Index';
        if (this.funcAbilityWant?.parameters?.router) {
            if (this.funcAbilityWant.parameters.router === 'funA') {
                url = 'pages/Second';
            }
        }
        windowStage.loadContent(url, (err, data) => {
            // ...
        });
    }
}

指标UIAbility非首次启动

常常还会遇到一类场景，当利用A曾经启动且处于主页面时，回到桌面，关上利用B，并从利用B再次启动利用A，且须要跳转到利用A的指定页面。例如联系人利用和短信利用配合应用的场景。关上短信利用主页，回到桌面，此时短信利用处于已关上状态且以后处于短信利用的主页。再关上联系人利用主页，进入联系人用户A查看详情，点击短信图标，筹备给用户A发送短信，此时会再次拉起短信利用且以后处于短信利用的发送页面。

针对以上场景，即当利用A的UIAbility实例已创立，并且处于该UIAbility实例对应的主页面中，此时，从利用B中须要再次启动利用A的该UIAbility，并且须要跳转到不同的页面，这种状况下要如何实现呢？

1.在指标UIAbility中，默认加载的是Index页面。因为以后UIAbility实例之前曾经创立实现，此时会进入UIAbility的onNewWant()回调中且不会进入onCreate()和onWindowStageCreate()生命周期回调，在onNewWant()回调中解析调用方传递过去的want参数，并挂在到全局变量globalThis中，以便于后续在页面中获取。

import UIAbility from '@ohos.app.ability.UIAbility'
export default class FuncAbility extends UIAbility {
    onNewWant(want, launchParam) {
        // 接管调用方UIAbility传过来的参数
        globalThis.funcAbilityWant = want;
        // ...
    }
}

2.在FuncAbility中，此时须要在Index页面中通过页面路由Router模块实现指定页面的跳转，因为此时FuncAbility对应的Index页面是处于激活状态，不会从新变量申明以及进入aboutToAppear()生命周期回调中。因而能够在Index页面的onPageShow()生命周期回调中实现页面路由跳转的性能。

import router from '@ohos.router';
@Entry
@Component
struct Index {
  onPageShow() {
    let funcAbilityWant = globalThis.funcAbilityWant;
    let url2 = funcAbilityWant?.parameters?.router;
    if (url2 && url2 === 'funcA') {
      router.replaceUrl({
        url: 'pages/Second',
      })
    }
  }

  // 页面展现
  build() {
    // ...
  }
}

阐明
当被调用方Ability的启动模式设置为multiton启动模式时，每次启动都会创立一个新的实例，那么onNewWant()回调就不会被用到。

通过Call调用实现UIAbility交互（仅对系统利用凋谢）

Call调用是UIAbility能力的扩大，它为UIAbility提供一种可能被内部调用并与内部进行通信的能力。Call调用反对前台与后盾两种启动形式，使UIAbility既能被拉起到前台展现UI，也能够在后盾被创立并运行。Call调用在调用方与被调用方间建设了IPC通信，因而利用开发者可通过Call调用实现不同UIAbility之间的数据共享。

Call调用的外围接口是startAbilityByCall办法，与startAbility接口的不同之处在于：

startAbilityByCall反对前台与后盾两种启动形式，而startAbility仅反对前台启动。
调用方可应用startAbilityByCall所返回的Caller对象与被调用方进行通信，而startAbility不具备通信能力。

Call调用的应用场景次要包含：

须要与被启动的UIAbility进行通信。
心愿被启动的UIAbility在后盾运行。
表1 Call调用相干名词解释

Call调用示意图如下所示。

图1 Call调用示意图

CallerAbility调用startAbilityByCall接口获取Caller，并应用Caller对象的call办法向CalleeAbility发送数据。
CalleeAbility持有一个Callee对象，通过Callee的on办法注册回调函数，当接管到Caller发送的数据时将会调用对应的回调函数。

阐明
1.以后仅支持系统利用应用Call调用。
2.CalleeAbility的启动模式须要为单实例。
3.Call调用既反对本地（设施内）Call调用，也反对跨设施Call调用，上面介绍设施内Call调用办法。

接口阐明

Call性能次要接口如下表所示。具体的API详见接口文档。

表2 Call性能次要接口

设施内通过Call调用实现UIAbility交互，波及如下两局部开发：

创立Callee被调用端
拜访Callee被调用端

开发步骤（创立Callee被调用端）

在Callee被调用端，须要实现指定办法的数据接管回调函数、数据的序列化及反序列化办法。在须要接收数据期间，通过on接口注册监听，无需接收数据时通过off接口解除监听。

配置Ability的启动模式。

配置module.json5，将CalleeAbility配置为单实例”singleton”。

Ability配置标签示例如下：

"abilities":[{
  "name": ".CalleeAbility",
  "srcEntrance": "./ets/CalleeAbility/CalleeAbility.ts",
  "launchType": "singleton",
  "description": "$string:CalleeAbility_desc",
  "icon": "$media:icon",
  "label": "$string:CalleeAbility_label",
  "visible": true
}]

2.导入UIAbility模块。

import Ability from '@ohos.app.ability.UIAbility';

3.定义约定的序列化数据。

调用端及被调用端发送接管的数据格式需协商一致，如下示例约定数据由number和string组成。

export default class MyParcelable {
    num: number = 0
    str: string = ""
    constructor(num, string) {
        this.num = num
        this.str = string
    }
    marshalling(messageSequence) {
        messageSequence.writeInt(this.num)
        messageSequence.writeString(this.str)
        return true
    }
    unmarshalling(messageSequence) {
        this.num = messageSequence.readInt()
        this.str = messageSequence.readString()
        return true
    }
}

4.实现Callee.on监听及Callee.off解除监听。

被调用端Callee的监听函数注册机会，取决于利用开发者。注册监听之前的数据不会被解决，勾销监听之后的数据不会被解决。如下示例在Ability的onCreate注册’MSG_SEND_METHOD’监听，在onDestroy勾销监听，收到序列化数据后作相应解决并返回，利用开发者依据理论须要做相应解决。具体示例代码如下：

const TAG: string = '[CalleeAbility]';
const MSG_SEND_METHOD: string = 'CallSendMsg';
function sendMsgCallback(data) {
    console.info('CalleeSortFunc called');
    // 获取Caller发送的序列化数据
    let receivedData = new MyParcelable(0, '');
    data.readParcelable(receivedData);
    console.info(`receiveData[${receivedData.num}, ${receivedData.str}]`);
    // 作相应解决
    // 返回序列化数据result给Caller
    return new MyParcelable(receivedData.num + 1, `send ${receivedData.str} succeed`);
}
export default class CalleeAbility extends Ability {
    onCreate(want, launchParam) {
        try {
            this.callee.on(MSG_SEND_METHOD, sendMsgCallback);
        } catch (error) {
            console.info(`${MSG_SEND_METHOD} register failed with error ${JSON.stringify(error)}`);
        }
    }
    onDestroy() {
        try {
            this.callee.off(MSG_SEND_METHOD);
        } catch (error) {
            console.error(TAG, `${MSG_SEND_METHOD} unregister failed with error ${JSON.stringify(error)}`);
        }
    }
}

开发步骤（拜访Callee被调用端）

导入UIAbility模块。

import Ability from '@ohos.app.ability.UIAbility';

2.获取Caller通信接口。

Ability的context属性实现了startAbilityByCall办法，用于获取指定通用组件的Caller通信接口。如下示例通过this.context获取Ability实例的context属性，应用startAbilityByCall拉起Callee被调用端并获取Caller通信接口，注册Caller的onRelease监听。利用开发者依据理论须要做相应解决。

// 注册caller的release监听
private regOnRelease(caller) {
    try {
        caller.on("release", (msg) => {
            console.info(`caller onRelease is called ${msg}`);
        })
        console.info('caller register OnRelease succeed');
    } catch (error) {
        console.info(`caller register OnRelease failed with ${error}`);
    }
}
async onButtonGetCaller() {
    try {
        this.caller = await context.startAbilityByCall({
            bundleName: 'com.samples.CallApplication',
            abilityName: 'CalleeAbility'
        })
        if (this.caller === undefined) {
            console.info('get caller failed')
            return
        }
        console.info('get caller success')
        this.regOnRelease(this.caller)
    } catch (error) {
        console.info(`get caller failed with ${error}`)
    }
}

作为一名合格一线开发程序员，大家心里必定会有很多疑难！鸿蒙零碎这么弱小~~

为了可能让大家跟上互联网时代的技术迭代，在这里跟大家分享一下我本人近期学习心得以及参考网上材料整顿出的一份最新版的鸿蒙学习晋升材料，有须要的小伙伴自行支付，限时开源，先到先得~~~~

支付以下高清学习路线原图请点击→《鸿蒙零根底入门学习指南》纯血鸿蒙HarmonyOS根底技能学习路线图

支付以上残缺高清学习路线图，请点击→《鸿蒙全套学习指南》小编本人整顿的局部学习材料（蕴含有高清视频、开发文档、电子书籍等）

以上分享的学习路线都适宜哪些人跟着学习？
-应届生/计算机专业通过学习鸿蒙新兴技术，入行互联网，将来高起点待业。
-0根底转行提前布局新方向，抓住风口，自我晋升，取得更多就业机会。
-技术晋升/进阶跳槽倒退瓶颈期，晋升职场竞争力，疾速把握鸿蒙技术，享受蓝海红利。

总结

如果你感觉这篇内容对你有帮忙，我想麻烦大家动动小手给我：点赞，转发，有你们的『点赞和评论』，才是我发明的能源。关注我，同时能够期待后续文章ing，不定期分享原创常识。想要获取更多残缺鸿蒙最新VIP学习材料，请点击→《鸿蒙开发学习之UI》

关于前端:OpenHarmonyUIAbility组件间交互设备内

启动利用内的UIAbility

启动利用内的UIAbility并获取返回后果

启动其余利用的UIAbility

启动其余利用的UIAbility并获取返回后果

启动UIAbility的指定页面

调用方UIAbility指定启动页面

指标UIAbility首次启动

指标UIAbility非首次启动

通过Call调用实现UIAbility交互（仅对系统利用凋谢）

接口阐明

开发步骤（拜访Callee被调用端）

总结

评论

发表回复取消回复

更多文章

苹果iOS打包的ipa应用无法安装？一篇文章带你了解可能的原因及排查方法

图解Golang：从零开始实现简易版过期LRU缓存

深入解析：基于Delta的线性数据结构模型，打造高效富文本编辑器

轻松管理社交媒体：使用Automa插件实现一键拉黑功能

关于前端:OpenHarmonyUIAbility组件间交互设备内

启动利用内的UIAbility

启动利用内的UIAbility并获取返回后果

启动其余利用的UIAbility

启动其余利用的UIAbility并获取返回后果

启动UIAbility的指定页面

调用方UIAbility指定启动页面

指标UIAbility首次启动

指标UIAbility非首次启动

通过Call调用实现UIAbility交互（仅对系统利用凋谢）

接口阐明

开发步骤（拜访Callee被调用端）

总结

评论

发表回复 取消回复

更多文章

苹果iOS打包的ipa应用无法安装？一篇文章带你了解可能的原因及排查方法

图解Golang：从零开始实现简易版过期LRU缓存

深入解析：基于Delta的线性数据结构模型，打造高效富文本编辑器

轻松管理社交媒体：使用Automa插件实现一键拉黑功能

发表回复取消回复