• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 构建第一个ArkTS应用(Stage模型)
2
3
4## 创建ArkTS工程(4.1Beta1版本及之前)
5
6> **说明:**
7>
8> - 为确保运行效果,此处以使用**DevEco Studio 4.1 Beta1**版本为例<!--Del-->,点击[此处](../../release-notes/OpenHarmony-v4.1-beta1.md#配套关系)获取下载链接<!--DelEnd-->。
9>
10> - 此版本可直接创建OpenHarmony ArkTS工程。
11
121. 若首次打开**DevEco Studio**,请点击**Create Project**创建工程。如果已经打开了一个工程,请在菜单栏选择**File** &gt; **New** &gt; **Create Project**来创建一个新工程。
13
142. 选择**Application**应用开发(本文以应用开发为例,**Atomic Service**对应为原子化服务开发),选择模板“**[OpenHarmony]Empty Ability**”,点击**Next**进行下一步配置。
15
16   若开发者需要进行Native相关工程的开发,可选择Native C++模板。
17
18   ![createProject](figures/createProject.png)
19
203. 进入配置工程界面,**Compile SDK**选择**11**,其他参数保持默认设置即可。
21
22   其中**Node**用来配置当前工程运行的Node.js版本,可选择使用已有的Node.js或下载新的Node.js版本。
23
24   ![chooseStageModel](figures/chooseStageModel.png)
25
264. 点击**Finish**,工具会自动生成示例代码和相关资源,等待工程创建完成。
27
28## 创建ArkTS工程(4.1Beta1版本之后)
29
30> **说明:**
31>
32> - 4.1Beta1版本及之后,DevEco Studio默认创建的工程为HarmonyOS工程,不再支持直接创建OpenHarmony工程。需要基于创建完成的HarmonyOS工程进行一些字段修改,才能得到OpenHarmony工程。
33>
34> - 为确保运行效果,此处以使用[最新DevEco Studio版本](https://developer.huawei.com/consumer/cn/download/)为例。
35
361. 若首次打开**DevEco Studio**,请点击**Create Project**创建工程。如果已经打开了一个工程,请在菜单栏选择**File > New > Create Project**来创建一个新工程。
37
382. 选择**Application**应用开发(本文以应用开发为例,**Atomic Service**对应为元服务开发),选择模板**Empty Ability**,点击**Next**进行下一步配置。
39
40   若开发者需要进行Native相关工程的开发,请选择Native C++模板,更多模板的使用和说明请见[工程模板介绍](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/ide-template)41
42   ![createProject](figures/zh-cn_image_00250403.png)
43
443. 进入配置工程界面,**Compatible SDK**表示兼容的最低API Version,此处以选择5.0.0(12)为例,其他参数保持默认设置即可。
45
46   ![chooseStageModel](figures/zh-cn_image_compatible_version.png)
47
484. 点击**Finish**,工具会自动生成示例代码和相关资源,等待工程创建完成,此时创建的工程为HarmonyOS工程。
49
505. 在完成创建HarmonyOS工程后,根据如下操作修改工程级build-profile.json5文件(即与entry同级)中相关字段:
51
52   1. 在工程级build-profile.json5文件添加compileSdkVersion字段。
53
54   2. 将compatibleSdkVersion和compileSdkVersion字段赋值为整数类型,如10,11或12。
55
56   3. 将runtimeOS从"HarmonyOS"修改为"OpenHarmony"。
57
58   ```json
59   "products": [
60     {
61       "name": "default",
62       "signingConfig": "default",
63       "compileSdkVersion": 12,    // 指定OpenHarmony应用/原子化服务编译时的版本
64       "compatibleSdkVersion": 12, // 指定OpenHarmony应用/原子化服务兼容的最低版本
65       "runtimeOS": "OpenHarmony",
66     }
67   ],
68   ```
69
706. 单击**Sync Now**进行同步。
71
72   在Sync Check弹窗中点击Yes,同意将module.json5/config.json文件中的phone切换为OpenHarmony支持的default类型,并删除在OpenHarmony不适用的其他设备类型,同步成功无其他报错则OpenHarmony工程创建完成。
73
74## ArkTS工程目录结构(Stage模型)
75
76![project](figures/project.png)
77
78- **AppScope &gt; app.json5**:应用的全局配置信息,详见[app.json5配置文件](app-configuration-file.md)。
79
80- **entry**:应用/原子化服务模块,编译构建生成一个HAP包。
81  - **src &gt; main &gt; ets**:用于存放ArkTS源码。
82
83  - **src &gt; main &gt; ets &gt; entryability**:应用/服务的入口。
84
85  - **src &gt; main &gt; ets &gt; pages**:应用/服务包含的页面。
86
87  - **src &gt; main &gt; resources**:用于存放应用/服务所用到的资源文件,如图形、多媒体、字符串、布局文件等。关于资源文件,详见[资源文件的分类](resource-categories-and-access.md#资源分类)。
88
89  - **src &gt; main &gt; module.json5**:模块配置文件。主要包含HAP包的配置信息、应用/服务在具体设备上的配置信息以及应用/服务的全局配置信息。具体的配置文件说明,详见[module.json5配置文件](module-configuration-file.md)。
90
91  - **build-profile.json5**:当前的模块信息 、编译信息配置项,包括buildOption、targets配置等。
92
93  - **hvigorfile.ts**:模块级编译构建任务脚本,开发者可以自定义相关任务和代码实现。
94  - **obfuscation-rules.txt**:混淆规则文件。混淆开启后,在使用Release模式进行编译时,会对代码进行编译、混淆及压缩处理,保护代码资产。
95
96- **oh_modules**:用于存放三方库依赖信息。
97
98- **build-profile.json5**:工程级配置信息,包括签名signingConfigs、产品配置products等。
99
100- **hvigorfile.ts**:应用级编译构建任务脚本。
101
102
103## 构建第一个页面
104
1051. 使用文本组件。
106
107   工程同步完成后,在Project窗口,点击entry &gt; src &gt; main &gt; ets &gt; pages,打开Index.ets文件,可以看到页面由Text组件组成。**Index.ets**文件的示例如下:
108
109   ```ts
110   // Index.ets
111   @Entry
112   @Component
113   struct Index {
114     @State message: string = 'Hello World';
115
116     build() {
117       Row() {
118         Column() {
119           Text(this.message)
120             .fontSize(50)
121             .fontWeight(FontWeight.Bold)
122         }
123         .width('100%')
124       }
125       .height('100%')
126     }
127   }
128   ```
129
1302. 添加按钮。
131
132   在默认页面基础上,我们添加一个Button组件,作为按钮响应用户点击,从而实现跳转到另一个页面。**Index.ets**文件的示例如下:
133
134   ```ts
135   // Index.ets
136   @Entry
137   @Component
138   struct Index {
139     @State message: string = 'Hello World';
140
141     build() {
142       Row() {
143         Column() {
144           Text(this.message)
145             .fontSize(50)
146             .fontWeight(FontWeight.Bold)
147           // 添加按钮,以响应用户点击
148           Button() {
149             Text('Next')
150               .fontSize(30)
151               .fontWeight(FontWeight.Bold)
152           }
153           .type(ButtonType.Capsule)
154           .margin({
155             top: 20
156           })
157           .backgroundColor('#0D9FFB')
158           .width('40%')
159           .height('5%')
160         }
161         .width('100%')
162       }
163       .height('100%')
164     }
165   }
166   ```
167
1683. 在编辑窗口右上角的侧边工具栏,点击Previewer,打开预览器。第一个页面效果如下图所示:
169
170   ![zh-cn_image_0000001311334976](figures/zh-cn_image_0000001311334976.png)
171
172
173## 构建第二个页面
174
1751. 创建第二个页面。
176
177   - 新建第二个页面文件。在“**Project**”窗口,打开“**entry &gt; src &gt; main &gt; ets**”,右键点击“**pages**”文件夹,选择“**New &gt; ArkTS File**”,命名为“**Second**”,点击**回车键**。可以看到文件目录结构如下:
178
179      ![secondPage](figures/secondPage.png)
180
181      >  **说明:**
182      >
183      > 开发者也可以在右键点击“**pages**”文件夹时,选择“**New > Page > Empty Page**”,命名为“**Second**”,点击“**Finish**”完成第二个页面的创建。使用此种方式则无需再进行下文中第二个页面路由的手动配置。
184
185   - 配置第二个页面的路由。在“**Project**”窗口,打开“**entry &gt; src &gt; main &gt; resources &gt; base &gt; profile**”,在main_pages.json文件中的“src”下配置第二个页面的路由“pages/Second”。示例如下:
186
187      ```json
188      {
189        "src": [
190          "pages/Index",
191          "pages/Second"
192        ]
193      }
194      ```
195
1962. 添加文本及按钮。
197
198   参照第一个页面,在第二个页面添加Text组件、Button组件等,并设置其样式。“**Second.ets**”文件的示例如下:
199
200   ```ts
201   // Second.ets
202   @Entry
203   @Component
204   struct Second {
205     @State message: string = 'Hi there';
206
207     build() {
208       Row() {
209         Column() {
210           Text(this.message)
211             .fontSize(50)
212             .fontWeight(FontWeight.Bold)
213           Button() {
214             Text('Back')
215               .fontSize(25)
216               .fontWeight(FontWeight.Bold)
217           }
218           .type(ButtonType.Capsule)
219           .margin({
220             top: 20
221           })
222           .backgroundColor('#0D9FFB')
223           .width('40%')
224           .height('5%')
225         }
226         .width('100%')
227       }
228       .height('100%')
229     }
230   }
231   ```
232
233
234## 实现页面间的跳转
235
236页面间的导航可以通过[页面路由router](../reference/apis-arkui/js-apis-router.md)来实现。页面路由router根据页面url找到目标页面,从而实现跳转。使用页面路由请导入router模块。
237
238如果需要实现更好的转场动效等,推荐使用[Navigation](../ui/arkts-navigation-navigation.md)。
239
2401. 第一个页面跳转到第二个页面。
241
242   在第一个页面中,跳转按钮绑定onClick事件,点击按钮时跳转到第二页。“**Index.ets**”文件的示例如下:
243
244   ```ts
245   // Index.ets
246   // 导入页面路由模块
247   import { BusinessError } from '@kit.BasicServicesKit';
248
249   @Entry
250   @Component
251   struct Index {
252     @State message: string = 'Hello World';
253
254     build() {
255       Row() {
256         Column() {
257           Text(this.message)
258             .fontSize(50)
259             .fontWeight(FontWeight.Bold)
260           // 添加按钮,以响应用户点击
261           Button() {
262             Text('Next')
263               .fontSize(30)
264               .fontWeight(FontWeight.Bold)
265           }
266           .type(ButtonType.Capsule)
267           .margin({
268             top: 20
269           })
270           .backgroundColor('#0D9FFB')
271           .width('40%')
272           .height('5%')
273           // 跳转按钮绑定onClick事件,点击时跳转到第二页
274           .onClick(() => {
275             console.info(`Succeeded in clicking the 'Next' button.`)
276             // 获取UIContext
277             let uiContext : UIContext = this.getUIContext();
278             let router = uiContext.getRouter();
279            // 跳转到第二页
280              router.pushUrl({ url: 'pages/Second' }).then(() => {
281                console.info('Succeeded in jumping to the second page.')
282              }).catch((err: BusinessError) => {
283                console.error(`Failed to jump to the second page.Code is ${err.code}, message is ${err.message}`)
284              })
285           })
286         }
287         .width('100%')
288       }
289       .height('100%')
290     }
291   }
292   ```
293
2942. 第二个页面返回到第一个页面。
295
296   在第二个页面中,返回按钮绑定onClick事件,点击按钮时返回到第一页。“**Second.ets**”文件的示例如下:
297
298   ```ts
299   // Second.ets
300   // 导入页面路由模块
301   import { BusinessError } from '@kit.BasicServicesKit';
302
303   @Entry
304   @Component
305   struct Second {
306     @State message: string = 'Hi there';
307
308     build() {
309       Row() {
310         Column() {
311           Text(this.message)
312             .fontSize(50)
313             .fontWeight(FontWeight.Bold)
314           Button() {
315             Text('Back')
316               .fontSize(25)
317               .fontWeight(FontWeight.Bold)
318           }
319           .type(ButtonType.Capsule)
320           .margin({
321             top: 20
322           })
323           .backgroundColor('#0D9FFB')
324           .width('40%')
325           .height('5%')
326           // 返回按钮绑定onClick事件,点击按钮时返回到第一页
327           .onClick(() => {
328             console.info(`Succeeded in clicking the 'Back' button.`)
329             // 获取UIContext
330             let uiContext : UIContext = this.getUIContext();
331             let router = uiContext.getRouter();
332             try {
333               // 返回第一页
334               router.back()
335               console.info('Succeeded in returning to the first page.')
336             } catch (err) {
337                let code = (err as BusinessError).code;
338                let message = (err as BusinessError).message;
339               console.error(`Failed to return to the first page.Code is ${code}, message is ${message}`)
340             }
341           })
342         }
343         .width('100%')
344       }
345       .height('100%')
346     }
347   }
348   ```
349
3503. 打开Index.ets文件,点击预览器中的![zh-cn_image_0000001311015192](figures/zh-cn_image_0000001311015192.png)按钮进行刷新。效果如下图所示:
351
352   ![zh-cn_image_0000001364254729](figures/zh-cn_image_0000001364254729.png)
353
354
355## 使用真机运行应用
356
3571. 将搭载OpenHarmony标准系统的开发板与电脑连接。
358
3592. 点击**File** &gt; **Project Structure...** &gt; **Project** &gt; **SigningConfigs**界面勾选“**Automatically generate signature**”,等待自动签名完成即可,点击“**OK**”。如下图所示:
360
361   ![signConfig](figures/signConfig.png)
362
3633. 在编辑窗口右上角的工具栏,点击![zh-cn_image_0000001364054485](figures/zh-cn_image_0000001364054485.png)按钮运行。效果如下图所示:
364
365   ![zh-cn_image_0000001364254729](figures/zh-cn_image_0000001364254729.png)
366
367恭喜您已经使用ArkTS语言开发(Stage模型)完成了第一个OpenHarmony应用,快来探索更多的OpenHarmony功能吧。