当前位置: 首页 > news >正文

【HarmonyOS Next之旅】DevEco Studio使用指南(四十二) -> 动态修改编译配置

目录

1 -> 通过hook以及插件上下文实现动态配置

2 -> 在hvigorfile.ts中通过overrides关键字导出动态配置

3 -> 通过hook以及插件上下文动态配置构建配置

3.1 -> 修改每个hvigorNode中的build-profile.json5

3.2 -> 修改module.json5中的配置信息

3.3 -> 修改app.json5中的配置信息

3.4 -> 修改oh-package.json5中的依赖


1 -> 通过hook以及插件上下文实现动态配置

Hvigor支持stage模型在hvigor hook中操作从硬盘上读取的以下配置文件:

  • 每个hvigorNode中的build-profile.json5
  • module.json5
  • app.json5
  • 每个module下的oh-package.json5文件中的dependency、devDependency、dynamicDependency以及version。

目前可以通过hvigor对象提供的上下文直接获取和修改配置以实现动态配置构建配置、并使能到构建的过程与结果中。

在hvigorfile.ts或hvigorconfig.ts文件中,可以使用Hvigor提供的API接口来实现此能力。

相比于下面的overrides的能力来说,通过hook以及插件上下文来动态修改签名和编译配置更为灵活和易于理解,功能也更为全面,推荐使用此种方式。

2 -> 在hvigorfile.ts中通过overrides关键字导出动态配置

在hvigorfile.ts中,我们约定在导出的对象中的config.ohos属性里接收编译的配置:

export default {  system: hapTasks,  config: {  ohos: {...}    }
}

目前可以在工程级的hvigorfile.ts的config.ohos中配置的字段:

  • overrides:定义起覆盖作用的字段的位置,会在构建过程中覆盖原有的对应配置项。
    • signingConfig:签名配置,对应build-profile.json5里的signingConfig配置项。
      • type
      • material
        • certpath
        • storePassword
        • keyAlias
        • keyPassword
        • profile
        • signAlg
        • storeFile
    • appOpt:对应​​​​​​​app.json5里的配置项字段。
      • bundleName
      • bundleType
      • icon
      • label
      • vendor
      • versionCode
      • versionName

目前可以在模块级的hvigorfile.ts的config.ohos中配置的字段:

  • overrides:定义起覆盖作用的字段的位置,会在构建过程中覆盖原有的对应配置项。
    • buildOption:对应build-profile.json5里的​​​​​​​buildOption配置项。
      • arkOptions
      • externalNativeOptions
      • napiLibFilterOption
      • nativeLib
      • resOptions
      • sourceOption

配置在overrides项中的参数,其优先级会高于在配置项中的对应字段。

3 -> 通过hook以及插件上下文动态配置构建配置

3.1 -> 修改每个hvigorNode中的build-profile.json5

此处只举例为单个node注册hook并修改build-profile.json5的信息。

例如需要修改根目录下的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 在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();// 修改obj对象为想要的,此处举例修改app中的signingConfigsbuildProfileOpt['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,  /* Built-in plugin of Hvigor. It cannot be modified. */plugins:[]         /* Custom plugin to extend the functionality of Hvigor. */
}

3.2 -> 修改module.json5中的配置信息

可以通过hvigor对象的hook能力快捷为所有的node创建hook,此处先举例为单一的node创建一个hook并修改其中的module.json5的配置信息。

例如此处需要修改entry下的module.json5配置,则在entry下的hvigorfile.ts中添加如下内容:

import { hapTasks, OhosHapContext, OhosPluginId } from '@ohos/hvigor-ohos-plugin';
import { getNode } from '@ohos/hvigor'const entryNode = getNode(__filename);
// 为此节点添加一个afterNodeEvaluate hook 在hook中修改module.json5的内容并使能
entryNode.afterNodeEvaluate(node => {// 获取此节点使用插件的上下文对象 此时为hap插件 获取hap插件上下文对象const hapContext = node.getContext(OhosPluginId.OHOS_HAP_PLUGIN) as OhosHapContext;// 通过上下文对象获取从module.json5文件中读出来的obj对象const moduleJsonOpt = hapContext.getModuleJsonOpt();// 修改obj对象为想要的,此处举例修改module中的deviceTypesmoduleJsonOpt['module']['deviceTypes'] = ["phone", "tablet", "2in1", "car"];// 将obj对象设置回上下文对象以使能到构建的过程与结果中hapContext.setModuleJsonOpt(moduleJsonOpt);
})
export default {system: hapTasks,  /* Built-in plugin of Hvigor. It cannot be modified. */plugins:[]         /* Custom plugin to extend the functionality of Hvigor. */
}

3.3 -> 修改app.json5中的配置信息

在项目的根目录下的hvigorfile.ts中添加如下代码内容:

import { appTasks, OhosAppContext, OhosPluginId } from '@ohos/hvigor-ohos-plugin';
import { hvigor } from '@ohos/hvigor'// 为根节点添加一个afterNodeEvaluate hook 在hook中修改app.json5的内容并使能
hvigor.getRootNode().afterNodeEvaluate(rootNode => {// 获取app插件的上下文对象const appContext = rootNode.getContext(OhosPluginId.OHOS_APP_PLUGIN) as OhosAppContext;// 通过上下文对象获取从app.json5文件中读出来的obj对象const appJsonOpt = appContext.getAppJsonOpt();// 修改obj对象为想要的,此处举例修改app中的versionCodeappJsonOpt['app']['versionCode'] = 1000001;// 将obj对象设置回上下文对象以使能到构建的过程与结果中appContext.setAppJsonOpt(appJsonOpt);
})
export default {system: appTasks,  /* Built-in plugin of Hvigor. It cannot be modified. */plugins:[]         /* Custom plugin to extend the functionality of Hvigor. */
}

3.4 -> 修改oh-package.json5中的依赖

可以通过hvigorfile.ts自定义插件修改工程级、模块级的oh-package.json5的依赖,例如在工程级hvigorfile.ts或模块级hvigorfile.ts分别添加以下内容:

// 工程级hvigorfile.ts
import { appTasks, OhosAppContext, OhosPluginId, Target } from '@ohos/hvigor-ohos-plugin';
import { HvigorNode, HvigorPlugin, TaskInput, TaskOutput } from '@ohos/hvigor';
export function customPlugin(): HvigorPlugin {return {pluginId: 'customPlugin',async apply(currentNode: HvigorNode): Promise<void> {const appContext = currentNode.getContext(OhosPluginId.OHOS_APP_PLUGIN) as OhosAppContext;const dependency = appContext.getDependenciesOpt({});  //获取dependency依赖dependency["library"]="file:library.har"console.log(dependency);appContext.setDependenciesOpt(dependency );  //修改dependency依赖}};
}
export default {system: appTasks,  /* Built-in plugin of Hvigor. It cannot be modified. */plugins:[customPlugin()]         /* Custom plugin to extend the functionality of Hvigor. */
}// 模块级hvigorfile.ts
import {hapTasks,OhosHapContext,OhosPluginId,Target} from '@ohos/hvigor-ohos-plugin';
import { hvigor, HvigorNode, HvigorPlugin} from '@ohos/hvigor';
import * as fs from 'fs';
export function customPlugin(options: OnlineSignOptions): HvigorPlugin {return {pluginId: 'customPlugin',context() {return {signConfig: options};},async apply(currentNode: HvigorNode): Promise<void> {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,  /* Built-in plugin of Hvigor. It cannot be modified. */plugins:[customPlugin()]         /* Custom plugin to extend the functionality of Hvigor. */
}

感谢各位大佬支持!!!

互三啦!!!

http://www.dtcms.com/a/271954.html

相关文章:

  • 全面解析 wxPython:构建原生桌面应用的 Python GUI 框架
  • 【计算机基础理论知识】C++篇(二)
  • [python] 数据拷贝浪费内存,原地修改暗藏风险:如何平衡内存使用效率与数据完整性?
  • 【SpringBoot实战系列】SpringBoot3.X 整合 MinIO 存储原生方案
  • C++类对象多态底层原理及扩展问题
  • Python-GEE遥感云大数据分析与可视化(如何建立基于云计算的森林监测预警系统)
  • Yolov模型参数对比
  • Docker的/var/lib/docker/目录占用100%的处理方法
  • 变压器初级(原边)和次级(副边)的感应电动势、电压方向如何标注?
  • 安卓应用启动崩溃的问题排查记录
  • 《Effective Python》第十三章 测试与调试——使用 Mock 测试具有复杂依赖的代码
  • 【笔记分享】集合的基数、群、环、域
  • Python毕业设计232—基于python+Django+vue的图书管理系统(源代码+数据库)
  • EXCEL_单元格中图片调整代码留存
  • 什么是Kibana
  • 【C++】第十四节—模版进阶(非类型模版参数+模板的特化+模版分离编译+模版总结)
  • 保姆级搭建harbor私有仓库与docker-ce教程与使用教程
  • 机器学习基础:从理论到实践的完整指南
  • 解锁医疗新视界:医患共决策时间轴AI可视化工具
  • Linux面试问题-软件测试
  • Web前端:table标签的用法与属性
  • 酒店IPTV系统:重塑数字化时代的宾客体验生态
  • 图计算怎么用?从数据到关系的魔力
  • 实时风险监控系统工具设计原理:2025异常检测算法与自动化响应机制
  • 深度学习中的激活函数
  • window显示驱动开发—XR_BIAS 和 BltDXGI
  • RISC-V:开源芯浪潮下的技术突围与职业新赛道 (二) RISC-V架构深度解剖(上)
  • 【网络】Linux 内核优化实战 - net.ipv4.tcp_moderate_rcvbuf
  • 文件系统子系统 · 核心问题问答精要
  • Redis持久化机制深度解析:数据安全的双保险