From 22dc11f3fb69c71ca6fe1b9a2dd5cb89a8e9c990 Mon Sep 17 00:00:00 2001 From: "zhangyafei.echo" Date: Tue, 30 Aug 2022 10:26:19 +0800 Subject: [PATCH] Description: Modify module.json to module.json5 Sig:SIG_ApplicationFramework Feature or BugFix: BugFix Binary Source: No Signed-off-by: zhangyafei.echo Change-Id: Ic103eb8cf73d82b2b8cb83b48a6e8f3a5f549c11 --- zh-cn/application-dev/ability/ability-brief.md | 4 ++-- zh-cn/application-dev/ability/stage-ability.md | 10 +++++----- .../application-dev/ability/stage-serviceextension.md | 6 +++--- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/zh-cn/application-dev/ability/ability-brief.md b/zh-cn/application-dev/ability/ability-brief.md index 3abd49268b..56f3ebe85d 100644 --- a/zh-cn/application-dev/ability/ability-brief.md +++ b/zh-cn/application-dev/ability/ability-brief.md @@ -1,6 +1,6 @@ # Ability框架概述 -​ Ability是应用所具备能力的抽象，也是应用程序的重要组成部分。Ability是系统调度应用的最小单元，是能够完成一个独立功能的组件。一个应用可以包含一个或多个Ability。 +​ Ability是应用所具备能力的抽象，也是应用程序的重要组成部分。Ability是系统调度应用的最小单元，是能够完成一个独立功能的组件。一个应用可以包含一个或多个Ability。 ​ Ability框架模型具有两种形态： @@ -14,7 +14,7 @@ | 开发方式 | 提供类Web的API，UI开发与Stage模型一致。 | 提供面向对象的开发方式，UI开发与FA模型一致。 | | 引擎实例 | 每个进程内的每个Ability实例独享一个JS VM引擎实例。 | 每个进程内的多个Ability实例共享一个JS VM引擎实例。 | | 进程内对象共享 | 不支持。 | 支持。 | -| 包描述文件 | 使用config.json描述HAP包和组件信息，组件必须使用固定的文件名。 | 使用module.json描述HAP包和组件信息，可以指定入口文件名。 | +| 包描述文件 | 使用config.json描述HAP包和组件信息，组件必须使用固定的文件名。 | 使用module.json5描述HAP包和组件信息，可以指定入口文件名。 | | 组件 | 提供PageAbility(页面展示)，ServiceAbility(服务)，DataAbility(数据分享)以及FormAbility(卡片)。 | 提供Ability(页面展示)、Extension(基于场景的服务扩展)。 | ​ 除了上述设计上的差异外，对于开发者而言，两种模型的主要区别在于： diff --git a/zh-cn/application-dev/ability/stage-ability.md b/zh-cn/application-dev/ability/stage-ability.md index ef785cc275..e9ad6780e3 100644 --- a/zh-cn/application-dev/ability/stage-ability.md +++ b/zh-cn/application-dev/ability/stage-ability.md @@ -1,6 +1,6 @@ # Ability开发指导 ## 场景介绍 -Stage模型是区别于FA模型的一种应用开发模型，对此模型的介绍详见[Stage模型综述](stage-brief.md)。开发Stage模型应用时，需要在module.json和app.json配置文件中对应用的包结构进行声明，对应用包结构配置文件的说明详见[应用包结构配置文件的说明](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/quick-start/stage-structure.md)。基于Stage模型的Ability应用开发，主要涉及如下功能逻辑： +Stage模型是区别于FA模型的一种应用开发模型，对此模型的介绍详见[Stage模型综述](stage-brief.md)。开发Stage模型应用时，需要在module.json5和app.json5配置文件中对应用的包结构进行声明，对应用包结构配置文件的说明详见[应用包结构配置文件的说明](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/quick-start/stage-structure.md)。基于Stage模型的Ability应用开发，主要涉及如下功能逻辑： - 创建支持使用屏幕浏览及人机交互的Ability应用，包括实现Ability的生命周期、获取Ability配置信息、向用户申请授权及环境变化通知等场景。 - 启动Ability应用，包括相同设备启动Ability、跨设备启动Ability以及指定页面启动Ability等场景。 - 通用组件Call功能，详见[Call调用开发指导](stage-call.md)。 @@ -8,7 +8,7 @@ Stage模型是区别于FA模型的一种应用开发模型，对此模型的介 - 应用迁移，详见[应用迁移开发指导](stage-ability-continuation.md)。 ### 启动模式 -ability支持单实例、多实例和指定实例3种启动模式，在module.json中通过launchType配置。启动模式对应Ability被启动时的行为，对启动模式的详细说明如下： +ability支持单实例、多实例和指定实例3种启动模式，在module.json5中通过launchType配置。启动模式对应Ability被启动时的行为，对启动模式的详细说明如下： | 启动模式 | 描述 |说明 | | ----------- | ------- |---------------- | @@ -16,7 +16,7 @@ ability支持单实例、多实例和指定实例3种启动模式，在module.js | singleton | 单实例 | 系统中只存在唯一一个实例，startAbility时，如果已存在，则复用系统中的唯一一个实例 | | specified | 指定实例 | 运行时由ability内部业务决定是否创建多实例 | -缺省情况下是singleton模式，module.json示例如下： +缺省情况下是singleton模式，module.json5示例如下： ```json { "module": { @@ -146,9 +146,9 @@ export default class MainAbility extends Ability { } ``` ### 应用向用户申请授权 -应用需要获取用户的隐私信息或使用系统能力时，比如获取位置信息、使用相机拍摄照片或录制视频等，需要向用户申请授权。在开发过程中，首先需要明确涉及的敏感权限并在module.json中声明需要的权限，同时通过接口`requestPermissionsFromUser`以动态弹窗的方式向用户申请授权。以访问日历为例，具体示例代码如下： +应用需要获取用户的隐私信息或使用系统能力时，比如获取位置信息、使用相机拍摄照片或录制视频等，需要向用户申请授权。在开发过程中，首先需要明确涉及的敏感权限并在module.json5中声明需要的权限，同时通过接口`requestPermissionsFromUser`以动态弹窗的方式向用户申请授权。以访问日历为例，具体示例代码如下： -在module.json声明需要的权限： +在module.json5声明需要的权限： ```json "requestPermissions": [ { diff --git a/zh-cn/application-dev/ability/stage-serviceextension.md b/zh-cn/application-dev/ability/stage-serviceextension.md index 89e04f9126..d4d28a6cb3 100644 --- a/zh-cn/application-dev/ability/stage-serviceextension.md +++ b/zh-cn/application-dev/ability/stage-serviceextension.md @@ -61,9 +61,9 @@ ExtensionAbility，是Stage模型中新增的扩展组件的基类，一般用 2.注册ServiceExtensionAbility -需要在应用配置文件module.json中进行注册，注册类型type需要设置为service。 +需要在应用配置文件module.json5中进行注册，注册类型type需要设置为service。 -**module.json配置样例** +**module.json5配置样例** ```json "extensionAbilities":[{ @@ -72,6 +72,6 @@ ExtensionAbility，是Stage模型中新增的扩展组件的基类，一般用 "description": "service", "type": "service", "visible": true, - "srcEntrance": "./ets/ServiceExtAbility/ServiceExtAbility.ts" + "srcEntrance": "./ets/ServiceExtAbility/ServiceExtAbility.ts" }] ``` -- GitLab