JRouterHarmonyOs

鸿蒙路由框架,使用hvigor插件生成模版,支持跨模块通信,实现代码解耦。

• path支持跨模块常量

• path支持跨模块静态变量

• 修复跨模块跳转hap模块页面的问题

• 跨模块命名路由跳转(基于@ohos.router)
• 自定义拦截器,支持全局和指定拦截器注册
• SPI服务发现

1. 项目hvigor目录下新建hvigor-config.json 文件, 添加插件依赖

   {
    "modelVersion": "5.0.0",
    "dependencies": {
    "@mufans/router-plugin": "file:../plugin/lib/mufans-router-plugin-1.0.3.tgz" // 插件包
    },
    "execution": {
    // "daemon": true, /* Enable daemon compilation. Default: true */
    // "incremental": true, /* Enable incremental compilation. Default: true */
    // "parallel": true, /* Enable parallel compilation. Default: true */
    // "typeCheck": false, /* Enable typeCheck. Default: false */
    },
    "logging": {
    // "level": "info" /* Define the log level. Value: [ "debug" | "info" | "warn" | "error" ]. Default: "info" */
    },
    "debugging": {
    // "stacktrace": false /* Disable stacktrace compilation. Default: false */
    }
   }

2. 在模块的hvigorfile.ts文件中添加对应插件

   import { hapTasks } from '@ohos/hvigor-ohos-plugin';
   import {hapPlugin} from '@mufans/router-plugin';
   export default {
    system: hapTasks, /* Built-in plugin of Hvigor. It cannot be modified. */
    plugins:[hapPlugin()] /* Custom plugin to extend the functionality of Hvigor. */
   }
   import { harTasks } from '@ohos/hvigor-ohos-plugin';
   import {harPlugin} from '@mufans/router-plugin';
   export default {
    system: harTasks, /* Built-in plugin of Hvigor. It cannot be modified. */
    plugins:[harPlugin()] /* Custom plugin to extend the functionality of Hvigor. */
   }
   import { hspTasks } from '@ohos/hvigor-ohos-plugin';
   import {hspPlugin} from '@mufans/router-plugin';
   export default {
    system: hspTasks, /* Built-in plugin of Hvigor. It cannot be modified. */
    plugins:[hspPlugin()] /* Custom plugin to extend the functionality of Hvigor. */
   }

3. 在项目根目录或者模块目录添加配置文件router_config.json, 插件优先读取当前目录的配置

{
 disablePlugin: false, // 是否禁用插件
 root: 'demo', // 模块的根目录,默认目录无需配置
 dirs: ['src/main/ets/components'] // 添加源码扫描目录,提升构建性能
}

4. 添加路由库依赖

 { 
 "devDependencies": {
 "@mufans/jrouter": "file:./libRouter"
 }
 }

1. @JRouter 标识页面路由

   参数说明:

   path : 页面路由唯一路径,支持常量、静态变量

   interceptors: 指定拦截器,不设置使用全局拦截器

   @JRouter({ path: TEST_PAGE,interceptors:["SpecialInterceptor"] })
   @Entry({ routeName: TEST_PAGE })
   @Component
   export struct MainPage {
   }

2. @JRouterInterceptor 标识拦截器

   参数说明:

   path : 唯一标识,支持常量,静态变量

   global: 标识全局拦截器

   priority: 拦截器优先级

   @JRouterInterceptor({path:"SpecialInterceptor",global:false,priority:100})
   export class SpecialInterceptor implements IInterceptor {
    async intercept(options: NamedRouterOptions): Promise<InterceptorResult> {
    console.log("SpecialInterceptor..........")
    ToastUtil.showToast(`${options.name} intercepted by SpecialInterceptor `)
    return {
    terminal: true, // terminal 为true表示行为终止,不会执行后续的拦截器和页面跳转
    options: options // 路由参数,多个拦截器可以修改参数实现多层级aop的功能
    }
    }
   }

3. @JProvider 标识服务接口

   参数说明:

   path : 唯一标识,支持常量,静态变量

   singleton: 标识是否单例

   @JProvider({
    path: "TestService2",
    singleton: true,
   })
   export class TestService2Impl implements ITestService2{
    execute(): void {
    console.log("TestService2 ......")
    ToastUtil.showToast(`TestService2Impl execute `)
    }
   }

执行项目构建后,插件会执行以下操作

• 读取配置,遍历包含装饰器的代码,生成路由表。

• 在模块 generate目录下生成 routemap.ets, 用于运行时注册路由表。

• 在hap模块的rawFile目录中生成合并后的路由表routemap.json, 用来运行时构建路由表。

1. 在EntryAbility中初始化路由框架

 RouterWrapper.init(this.context, {
 entry: () => {
 // routeMap为hap generate下的routemap, 框架使用了动态导入实现命名路由,
 // 由于hap无法被其他模块引用,所以这里手动添加。
 // 如hap模块没有路由则无需配置
 return routeMap; 
 }
 });

2. 页面跳转

RouterWrapper.pushNamedRoute({ name: "test_page" });

3. SPI

// 定义接口
export interface ITestService2 {
 execute(): void
}
// 实现接口
@JProvider({
 path: "TestService2",
 singleton: true,
})
export class TestService2Impl implements ITestService2{
 execute(): void {
 console.log("TestService2 ......")
 ToastUtil.showToast(`TestService2Impl execute `)
 }
}
// 获取接口
RouterWrapper.findServiceAsync<ITestService2>("TestService2").then((service) => {service?.execute();});

4. 拦截器

@JRouterInterceptor({path:"SpecialInterceptor",priority:100})
export class SpecialInterceptor implements IInterceptor {
 async intercept(options: NamedRouterOptions): Promise<InterceptorResult> {
 console.log("SpecialInterceptor..........")
 ToastUtil.showToast(`${options.name} intercepted by SpecialInterceptor `)
 return {
 terminal: true, // terminal 为true表示行为终止,不会执行后续的拦截器和页面跳转
 options: options // 路由参数,多个拦截器可以修改参数实现多层级aop的功能
 }
 }
}

• HMRouter