HarmonyOS之在工程中导入Sample工程和添加Module

Posted 2021-06-28 Forever_wj

一、导入 Sample 工程

① Sample 说明

• DevEco Studio 支持 HarmonyOS Sample 工程的导入功能，通过对接 Gitee 开源社区中的 Sample 资源，可一键导入 Sample 工程到 DevEco Studio 中。
• 目前，HarmonyOS 和 OpenHarmony 的 Sample 均在同一个 Gitee 仓中，但 OpenHarmony 的 Sample 示例并不适用于 HarmonyOS SDK。在导入时，请不要导入在 Sample 简介中存在 “This sample is intended for novices at developing OpenHarmony applications.” 说明的 Sample，例如：

② Sample 导入方法

• 在 DevEco Studio 的欢迎页，进入 Configure > Settings > Version Control > Git 界面，点击 Test 按钮检测是否安装 Git 工具：
• • 已安装，请根据下一步开始导入 Sample；

• • 未安装，请点击 Download and Install，DevEco Studio 会自动下载并安装。安装完成后，请根据第二步开始导入Sample；

• 在 DevEco Studio 的欢迎页，点击 Import HarmonyOS Sample 按钮，导入 Sample 工程（在打开工程的情况下，可以点击 File > New > Import HarmonyOS Sample 来进行导入）：

• 选择需要导入的 Sample 工程，然后点击 Next：

• 设置 App Name 和 Project Location，然后点击 Finish，等待 Sample 工程导入完成：

• 导入 Sample 后，等待工程同步完成即可。

二、添加 Module

① Module 单元

• Module 是 HarmonyOS 应用的基本功能单元，包含了源代码、资源文件、第三方库及应用清单文件，每一个 Module 都可以独立进行编译和运行。
• 一个 HarmonyOS 应用通常会包含一个或多个 Module，因此，可以在工程中，创建多个 Module，每个 Module 分为 Ability 和 Library（其中 Library 包括 HarmonyOS Library 和 Java Library）两种类型。
• 在一个 APP 中，对于同一类型设备有且只有一个 Entry Module，其余 Module 的类型均为 Feature。
• 因此，在创建一个类型为 Ability 的 Module 时，遵循如下原则：
• • 若新增 Module 的设备类型为已有设备时，则 Module 的类型将自动设置为“Feature”；
• • 若新增Module的设备类型为当前还没有创建 Module，则 Module 的类型将自动设置为“Entry”。

② 新增 Module

• 通过如下两种方法，在工程中添加新的 Module：
• • 方法一：鼠标移到工程目录顶部，点击鼠标右键，选择 New>Module，开始创建新的 Module；
• • 方法二：在菜单栏选择 File > New > Module，开始创建新的 Module。
• 在 New Project Module 界面中，选择需要创建的模板：

• 点击 Next，在 Module 配置页面，设置新增 Module 的基本信息（Module 类型为 Ability 或者 HarmonyOS Library 时，请根据如下内容进行设置，然后点击 Next）：
• • Application/Library name：新增 Module 所属的类名称。
• • Module Name：新增模块的名称。
• • Module Type：仅再 Ability 模板存在，工具自动根据设备类型下的模块进行设置，设置规则请参考 Ability 的 Module 类型设置原则。
• • Package Name：软件包名称，可以点击 Edit 修改默认包名称，需全局唯一。
• • Compatible API Version：兼容的 SDK 最低版本。
• • Device Type：选择模块的设备类型，如果新建模块的 Module Type 为 Feature，则只能选择该工程原有的设备类型；如果 Module Type 为 Entry，可以选择该 Module 支持的其他设备类型。
• • Show in Service Center：是否在服务中心露出，仅在 Ability 模板存在。如果工程类型为 HarmonyOS Service，则会同步创建一个2*2的服务卡片模板，同时还会创建入口卡片；如果工程类型为HarmonyOS Application，则只会创建一个2 * 2的服务卡片模板。

• Module 类型为 Java Library 时，请根据如下内容进行设置，然后点击 Finish 完成创建：
• • Library name：Java Library 类名称。
• • Java package name：软件包名称，可以点击 Edit 修改默认包名称，需全局唯一。
• • Java class name：class 文件名称。
• • Create.gitignore file：是否自动创建 .gitignore文件，勾选表示创建。

• 设置新增 Ability 的 Page Name 和 Layout Name，若该 Module 的模板类型为 Ability，还需要设置 Visible 参数，表示该 Ability 是否可以被其它应用所调用：
• • 勾选（true）：可以被其它应用调用；
• • 不勾选（false）：不能被其它应用调用。
• 点击 Finish，等待创建完成后，可以在工程目录中查看和编辑新增的 Module。

③ 删除 Module

• 为防止开发者在删除 Module 的过程中，误将其它的模块删除，DevEco Studio 提供统一的模块管理功能，需要先在模块管理中，移除对应的模块后，才允许删除。
• 在菜单栏中选择 File > Project Structure > Modules，选择需要删除的 Module，点击“-”按钮，并在弹出的对话框中点击 Yes。

• 在工程目录中选中该模块，点击鼠标右键，选中 Delete，并在弹出的对话框中点击 Delete。