應(yīng)用組件間的信息傳遞

2024-01-23 12:50 更新

Want是對象間信息傳遞的載體, 可以用于應(yīng)用組件間的信息傳遞。 Want的使用場景之一是作為startAbility的參數(shù), 其包含了指定的啟動目標(biāo), 以及啟動時需攜帶的相關(guān)數(shù)據(jù), 如bundleName和abilityName字段分別指明目標(biāo)Ability所在應(yīng)用的包名以及對應(yīng)包內(nèi)的Ability名稱。當(dāng)Ability A需要啟動Ability B并傳入一些數(shù)據(jù)時, 可使用Want作為載體將這些數(shù)據(jù)傳遞給Ability B。

說明

本模塊首批接口從API version 9 開始支持。后續(xù)版本的新增接口,采用上角標(biāo)單獨標(biāo)記接口的起始版本。

導(dǎo)入模塊

  1. import Want from '@ohos.app.ability.Want';

屬性

系統(tǒng)能力:以下各項對應(yīng)的系統(tǒng)能力均為SystemCapability.Ability.AbilityBase

名稱

類型

必填

說明

deviceId

string

表示運行指定Ability的設(shè)備ID。

bundleName

string

表示包描述。如果在Want中同時指定了BundleName和AbilityName,則Want可以直接匹配到指定的Ability。

abilityName

string

表示待啟動的Ability名稱。如果在Want中該字段同時指定了BundleName和AbilityName,則Want可以直接匹配到指定的Ability。AbilityName需要在一個應(yīng)用的范圍內(nèi)保證唯一。

uri

string

表示Uri描述。如果在Want中指定了Uri,則Want將匹配指定的Uri信息,包括scheme, schemeSpecificPart, authority和path信息。

type

string

表示MIME type類型描述,打開文件的類型,主要用于文管打開文件。比如:'text/xml' 、 'image/*'等,MIME定義參考:https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。

flags

number

表示處理Want的方式。默認(rèn)傳數(shù)字,具體參考:flags說明。

action

string

表示要執(zhí)行的通用操作(如:查看、分享、應(yīng)用詳情)。在隱式Want中,您可以定義該字段,配合uri或parameters來表示對數(shù)據(jù)要執(zhí)行的操作。

parameters

{[key: string]: any}

表示W(wǎng)antParams描述,由開發(fā)者自行決定傳入的鍵值對。默認(rèn)會攜帶以下key值:

- ohos.aafwk.callerPid:表示拉起方的pid。

- ohos.aafwk.param.callerToken:表示拉起方的token。

- ohos.aafwk.param.callerUid:表示BundleInfo中的uid,應(yīng)用包里應(yīng)用程序的uid。

- component.startup.newRules:表示是否啟用新的管控規(guī)則。

- moduleName:表示拉起方的模塊名,該字段的值即使定義成其他字符串,在傳遞到另一端時會被修改為正確的值。

- ohos.dlp.params.sandbox:表示dlp文件才會有。

entities

Array<string>

表示目標(biāo)Ability額外的類別信息(如:瀏覽器、視頻播放器),在隱式Want中是對action字段的補充。在隱式Want中,您可以定義該字段,來過濾匹配Ability類型。

moduleName

string

表示待啟動的Ability所屬的模塊(module)。

示例:

  • 基礎(chǔ)用法

    1. let want = {
    2. 'deviceId': '', // deviceId為空表示本設(shè)備
    3. 'bundleName': 'com.extreme.test',
    4. 'abilityName': 'MainAbility',
    5. 'moduleName': 'entry' // moduleName非必選
    6. };
    7. this.context.startAbility(want, (error) => {
    8. // 顯式拉起Ability,通過bundleName、abilityName和moduleName可以唯一確定一個Ability
    9. console.log('error.code = ' + error.code);
    10. })
  • 通過自定字段傳遞數(shù)據(jù),以下為當(dāng)前支持類型。

    • 字符串(String)
      1. let want = {
      2. bundleName: 'com.example.demo',
      3. abilityName: 'com.example.demo.MainAbility',
      4. parameters: {
      5. keyForString: 'str',
      6. },
      7. };
    • 數(shù)字(Number)
      1. let want = {
      2. bundleName: 'com.example.demo',
      3. abilityName: 'com.example.demo.MainAbility',
      4. parameters: {
      5. keyForInt: 100,
      6. keyForDouble: 99.99,
      7. },
      8. };
    • 布爾(Boolean)
      1. let want = {
      2. bundleName: 'com.example.demo',
      3. abilityName: 'com.example.demo.MainAbility',
      4. parameters: {
      5. keyForBool: true,
      6. },
      7. };
    • 對象(Object)
      1. let want = {
      2. bundleName: 'com.example.demo',
      3. abilityName: 'com.example.demo.MainAbility',
      4. parameters: {
      5. keyForObject: {
      6. keyForObjectString: 'str',
      7. keyForObjectInt: -200,
      8. keyForObjectDouble: 35.5,
      9. keyForObjectBool: false,
      10. },
      11. },
      12. };
    • 數(shù)組(Array)
      1. let want = {
      2. bundleName: 'com.example.demo',
      3. abilityName: 'com.example.demo.MainAbility',
      4. parameters: {
      5. keyForArrayString: ['str1', 'str2', 'str3'],
      6. keyForArrayInt: [100, 200, 300, 400],
      7. keyForArrayDouble: [0.1, 0.2],
      8. keyForArrayObject: [{obj1: 'aaa'}, {obj2: 100}],
      9. },
      10. };
    • 文件描述符(FD)
      1. import fileio from '@ohos.fileio';
      2. let fd;
      3. try {
      4. fd = fileio.openSync('/data/storage/el2/base/haps/pic.png');
      5. } catch(e) {
      6. console.log('openSync fail:' + JSON.stringify(e));
      7. }
      8. let want = {
      9. 'deviceId': '', // deviceId為空表示本設(shè)備
      10. 'bundleName': 'com.extreme.test',
      11. 'abilityName': 'MainAbility',
      12. 'moduleName': 'entry', // moduleName非必選
      13. 'parameters': {
      14. 'keyFd':{'type':'FD', 'value':fd} // {'type':'FD', 'value':fd}是固定用法,用于表示該數(shù)據(jù)是FD
      15. }
      16. };
      17. this.context.startAbility(want, (error) => {
      18. // 顯式拉起Ability,通過bundleName、abilityName和moduleName可以唯一確定一個Ability
      19. console.log('error.code = ' + error.code);
      20. });
    • parameter參數(shù)用法:以ability.params.backToOtherMissionStack為例,ServiceExtension在拉起UIAbility的時候,可以支持跨任務(wù)鏈返回。
      1. // (1) UIAbility1啟動一個ServiceExtension
      2. let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext
      3. let want = {
      4. bundleName: 'com.example.myapplication1',
      5. abilityName: 'ServiceExtensionAbility',
      6. };
      7. context.startAbility(want, (err) => {
      8. console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`);
      9. });
      10. // (2) 該ServiceExtension去啟動另一個UIAbility2,并在啟動的時候攜帶參數(shù)ability.params.backToOtherMissionStack為true
      11. let context = ...; // ServiceExtensionContext
      12. let want = {
      13. bundleName: 'com.example.myapplication2',
      14. abilityName: 'MainAbility',
      15. parameters: {
      16. "ability.params.backToOtherMissionStack": true,
      17. },
      18. };
      19. context.startAbility(want, (err) => {
      20. console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`);
      21. });

      在上述例子中:

      • 如果ServiceExtension啟動UIAbility2時,不攜帶ability.params.backToOtherMissionStack參數(shù),或者攜帶的ability.params.backToOtherMissionStack參數(shù)為false,則UIAbility1和UIAbility2不在同一個任務(wù)棧里面,在UIAbility2的界面點back鍵,不會回到UIAbility1的界面。
      • 如果攜帶的ability.params.backToOtherMissionStack參數(shù)為true,則表示支持跨任務(wù)鏈返回,此時在UIAbility2的界面點back鍵,會回到UIAbility1的界面。
以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號