你是否每次手动更改发布证书打 app 包上加应用市场呢?你是否每次打完包都手动在名称后添加版本号和时间呢?不同环境的依赖包经常打包时忘记改呢?其实这些鸿蒙都支持动态配置。
认识 hvigor 编译构建
hvigor 将工程解析为一个树形结构,项目为树的根节点,项目中的每个模块为树的叶子节点,树最多为两层,模块中不能包含其他模块,在 hvigor 的定义中统称项目或模块为一个 node(节点)。在构建最开始的初始化阶段,会通过 hvigorconfig.ts 文件以及工程级 build-profile.json5 文件中的配置来构造出一个树形结构存储项目的工程结构,工程级 build-profile.json5 文件和 hvigorconfig.ts 文件均可以配置多模块。
hvigor 是基于任务对您的项目进行自动化构建的,任务(Task)是 hvigor 构建过程中的基本工作单元,它定义了构建项目时需要执行的具体工作。任务可以完成多种操作,比如源码编译任务,打包任务或签名任务等。每一种任务的执行逻辑由插件(plugin)提供,插件可以是由 hvigor-ohos-plugin 提供的默认任务逻辑,也可由您个性化定制。
如何动态配置发布证书
发布证书是在应用打包 APP 上架应用市场时使用,所以有人将 debug 环境配置为调试证书,release 环境配置为发布证书是不对的,用发布证书打包的应用是不能直接运行到手机上。我们可以对比一下调试证书和发布证书,不一样的是 profile、certpath、keyPassword 和 storePassword,我们只需要在 hvigor 中判断当前任务是在打包 APP,就可以将这些值动态替换为发布证书的值。比如我们正常在 build-profile.json5 中配置调试证书如下
{
"app": {
"signingConfigs": [
{
"name": "default",
"type": "HarmonyOS",
"material": {
"keyAlias": "harmony",
"storeFile": "key/key.p12",
"signAlg": "SHA256withECDSA",
"profile": "key/key_debug.p7b",
"certpath": "key/key_debug.cer",
"keyPassword": "password_debug",
"storePassword": "password_debug"
}
}
]
}
}
复制代码
在根目录下的 hvigorfile.ts 可以这么处理
import { appTasks, OhosAppContext, OhosPluginId } from '@ohos/hvigor-ohos-plugin';
import { hvigor } from '@ohos/hvigor'
hvigor.getRootNode().afterNodeEvaluate(node => {
const appCtx = node.getContext(OhosPluginId.OHOS_APP_PLUGIN) as OhosAppContext;
const profileOpt = appCtx.getBuildProfileOpt()
if (hvigor.getCommandEntryTask() === 'assembleApp') {
const signArray = profileOpt['app']['signingConfigs']
for (const element of signArray) {
element['material']['profile'] = 'key/key_release.p7b'
element['material']['certpath'] = 'key/key_release.cer'
element['material']['storePassword'] = 'password_release'
element['material']['keyPassword'] = 'password_release'
}
}
appCtx.setBuildProfileOpt(profileOpt)
})
复制代码
打包时如何动态设置 APP 版本和日期
我们可以在根目录下的 hvigorfile.ts 中动态获取项目的版本号以及通过 Date 获取打包时的日期时间,并追加到 APP 的名称上,示例如下
import { appTasks, OhosAppContext, OhosPluginId } from '@ohos/hvigor-ohos-plugin';
import { hvigor } from '@ohos/hvigor'
hvigor.getRootNode().afterNodeEvaluate(node => {
const appCtx = node.getContext(OhosPluginId.OHOS_APP_PLUGIN) as OhosAppContext;
const profileOpt = appCtx.getBuildProfileOpt()
const jsonOpt = appCtx.getAppJsonOpt()
const products = profileOpt['app']['products']
for (const element of products) {
element['output']['artifactName'] += `-${jsonOpt['app']['versionName']}-${getDate()}`
}
appCtx.setBuildProfileOpt(profileOpt)
})
function getDate(): string {
const date = new Date()
const dateStr = `${date.getFullYear()}${parseNum(date.getMonth() + 1)}${parseNum(date.getDate())}`
const timeStr = `${parseNum(date.getHours())}${parseNum(date.getMinutes())}${parseNum(date.getSeconds())}`
return `${dateStr}${timeStr}`
}
function parseNum(num: number): string {
return num < 10 ? `0${num}` : `${num}`
}
复制代码
假如我们在 build-profile.json5 中配置 artifactName 的值为 app,则打包的名称为 app-1.0.0-20241027204510.app
如何根据不同的环境依赖不同的库
比如我们要在开发环境依赖 flutter 的 debug 包,在生产环境依赖 flutter 的 release 包该怎么处理呢?我们可以在 oh-package.json5 中先配置 debug 包,在模块下的 hvigorfile.ts 中检测到当前是生产环境,则动态的将依赖包替换为 release 版本。oh-package.json5 的配置如下
{
"dependencies": {
"flutter": "file:libs/flutter_debug.har"
}
}
复制代码
假如生产环境的 product 配置为 prod,则 hvigorfile.ts 中的示例如下
import { hapTasks, OhosHapContext, OhosPluginId } from '@ohos/hvigor-ohos-plugin'
import { getNode } from '@ohos/hvigor'
const entryNode = getNode(__filename)
entryNode.afterNodeEvaluate(node => {
const hapCtx = node.getContext(OhosPluginId.OHOS_HAP_PLUGIN) as OhosHapContext
hapCtx.targets((target)=>{
if (target.getCurrentProduct().getProductName() === 'prod') {
const depOpt = hapCtx.getDependenciesOpt()
depOpt["flutter"]="file:libs/flutter_release.har"
hapCtx.setDependenciesOpt(depOpt)
}
})
})
复制代码
在 hvigorfile.ts 中可以做很多事情,可以动态更改 app.json5、module.json5、build-profile.json5 和 oh-package.json5 中的很多内容,大家可以多尝试尝试,有了这些能力,就不用担心打包时忘记更改或改错了。
评论