《探索 HarmonyOS NEXT (5.0):开启构建模块化项目架构奇幻之旅 —— 动态路由 ZRouter:引领高效模块通信的智慧中枢》

ZRouter简介:是一款轻量级的动态路由框架,基于Navigation系统路由表和Hvigor插件实现的方案,可以解决多个业务模块(HAR/HSP)之间解耦和通信问题,从而实现业务复用和功能扩展。
ZRouter出处ZRouter


非常感谢大佬出的库,方便我们开发,提高我们开发效率,更详细的介绍和使用请看官方出处。
其它
Navigation官网


ZRouter的配置


  • 在Dev工具里选择Terminal,通过ohpm工具下载安装库:
    点击查看最新版本

  • ohpm install @hzw/zrouter



        // 远程依赖     "router-register-plugin":"1.1.1"



    2.2. 初始配置,在每个模块中的hvigorfile.ts文件导入router-register-plugin插件模块,如下:


  • 导入方式唯一不同在于system:产品定制层是hapTasks ,基础特性层是harTasks 。

  • 2.2.1:产品定制层 导入方式:


    import { hapTasks } from '@ohos/hvigor-ohos-plugin';// 1、导入import { routerRegisterPlugin, PluginConfig } from 'router-register-plugin'// 2、初始化配置const config: PluginConfig = {  //scanDirs: ['src/main/ets/pages', 'src/main/ets/views'],  // 扫描的目录,如果不设置,默认是扫描src/main/ets目录  logEnabled: true, // 日志记录开关  viewNodeInfo: false, // 查看节点信息  isAutoDeleteHistoryFiles: true // 删除无用编译产物}export default {  system: hapTasks, /* Built-in plugin of Hvigor. It cannot be modified. */  // 3、添加插件  plugins: [routerRegisterPlugin(config)] /* Custom plugin to extend the functionality of Hvigor. */}


    2.2.2:基础特性层 导入方式:


    import { harTasks } from '@ohos/hvigor-ohos-plugin';// 1、导入import { routerRegisterPlugin, PluginConfig } from 'router-register-plugin'// 2、初始化配置const config: PluginConfig = {    //scanDirs: ['src/main/ets/pages', 'src/main/ets/views'],  // 扫描的目录,如果不设置,默认是扫描src/main/ets目录    logEnabled: true, // 日志记录开关    viewNodeInfo: false, // 查看节点信息    isAutoDeleteHistoryFiles: true // 删除无用编译产物}export default {    system: harTasks, /* Built-in plugin of Hvigor. It cannot be modified. */    // 3、添加插件    plugins: [routerRegisterPlugin(config)] /* Custom plugin to extend the functionality of Hvigor. */}


    2.3. 添加代码忽略: _generated目录和route_map.json文件在编译阶段自动生成的,建议在git的.gitignore忽略掉这两个文件。


    _generatedroute_map.json


    ZRouter的基本使用


    1、 在EntryAbility的onCreate()方法中初始化ZRouter


        // 如果项目中存在hsp模块则传入true    ZRouter.initialize((config) => {      config.isLoggingEnabled = BuildProfile.DEBUG      config.isHSPModuleDependent = false    })


    2、在Index页面使用Navigation作为根视图



    3、页面跳转


    1.普通跳转,通过页面的name去跳转,并可以携带param,name属性值建议用常量,方便后期维护。本例子中使用 NavName.LOGIN_VIEW


          // 跳转到登录页面      ZRouter.getInstance().navigation(NavName.LOGIN_VIEW)      // 携带参数跳转      ZRouter.getInstance()        .setParam("携带参数")        .navigation(NavName.LOGIN_VIEW)   // 获取参数   ZRouter.getInstance().getParamByName(NavName.LOGIN_VIEW)


    2.带返回回调的跳转


     ZRouter.getInstance()        .setParam("携带参数")        .enableCrossPageParamReturn()        .setPopListener((info) => {          console.log('xxx 返回携带的数据:', info.data)        })        .navigation(NavName.LOGIN_VIEW)        // 返回传的参数 ZRouter.getInstance().popToRootWithResult<string>( '我是登录页返回的数据')


    4、根视图的用法


      build() {    // 获取NavPathStack实例对象    Navigation(ZRouter.getNavStack()) {    }    .onAppear(() => {      // 跳转到登录页面      ZRouter.getInstance().navigation(NavName.LOGIN_VIEW)    })    .hideTitleBar(true)    .mode(NavigationMode.Stack)    .width(CommonConst.FULL_PARENT)    .height(CommonConst.FULL_PARENT)  }


    5、子视图的用法


    build() {    NavDestination() {      Column() {        Text(ZRouter.getInstance().getParamByName(NavName.LOGIN_VIEW).toString()).onClick(() => {          ZRouter.getInstance().popToRootWithResult<string>( '我是登录页返回的数据')        })      }    }.width(CommonConst.FULL_PARENT)    .height(CommonConst.FULL_PARENT)  }


    6、其它使用方法请查看ZRouter官方文档,后续本篇内容会持续更新更多使用方法。


  • 以往系列文章

  • 《探索 HarmonyOS NEXT(5.0):开启构建模块化项目架构奇幻之旅 —— 模块化基础篇》
  • 《探索 HarmonyOS NEXT(5.0):开启构建模块化项目架构奇幻之旅 —— 构建基础特性层》
  • 《探索 HarmonyOS NEXT(5.0):开启构建模块化项目架构奇幻之旅 —— 构建公共能力层》
  • 《探索 HarmonyOS NEXT(5.0):开启构建模块化项目架构奇幻之旅 —— Tabs底部导航栏》

  • 若本文对您稍有帮助,诚望您不吝点赞,多谢。


    有兴趣的同学可以点击查看源码


  • gitee:https://gitee.com/jiaojiaoone/explore-harmony-next.git
  • github:https://github.com/JasonYinH/ExploreHarmonyNext.git

  • 欢迎一起交流


    最后编辑于
    ©著作权归作者所有,转载或内容合作请联系作者
    • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
      沈念sama阅读 213,186评论 6 492
    • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
      沈念sama阅读 90,858评论 3 387
    • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
      开封第一讲书人阅读 158,620评论 0 348
    • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
      开封第一讲书人阅读 56,888评论 1 285
    • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
      茶点故事阅读 66,009评论 6 385
    • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
      开封第一讲书人阅读 50,149评论 1 291
    • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
      沈念sama阅读 39,204评论 3 412
    • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
      开封第一讲书人阅读 37,956评论 0 268
    • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
      沈念sama阅读 44,385评论 1 303
    • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
      茶点故事阅读 36,698评论 2 327
    • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
      茶点故事阅读 38,863评论 1 341
    • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
      沈念sama阅读 34,544评论 4 335
    • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
      茶点故事阅读 40,185评论 3 317
    • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
      开封第一讲书人阅读 30,899评论 0 21
    • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
      开封第一讲书人阅读 32,141评论 1 267
    • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
      沈念sama阅读 46,684评论 2 362
    • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
      茶点故事阅读 43,750评论 2 351

    推荐阅读更多精彩内容