目录

Hvigor编译构建实现添加自定义文件至.har产物中

问题现象

如何在对模块进行编译时,将自定义的目录文件,例如.ets文件、.log文件等,动态打包进最终的.har产物中。

背景知识

开发Hvigor插件:Hvigor允许开发者实现自己的插件,开发者可以定义自己的构建逻辑,并与他人共享。Hvigor主要提供了两种方式来开发插件:基于hvigorfile脚本开发插件、基于typescript项目开发。

解决方案

目前以以下方式基于Hvigor构建HAR模块时,Hvigor内部会采用白名单模式,只有匹配到的文件,才会被打包进最终的.har产物中,场景需要满足如下条件:

在这些场景下,如果您想要将一些其他的文件也打包进去,可以使用自定义插件配合自定义任务进行处理。

比如一个名称为har01的HAR模块,其目录结构如下:

如果您需要将以下文件打包进最终的.har产物中:

可以编写har01模块的hvigorfile.ts文件如下:

import { harTasks, OhosHarContext, OhosPluginId } from '@ohos/hvigor-ohos-plugin';
import { hvigor, getNode } from '@ohos/hvigor';
import path from 'path';
import fs from 'fs';


// 基于hvigor钩子实现添加自定义文件至.har产物中:
function copyFolder(source: string, target: string, excludeExts: string[] = []): void {
  // 检查目标文件夹是否存在,如果不存在则创建
  if (!fs.existsSync(target)) {
    fs.mkdirSync(target, { recursive: true });
  }


  // 读取源文件夹中的文件和文件夹
  const entries = fs.readdirSync(source, { withFileTypes: true });


  for (const entry of entries) {
    const srcPath = path.join(source, entry.name);
    const destPath = path.join(target, entry.name);


    if (entry.isDirectory()) {
      // 如果是文件夹,则递归调用
      copyFolder(srcPath, destPath, excludeExts);
    } else if (entry.isFile() && !excludeExts.includes(path.extname(entry.name))) {
      // 如果是文件,则复制文件
      fs.copyFileSync(srcPath, destPath);
    }
  }
}


hvigor.nodesEvaluated(() => {
  const node = getNode(__filename);
  const context = node.getContext(OhosPluginId.OHOS_HAR_PLUGIN) as OhosHarContext;
  if (!context) {
    return;
  }
  context.targets((target: Target) => {
    const targetName = target.getTargetName();
    const modulePath = context.getModulePath();
    const outputPath = target.getBuildTargetOutputPath();
    const task = node.getTaskByName(`${targetName}@ProcessHarArtifacts`);
    task.afterRun(() => {
      const packageHarDir = path.resolve(outputPath, '../../', 'cache', targetName, `${targetName}@PackageHar`);


      copyFolder(path.join(modulePath, 'interface'), path.join(packageHarDir, 'interface'));
      copyFolder(path.join(modulePath, 'logs'), path.join(packageHarDir, 'logs'), ['.txt']);
    });
  });
});


export default {
  system: harTasks,  /* Built-in plugin of Hvigor. It cannot be modified. */
  plugins:[]         /* Custom plugin to extend the functionality of Hvigor. */
}