UIAbility內(nèi)和UIAbility間頁(yè)面的跳轉(zhuǎn)（ArkTS）

介紹

基于Stage模型下的UIAbility開發(fā)，實(shí)現(xiàn)UIAbility內(nèi)和UIAbility間頁(yè)面的跳轉(zhuǎn)。包含如下功能：

UIAbility內(nèi)頁(yè)面的跳轉(zhuǎn)。
跳轉(zhuǎn)到指定UIAbility的首頁(yè)。
跳轉(zhuǎn)到指定UIAbility的指定頁(yè)面（非首頁(yè)）。

最終效果圖如下：

環(huán)境搭建

軟件要求

[DevEco Studio]版本：DevEco Studio 3.1 Release。
OpenHarmony SDK版本：API version 9。

硬件要求

開發(fā)板類型：[潤(rùn)和RK3568開發(fā)板]。
OpenHarmony系統(tǒng)：3.2 Release。

環(huán)境搭建

完成本篇Codelab我們首先要完成開發(fā)環(huán)境的搭建，本示例以RK3568開發(fā)板為例，參照以下步驟進(jìn)行：

[獲取OpenHarmony系統(tǒng)版本]：標(biāo)準(zhǔn)系統(tǒng)解決方案（二進(jìn)制）。以3.2 Release版本為例：
搭建燒錄環(huán)境。
1. [完成DevEco Device Tool的安裝]
2. [完成RK3568開發(fā)板的燒錄](méi)
搭建開發(fā)環(huán)境。
1. 開始前請(qǐng)參考[工具準(zhǔn)備]，完成DevEco Studio的安裝和開發(fā)環(huán)境配置。
2. 開發(fā)環(huán)境配置完成后，請(qǐng)參考[使用工程向?qū)創(chuàng)建工程（模板選擇“Empty Ability”）。
3. 工程創(chuàng)建完成后，選擇使用[真機(jī)進(jìn)行調(diào)測(cè)]。
4. 開發(fā)前請(qǐng)熟悉鴻蒙開發(fā)指導(dǎo)文檔：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

代碼結(jié)構(gòu)解讀

本篇Codelab只對(duì)核心代碼進(jìn)行講解，完整代碼可以直接從gitee獲取。

├──device/src/main/ets              // device模塊的代碼區(qū)
│  ├──pages
│  │  ├──Index.ets                  // SecondAbility的Index頁(yè)面
│  │  └──Second.ets                 // SecondAbility的Second頁(yè)面
│  ├──secondability
│  │  └──SecondAbility.ets          // 程序入口類
├──device/src/main/resources        // device模塊的資源文件目錄
├──entry/src/main/ets               // entry模塊的代碼區(qū)
│  ├──common
│  │  ├──constants
│  │  │  ├──CommonConstants.ets     // 公共常量類
│  │  │  └──StyleConstants.ets	    // 樣式常量類
│  │  ├──utils
│  │  │  ├──GlobalContext.ets       // 全局變量控制類
│  │  │  └──Logger.ets	            // 日志打印類
│  ├──entryability
│  │  └──EntryAbility.ts            // 程序入口類
│  ├──model
│  │  └──ButtonClickMethod.ets      // 按鈕點(diǎn)擊后調(diào)用的方法類
│  ├──pages
│  │  ├──Index.ets                  // EntryAbility的Index頁(yè)面
│  │  └──Second.ets                 // EntryAbility的Second頁(yè)面
└──entry/src/main/resources         // entry模塊的資源文件目錄

`HarmonyOS與OpenHarmony鴻蒙文檔籽料：mau123789是v直接拿`

搜狗高速瀏覽器截圖20240326151450.png

UIAbility內(nèi)頁(yè)面的跳轉(zhuǎn)

entry模塊中，EntryAbility內(nèi)頁(yè)面的跳轉(zhuǎn)可以通過(guò)頁(yè)面路由router來(lái)實(shí)現(xiàn)。頁(yè)面路由router根據(jù)頁(yè)面url找到目標(biāo)頁(yè)面，從而實(shí)現(xiàn)跳轉(zhuǎn)。效果圖如下：

實(shí)現(xiàn)UIAbility內(nèi)頁(yè)面的跳轉(zhuǎn)，我們首先需要構(gòu)建兩個(gè)頁(yè)面。在“Project”窗口，點(diǎn)擊“entry > src > main > ets > pages”，打開“Index.ets”文件，可以看到EntryAbility的Index頁(yè)面由一個(gè)Image組件、兩個(gè)Text組件、三個(gè)Button組件組成。“Index.ets”文件的示例代碼如下：

@Entry
@Component
struct Index {
  @State text: string = '';
  @State bottomMargin: string = StyleConstants.MAIN_INDEX_BUTTON_MARGIN_BOTTOM;

  build() {
    Column() {
      Image($r('app.media.right'))
        ...

      Text($r('app.string.main_index_page_name'))
        ...

      // 條件渲染：當(dāng)text的值不為空時(shí)，顯示該組件
      if (this.text !== '') {
        Text(this.text)
          ...
      }

      // 導(dǎo)航到EntryAbility的Second Page
      Button($r('app.string.to_main_second_page_btn_text'), { type: ButtonType.Capsule, stateEffect: true })
        ...

      // 導(dǎo)航到SecondAbility的Index Page
      Button($r('app.string.to_second_index_page_btn_text'), { type: ButtonType.Capsule, stateEffect: true })
        ...

      // 導(dǎo)航到SecondAbility的Second Page
      Button($r('app.string.to_second_second_page_btn_text'), { type: ButtonType.Capsule, stateEffect: true })
        ...
    }
    ...
  }
}

在“Project”窗口，打開“entry > src > main > ets”，右鍵點(diǎn)擊“pages”文件夾，選擇“New > Page”，命名為“Second”。可以看到EntryAbility的Second頁(yè)面由一個(gè)Image組件、兩個(gè)Text組件、一個(gè)Button組件組成?！癝econd.ets”文件的示例代碼如下：

@Entry
@Component
struct Second {
  ...

  build() {
    Column() {
      Image($r('app.media.left'))
        ...

      Text($r('app.string.main_second_page_name'))
        ...

      Text(`${this.src}：${this.count}`)
        ...

      // 返回到EntryAbility的Index Page
      Button($r('app.string.back_main_index_page_btn_text'), { type: ButtonType.Capsule, stateEffect: true })
        ...
    }
    ...
  }
}

從entry模塊的Index頁(yè)面跳轉(zhuǎn)到Second頁(yè)面，并進(jìn)行數(shù)據(jù)傳遞，通過(guò)頁(yè)面路由router來(lái)實(shí)現(xiàn)。需要如下幾個(gè)步驟：

給兩個(gè)頁(yè)面導(dǎo)入router模塊。
在EntryAbility的Index頁(yè)面中，點(diǎn)擊“導(dǎo)航到EntryAbility的Second Page”按鈕后，調(diào)用ButtonClickMethod類中的toEntryAbilitySecond方法，跳轉(zhuǎn)到EntryAbility的Second頁(yè)面。使用router.pushUrl實(shí)現(xiàn)跳轉(zhuǎn)，可以通過(guò)params來(lái)向新頁(yè)面?zhèn)魅雲(yún)?shù)，示例代碼如下：

// 導(dǎo)入router模塊
import router from '@ohos.router';

// 導(dǎo)航到EntryAbility的Second Page
toEntryAbilitySecond() {
  router.pushUrl({
    url: 'pages/Second',
    params: {
      src: textMessage,
      count: CommonConstants.NUM_VALUES[0]
    }
  });
}

Second頁(yè)面通過(guò)router.getParams()方法獲取Index頁(yè)面?zhèn)鬟f過(guò)來(lái)的自定義參數(shù)，并用一個(gè)Text文本展示從Index頁(yè)面?zhèn)鬟f過(guò)來(lái)的數(shù)據(jù)，示例代碼如下：

@Entry
@Component
struct Second {
  ...
  // 獲取Index頁(yè)面?zhèn)鬟f過(guò)來(lái)的自定義參數(shù)
  params = router?.getParams();
  @State src: string = this.params == undefined ? '-' : (this.params as Record< string,Object >)['src'] as string;
  @State count: number = this.params == undefined ? 0 : (this.params as Record< string,Object >)['count'] as number;

  build() {
    Column() {
      Image($r('app.media.left'))
        ...

      Text($r('app.string.main_second_page_name'))
        ...

      // 用一個(gè)Text文本展示從Index頁(yè)面?zhèn)鬟f過(guò)來(lái)的數(shù)據(jù)      
      Text(`${this.src}：${this.count}`)
        ...

      // 返回到EntryAbility的Index Page
      Button($r('app.string.back_main_index_page_btn_text'), { type: ButtonType.Capsule, stateEffect: true })
        ...
    }
    ...
  }
}

從entry模塊的Second返回到Index頁(yè)面，使用router.back來(lái)實(shí)現(xiàn)。在EntryAbility的Second頁(yè)面中，點(diǎn)擊“返回到EntryAbility的Index Page”按鈕后，返回到EntryAbility的Index頁(yè)面，示例代碼如下：
```
// 返回到EntryAbility的Index Page
router.back();
```

跳轉(zhuǎn)到指定UIAbility的首頁(yè)

實(shí)現(xiàn)UIAbility間頁(yè)面的跳轉(zhuǎn)，需要啟動(dòng)另外一個(gè)UIAbility，可以通過(guò)UIAbilityContext的startAbility的方法來(lái)完成。本篇Codelab是用兩個(gè)模塊（entry和device），實(shí)現(xiàn)UIAbility間頁(yè)面的跳轉(zhuǎn)。跳轉(zhuǎn)到指定UIAbility的首頁(yè)，效果圖如下：

在本章節(jié)中，實(shí)現(xiàn)跳轉(zhuǎn)到指定UIAbility的首頁(yè)，我們需要新建一個(gè)模塊。在“Project”窗口，右鍵點(diǎn)擊“entry 文件夾”，選擇“New > Module > Empty Ability > Next”，在“Module name”中給新建的模塊命名為“device”，點(diǎn)擊“Next”，在“Ability name”中給新建模塊的Ability命名為“SecondAbility”，點(diǎn)擊“Finish”?？梢钥吹轿募夸浗Y(jié)構(gòu)如下：

構(gòu)建SecondAbility的首頁(yè)。在“Project”窗口，點(diǎn)擊“device > src > main > ets > pages”，打開“Index.ets”文件，可以看到SecondAbility的Index頁(yè)面由一個(gè)Image組件、兩個(gè)Text組件、一個(gè)Button組件組成?！癐ndex.ets”文件的示例代碼如下：

@Entry
@Component
struct Index {
  ...

  build() {
    Column() {
      Image($r('app.media.left'))
        ...

      Text($r('app.string.second_index_page_name'))
        ...

      Text(`${this.src}：${this.count}`)
        ...

      // 停止SecondAbility自身
      Button($r('app.string.terminate_second_btn_text'), { type: ButtonType.Capsule, stateEffect: true })
        ...
    }
    ...
  }
}

從entry模塊的EntryAbility的首頁(yè)，跳轉(zhuǎn)到SecondAbility的首頁(yè)，即從EntryAbility的Index頁(yè)面跳轉(zhuǎn)到SecondAbility的Index頁(yè)面。通過(guò)UIAbilityContext的startAbility方法來(lái)實(shí)現(xiàn)。

首先需要在EntryAbility的“Index.ets”文件中獲取UIAbilityContext，示例代碼如下：
```
// 獲取UIAbilityContext
let context = getContext(this) as common.UIAbilityContext;
```
說(shuō)明： 如果需要使用UIAbilityContext中的方法，需要在對(duì)應(yīng)的頁(yè)面獲取相應(yīng)的UIAbilityContext。

在EntryAbility的Index頁(yè)面中，點(diǎn)擊“導(dǎo)航到SecondAbility的Index Page”按鈕后，調(diào)用ButtonClickMethod類中的toSecondAbilityIndex方法，拉起SecondAbility的Index頁(yè)面。使用UIAbilityContext.startAbility來(lái)實(shí)現(xiàn)，可以通過(guò)parameters來(lái)向被拉起方傳遞參數(shù)，示例代碼如下：

// 導(dǎo)航到SecondAbility的Index Page
toSecondAbilityIndex(context: common.UIAbilityContext) {
  let want: Want = {
    'deviceId': '',
    'bundleName': CommonConstants.BUNDLE_NAME,
    'abilityName': CommonConstants.SECOND_ABILITY_NAME,
    'moduleName': CommonConstants.DEVICE_MODULE_NAME,
    'parameters': {
       src: textMessage,
       count: CommonConstants.NUM_VALUES[1]
     }
  };
  context.startAbility(want).then(() = > {
    Logger.info(CommonConstants.TAG, `start second ability index page succeed with ${JSON.stringify(want)}`);
  }).catch((error: Error) = > {
    Logger.error(CommonConstants.TAG, `start second ability index page failedwith ${error}`);
  });
}

在SecondAbility的Index頁(yè)面，獲取從EntryAbility的Index頁(yè)面?zhèn)鬟f過(guò)來(lái)的自定義參數(shù)，并用一個(gè)Text文本展示從Index頁(yè)面?zhèn)鬟f過(guò)來(lái)的數(shù)據(jù)，示例代碼如下：

@Entry
@Component
struct Index {
  // 獲取從EntryAbility的Index頁(yè)面?zhèn)鬟f過(guò)來(lái)的自定義參數(shù)
  secondAbilityWant?: Want = GlobalContext.getContext().getObject('secondAbilityWant');
  @State src: string = this.secondAbilityWant?.parameters?.src as string ?? '-';
  @State count: number = this.secondAbilityWant?.parameters?.count as number ?? 0;

  build() {
    Column() {
      Image($r('app.media.left'))
        ...

      Text($r('app.string.second_index_page_name'))
        ...

      // 用一個(gè)Text文本展示從Index頁(yè)面?zhèn)鬟f過(guò)來(lái)的數(shù)據(jù)
      Text(`${this.src}：${this.count}`)
        ...

      // 停止SecondAbility自身
      Button($r('app.string.terminate_second_btn_text'), { type: ButtonType.Capsule, stateEffect: true })
        ...
    }
    ...
  }
}

在SecondAbility的Index頁(yè)面，點(diǎn)擊“停止SecondAbility自身”按鈕，使用UIAbilityContext.terminateSelf方法手動(dòng)銷毀Ability。示例代碼如下：

// 停止SecondAbility自身
terminateSecondAbility(context: common.UIAbilityContext) {
  context.terminateSelf().then(() = > {
    Logger.info(CommonConstants.TAG, 'terminate second ability self succeed');
  }).catch((error: Error) = > {
    Logger.error(CommonConstants.TAG, `terminate second ability self failed with ${error}`);
  });
}

運(yùn)行時(shí)，需要在DevEco Studio的entry模塊中勾選“Deploy Multi Hap Packages”，如下圖所示：

跳轉(zhuǎn)到指定UIAbility的指定頁(yè)面（非首頁(yè)）

跳轉(zhuǎn)到指定UIAbility的指定頁(yè)面（非首頁(yè)），本章節(jié)以從EntryAbility的Index頁(yè)面跳轉(zhuǎn)到SecondAbility的Second頁(yè)面為例。只需要在本文檔“跳轉(zhuǎn)到指定UIAbility的首頁(yè)”章節(jié)的基礎(chǔ)上，另外在device模塊中構(gòu)建一個(gè)Second頁(yè)面。效果圖如下：

構(gòu)建SecondAbility的Second頁(yè)面。在“Project”窗口，打開“device > src > main > ets”，右鍵點(diǎn)擊“pages”文件夾，選擇“New > Page”，命名為“Second”。可以看到文件目錄結(jié)構(gòu)如下：

可以看到SecondAbility的Second頁(yè)面由一個(gè)Image組件、兩個(gè)Text組件、一個(gè)Button組件組成?！癝econd.ets”文件的示例代碼如下：

@Entry
@Component
struct Second {
  // 用來(lái)接收parameters參數(shù)傳過(guò)來(lái)的值
  secondAbilityWant?: Want = GlobalContext.getContext().getObject('secondAbilityWant');
  @State src: string = this.secondAbilityWant?.parameters?.src as string ?? '-';
  @State count: number = this.secondAbilityWant?.parameters?.count as number ?? 0;

  build() {
    Column() {
      Image($r('app.media.left'))
        ...

      Text($r('app.string.second_second_page_name'))
        ...

      Text(`${this.src}：${this.count}`)
        ...

      // 停止SecondAbility自身并返回結(jié)果
      Button($r('app.string.terminate_second_for_result_btn_text'), { type: ButtonType.Capsule, stateEffect: true })
        ...
    }
    ...
  }
}

在EntryAbility的Index頁(yè)面中，點(diǎn)擊“導(dǎo)航到SecondAbility的Second Page”按鈕后，調(diào)用ButtonClickMethod類中的toSecondAbilitySecond方法，拉起SecondAbility的Second頁(yè)面。

使用UIAbilityContext.startAbilityForResult來(lái)實(shí)現(xiàn)，并獲取被拉起側(cè)銷毀后的返回結(jié)果。可以通過(guò)parameters來(lái)向被拉起方傳遞參數(shù)，示例代碼如下：

// 導(dǎo)航到SecondAbility的Second Page
toSecondAbilitySecond(context: common.UIAbilityContext, callback: (abilityResult: common.AbilityResult) = > void) {
  let want: Want = {
    'deviceId': '',
    'bundleName': CommonConstants.BUNDLE_NAME,
    'abilityName': CommonConstants.SECOND_ABILITY_NAME,
    'moduleName': CommonConstants.DEVICE_MODULE_NAME,
    'parameters': {
       url: 'pages/Second',
       src: textMessage,
       count: CommonConstants.NUM_VALUES[2]
     }
  };

  // 被拉起側(cè)銷毀后，在startAbilityForResult回調(diào)中可以獲取到被拉起側(cè)銷毀時(shí)傳遞過(guò)來(lái)的AbilityResult
  context.startAbilityForResult(want).then((result) = > {
    callback(result);
    Logger.info(CommonConstants.TAG, `start second ability second page succeed with ${JSON.stringify(want)}`);
  }).catch((error: Error) = > {
    Logger.error(CommonConstants.TAG, `start second ability second page failed with ${error}`);
  });
}

在“Project”窗口，點(diǎn)擊“device > src > main > ets > SecondAbility”，打開“SecondAbility.ets”文件，在onWindowStageCreate的生命周期回調(diào)函數(shù)中獲取拉起方的意圖，展示SecondAbility的指定頁(yè)面到界面。示例代碼如下：

onWindowStageCreate(windowStage: Window.WindowStage) {
  ...
  let parameters: Record< string, Object > = (GlobalContext.getContext().getObject('secondAbilityWant') as Want)?.parameters as Record< string, Object >;
  let url = parameters?.url ?
    parameters.url as string : 'pages/Index';
  windowStage.loadContent(url, (err, data) = > {
    ...
  });
}

在SecondAbility的Second頁(yè)面，點(diǎn)擊“停止SecondAbility自身并返回結(jié)果”按鈕，使用UIAbilityContext.terminateSelfWithResult方法，傳入不同的resultCode和want，手動(dòng)銷毀Ability。成功后發(fā)起拉起側(cè)會(huì)收到abilityResult的值。示例代碼如下：

// 停止SecondAbility自身并返回結(jié)果
terminateSecondAbilityForResult(context: common.UIAbilityContext) {
  let abilityResult: common.AbilityResult = {
    resultCode: CommonConstants.RESULT_CODE,
    want: {
      'deviceId': '',
      'bundleName': CommonConstants.BUNDLE_NAME,
      'abilityName': CommonConstants.SECOND_ABILITY_NAME,
      'moduleName': CommonConstants.DEVICE_MODULE_NAME,
      'parameters': {
         src: returnMessage,
         count: CommonConstants.RESULT_NUM_VALUE
       }
    }
  };

  // 停止SecondAbility自身，并將abilityResult返回給startAbilityForResult接口調(diào)用方
  context.terminateSelfWithResult(abilityResult).then(() = > {
    Logger.info(CommonConstants.TAG, `terminate second ability self with
      result succeed with ${JSON.stringify(abilityResult)}`);
  }).catch((error: Error) = > {
    Logger.error(CommonConstants.TAG, `terminate second ability self with
      result failed with ${error}`);
  });
}

審核編輯黃宇

聲明：本文內(nèi)容及配圖由入駐作者撰寫或者入駐合作網(wǎng)站授權(quán)轉(zhuǎn)載。文章觀點(diǎn)僅代表作者本人，不代表電子發(fā)燒友網(wǎng)立場(chǎng)。文章及其配圖僅供工程師學(xué)習(xí)之用，如有內(nèi)容侵權(quán)或者其他違規(guī)問(wèn)題，請(qǐng)聯(lián)系本站處理。舉報(bào)投訴