• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 工程管理
2
3
4DevEco Studio的基本使用,请参考[DevEco Studio使用指南](../../quick-start/deveco-studio-user-guide-for-openharmony.md)。本章主要介绍如何使用DevEco Studio进行多设备应用开发。
5
6
7> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
8> 本章的内容基于[DevEco Studio 3.0 Beta3](https://developer.harmonyos.com/cn/develop/deveco-studio#download_beta_openharmony)版本进行介绍,如您使用DevEco Studio其它版本,可能存在文档与产品功能界面、操作不一致的情况,请以实际功能界面为准。
9
10
11## 工程创建
12
13参考[创建OpenHarmony工程](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/ohos-create-new-project-0000001263280423),先创建出最基本的项目工程。可以看到DevEco Studio创建出的默认工程,仅包含一个的entry类型的模块。
14
15![zh-cn_image_0000001267274204](figures/zh-cn_image_0000001267274204.jpg)
16
17如果直接使用如下所示的平级目录进行模块管理,工程逻辑结构较混乱且模块间的依赖关系不够清晰,不利于开发及后期维护。
18
19
20```
21/application
22├── common
23├── feature1
24├── feature2
25├── featureN
26├── wearable
27├── default
28└── productN
29```
30
31更推荐使用本文[部署模型](introduction.md#部署模型)小节中介绍的common、features、product三层工程结构。工程结构示例如下所示:
32
33
34```
35/application
36 ├── common                  # 公共特性目录
3738 ├── features                # 功能模块目录
39 │   ├── feature1            # 子功能
40 │   ├── feature2            # 子功能2
41 │   └── ...                 # 子功能n
4243 └── product                 # 产品层目录
44     ├── wearable            # 智能穿戴泛类目录
45     ├── default             # 默认设备泛类目录
46     └── ...
47```
48
49接下来将依次介绍如何新建Module、修改配置文件以及调整目录,以实现“一多”推荐的“三层工程结构”。
50
51
52## 新建Module
53
54参考[开发OpenHarmony npm包](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/ohos-development-npm-package-0000001222578434),新建三个npm模块,分别命名为common、feature1、feature2。参考[添加/删除Module](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/ohos-adding-deleting-module-0000001218760594),新建一个entry类型的模块,假设命名为“wearable”(仅仅为了说明某一类产品)。示例如下:
55
56![zh-cn_image_0000001315434285](figures/zh-cn_image_0000001315434285.png)
57
58> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
59> - 在一个工程中同一个设备类型只支持一个Entry类型的模块。
60>
61> - 当前的DevEco Studio(3.0 Beta3版本)在创建工程时,设备类型仅能选择dafault和tablet,默认该模块已经选择了entry类型,那么在创建wearable这个模块,只能选择feature类型。
62>
63> - 在下一个小节,我们将介绍如何修改Module的配置,包括Module的类型以及其支持的设备类型等。
64
65
66## 修改Module配置
67
68
69### 修改Module名称
70
71修改创建工程时默认的entry模块名称。在该模块上点击鼠标右键,依次选择”Refactor -> Rename”,将名称修改为default。
72
73![zh-cn_image_0000001315914185](figures/zh-cn_image_0000001315914185.jpg)
74
75
76### 修改Module类型及其设备类型
77
78通过修改每个模块中的配置文件(module.json5)对模块进行配置,配置文件中各字段含义详见[配置文件说明](../../quick-start/module-configuration-file.md)。
79
80- 将default模块的deviceTypes配置为["default", "tablet"],同时将其type字段配置为entry。
81  即default模块编译出的hap包在默认设备和平板上安装和运行。
82
83  ![zh-cn_image_0000001267914116](figures/zh-cn_image_0000001267914116.png)
84
85- 将wearable模块的deviceTypes配置为["wearable"],同时将其type字段配置为entry。
86  即wearable模块编译出的hap包仅在智能穿戴设备上安装和运行。
87
88  ![zh-cn_image_0000001267514192](figures/zh-cn_image_0000001267514192.png)
89
90
91## 调整目录结构
92
93调整目录结构
94
95在工程根目录(MyApplication)上点击鼠标右键,依次选择“New -> Directory”新建子目录。创建product和features两个子目录。
96
97![zh-cn_image_0000001266874320](figures/zh-cn_image_0000001266874320.png)
98
99用鼠标左键将default目录拖拽到新建的product目录中,在IDE弹出的确认窗口中,点击“Refactor”即可。
100
101![zh-cn_image_0000001315714137](figures/zh-cn_image_0000001315714137.jpg)
102
103按照同样的步骤,将wearable目录放到product目录中,将feature1和feature2放到features目录中。
104
105![zh-cn_image_0000001316914105](figures/zh-cn_image_0000001316914105.png)
106
107
108## 修改依赖关系
109
110回顾之前小节中关于“工程结构”的介绍,我们推荐在common目录中存放基础公共代码,features目录中存放相对独立的功能模块代码,product目录中存放完全独立的产品代码。这样在product目录中依赖features和common中的公共代码来实现功能,可以最大程度实现代码复用。
111
112配置依赖关系可以通过修改模块中的package.json文件。如下图所示,通过修改default模块中的package.json文件,使其可以使用common、feature1和feature2模块中的代码。更多详情参考[配置OpenHarmony npm包依赖](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/ohos-development-npm-package-0000001252769386#section89674298391)113
114![zh-cn_image_0000001267274208](figures/zh-cn_image_0000001267274208.png)
115
116同样的,修改feature1和feature2模块中的package.json文件,使其可以使用common模块中的代码。
117
118修改package.json文件后,一定要点击右上角的“Sync Now”,否则改动不会生效!
119
120
121## 引用npm包中的代码
122
123在[开发OpenHarmony npm包](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/ohos-development-npm-package-0000001252769386)中,仅介绍了如何使用npm包中的页面和资源,本小节以例子的形式补充介绍如何使用npm包中的类和函数。
124
125示例如下:
126
127- 在common模块中新增ComplexNumber类,用于表征复数(数学概念,由实部和虚部组成),该类包含toString()方法,将复数转换为字符形式。
128
129- 在common模块中新增Add函数,用于计算并返回两个数字的和。
130
131- 在default模块中,使用common模块新增的ComplexNumber类和Add函数。
132
1331. 在”common/src/main/ets”目录中,按照需要新增文件和自定义类和函数。
134   ![zh-cn_image_0000001315434289](figures/zh-cn_image_0000001315434289.png)
135
1362. 在”common/index.ets”文件中,申明需要export的类、函数的名称及在当前模块中的位置,否则其它模块无法使用。
137   ![zh-cn_image_0000001315914189](figures/zh-cn_image_0000001315914189.png)
138
1393. 在default模块中import和使用这些类和函数。注意提前在default模块的package.json文件中配置对common模块的依赖关系。
140   ![zh-cn_image_0000001267914120](figures/zh-cn_image_0000001267914120.png)
141
142> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
143> 如果需要将npm包发布供其他开发者使用,当前npm包可发布到npm官方中心仓和OpenHarmony npm专用仓,具体可参考[发布OpenHarmony npm包](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/ohos-development-npm-package-0000001222578434#section663116411397)144
145
146## 总结
147
148本章主要介绍了如何实现推荐的工程结构,以便更好的进行多设备应用开发。
149
150关于IDE的基本使用,比如如何进行编译构建、如何签名、如何使用预览器等,[DevEco Studio使用指南](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/ohos-deveco-studio-overview-0000001263280421)中已经有非常详尽的介绍,本文不再重复介绍。
151