提交 f9a16200 编写于 作者: G ge-yafang

update docs

Signed-off-by: Nge-yafang <geyafang@huawei.com>
上级 ef5224af
......@@ -2,10 +2,8 @@
本文档适用于OpenHarmony应用开发的初学者。通过构建一个简单的具有页面跳转/返回功能的应用(如下图所示),快速了解工程目录的主要文件,熟悉OpenHarmony应用开发流程。
![zh-cn_image_0000001364254729](figures/zh-cn_image_0000001364254729.png)
在开始之前,您需要了解有关OpenHarmony应用的一些基本概念:UI框架的简单说明、Ability的基本概念。
......@@ -45,7 +43,7 @@ FA模型和Stage模型的工程目录结构存在差异,Stage模型只支持
## 工具准备
1. 安装最新版[DevEco Studio](https://developer.harmonyos.com/cn/develop/deveco-studio#download)
1. 安装最新版[DevEco Studio](https://developer.harmonyos.com/cn/develop/deveco-studio)
2. 请参考[配置OpenHarmony SDK](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/ohos-setting-up-environment-0000001263160443),完成**DevEco Studio**的安装和开发环境配置。
......
......@@ -2,18 +2,19 @@
> **说明:**
> 请使用**DevEco Studio V3.0.0.601 Beta1**及更高版本。
>
> 为确保运行效果,本文以使用**DevEco Studio V3.0.0.993**版本为例,点击[此处](https://developer.harmonyos.com/cn/develop/deveco-studio#download)获取下载链接。
>
> 请使用**DevEco Studio V3.0.0.601 Beta1**及更高版本。
>
> 为确保运行效果,本文以使用**DevEco Studio V3.1.0.100**版本为例,点击[此处](https://developer.harmonyos.com/cn/develop/deveco-studio)获取下载链接。
## 创建eTS工程
## 创建ArkTS工程
1. 若首次打开**DevEco Studio**,请点击**Create Project**创建工程。如果已经打开了一个工程,请在菜单栏选择**File** &gt; **New** &gt; **Create Project**来创建一个新工程。选择**OpenHarmony**模板库,选择模板“**Empty Ability**”,点击**Next**进行下一步配置。
![01](figures/01.png)
2. 进入配置工程界面,**Compile SDK** 选择“**8**”(**Compile SDK**选择“**9**”时注意同步选择**Model** 为“**FA**”,此处以选择“**8**”为例),**Language**选择“**eTS**”,其他参数保持默认设置即可。
2. 进入配置工程界面,**Compile SDK** 选择“**8**”(**Compile SDK**选择“**9**”时注意同步选择**Model** 为“**FA**”,此处以选择“**8**”为例),**Language**选择“**ArkTS**”,其他参数保持默认设置即可。
![02](figures/02.png)
......@@ -27,7 +28,9 @@
3. 点击**Finish**,工具会自动生成示例代码和相关资源,等待工程创建完成。
## eTS工程目录结构
## ArkTS工程目录结构(FA模型)
![zh-cn_image_0000001384652328](figures/zh-cn_image_0000001384652328.png)
- **entry**:OpenHarmony工程模块,编译构建生成一个[HAP](../../glossary.md#hap)包。
- **src &gt; main &gt; ets**:用于存放ets源码。
......@@ -38,11 +41,11 @@
- **src &gt; main &gt; resources**:用于存放应用/服务所用到的资源文件,如图形、多媒体、字符串、布局文件等。关于资源文件,详见[资源文件的分类](resource-categories-and-access.md#资源分类)
- **src &gt; main &gt; config.json**:模块配置文件。主要包含HAP包的配置信息、应用/服务在具体设备上的配置信息以及应用/服务的全局配置信息。具体的配置文件说明,详见[应用包结构配置文件的说明(FA模型)](package-structure.md)
- **build-profile.json5**:当前的模块信息 、编译信息配置项,包括buildOption、targets配置等。
- **hvigorfile.js**:模块级编译构建任务脚本,开发者可以自定义相关任务和代码实现。
- **hvigorfile.ts**:模块级编译构建任务脚本,开发者可以自定义相关任务和代码实现。
- **build-profile.json5**:应用级配置信息,包括签名、产品配置等。
- **hvigorfile.js**:应用级编译构建任务脚本。
- **hvigorfile.ts**:应用级编译构建任务脚本。
## 构建第一个页面
......@@ -112,15 +115,13 @@
3. 在编辑窗口右上角的侧边工具栏,点击Previewer,打开预览器。第一个页面效果如下图所示:
![zh-cn_image_0000001364254741](figures/zh-cn_image_0000001364254741.png)
![zh-cn_image_0000001311334976](figures/zh-cn_image_0000001311334976.png)
## 构建第二个页面
1. 创建第二个页面。
- 新建第二个页面文件。在“**Project**”窗口,打开“**entry &gt; src &gt; main &gt; ets &gt; MainAbility**”,右键点击“**pages**”文件夹,选择“**New &gt; eTS File**”,命名为“**second**”,点击“**Finish**”。可以看到文件目录结构如下:
- 新建第二个页面文件。在“**Project**”窗口,打开“**entry &gt; src &gt; main &gt; ets &gt; MainAbility**”,右键点击“**pages**”文件夹,选择“**New &gt; ArkTS File**”,命名为“**second**”,点击“**Finish**”。可以看到文件目录结构如下:
![zh-cn_image_0000001311334932](figures/zh-cn_image_0000001311334932.png)
> **说明:**
......@@ -273,21 +274,21 @@
}
```
3. 打开index.ets文件,点击预览器中的![zh-cn_image_0000001311175120](figures/zh-cn_image_0000001311175120.png)按钮进行刷新。效果如下图所示:
3. 打开index.ets文件,点击预览器中的![zh-cn_image_0000001311015192](figures/zh-cn_image_0000001311015192.png)按钮进行刷新。效果如下图所示:
![zh-cn_image_0000001364173989](figures/zh-cn_image_0000001364173989.png)
![zh-cn_image_0000001364254729](figures/zh-cn_image_0000001364254729.png)
## 使用真机运行应用
1. 将搭载OpenHarmony标准系统的开发板与电脑连接。
2. 点击**File**&gt; **Project Structure...** &gt; **Project**&gt;**SigningConfigs** 界面勾选“**Automatically generate signature**”,等待自动签名完成即可,点击“**OK**”。如下图所示:
2. 点击**File** &gt; **Project Structure...** &gt; **Project** &gt; **SigningConfigs** 界面勾选“**Automatically generate signature**”,等待自动签名完成即可,点击“**OK**”。如下图所示:
![06](figures/06.png)
3. 在编辑窗口右上角的工具栏,点击![zh-cn_image_0000001311494580](figures/zh-cn_image_0000001311494580.png)按钮运行。效果如下图所示:
3. 在编辑窗口右上角的工具栏,点击![zh-cn_image_0000001364054485](figures/zh-cn_image_0000001364054485.png)按钮运行。效果如下图所示:
![zh-cn_image_0000001363934577](figures/zh-cn_image_0000001363934577.png)
![zh-cn_image_0000001364254729](figures/zh-cn_image_0000001364254729.png)
恭喜您已经使用ArkTS语言开发(FA模型)完成了第一个OpenHarmony应用,快来[探索更多的OpenHarmony功能](../application-dev-guide.md)吧。
......@@ -2,12 +2,13 @@
> **说明:**
>
> 请使用**DevEco Studio V3.0.0.900 Beta3**及更高版本。
>
> 为确保运行效果,本文以使用**DevEco Studio V3.0.0.993**版本为例,点击[此处](https://developer.harmonyos.com/cn/develop/deveco-studio#download)获取下载链接。
> 为确保运行效果,本文以使用**DevEco Studio V3.1.0.100**版本为例,点击[此处](https://developer.harmonyos.com/cn/develop/deveco-studio)获取下载链接。
## 创建eTS工程
## 创建ArkTS工程
1. 若首次打开**DevEco Studio**,请点击**Create Project**创建工程。如果已经打开了一个工程,请在菜单栏选择**File** &gt; **New** &gt; **Create Project**来创建一个新工程。选择**OpenHarmony**模板库,选择模板“**Empty Ability**”,点击**Next**进行下一步配置。
......@@ -28,36 +29,32 @@
3. 点击**Finish**,工具会自动生成示例代码和相关资源,等待工程创建完成。
## eTS工程目录结构
## ArkTS工程目录结构(Stage模型)
![zh-cn_image_0000001364054489](figures/zh-cn_image_0000001364054489.png)
- **AppScope &gt; app.json5**:应用的全局配置信息。
- **entry**:OpenHarmony工程模块,编译构建生成一个[HAP](../../glossary.md#hap)包。
- **src &gt; main &gt; ets**:用于存放ets源码。
- **src &gt; main &gt; ets &gt; Application &gt; AbilityStage.ts**:实现AbilityStage接口。
- **src &gt; main &gt; ets &gt; MainAbility**:应用/服务的入口。
- **src &gt; main &gt; ets &gt; MainAbility &gt; MainAbility.ts**:承载Ability生命周期。
- **src &gt; main &gt; ets &gt; pages**:MainAbility包含的页面。
- **src &gt; main &gt; ets &gt; entryability**:应用/服务的入口。
- **src &gt; main &gt; ets &gt; pages**:应用/服务包含的页面。
- **src &gt; main &gt; resources**:用于存放应用/服务所用到的资源文件,如图形、多媒体、字符串、布局文件等。关于资源文件,详见[资源文件的分类](resource-categories-and-access.md#资源分类)
- **src &gt; main &gt; module.json5**:模块配置文件。主要包含HAP包的配置信息、应用/服务在具体设备上的配置信息以及应用/服务的全局配置信息。具体的配置文件说明,详见[应用包结构配置文件的说明(Stage模型)](stage-structure.md)
- **build-profile.json5**:当前的模块信息 、编译信息配置项,包括buildOption、targets配置等。
- **hvigorfile.js**:模块级编译构建任务脚本,开发者可以自定义相关任务和代码实现。
- **hvigorfile.ts**:模块级编译构建任务脚本,开发者可以自定义相关任务和代码实现。
- **build-profile.json5**:应用级配置信息,包括签名、产品配置等。
- **hvigorfile.js**:应用级编译构建任务脚本。
- **hvigorfile.ts**:应用级编译构建任务脚本。
## 构建第一个页面
1. 使用文本组件。
工程同步完成后,在“**Project**”窗口,点击“**entry &gt; src &gt; main &gt; ets &gt; pages**”,打开“**index.ets**”文件,可以看到页面由Text组件组成。“**index.ets**”文件的示例如下:
工程同步完成后,在“**Project**”窗口,点击“**entry &gt; src &gt; main &gt; ets &gt; pages**”,打开“**Index.ets**”文件,可以看到页面由Text组件组成。“**Index.ets**”文件的示例如下:
```ts
// index.ets
// Index.ets
@Entry
@Component
struct Index {
......@@ -79,10 +76,10 @@
2. 添加按钮。
在默认页面基础上,我们添加一个Button组件,作为按钮响应用户点击,从而实现跳转到另一个页面。“**index.ets**”文件的示例如下:
在默认页面基础上,我们添加一个Button组件,作为按钮响应用户点击,从而实现跳转到另一个页面。“**Index.ets**”文件的示例如下:
```ts
// index.ets
// Index.ets
@Entry
@Component
struct Index {
......@@ -123,30 +120,28 @@
## 构建第二个页面
1. 创建第二个页面。
- 新建第二个页面文件。在“**Project**”窗口,打开“**entry &gt; src &gt; main &gt; ets**”,右键点击“**pages**”文件夹,选择“**New &gt; eTS File**”,命名为“**second**”,点击“**Finish**”。可以看到文件目录结构如下:
- 新建第二个页面文件。在“**Project**”窗口,打开“**entry &gt; src &gt; main &gt; ets **”,右键点击“**pages**”文件夹,选择“**New &gt; ArkTS File**”,命名为“**Second**”,点击“**Finish**”。可以看到文件目录结构如下:
![09](figures/09.png)
> **说明:**
> 开发者也可以在右键点击“**pages**”文件夹时,选择“**New &gt; Page**”,则无需手动配置相关页面路由。
- 配置第二个页面的路由。在“**Project**”窗口,打开“**entry &gt; src &gt; main &gt; resources &gt; base &gt; profile**”,在main_pages.json文件中的“src”下配置第二个页面的路由“pages/second”。示例如下:
- 配置第二个页面的路由。在“**Project**”窗口,打开“**entry &gt; src &gt; main &gt; resources &gt; base &gt; profile**”,在main_pages.json文件中的“src”下配置第二个页面的路由“pages/Second”。示例如下:
```json
{
"src": [
"pages/index",
"pages/second"
"pages/Index",
"pages/Second"
]
}
```
2. 添加文本及按钮。
参照第一个页面,在第二个页面添加Text组件、Button组件等,并设置其样式。“**second.ets**”文件的示例如下:
参照第一个页面,在第二个页面添加Text组件、Button组件等,并设置其样式。“**Second.ets**”文件的示例如下:
```ts
// second.ets
// Second.ets
@Entry
@Component
struct Second {
......@@ -185,10 +180,10 @@
1. 第一个页面跳转到第二个页面。
在第一个页面中,跳转按钮绑定onClick事件,点击按钮时跳转到第二页。“**index.ets**”文件的示例如下:
在第一个页面中,跳转按钮绑定onClick事件,点击按钮时跳转到第二页。“**Index.ets**”文件的示例如下:
```ts
// index.ets
// Index.ets
// 导入页面路由模块
import router from '@ohos.router';
......@@ -218,7 +213,7 @@
.height('5%')
// 跳转按钮绑定onClick事件,点击时跳转到第二页
.onClick(() => {
router.push({ url: 'pages/second' })
router.push({ url: 'pages/Second' })
})
}
.width('100%')
......@@ -230,10 +225,10 @@
2. 第二个页面返回到第一个页面。
在第二个页面中,返回按钮绑定onClick事件,点击按钮时返回到第一页。“**second.ets**”文件的示例如下:
在第二个页面中,返回按钮绑定onClick事件,点击按钮时返回到第一页。“**Second.ets**”文件的示例如下:
```ts
// second.ets
// Second.ets
// 导入页面路由模块
import router from '@ohos.router';
......@@ -272,21 +267,21 @@
}
```
3. 打开index.ets文件,点击预览器中的![zh-cn_image_0000001311015192](figures/zh-cn_image_0000001311015192.png)按钮进行刷新。效果如下图所示:
3. 打开Index.ets文件,点击预览器中的![zh-cn_image_0000001311015192](figures/zh-cn_image_0000001311015192.png)按钮进行刷新。效果如下图所示:
![zh-cn_image_0000001364254773](figures/zh-cn_image_0000001364254773.png)
![zh-cn_image_0000001364254729](figures/zh-cn_image_0000001364254729.png)
## 使用真机运行应用
1. 将搭载OpenHarmony标准系统的开发板与电脑连接。
2. 点击**File**&gt; **Project Structure...** &gt; **Project**&gt;**SigningConfigs**界面勾选“**Automatically generate signature**”,等待自动签名完成即可,点击“**OK**”。如下图所示:
2. 点击**File** &gt; **Project Structure...** &gt; **Project** &gt; **SigningConfigs**界面勾选“**Automatically generate signature**”,等待自动签名完成即可,点击“**OK**”。如下图所示:
![06](figures/06.png)
3. 在编辑窗口右上角的工具栏,点击![zh-cn_image_0000001364054485](figures/zh-cn_image_0000001364054485.png)按钮运行。效果如下图所示:
![zh-cn_image_0000001311334972](figures/zh-cn_image_0000001311334972.png)
![zh-cn_image_0000001364254729](figures/zh-cn_image_0000001364254729.png)
恭喜您已经使用ArkTS语言开发(Stage模型)完成了第一个OpenHarmony应用,快来[探索更多的OpenHarmony功能](../application-dev-guide.md)吧。
......@@ -2,6 +2,7 @@
> **说明:**
>
> 为确保运行效果,本文以使用**DevEco Studio V3.0.0.993**版本为例,点击[此处](https://developer.harmonyos.com/cn/develop/deveco-studio#download)获取下载链接。
......@@ -27,6 +28,8 @@
## JS工程目录结构
![zh-cn_image_0000001435376433](figures/zh-cn_image_0000001435376433.png)
- **entry**:OpenHarmony工程模块,编译构建生成一个[HAP](../../glossary.md#hap)包。
- **src &gt; main &gt; js**:用于存放js源码。
- **src &gt; main &gt; js &gt; MainAbility**:应用/服务的入口。
......@@ -37,11 +40,11 @@
- **src &gt; main &gt; resources**:用于存放应用/服务所用到的资源文件,如图形、多媒体、字符串、布局文件等。关于资源文件,详见[资源限定与访问](../ui/js-framework-resource-restriction.md)
- **src &gt; main &gt; config.json**:模块配置文件。主要包含HAP包的配置信息、应用/服务在具体设备上的配置信息以及应用/服务的全局配置信息。具体的配置文件说明,详见[应用包结构配置文件的说明(FA模型)](package-structure.md)
- **build-profile.json5**:当前的模块信息 、编译信息配置项,包括buildOption、targets配置等。
- **hvigorfile.js**:模块级编译构建任务脚本,开发者可以自定义相关任务和代码实现。
- **hvigorfile.ts**:模块级编译构建任务脚本,开发者可以自定义相关任务和代码实现。
- **build-profile.json5**:应用级配置信息,包括签名、产品配置等。
- **hvigorfile.js**:应用级编译构建任务脚本。
- **hvigorfile.ts**:应用级编译构建任务脚本。
## 构建第一个页面
......@@ -211,7 +214,7 @@
}
```
3. 打开index文件夹下的任意一个文件,点击预览器中的![zh-cn_image_0000001364174013](figures/zh-cn_image_0000001364174013.png)按钮进行刷新。效果如下图所示:
3. 打开index文件夹下的任意一个文件,点击预览器中的![zh-cn_image_0000001311015192](figures/zh-cn_image_0000001311015192.png)按钮进行刷新。效果如下图所示:
![zh-cn_image_0000001311175132](figures/zh-cn_image_0000001311175132.png)
......@@ -220,17 +223,18 @@
1. 将搭载OpenHarmony标准系统的开发板与电脑连接。
2. 点击**File**&gt; **Project Structure...** &gt; **Project**&gt;**Signing Configs**界面勾选“**Automatically generate signature**”,等待自动签名完成即可,点击“**OK**”。如下图所示:
2. 点击**File** &gt; **Project Structure...** &gt; **Project** &gt; **Signing Configs**界面勾选“**Automatically generate signature**”,等待自动签名完成即可,点击“**OK**”。如下图所示:
![06](figures/06.png)
3. 在编辑窗口右上角的工具栏,点击![zh-cn_image_0000001311494604](figures/zh-cn_image_0000001311494604.png)按钮运行。效果如下图所示:
3. 在编辑窗口右上角的工具栏,点击![zh-cn_image_0000001364054485](figures/zh-cn_image_0000001364054485.png)按钮运行。效果如下图所示:
![zh-cn_image_0000001363934589](figures/zh-cn_image_0000001363934589.png)
![zh-cn_image_0000001311175132](figures/zh-cn_image_0000001311175132.png)
恭喜您已经使用JS语言开发(FA模型)完成了第一个OpenHarmony应用,快来[探索更多的OpenHarmony功能](../application-dev-guide.md)吧。
## 相关实例
针对使用JS语言开发(FA模型),有以下相关实例可供参考:
- [`JsHelloWorld`:你好世界(JS)(API8)](https://gitee.com/openharmony/applications_app_samples/tree/master/common/JsHelloWorld)
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册