HarmonyOS鸿蒙Next中deduplicateHar跟idDefinedFilePath怎么使用 6.0.1（21）

HarmonyOS鸿蒙Next中deduplicateHar跟idDefinedFilePath怎么使用 6.0.1（21）

疑问一：文档说明要配置id-config.json5 这个是每个module的build-profile.json5都要配置，还是仅配置工程的build-profile.json5就可以了？

疑问二：id-config.json5这个配置，文档注释中的资源类型，名称，id，是什么意思？能够更具体一点吗？

是要把所有的资源都列出来赋予自定义id吗？


更多关于HarmonyOS鸿蒙Next中deduplicateHar跟idDefinedFilePath怎么使用 6.0.1（21）的实战教程也可以访问 https://www.itying.com/category-93-b0.html

4 回复

鸿蒙 6.0.1 中 deduplicateHar 与 idDefinedFilePath 的使用说明

一、基础使用流程（deduplicateHar + idDefinedFilePath）

deduplicateHar是模块级的 HAR 包去重配置（减少重复依赖的 HAR 体积），idDefinedFilePath是其配套配置（指定固定资源 id 的 json5 文件路径），核心步骤：

  1. 在模块的 build-profile.json5中启用deduplicateHar并配置idDefinedFilePath；
  2. 创建id-config.json5文件，配置需要固定 id 的资源；
  3. 构建时，系统会基于该配置固定资源 id，实现跨 HAP/HSP 的资源访问。

二、疑问解答

疑问一：id-config.json5 是每个 module 的 build-profile.json5 配置，还是工程的？

需在每个启用了deduplicateHar的模块的build-profile.json5中配置，不是工程级的。

原因：

  • deduplicateHar是模块级配置（每个模块的 HAR 依赖是独立的），仅对当前模块的 HAR 去重生效；
  • 不同模块的资源 id 是独立管理的，因此每个模块需单独配置idDefinedFilePath指向自己的id-config.json5文件。

示例（某模块的 build-profile.json5）：

{
  "buildOption": {
    "deduplicateHar": true, // 启用HAR去重
    "idDefinedFilePath": "./id-config.json5" // 指向当前模块下的id-config.json5
  }
}

疑问二：id-config.json5 中资源类型、名称、id 的含义，是否要列所有资源？

1. 字段含义（以示例为例）

字段 含义 具体说明
type 资源类型 对应鸿蒙资源的分类：- string：字符串资源（对应element/string.json中的资源）；- float：数值型资源（对应element/float.json中的尺寸、间距等）；- media：媒体资源（对应media目录下的图片、音频等）；- profile：配置文件资源（对应profile目录下的配置文件）。
name 资源名称 对应资源文件中该资源的name字段（比如string.json中"name": "app_name"的app_name）。
id 固定资源 id 用户自定义的十六进制 id（范围：0x01000000~0x06FFFFFF/0x08000000~0x0FFFFFFF），用于跨 HAP/HSP 访问时定位该资源（去重后 HAR 仅打包到 HAP，HSP 需通过该 id 访问 HAP 中的资源）。

2. 是否要列所有资源？

推荐将该模块下需要跨 HAP/HSP 访问的资源全部列出并配置 id。

原因：启用deduplicateHar后，HAR 包会被去重并仅打包到 HAP 中，HSP 无法通过原资源名称访问 HAP 的资源，必须通过固定 id 访问。若未配置某资源的 id，跨 HAP/HSP 访问该资源时会失败。

三、补充注意事项

  1. id的取值范围需严格遵守（仅支持指定区间的十六进制），否则构建会报错；
  2. 同一应用内的资源 id 需唯一，避免不同资源重复使用同一个 id；
  3. 若模块无需跨 HAP/HSP 访问资源，可不用配置idDefinedFilePath（但deduplicateHar仍可单独启用减少体积）。

更多关于HarmonyOS鸿蒙Next中deduplicateHar跟idDefinedFilePath怎么使用 6.0.1（21）的实战系列教程也可以访问 https://www.itying.com/category-93-b0.html


一、deduplicateHar 配置

作用

  • 功能：用于 自动去重多个 HAR（HarmonyOS Ability Resources）中的重复资源，避免多模块开发时资源冲突或冗余。
  • 场景：当工程包含多个共享包（HAR）且存在同名资源文件时，开启此配置可确保最终编译时仅保留一份资源。

配置示例

在 build-profile.json5 的 buildOption 对象中添加：

{
  "buildOption": {
    "deduplicateHar": true  // true 表示开启去重，false 表示关闭
  }
}

注意事项：

  • 默认值为 false，需要显式配置为 true 才会生效。
  • 开启后，重复的媒体资源（如图片）、布局文件等会被自动筛选合并。

二、idDefinedFilePath 配置

作用

  • 功能：指定 自定义资源 ID 的配置文件路径，用于固定某些资源的 ID 值（如字符串、颜色等）。
  • 场景：跨模块共享资源时，通过固定资源 ID 确保不同模块访问同一资源时 ID 一致性。

配置示例

在 buildOption 中配置 idDefinedFilePath 对象：

{
  "buildOption": {
    "idDefinedFilePath": {
      "excludes": [  // 排除不需要自定义 ID 的目录或文件
        "src/main/resources/base/element/color.json",
        "src/main/resources/**/excluded_dir/"
      ]
    }
  }
}

注意事项：

  1. excludes 数组支持通配符 * 和 **，路径需相对于工程根目录。
  2. 自定义 ID 需通过 id_defined.json 文件管理（需配合 restool 工具生成）。

三、版本适配说明（6.0.1(21)）

  • SDK 版本：compileSdkVersion 需配置为 “6.0.1(21)”，与 buildOption 参数兼容1。
  • 资源管理工具：建议使用 restool 工具（如生成 id_defined.json 时添加 --ids 参数指定输出路径）。

deduplicateHar用于去除重复HAR包，idDefinedFilePath指定ID定义文件路径。在6.0.1（21）中，在模块级build-profile.json5的buildOption字段配置。deduplicateHar设为true启用去重，idDefinedFilePath填写包含资源ID的.ets文件路径。

针对你的问题，我结合文档和开发实践进行解答。

疑问一：配置位置 id-config.json5 文件应放置在每个需要自定义资源ID的模块（Module）的根目录下，而不是仅在工程级的 build-profile.json5 中配置。每个模块的构建过程是独立的，需要各自管理其资源的ID定义，以确保编译时能正确识别和去重。

疑问二：id-config.json5 配置详解 该文件的核心作用是为特定资源预定义固定的ID，防止在构建合并多个HAR包时，因自动生成的ID冲突导致资源引用错误。你不需要列出所有资源，只需为那些可能因冲突而导致问题的关键资源进行定义。

配置项说明：

  • resourceType： 指资源的类型，使用固定的字符串标识，例如：
    • "element"： 表示UI组件（在*.ets中通过$r('app.type.name')引用的资源）。
    • "media"： 表示图片、音频等媒体资源。
    • "string"： 表示字符串资源。
    • "float"： 表示浮点数资源。
    • "color"： 表示颜色资源。
    • "pattern"： 表示样式、主题等模式资源。
  • resourceName： 指资源在项目中的名称。对于element，通常是*.ets文件中@Component装饰的组件名；对于其他类型，则是在资源目录（如resources/base/element/）下定义的资源文件名（不含后缀）。
  • resourceId： 你为该资源指定的唯一十进制整数ID。你需要确保在同一模块内，为不同资源分配的ID是唯一的。

使用场景与建议

  1. 主要用途： 当你的应用依赖多个HAR（HarmonyOS Archive）包，并且这些HAR包中存在同类型、同名称但需要区分的资源时，使用id-config.json5为它们分配明确的ID是必要的。这可以避免运行时引用到错误的资源。
  2. 并非必须： 如果你的项目结构简单，没有多个HAR包，或者没有明显的资源名冲突风险，可以依赖HarmonyOS Next构建工具自动分配ID，无需手动配置此文件。
  3. 如何配置： 在模块根目录创建id-config.json5，参考以下格式：
    // id-config.json5
{
  "idDefinedFilePath": "./id-config.json5", // 指向本文件路径
  "resourceIdList": [
    {
      "resourceType": "element", // 资源类型
      "resourceName": "MyCustomButton", // 你的组件名
      "resourceId": 100001 // 自定义的唯一ID
    },
    {
      "resourceType": "media",
      "resourceName": "icon_app",
      "resourceId": 200001
    }
    // ... 可根据需要添加其他资源项
  ]
}
  4. 与 deduplicateHar 的关系： deduplicateHar 是构建选项（在build-profile.json5中配置），用于开启HAR包的资源去重优化。而id-config.json5是为该去重过程提供确定性ID分配的依据。两者配合使用，确保优化后资源引用的正确性。

总结：你只需在需要自定义ID的模块中配置id-config.json5，并仅为那些关键且易冲突的资源（如多个HAR共享名称的组件或图片）定义唯一ID即可。

回到顶部