当前位置:

首页 > 编程开发 > 鸿蒙开发Hvigor插件动态生成代码的操作方法

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

Hvigor支持基于hvigorfile脚本开发插件,能自动生成混淆配置文件与页面枚举文件。通过解析路由表,动态输出obfuscation-router.txt和Pages.ets,有效解决页面混淆与跳转错误,提升开发效率,并简化插件开发流程,确保路由一致性,适用于鸿蒙应用开发。

本文目录

    Hvigor 给了开发者一个相当灵活的扩展空间——你可以自己写插件,把自定义的构建逻辑塞进去,还能跟别人共享。目前 Hvigor 支持两种插件开发方式:一种是直接基于 hvigorfile 脚本,另一种是基于 TypeScript 项目。这里先聊聊第一种,基于 hvigorfile 脚本开发,上手快,改起来也方便。

    基于 hvigorfile 脚本开发

    直接在工程或模块下的 hvigorfile.ts 里写插件代码,好处是即改即用,不需要额外搭建项目结构。不过缺点也很明显:想在不同项目之间复用就比较麻烦,没法像独立的 npm 包那样分发共享。

    先导入必要的接口:

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

    然后定义一个插件方法,实现 HvigorPlugin 接口:

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

    最后在导出声明里把插件注册进去:

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

    流程就这么简单。但真正有意思的是,我们可以用这个机制解决一些日常开发中的痛点。下面两个例子就很能说明问题。

    自动生成 na vigation 防混淆文件

    使用系统路由表时,每次添加新页面都得在 release 环境下配一下混淆规则,否则页面名被混淆后导航就失败了。要是把页面都放在一个固定目录下,和模块化设计又冲突;用固定前缀或后缀命名,又总觉得怪怪的。手动一个一个加,虽然符合规范,但确实繁琐。

    其实可以写一个 Hvigor 插件来自动生成混淆配置文件。思路很简单:自定义一个 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 文件,直接把它引入到混淆配置里就行了。

    自动生成 na vigation 页面枚举名称

    另一个常见的痛点:用 na vigation 做 push 跳转时,必须提前定义好系统路由表中的页面 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"
        }
      ]
    }

    对应的插件实现如下:

    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 文件,内容如下:

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

    之后在页面跳转时直接使用 Pages.dialog 这样的枚举值,既安全又省心。每次修改路由表,枚举文件都会自动更新,完全不需要手动维护。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    QQ影音怎么加速播放视频课程
    QQ影音怎么加速播放视频课程

    播放时右键选播放速度,或点控制条倍速,1.25 到 1.5 倍看课最舒服;公式代码类内容别超过 1.25 倍。

    企业微信创建企业提示失败怎么办 实名与填写检查
    企业微信创建企业提示失败怎么办 实名与填写检查

    先看提示属于哪类:名称占用就加后缀,实名不一致就重填本人信息,证件不清晰就重拍。统一社会信用代码逐位核对,连续三次失败别改材料重投,直接联系客服人工核。

    Modern Web Guidance 的 legacy-scan 反转建议应该怎样判断?
    Modern Web Guidance 的 legacy-scan 反转建议应该怎样判断?

    说明源码提交对字符串、生成器和数组的识别边界,以及扫描命令与发行包核验限制。

    Codex 0.170.0 正式版的语音与连接更新,适用范围有哪些限制?
    Codex 0.170.0 正式版的语音与连接更新,适用范围有哪些限制?

    0.170.0 的语音更新限于终端通话协商能力的明确新增,同名工具服务器跨环境支持仍标注实验性质;连接部分则修复大请求回退、认证竞态和云端重连等具体问题。这份正式版公告不足以证明所有账户、所有客户端都已具备完整语音功能。

    Hy4 flash 三种权重怎么选,安装和授权要注意哪些条件?
    Hy4 flash 三种权重怎么选,安装和授权要注意哪些条件?

    了解Hy4 flash、FP8与base的适用任务,阅读官方安装及图文代码,并核对资源和MaaS许可条件。

    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化
    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化

    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化。说明已核实的更新范围、类型兼容性和本地版本确认方法。

    OpenAI Java SDK 4.108.0 的两项新增能力适合哪些项目?
    OpenAI Java SDK 4.108.0 的两项新增能力适合哪些项目?

    OpenAI Java SDK 4.108.0 面向 Live MCP 工具接入与 Managed Agents 预算状态处理,说明新增模型、事件含义、正式发布范围和适用限制。

    Free Claude Code 6.19.37 如何兼顾网页搜索与普通工具调用?
    Free Claude Code 6.19.37 如何兼顾网页搜索与普通工具调用?

    Free Claude Code 6.19.37 在自动搜索时保留客户端工具及选择条件,代理执行搜索后仍返回普通调用。说明适用场景、历史信息保留、请求约束与第三方项目的版本边界。

    Google GenAI Go SDK 1.78.0 的 v1beta 配置优先级怎样判断?
    Google GenAI Go SDK 1.78.0 的 v1beta 配置优先级怎样判断?

    Google GenAI Go SDK 1.78.0 将 Gemini Developer API 默认改为 v1,可用 HTTPOptions.APIVersion 或环境变量保留 v1beta,Vertex AI 默认值不变。

    Google GenAI SDK 3.5.0实时交互值得哪些项目升级评估?
    Google GenAI SDK 3.5.0实时交互值得哪些项目升级评估?

    解释实验性实时支持、环境检查与生产评估中需要验证的条件。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。