鸿蒙开发：hvigor插件中的节点模型HvigorNode

前言

本文API>=13，基于DevEco Studio 5.1.0 Release，版本号5.1.0.828

上篇文章，我们介绍了两种方式，实现了一个hvigor插件的开发，但是只概述了基本的开发流程，并未涉及到具体的代码开发，接下来的几篇文章，我们会重点去了解一下，hvigor插件中的那些API用法，以便于实际的插件开发。

像一些常见的需求，比如构建前的代码检查，基础配置的检查等等，我们往往需要获取当前的项目路径，项目下的各个模块，甚至于项目下的各个文件，那么，这些功能，我们如何获取呢，目前官方中有多种方式供大家选择，我们就一一概述一下。

首先是HvigorNode，它是hvigor中的节点模型接口，通过它，我们可以获取到模块的配置，属性和任务等。

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

登录后复制

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

• 1.
• 2.
• 3.
• 4.
• 5.
• 6.
• 7.
• 8.
• 9.

HvigorNode中的方法介绍

1、获取当前节点路径

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

2、获取当前节点名称

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

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

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

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

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

登录后复制

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

• 1.
• 2.

5、获取父级节点对象

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

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

登录后复制

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

• 1.
• 2.
• 3.
• 4.
• 5.
• 6.

6、节点注册任务

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

登录后复制

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

• 1.
• 2.
• 3.
• 4.
• 5.
• 6.

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

登录后复制

node.getTaskByName('myTask')

• 1.

8、pluginId获取当前节点信息

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

登录后复制

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

• 1.
• 2.

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

登录后复制

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

• 1.
• 2.
• 3.
• 4.

10、添加拓展属性

登录后复制

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

• 1.

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

登录后复制

node.getExtraOption('key');

• 1.

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

登录后复制

node.beforeNodeEvaluate(hvigorNode => {
       
      })

• 1.
• 2.
• 3.

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

登录后复制

node.afterNodeEvaluate(hvigorNode => {
        
      })

• 1.
• 2.
• 3.

相关总结

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

本文标签：鸿蒙开发工具/DevEco Studio