鸿蒙 动态修改编译配置

一、实现方式Hvigor支持在hvigorfile.ts中动态修改编译配置现有两种方式方式推荐度说明hook 插件上下文推荐更灵活、易于理解、功能更全面overrides关键字导出不推荐功能有限已不推荐使用二、通过hook以及插件实现推荐2.1 支持动态修改的配置文件Hvigor支持stage模型在hvigor hook中操作以下配置文件配置文件说明build-profile.json5每个hvigorNode中的构建配置module.json5模块配置文件app.json5应用配置文件oh-package.json5每个module下的依赖和版本信息dependency、devDependency、dynamicDependency、version2.2 使用方式在hvigorfile.ts或hvigorconfig.ts文件中使用Hvigor提供的API接口实现动态配置。优势相比于overrides方式通过hook和插件上下文动态修改签名和编译配置更为灵活、易于理解功能更全面。使用方式如下1、修改build-profile.json5在项目根目录下的hvigorfile.ts中添加import { appTasks, OhosAppContext, OhosPluginId } from ohos/hvigor-ohos-plugin; import { hvigor, getNode } from ohos/hvigor // 获取根节点 const rootNode getNode(__filename); // 为根节点添加afterNodeEvaluate hook修改build-profile.json5 rootNode.afterNodeEvaluate(node { // 获取app插件的上下文对象 const appContext node.getContext(OhosPluginId.OHOS_APP_PLUGIN) as OhosAppContext; // 获取从build-profile.json5中读出的obj对象 const buildProfileOpt appContext.getBuildProfileOpt(); // 修改签名配置 buildProfileOpt[app][signingConfigs] [ { name: default, type: HarmonyOS, material: { certpath: D:\\SigningConfig\\debug_hos.cer, storePassword: *******, keyAlias: debugKey, keyPassword: *******, profile: D:\\SigningConfig\\debug_hos.p7b, signAlg: SHA256withECDSA, storeFile: D:\\SigningConfig\\debug_hos.p12 } } ]; // 将obj对象设置回上下文对象使能到构建过程 appContext.setBuildProfileOpt(buildProfileOpt); }) export default { system: appTasks, plugins: [] }2、修改module.json5修改entry下module.json5的配置信息如deviceTypes。在entry下的hvigorfile.ts中添加import { hapTasks, OhosHapContext, OhosPluginId } from ohos/hvigor-ohos-plugin; import { getNode } from ohos/hvigor const entryNode getNode(__filename); entryNode.afterNodeEvaluate(node { // 获取hap插件上下文对象 const hapContext node.getContext(OhosPluginId.OHOS_HAP_PLUGIN) as OhosHapContext; // 获取从module.json5中读出的obj对象 const moduleJsonOpt hapContext.getModuleJsonOpt(); // 修改设备类型 moduleJsonOpt[module][deviceTypes] [phone, tablet, 2in1, car]; // 设置回上下文对象 hapContext.setModuleJsonOpt(moduleJsonOpt); }) export default { system: hapTasks, plugins: [] }3、修改app.json5在项目根目录下的hvigorfile.ts中修改app.json5的配置。import { appTasks, OhosAppContext, OhosPluginId } from ohos/hvigor-ohos-plugin; import { hvigor } from ohos/hvigor hvigor.getRootNode().afterNodeEvaluate(rootNode { // 获取app插件上下文对象 const appContext rootNode.getContext(OhosPluginId.OHOS_APP_PLUGIN) as OhosAppContext; // 获取从app.json5中读出的obj对象 const appJsonOpt appContext.getAppJsonOpt(); // 修改版本号 appJsonOpt[app][versionCode] 1000001; // 设置回上下文对象 appContext.setAppJsonOpt(appJsonOpt); }) export default { system: appTasks, plugins: [] }4、工程级修改在工程级hvigorfile.ts中添加自定义插件import { appTasks, OhosAppContext, OhosPluginId } from ohos/hvigor-ohos-plugin; import { HvigorNode, HvigorPlugin } from ohos/hvigor; export function customPlugin(): HvigorPlugin { return { pluginId: customPlugin, async apply(currentNode: HvigorNode): Promisevoid { const appContext currentNode.getContext(OhosPluginId.OHOS_APP_PLUGIN) as OhosAppContext; const dependency appContext.getDependenciesOpt(); // 获取dependency依赖 dependency[library] file:library.har; // 确保har包存在 appContext.setDependenciesOpt(dependency); // 需要确保oh-package.json5中dependencies字段存在 } }; } export default { system: appTasks, plugins: [customPlugin()] }在模块级hvigorfile.ts中添加自定义插件import { hapTasks, OhosHapContext, OhosPluginId } from ohos/hvigor-ohos-plugin; import { HvigorNode, HvigorPlugin } from ohos/hvigor; export function customPlugin(): HvigorPlugin { return { pluginId: customPlugin, async apply(currentNode: HvigorNode): Promisevoid { const hapContext currentNode.getContext(OhosPluginId.OHOS_HAP_PLUGIN) as OhosHapContext; const dependency hapContext.getDependenciesOpt(); // 获取dependency依赖 dependency[library] file:library.har; hapContext.setDependenciesOpt(dependency); } }; } export default { system: hapTasks, plugins: [customPlugin()] }三、通过overrides关键字导出动态配置不推荐基本格式在hvigorfile.ts中在导出对象的config.ohos属性中接收编译配置export default { system: hapTasks, config: { ohos: { // 动态配置内容 } } }工程级可配置字段在工程级hvigorfile.ts的config.ohos中可配置字段说明对应配置overrides覆盖原有配置项-signingConfig签名配置build-profile.json5的signingConfigsappOpt应用配置app.json5signingConfig子字段字段说明type签名类型material签名材料certpath、storePassword、keyAlias、keyPassword、profile、signAlg、storeFileappOpt子字段字段说明bundleName包名bundleType包类型icon图标label标签vendor供应商versionCode版本号versionName版本名称模块级可配置字段在模块级hvigorfile.ts的config.ohos中可配置字段说明对应配置overrides覆盖原有配置项-buildOption编译构建配置build-profile.json5的buildOptionbuildOption子字段字段说明arkOptionsArkTS编译配置externalNativeOptionsNative编译配置napiLibFilterOptionNAPI库筛选配置nativeLibNative库配置resOptions资源编译配置sourceOption源码相关配置备注配置在overrides项中的参数其优先级高于在配置文件中对应的字段。