HarmonyOS Next DevEco Studio 编译选项定制指南

模块级 build-profile.json5 文件：

合并编译选项规则

1. 工程级默认有三种 buildMode：debug，release，test。
2. 模块级默认有三种 buildOption：default，debug，release。
3. 当 buildModeBinder 未定义 target 与 buildOption 的匹配关系时：
   • release 构建模式：为 target 匹配 release option，但 ohosTest 分配 default option；
   • debug 构建模式：为 target 匹配 debug option，但 ohosTest 分配 default option；
   • test 构建模式：为 target 匹配 debug option，ohosTest 分配 default option；
   • 自定义构建模式：所有 target 均匹配 default option。
4. 工程级 build-profile.json5 中 product 的 buildOption 会对 buildMode 的 buildOption 继承覆写，即相同配置项 product 的优先级更高。
5. 模块级别的 buildOption 作为一个公共配置会被继承到 buildOptionSet 中的每一个 buildOption 中，如有 copyFrom 字段，也是先继承再进行复制，即 buildOptionSet 优先级比 buildOption 更高。
6. 根据模块级中的 buildModeBinder 字段可以找到 target 对应的唯一 buildOption；target 中的 buildOption 优先级更高，采用继承覆盖策略与对应 buildOption 进行合并。
7. 命令行选项为最高优先级，在已整合的配置项基础上，采用覆写的方式，定点修订。

编译选项继承覆写关系

优先级：命令行配置 > targets 配置 > buildOptionSet 配置 > buildOption 配置 > products 配置 > buildModeSet 配置

实践说明

应用正式对外布版本前，需要对应用进行代码调试。调试和正式发布版本，两者编译行为可能不同。此时，可以利用 buildMode 能力，来定制两个版本的编译差异性。

假设其中构建产物均为 default，但编译行为不同：release 模式下使能混淆，debug 模式下使能 debug 调试。

示例工程中包含一个模块 entry，将 entry 模块交付到构建产物 default 中，模块定制两种不同的编译模式 debug、release，将两种构建模式均绑定到构建产物 default 中。

工程级 build-profile.json5 示例

{
  "app": {
    "signingConfigs": [],
    "products": [
      {
        "name": "default",
        "signingConfig": "default",
        "compatibleSdkVersion": "5.0.2(14)",
        "runtimeOS": "HarmonyOS",
        "buildOption": {
          "strictMode": {
            "caseSensitiveCheck": true,
            "useNormalizedOHMUrl": true
          }
        }
      }
    ],
    "buildModeSet": [
      {
        "name": "debug"
      },
      {
        "name": "release"
      }
    ]
  },
  "modules": [
    {
      "name": "entry",
      "srcPath": "./entry",
      "targets": [
        {
          "name": "default",
          "applyToProducts": ["default"]
        }
      ]
    }
  ]
}

模块级 build-profile.json5 示例

entry 模块

{
  "apiType": "stageMode",
  "buildOption": {},
  "buildOptionSet": [
    {
      "name": "release",
      "arkOptions": {
        "obfuscation": {
          "ruleOptions": {
            "enable": true,
            "files": ["./obfuscation-rules.txt"]
          }
        }
      }
    },
    {
      "name": "debug",
      "debuggable": true,
      "arkOptions": {
        "obfuscation": {
        "ruleOptions": {
          "enable": false
        }
      }
      }
    }
  ],
  "buildModeBinder": [
    {
      "buildModeName": "release",
      "mappings": [
        {
          "buildOptionName": "release",
          "targetName": "default"
        }
      ]
    },
    {
      "buildModeName": "debug",
      "mappings": [
        {
          "buildOptionName": "debug",
          "targetName": "default"
        }
      ]
    }
  ],
  "targets": [
    {
      "name": "default"
    },
    {
      "name": "ohosTest"
    }
  ]
}

指定构建模式

命令行

示例 1：构建 APP 时，构建产物为 default，指定构建模式为 debug，可执行如下命令：

hvigorw --mode project -p product=default -p buildMode=debug assembleApp

示例 2：构建 APP 时，构建产物为 default，指定构建模式为 release，可执行如下命令：

hvigorw --mode project -p product=default -p buildMode=release assembleApp

DevEco Studio 界面

在 DevEco Studio 界面进行可视化配置，Build Mode 下拉选择对应配置选项 debug 后，点击 Build -> Build Hap(s)/APP(s) -> Build APP(s)，构建编译模式为 debug，构建产物为 default 的 APP 包。