UIAbility內和UIAbility間頁面的跳轉（ArkTS）

介紹

基于Stage模型下的UIAbility開發，實現UIAbility內和UIAbility間頁面的跳轉。包含如下功能：

UIAbility內頁面的跳轉。
跳轉到指定UIAbility的首頁。
跳轉到指定UIAbility的指定頁面（非首頁）。

最終效果圖如下：

環境搭建

軟件要求

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

硬件要求

開發板類型：[潤和RK3568開發板]。
OpenHarmony系統：3.2 Release。

環境搭建

完成本篇Codelab我們首先要完成開發環境的搭建，本示例以RK3568開發板為例，參照以下步驟進行：

[獲取OpenHarmony系統版本]：標準系統解決方案（二進制）。以3.2 Release版本為例：
搭建燒錄環境。
1. [完成DevEco Device Tool的安裝]
2. [完成RK3568開發板的燒錄]
搭建開發環境。
1. 開始前請參考[工具準備]，完成DevEco Studio的安裝和開發環境配置。
2. 開發環境配置完成后，請參考[使用工程向導]創建工程（模板選擇“Empty Ability”）。
3. 工程創建完成后，選擇使用[真機進行調測]。
4. 開發前請熟悉鴻蒙開發指導文檔：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

代碼結構解讀

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

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

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

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

UIAbility內頁面的跳轉

entry模塊中，EntryAbility內頁面的跳轉可以通過頁面路由router來實現。頁面路由router根據頁面url找到目標頁面，從而實現跳轉。效果圖如下：

實現UIAbility內頁面的跳轉，我們首先需要構建兩個頁面。在“Project”窗口，點擊“entry > src > main > ets > pages”，打開“Index.ets”文件，可以看到EntryAbility的Index頁面由一個Image組件、兩個Text組件、三個Button組件組成?！癐ndex.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'))
        ...

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

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

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

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

在“Project”窗口，打開“entry > src > main > ets”，右鍵點擊“pages”文件夾，選擇“New > Page”，命名為“Second”?？梢钥吹紼ntryAbility的Second頁面由一個Image組件、兩個Text組件、一個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頁面跳轉到Second頁面，并進行數據傳遞，通過頁面路由router來實現。需要如下幾個步驟：

給兩個頁面導入router模塊。
在EntryAbility的Index頁面中，點擊“導航到EntryAbility的Second Page”按鈕后，調用ButtonClickMethod類中的toEntryAbilitySecond方法，跳轉到EntryAbility的Second頁面。使用router.pushUrl實現跳轉，可以通過params來向新頁面傳入參數，示例代碼如下：

// 導入router模塊
import router from '@ohos.router';

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

Second頁面通過router.getParams()方法獲取Index頁面傳遞過來的自定義參數，并用一個Text文本展示從Index頁面傳遞過來的數據，示例代碼如下：

@Entry
@Component
struct Second {
  ...
  // 獲取Index頁面傳遞過來的自定義參數
  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'))
        ...

      // 用一個Text文本展示從Index頁面傳遞過來的數據      
      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頁面，使用router.back來實現。在EntryAbility的Second頁面中，點擊“返回到EntryAbility的Index Page”按鈕后，返回到EntryAbility的Index頁面，示例代碼如下：
```
// 返回到EntryAbility的Index Page
router.back();
```

跳轉到指定UIAbility的首頁

實現UIAbility間頁面的跳轉，需要啟動另外一個UIAbility，可以通過UIAbilityContext的startAbility的方法來完成。本篇Codelab是用兩個模塊（entry和device），實現UIAbility間頁面的跳轉。跳轉到指定UIAbility的首頁，效果圖如下：

在本章節中，實現跳轉到指定UIAbility的首頁，我們需要新建一個模塊。在“Project”窗口，右鍵點擊“entry 文件夾”，選擇“New > Module > Empty Ability > Next”，在“Module name”中給新建的模塊命名為“device”，點擊“Next”，在“Ability name”中給新建模塊的Ability命名為“SecondAbility”，點擊“Finish”。可以看到文件目錄結構如下：

構建SecondAbility的首頁。在“Project”窗口，點擊“device > src > main > ets > pages”，打開“Index.ets”文件，可以看到SecondAbility的Index頁面由一個Image組件、兩個Text組件、一個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的首頁，跳轉到SecondAbility的首頁，即從EntryAbility的Index頁面跳轉到SecondAbility的Index頁面。通過UIAbilityContext的startAbility方法來實現。

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

在EntryAbility的Index頁面中，點擊“導航到SecondAbility的Index Page”按鈕后，調用ButtonClickMethod類中的toSecondAbilityIndex方法，拉起SecondAbility的Index頁面。使用UIAbilityContext.startAbility來實現，可以通過parameters來向被拉起方傳遞參數，示例代碼如下：

// 導航到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頁面，獲取從EntryAbility的Index頁面傳遞過來的自定義參數，并用一個Text文本展示從Index頁面傳遞過來的數據，示例代碼如下：

@Entry
@Component
struct Index {
  // 獲取從EntryAbility的Index頁面傳遞過來的自定義參數
  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'))
        ...

      // 用一個Text文本展示從Index頁面傳遞過來的數據
      Text(`${this.src}：${this.count}`)
        ...

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

在SecondAbility的Index頁面，點擊“停止SecondAbility自身”按鈕，使用UIAbilityContext.terminateSelf方法手動銷毀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}`);
  });
}

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

跳轉到指定UIAbility的指定頁面（非首頁）

跳轉到指定UIAbility的指定頁面（非首頁），本章節以從EntryAbility的Index頁面跳轉到SecondAbility的Second頁面為例。只需要在本文檔“跳轉到指定UIAbility的首頁”章節的基礎上，另外在device模塊中構建一個Second頁面。效果圖如下：

構建SecondAbility的Second頁面。在“Project”窗口，打開“device > src > main > ets”，右鍵點擊“pages”文件夾，選擇“New > Page”，命名為“Second”?？梢钥吹轿募夸浗Y構如下：

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

@Entry
@Component
struct Second {
  // 用來接收parameters參數傳過來的值
  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自身并返回結果
      Button($r('app.string.terminate_second_for_result_btn_text'), { type: ButtonType.Capsule, stateEffect: true })
        ...
    }
    ...
  }
}

在EntryAbility的Index頁面中，點擊“導航到SecondAbility的Second Page”按鈕后，調用ButtonClickMethod類中的toSecondAbilitySecond方法，拉起SecondAbility的Second頁面。

使用UIAbilityContext.startAbilityForResult來實現，并獲取被拉起側銷毀后的返回結果。可以通過parameters來向被拉起方傳遞參數，示例代碼如下：

// 導航到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]
     }
  };

  // 被拉起側銷毀后，在startAbilityForResult回調中可以獲取到被拉起側銷毀時傳遞過來的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”窗口，點擊“device > src > main > ets > SecondAbility”，打開“SecondAbility.ets”文件，在onWindowStageCreate的生命周期回調函數中獲取拉起方的意圖，展示SecondAbility的指定頁面到界面。示例代碼如下：

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頁面，點擊“停止SecondAbility自身并返回結果”按鈕，使用UIAbilityContext.terminateSelfWithResult方法，傳入不同的resultCode和want，手動銷毀Ability。成功后發起拉起側會收到abilityResult的值。示例代碼如下：

// 停止SecondAbility自身并返回結果
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接口調用方
  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}`);
  });
}

審核編輯黃宇

聲明：本文內容及配圖由入駐作者撰寫或者入駐合作網站授權轉載。文章觀點僅代表作者本人，不代表電子發燒友網立場。文章及其配圖僅供工程師學習之用，如有內容侵權或者其他違規問題，請聯系本站處理。舉報投訴

開發板

開發板

+關注

關注
25

文章
5081

瀏覽量
97692
鴻蒙

鴻蒙

+關注

關注
57

文章
2370

瀏覽量
42900
HarmonyOS

HarmonyOS

+關注

關注
79

文章
1980

瀏覽量
30280
OpenHarmony

OpenHarmony

+關注

關注
25

文章
3728

瀏覽量
16396

深入理解HarmonyOS UIAbility：生命周期、WindowStage與啟動模式探析

UIAbility組件概述 UIAbility組件是HarmonyOS中一種包含UI界面的應用組件，主要用于與用戶進行交互。每個UIAbility

發表于 02-17 15:33 ?1501次閱讀

鴻蒙OS開發實例：【頁面傳值跳轉】

本篇主要介紹如何在HarmonyOS中，在頁面跳轉之間如何傳值 HarmonyOS 的頁面指的是帶有@Entry裝飾器的文件，其不能獨自存

發表于 03-29 20:16 ?2288次閱讀

鴻蒙開發-應用程序框架UIAbility的使用

據傳遞、UIAbility間的數據跳轉和數據傳遞，本章節主要講解UIAbility內頁面的跳轉和

發表于 01-17 16:36

HarmonyOS/OpenHarmony應用開發- Stage模型概述

的開發方式。 UIAbility組件是一種包含UI界面的應用組件，主要用于和用戶交互。例如，圖庫類應用可以在UIAbility組件中展示圖片瀑布流，在用戶選擇某個圖片后，在新的

發表于 05-25 17:44

ArkTS語言HarmonyOS/OpenHarmony應用開發-router事件跳轉到指定UIAbility

hilog.info(0x0000, \'testTag\', \'%{public}s\', \'Ability onBackground\'); } } *附件：ArkTS語言HarmonyOSOpenHarmony應用開發-router事件

發表于 06-13 17:22

HarmonyOS/OpenHarmony應用開發-Stage模型UIAbility組件使用（一）

一、UIAbility組件概述1.概述 UIAbility組件是一種包含UI界面的應用組件，主要用于和用戶交互。 UIAbility組件是系統調度的基本單元，為應用提供繪制界

發表于 06-28 10:32

HarmonyOS/OpenHarmony應用開發-Stage模型UIAbility組件使用（一）

一、UIAbility組件概述1.概述 UIAbility組件是一種包含UI界面的應用組件，主要用于和用戶交互。 UIAbility組件是系統調度的基本單元，為應用提供繪制界

發表于 06-28 10:32

鴻蒙開發丨設備內 UIAbility 的幾種交互方式

UIAbility 組件間交互（設備內）在設備內，UIAbility（用戶界面能力）是系統調度的最小單元，它們負責展示用戶界面和執行相關的

發表于 02-02 10:42 ?639次閱讀

HarmonyOS開發案例：【Ability內頁面間的跳轉】

基于Stage模型下的Ability開發，實現Ability內頁面間的跳轉和數據傳遞。

發表于 05-09 10:39 ?579次閱讀

HarmonyOS開發案例：【UIAbility和自定義組件生命周期】

本文檔主要描述了應用運行過程中UIAbility和自定義組件的生命周期。對于UIAbility，描述了Create、Foreground、Background、Destroy四種生命周期。對于頁面

發表于 05-10 15:31 ?1281次閱讀

鴻蒙Ability Kit（程序框架服務）【UIAbility組件啟動模式】

UIAbility的啟動模式是指UIAbility實例在啟動時的不同呈現狀態。針對不同的業務場景，系統提供了三種啟動模式：

發表于 06-06 11:05 ?865次閱讀

鴻蒙Ability Kit（程序框架服務）【UIAbility組件基本用法】

UIAbility組件的基本用法包括：指定UIAbility的啟動頁面以及獲取UIAbility的上下文[UIAbilityContext]。

發表于 06-06 11:02 ?504次閱讀

鴻蒙Ability Kit（程序框架服務）【UIAbility組件間交互（設備內）】

UIAbility是系統調度的最小單元。在設備內的功能模塊之間跳轉時，會涉及到啟動特定的UIAbility，該UIAbility可以是應用

發表于 06-03 09:53 ?674次閱讀

鴻蒙Ability Kit（程序框架服務）【UIAbility內和UIAbility間頁面的跳轉】

基于Stage模型下的UIAbility開發，實現UIAbility內和UIAbility間

發表于 06-03 14:13 ?775次閱讀

鴻蒙開發：【頁面棧及任務鏈】

單個UIAbility組件可以實現多個頁面，并在多個頁面之間跳轉，這種UIAbility組件內部的頁面

發表于 06-14 10:10 ?440次閱讀