鸿蒙开发中，module.json5配置文件详解

module.json5 是鸿蒙系统中用于定义应用模块的核心配置文件。它包含模块的基本信息、入口能力、支持的设备类型、权限请求等内容，是应用开发和部署的基础。

配置文件结构

以下是一个典型的 module.json5 配置示例：

{"module": {"name": "entry","type": "entry","description": "$string:module_desc","mainElement": "EntryAbility","deviceTypes": ["phone", "tablet"],"deliveryWithInstall": true,"installationFree": false,"pages": "$profile:main_pages","abilities": [{"name": "EntryAbility","srcEntry": "./ets/entryability/EntryAbility.ets","description": "$string:EntryAbility_desc","icon": "$media:icon_app","label": "$string:app_name","startWindowIcon": "$media:icon_app","startWindowBackground": "$color:start_window_background","exported": true,"skills": [{"entities": ["entity.system.home"],"actions": ["action.system.home"]}]}],"requestPermissions": [{"name": "ohos.permission.INTERNET","reason": "$string:reason","usedScene": {"abilities": ["EntryAbility"],"when": "inuse"}}]}
}

关键字段解析

1. name: 模块名称，需在应用中唯一，长度不超过31字节。

2. type: 模块类型，支持 entry（主模块）、feature（动态特性模块）等。

3. mainElement: 指定模块的入口能力（Ability）。

4. deviceTypes: 支持的设备类型，如 phone、tablet 等。

5. deliveryWithInstall: 是否随安装包一起交付。

6. installationFree: 是否支持免安装运行。

7. abilities: 定义模块中的能力（Ability），包括名称、入口路径、图标、标签等。

8. requestPermissions: 定义模块运行时需要申请的权限。

{"module": {
   //模块名称，需在应用中唯一，长度不超过31字节。"name": "entry",
   //模块类型，支持 entry（主模块）、feature（动态特性模块）等。"type": "entry","description": "$string:module_desc",
   //指定模块的入口能力（Ability）。"mainElement": "EntryAbility",
   //支持的设备类型，如 phone、tablet 等。"deviceTypes": ["phone", "tablet"],
   //是否随安装包一起交付。"deliveryWithInstall": true,
   //是否支持免安装运行。"installationFree": false,"pages": "$profile:main_pages",
   //定义模块中的能力（Ability），包括名称、入口路径、图标、标签等。"abilities": [{"name": "EntryAbility","srcEntry": "./ets/entryability/EntryAbility.ets","description": "$string:EntryAbility_desc","icon": "$media:icon_app","label": "$string:app_name","startWindowIcon": "$media:icon_app","startWindowBackground": "$color:start_window_background","exported": true,"skills": [{"entities": ["entity.system.home"],"actions": ["action.system.home"]}]}],
   //定义模块运行时需要申请的权限。"requestPermissions": [{"name": "ohos.permission.INTERNET","reason": "$string:reason","usedScene": {"abilities": ["EntryAbility"],"when": "inuse"}}]}
}

 

使用场景

• 多设备支持: 通过 deviceTypes 指定模块适配的设备类型，如手机、平板等。

• 权限管理: 使用 requestPermissions 配置模块运行时所需的权限及其使用场景。

• 模块扩展: 通过 abilities 和 extensionAbilities 定义模块的功能扩展。

注意事项

• 资源引用: 配置中使用 $string:、$media: 等引用资源文件，需确保资源文件正确配置。

• 模块唯一性: name 和 mainElement 必须在应用中唯一。

• 权限声明: 申请的权限需在 requestPermissions 中完整配置，包括权限名称和使用场景。

通过合理配置 module.json5 文件，可以高效管理鸿蒙应用的模块化开发和部署。