HarmonyOS鸿蒙Next中hvigor插件中的节点模型HvigorNode是什么，如何使用

HarmonyOS鸿蒙Next中hvigor插件中的节点模型HvigorNode是什么，如何使用 像一些常见的需求，比如构建前的代码检查，基础配置的检查等等，我们往往需要获取当前的项目路径，项目下的各个模块，甚至于项目下的各个文件，那么，这些功能，我们如何获取呢，目前官方中有多种方式供大家选择，我们就先介绍其中的一种方式HvigorNode，了解一下其中的使用方式。

3 回复

在之前的问答中，还记的我们的插件开发是在哪里编写代码的吗？是不是我们自定义了一个插件的方法，实现了一个apply方法，在这个方法中，我们接收了一个参数，这个参数就是HvigorNode类型，里面提供了诸多方法，可以满足我们对项目的操作。

function myPlugin(): HvigorPlugin {
  return {
    pluginId: 'myPlugin',
    apply(node: HvigorNode) {
      // 插件主体
      console.log('我是一个简单的插件');
    }
  }
}

HvigorNode中的方法介绍

1、获取当前节点路径

获取节点路径，也就是获取当前的项目路径，可以getNodePath()方法来获取，代码如下：

cke_9405.png

2、获取当前节点名称

节点名称，可以通过getNodeName()方法来获取，直接获取的就是当前项目的名字。

cke_11720.png

3、获取项目下所有的子节点

项目下的子节点获取可以通过subNodes()方法来获取，此方法获取的是独立的模块信息，其他的文件不会返回。

cke_14082.png

4、根据节点名称获取节点对象

如果你不想通过遍历拿到子节点，你也可以通过已知的模块名字来获取，也就是通过getSubNodeByName()方法。

 const subNode = node.getSubNodeByName('entry');
 console.log(subNode);

5、获取父级节点对象

获取父级节点对象，可以getParentNode()方法来获取，使用这个方法有一点需要注意，那就是只适用于项目子节点的获取，如果在项目节点上获取是为undefined的，所以，千万不要直接通过项目节点来获取父节点。

以下的代码是没问题的，通过项目节点获取。

//获取子节点
      node.subNodes((childDode: HvigorNode) => {
        //获取父节点
        const parentNode = childDode.getParentNode();
        console.log(parentNode.getNodeName());
      })

6、节点注册任务

注册任务，它会在hvigor生命周期中的配置阶段中执行,注册任务需完成HvigorTask的实现作为入参对象。

node.registerTask({
    name: 'myTask',
    run() {
        console.log('myTask');
    }
});

7、节点中已注册的Task对象

node.getTaskByName('myTask')

8、pluginId获取当前节点信息

这种情况也能获取到项目的相关信息，比如项目的名字，路径等等。

 const appContext = node.getContext(OhosPluginId.OHOS_APP_PLUGIN) as OhosAppContext;
  console.log('projectName:', appContext.getProjectName());

9、获取当前节点已加载的pluginId集合

 const allPluginIds = node.getAllPluginIds();
            allPluginIds.forEach((id) => {
                console.log(id);
            })

10、添加拓展属性

 node.addExtraOption('key', 'value');

11、根据节点名称获取节点对象

node.getExtraOption('key');

12、添加一个node评估前的回调函数

node.beforeNodeEvaluate(hvigorNode => {
       
      })

13、添加一个node评估后的回调函数

node.afterNodeEvaluate(hvigorNode => {
        
      })

相关总结

HvigorNode，在实际的开发中，可以辅助我们获取项目及子模块的信息，便于我们对文件的操作，十分的方便，它可以应用与两种插件的实现方式，极大的提高了我们编写插件的效率。

更多关于HarmonyOS鸿蒙Next中hvigor插件中的节点模型HvigorNode是什么，如何使用的实战系列教程也可以访问 https://www.itying.com/category-93-b0.html


HvigorNode是鸿蒙Next构建工具hvigor中的核心节点模型，用于描述项目模块、任务和依赖关系。它代表构建流程中的一个可执行单元。

在hvigor配置文件中，通过定义HvigorNode来声明模块构建逻辑。主要使用方式是在模块级hvigorfile.ts中配置节点属性，如定义输入输出、声明依赖、注册任务等。构建系统会基于节点依赖关系图执行相应任务。

节点类型包括ProjectNode、ModuleNode等，开发者通过扩展节点类实现自定义构建行为。

HvigorNode是HarmonyOS Next构建工具hvigor的核心模型之一，它代表了构建过程中的一个节点，通常对应一个项目（Project）或一个模块（Module）。通过HvigorNode，开发者可以在插件中访问和操作构建项目的结构信息。

主要功能与使用方式：

  1. 获取项目信息：通过project属性获取当前HvigorNode对应的项目对象，进而访问项目名称、路径、版本等元数据。

  2. 遍历项目结构：使用getChildren()方法获取当前节点下的所有子节点（如模块），或通过getParent()获取父节点，方便递归遍历整个项目树。

  3. 访问文件系统：通过getNodeDir()获取节点对应的目录路径，结合file()或files()方法可访问节点目录下的特定文件或文件集合，常用于读取配置或检查源码。

  4. 依赖管理：通过getDependencies()获取节点的依赖信息，便于分析项目依赖结构或执行依赖相关的检查。

  5. 任务访问：通过getTasks()获取节点关联的构建任务，可用于任务执行前后的钩子操作。

典型使用场景示例： 在自定义hvigor插件中，通常可以在apply方法中通过project参数（本身即根HvigorNode）开始访问：

apply<YourPlugin> {
    // 获取项目根路径
    val rootDir = project.getNodeDir()
    // 遍历所有子模块
    project.getChildren().forEach { moduleNode ->
        val modulePath = moduleNode.getNodeDir()
        // 检查模块中的配置文件
        val configFile = moduleNode.file("hvigorfile.ts")
        if (configFile.exists()) {
            // 执行检查逻辑
        }
    }
}

注意事项：

  • HvigorNode接口的具体方法可能随版本更新而调整，建议结合官方API文档使用。
  • 节点操作应在配置阶段完成，避免在任务执行中频繁访问影响构建性能。

通过HvigorNode模型，开发者可以灵活地集成代码检查、配置验证等定制化构建功能，增强HarmonyOS应用的开发流程自动化能力。

回到顶部