鸿蒙开发Hvigor插件动态生成代码的操作方法

更新时间：2024年11月21日 08:59:51 作者：龙儿筝

Hvigor主要提供了两种方式来实现插件：基于hvigorfile脚本开发插件、基于typescript项目开发,下面以基于hvigorfile脚本开发插件进行介绍,感兴趣的朋友跟随小编一起看看吧

基于hvigorfile脚本开发

基于hvigorfile.ts脚本开发的方式，其优点是可实现快速开发，直接编辑工程或模块下hvigorfile.ts即可编写插件代码，不足之处是在多个项目中，无法方便的进行插件代码的复用和共享分发。

导入模块依赖。

// 导入接口
import { HvigorPlugin, HvigorNode } from '@ohos/hvigor'

编写插件代码。
在hvigorfile.ts中定义插件方法，实现HvigorPlugin接口。

// 实现自定义插件
function customPlugin(): HvigorPlugin {
    return {
        pluginId: 'customPlugin',
        apply(node: HvigorNode) {
            // 插件主体
            console.log('hello customPlugin!');
        }
    }
}

在导出声明中使用插件。

export default {
    system: appTasks,
    plugins:[
        customPlugin()  // 应用自定义Plugin
    ]
}

使用hvigorfile插件动态生成navigation防混淆文件

我们在使用navigation的系统路由表时，每次添加新页面，都需要配置一下release环境防混淆。若将这些页面放在一个固定的目录下，则与我们的模块化设计相违背，若命名使用固定的前缀或后缀，总感觉有点多余，手动一个一个的添加，虽然符合我们的代码规范设计，但就是有点繁琐。有没有更方便的方式来处理这个混淆配置呢？

其实我们可以在写一个hvigorfilew插件来自动生成混淆配置文件。我们自定义一个HvigorPlugin任务，通过OhosHapContext对象读取module.json5文件中的routerMap字段，可以获取系统路由表的名称，再读取profile目录下的路由表。解析json文件内存，并将页面路径写到一个混淆文件中，这样每次编译时，自动生成防混淆文件，我们只需要引入这个文件就可以了。示例如下

import { hapTasks, OhosHapContext, OhosPluginId } from '@ohos/hvigor-ohos-plugin'
import { HvigorPlugin, HvigorNode, FileUtil } from '@ohos/hvigor'
function parseRouterMap(): HvigorPlugin {
  return {
    pluginId: 'parseRouterMap',
    apply(node: HvigorNode) {
      const hapCtx = node.getContext(OhosPluginId.OHOS_HAP_PLUGIN) as OhosHapContext
      const moduleJson = hapCtx.getModuleJsonOpt()
      const routerMapName = moduleJson['module']['routerMap'].split(':')[1]
      const dir = hapCtx.getModulePath()
      const srcFile = FileUtil.pathResolve(dir, 'src', 'main', 'resources', 'base', 'profile', `${routerMapName}.json`)
      const json = FileUtil.readJson5(srcFile)
      const routerRuleFile = FileUtil.pathResolve(dir, 'obfuscation-router.txt')
      FileUtil.ensureFileSync(routerRuleFile)
      const routerMapArray = json['routerMap']
      let rules = '-keep-file-name\n'
      for (const element of routerMapArray) {
        const pageSourceFile = element['pageSourceFile']
        const path = pageSourceFile.substring(0, pageSourceFile.lastIndexOf('.'))
        rules += `${path}\n`
      }
      FileUtil.writeFileSync(routerRuleFile, rules)
    }
  }
}
export default {
  system: hapTasks,
  plugins:[parseRouterMap()]
}

编译后会在entry目录下生成obfuscation-router.txt防混淆文件，只要引入这个文件就可以了。

使用hvigorfile插件动态生成navigation页面枚举名称

我们在我们navigation的push跳转到新页面时，都得提前定义好系统路由表中的页面name，因为使用的name与系统路由表中定义的name不相同时，跳转页面则会白屏。有了前面的经验，其它我们也可以动态生成一个ets文件，将系统路由表中的页面名称自动生成一个枚举，这样就不用每次配置系统路由表，还是复制一下名称了。例如我们的系统路由表是这样的

{
  "routerMap": [
    {
      "name": "dialog",
      "pageSourceFile": "src/main/ets/pages/dialog/DialogPage.ets",
      "buildFunction": "dialogBuilder"
    },
    {
      "name": "web",
      "pageSourceFile": "src/main/ets/pages/web/WebPage.ets",
      "buildFunction": "webBuilder"
    },
    {
      "name": "login",
      "pageSourceFile": "src/main/ets/pages/login/LoginPage.ets",
      "buildFunction": "loginBuilder"
    }
  ]
}

我们现在实现一个hvigorfile插件，来解析系统路由表中的name字段，并生成对应的枚举值。示例如下

import { hapTasks, OhosHapContext, OhosPluginId } from '@ohos/hvigor-ohos-plugin'
import { HvigorPlugin, HvigorNode, FileUtil } from '@ohos/hvigor'
function parseRouterMap(): HvigorPlugin {
  return {
    pluginId: 'parseRouterMap',
    apply(node: HvigorNode) {
      const hapCtx = node.getContext(OhosPluginId.OHOS_HAP_PLUGIN) as OhosHapContext
      const moduleJson = hapCtx.getModuleJsonOpt()
      const routerMapName = moduleJson['module']['routerMap'].split(':')[1]
      const dir = hapCtx.getModulePath()
      const srcFile = FileUtil.pathResolve(dir, 'src', 'main', 'resources', 'base', 'profile', `${routerMapName}.json`)
      const json = FileUtil.readJson5(srcFile)
      const routerMapFile = FileUtil.pathResolve(dir, 'src', 'main', 'ets', 'Pages.ets')
      FileUtil.ensureFileSync(routerMapFile)
      const routerMapArray = json['routerMap']
      let ss = ''
      for (const element of routerMapArray) {
        const name = element['name']
        ss += `  ${name} = '${name}',\n`
      }
      ss = `export enum Pages {\n${ss}}`
      FileUtil.writeFileSync(routerMapFile, ss)
    }
  }
}
export default {
  system: hapTasks,
  plugins:[parseRouterMap()]
}

我们在ets目录下生成了一个Pages.ets文件，并将所有navigation页面生成对应的枚举值，页面跳转时，使用这些枚举值就不怕出错了。Pages.ets内容如下

export enum Pages {
  dialog = 'dialog',
  web = 'web',
  login = 'login',
}

到此这篇关于鸿蒙开发Hvigor插件动态生成代码的文章就介绍到这了,更多相关鸿蒙开发Hvigor插件动态生成代码内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Hadoop分布式集群的搭建的方法步骤
这篇文章主要介绍了Hadoop分布式集群的搭建的方法步骤，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-06-06
Webstorm开发工具使用教程详解
这篇文章主要为大家详细介绍了Webstorm使用教程的使用教程，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2020-09-09
好玩的vbs微信小程序之语言播报功能
这篇文章主要介绍了好玩的vbs微信小程序之语言播报功能,非常好玩有趣，需要的朋友跟随小编一起看看吧
2019-09-09
使用Spark进行实时流计算的方法
这篇文章主要介绍了用Spark进行实时流计算的相关知识，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-08-08
基于Laravel + Vue + Element 实现人力资源系统(考勤应用 )
Bee 是人力资源系统中的考勤应用，主要功能用于员工申请假单。接下来通过本文给大家介绍基于Laravel + Vue + Element 考勤应用之人力资源系统,需要的朋友可以参考下
2019-10-10
将WSL系统更换国内源的方法(固定路径+国内镜像源+详细教程)
这篇文章主要介绍了将WSL系统更换国内源的方法(固定路径+国内镜像源+详细教程),首先找到wsl镜像源，替换镜像源，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2022-10-10
深入理解TCP协议与UDP协议的原理及区别
网络编程有三个要素，分别是IP地址、端口号和通信协议，那本文主要讲述的是TCP与UDP这两种通信协议，以及编程的实现，感兴趣的可以了解一下
2021-06-06
将ChatGPT接入微信实现智能回复功能
这篇文章主要介绍了将ChatGPT接入微信实现智能回复功能,本项目是基于ChatGPT的微信聊天机器人，通过 OpenAI 接口生成对话内容，使用 itchat 实现微信消息的接收和自动回复，需要的朋友可以参考下
2023-02-02
一个假冒的序列号被用来注册Internet Download Manager,IDM正在退出的解决办法
这篇文章主要介绍了一个假冒的序列号被用来注册Internet Download Manager IDM正在退出的解决办法,在文章末尾给大家分享了序列号和绿色软件，大家根据自身情况选择，需要的朋友可以参考下
2023-01-01
自动驾驶网络到底是什么
自动驾驶网络(Self-Driving Network)是一种可预测并具有自主运行能力的网络。简单理解华为还是做IT基础设施的网络产品，只不过就是“网络”的自动驾驶。那网络的自动驾驶是什么？这个问题，每个人都有自己的理解，接下来我将来回答一下这个问题。
2021-05-05