文档开发者中心
我的
|

HarmonyOS 6

DevEco Studio

HarmonyOS 5

hvigor插件开发中如何获取当前的项目路径

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

点赞
收藏
回复
1
分享
举报
浏览78 发布于2025-12-17 09:11北京
全部评论
最多点赞
最新发布
最早发布

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

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

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

收起
自动换行
深色代码主题
复制
function myPlugin(): HvigorPlugin {
  return {
    pluginId: 'myPlugin',
    apply(node: HvigorNode) {
      // 插件主体
      console.log('我是一个简单的插件');
    }
  }
}

HvigorNode中的方法介绍

1、获取当前节点路径

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

cke_969.png

2、获取当前节点名称

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

cke_3169.png

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

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

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

展开全部
1楼回复于2025-12-17 10:17 来自北京
写回答
新增插入模板功能
一键使用模板,快速填写内容,轻松发帖~
知道了
  • 为了保障您的信息安全,请勿上传您的敏感个人信息(如您的密码等信息)和您的敏感资产信息(如关键源代码、签名私钥、调试安装包、业务日志等信息),且您需自行承担由此产生的信息泄露等安全风险。
  • 如您发布的内容为转载内容,请注明内容来源。

我要提问题

了解社区公约,与您携手共创和谐专业的开发者社区。