HarmonyOS NEXT 自动生成动态路由

最新推荐文章于 2024-07-15 17:42:36 发布

蜀道山QAQ

最新推荐文章于 2024-07-15 17:42:36 发布

阅读量1.1k

点赞数 21

分类专栏：鸿蒙鸿蒙实战案例文章标签： harmonyos 华为 android 驱动开发鸿蒙

本文链接：https://blog.csdn.net/shudaoshanQAQ/article/details/139203814

版权

鸿蒙同时被 2 个专栏收录

631 篇文章 64 订阅

订阅专栏

鸿蒙实战案例

134 篇文章 10 订阅

订阅专栏

本示例将介绍如何使用装饰器和插件，自动生成动态路由表，并通过动态路由跳转到模块中的页面，以及如何使用动态import的方式加载模块

使用说明

自定义装饰器
添加装饰器和插件配置文件，编译时自动生成动态路由表
配置动态路由，通过WrapBuilder接口，动态创建页面并跳转。
动态import变量表达式，需要DevEco Studio NEXT Developer Preview1 （4.1.3.500）版本IDE，配合hvigor 4.0.2版本使用。

实现思路

动态路由的实现

初始化动态路由

 public static routerInit(config: RouterConfig, context: Context) {
   DynamicsRouter.config = config;
   DynamicsRouter.appRouterStack.push(HOME_PAGE);
   RouterLoader.load(config.mapPath, DynamicsRouter.routerMap, context);
 }

获取路由

private static getNavPathStack(): NavPathStack {
  return DynamicsRouter.navPathStack;
}

通过builderName，注册WrappedBuilder对象，用于动态创建页面

private static registerBuilder(builderName: string, builder: WrappedBuilder<[object]>): void {
  DynamicsRouter.builderMap.set(builderName, builder);
}

通过builderName，获取注册的WrappedBuilder对象

public static getBuilder(builderName: string): WrappedBuilder<[object]> {
  let builder = DynamicsRouter.builderMap.get(builderName);
  if (!builder) {
    let msg = "not found builder";
    console.info(msg + builderName);
  }
  return builder as WrappedBuilder<[object]>;
}

通过页面栈跳转到指定页面

public static pushUri(name: string, param?: Object) {
  if (!DynamicsRouter.routerMap.has(name)) {
    return;
  }
  let routerInfo: AppRouterInfo = DynamicsRouter.routerMap.get(name)!;
  if (!DynamicsRouter.builderMap.has(name)) {
    import(`${DynamicsRouter.config.libPrefix}/${routerInfo.pageModule}`)
      .then((module: ESObject) => {
        module[routerInfo.registerFunction!](routerInfo);
        DynamicsRouter.navPathStack.pushPath({ name: name, param: param });
    })
      .catch((error: BusinessError) => {
        logger.error(`promise import module failed, error code:${error.code}, message:${error.message}`);
    });
  } else {
    DynamicsRouter.navPathStack.pushPath({ name: name, param: param });
    DynamicsRouter.pushRouterStack(routerInfo);
  }
}

注册动态路由跳转的页面信息

public static registerAppRouterPage(routerInfo: AppRouterInfo, wrapBuilder: WrappedBuilder<[object]>): void {
  const builderName: string = routerInfo.name;
  if (!DynamicsRouter.builderMap.has(builderName)) {
    DynamicsRouter.registerBuilder(builderName, wrapBuilder);
  }
}

动态路由的使用

在工程的hvigor/hvigor-config.json5中配置插件

{
    ...
    "dependencies": {
        ...
        "@app/ets-generator": "file:../plugin/AutoBuildRouter"
    }
}

在工程的根目录的build-profile.json5中添加动态路由模块和需要加载的子模块的依赖，详细代码参考build-profile.json5。

{
  "app":{
    ...
  }
  "modules":{
    ...
    {
      "name": "eventpropagation",
      "srcPath": "./feature/eventpropagation"
    },
    {
      "name": "routermodule",
      "srcPath": "./feature/routermodule"
    }
    ...
  }
}

在主模块中添加动态路由和需要加载的子模块的依赖，详细代码请参考oh-package.json。

"dependencies": {
  "@ohos/dynamicsrouter": "file:../../feature/routermodule",    
  "@ohos/event-propagation": "file:../../feature/eventpropagation",
  ...
}

在主模块中添加动态import变量表达式需要的参数，此处在packages中配置的模块名必须和oh-package.json中配置的名称相同，详细代码请参考build-profile.json5。
```
...
"buildOption": {
  "arkOptions": {
    "runtimeOnly": {
      "packages": [
        "@ohos/event-propagation",
        ...
      ]
    }
  }
}
```

在主模块EntryAbility的onCreate接口初始化动态路由，详细代码请参考EntryAbility.ets。

...
onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
  DynamicsRouter.routerInit({
    libPrefix: "@ohos", mapPath: "routerMap"
  }, this.context);
  ...
}
...

在主模块的WaterFlowData.ets中，将子模块要加载的页面，添加到列表中，详细代码请参考WaterFlowData.ets和SceneModuleInfo。

export const waterFlowData: SceneModuleInfo[] = [
  ...
  new SceneModuleInfo($r('app.media.address_exchange'), '地址交换动画', new RouterInfo("", ""), '动效', 2, "addressexchange/AddressExchangeView"),
  ...
}

在需要加载时将页面放入路由栈，详细代码请参考FunctionalScenes.ets。

@Builder
methodPoints(listData: ListData) {
  Column() {
  ...
    .onClick(() => {
      ...
      DynamicsRouter.pushUri(this.listData.appUri);
      ...
    })
}

在子模块中添加动态路由的依赖，详细代码可参考oh-package.json。

...
"dependencies": {
  ...
  "@ohos/dynamicsrouter": "file:../../feature/routermodule"
}

以上是需要在主模块中添加的配置，如果已经添加过相关代码，则可以直接略过，按照下面的步骤在子模块中添加相关即可自动生成动态路由相关文件。

在子模块的oh-package.json5中添加路由模块依赖，可参考oh-package.json5

{
  ...
  "dependencies": {
    ...
    // 动态路由模块，用于配置动态路由
    "@ohos/dynamicsrouter": "file:../../feature/routermodule"
  }
}

在子模块的hvigorfile.ts文件中添加插件配置，可参考hvigorfile.ts

...
import { PluginConfig, etsGeneratorPlugin } from '@app/ets-generator';
// 配置路由信息
const config: PluginConfig = {
  // 需要扫描的文件的路径，即配置自定义装饰AppRouter的文件路径
  scanFiles: ["src/main/ets/view/AddressExchangeView"]
}

export default {
  ...
  plugins: [etsGeneratorPlugin(config)]         /* Custom plugin to extend the functionality of Hvigor. */
}

在需要跳转的页面的自定义组件上添加装饰器，可参考AddressExchangeView.ets，如果需要通过路由传递参数，则需要设置hasParam为true，可参考NavigationParameterTransferView.ets。

// 自定义装饰器，用于自动生成动态路由代码及页面的跳转。命名规则：模块名/自定义组件名
@AppRouter({ name: "addressexchange/AddressExchangeView" })
@Component
export struct AddressExchangeView {
  ...
}

高性能知识点

本示例使用动态import的方式加载模块，只有需要进入页面时才加载对应的模块，减少主页面启动时间和初始化效率，减少内存的占用。

工程结构&模块类型

routermodule                                  // har类型
|---annotation
|---|---AppRouter.ets                         // 自定义装饰器
|---constants
|   |---RouterInfo.ets                        // 路由信息类，用于配置动态路由跳转页面的名称和模块名（后续会删除）
|---model
|   |---AppRouterInfo.ets                     // 路由信息类
|   |---RouterParam.ets                       // 路由参数
|---router
|   |---DynamicsRouter.ets                    // 动态路由实现类
|---util
|   |---RouterLoader.ets                      // 路由表加载类

模块依赖

不涉及

最后

有很多小伙伴不知道学习哪些鸿蒙开发技术？不知道需要重点掌握哪些鸿蒙应用开发知识点？而且学习时频繁踩坑，最终浪费大量时间。所以有一份实用的鸿蒙（HarmonyOS NEXT）资料用来跟着学习是非常有必要的。

这份鸿蒙（HarmonyOS NEXT）资料包含了鸿蒙开发必掌握的核心知识要点，内容包含了（ArkTS、ArkUI开发组件、Stage模型、多端部署、分布式应用开发、音频、视频、WebGL、OpenHarmony多媒体技术、Napi组件、OpenHarmony内核、Harmony南向开发、鸿蒙项目实战等等）鸿蒙（HarmonyOS NEXT）技术知识点。

希望这一份鸿蒙学习资料能够给大家带来帮助，有需要的小伙伴自行领取，限时开源，先到先得~无套路领取！！

如果你是一名有经验的资深Android移动开发、Java开发、前端开发、对鸿蒙感兴趣以及转行人员，可以直接领取这份资料

获取这份完整版高清学习路线，请点击→纯血版全套鸿蒙HarmonyOS学习资料

鸿蒙（HarmonyOS NEXT）最新学习路线

HarmonOS基础技能

HarmonOS就业必备技能
HarmonOS多媒体技术

鸿蒙NaPi组件进阶

HarmonOS高级技能

初识HarmonOS内核
实战就业级设备开发

有了路线图，怎么能没有学习资料呢，小编也准备了一份联合鸿蒙官方发布笔记整理收纳的一套系统性的鸿蒙（OpenHarmony ）学习手册（共计1236页）与鸿蒙（OpenHarmony ）开发入门教学视频，内容包含：ArkTS、ArkUI、Web开发、应用模型、资源分类…等知识点。

获取以上完整版高清学习路线，请点击→纯血版全套鸿蒙HarmonyOS学习资料