提交 058aacb7 编写于 作者: Y yang-lin-16

更新IDE使用指南

Signed-off-by: Nyang-lin-16 <yanglin5@huawei.com>
上级 ae445a3d
......@@ -2,7 +2,7 @@
- [生成密钥和证书请求文件](#生成密钥和证书请求文件)
- [生成应用证书文件](#生成应用证书文件)
- [生成应用Profile文件](#生成应用profile文件)
- [生成应用Profile文件](#生成应用Profile文件)
- [配置应用签名信息](#配置应用签名信息)
使用真机设备运行和调试OpenHarmony应用前,需要对应用进行签名才能正常运行。该指导用于OpenHarmony应用的签名配置。除此章节以外,DevEco Studio的其余操作指导无差别,具体请访问[HUAWEI DevEco Studio使用指南](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/tools_overview-0000001053582387)。配置应用签名信息的流程如下图所示。
......@@ -13,99 +13,14 @@
## 生成密钥和证书请求文件
OpenHarmony应用通过数字证书(.cer文件)和Profile文件(.p7b文件)来保证应用的完整性,需要通过DevEco Studio来生成密钥文件(.p12文件)和证书请求文件(.csr文件)。同时,也可以使用命令行工具的方式来生成密钥文件和证书请求文件。
### 使用DevEco Studio生成密钥和证书请求文件
1. 在主菜单栏点击**Build > Generate Key** **and CSR**
> ![](public_sys-resources/icon-note.gif)**说明**
>
> 如果本地已有对应的密钥,无需新生成密钥,可以在**Generate Key**界面中点击下方的Skip跳过密钥生成过程,直接使用已有密钥生成证书请求文件。
2.**Key Store File**中,可以点击**Choose Existing**选择已有的密钥库文件(存储有密钥的.p12文件);如果没有密钥库文件,点击**New**进行创建。下面以新创建密钥库文件为例进行说明。
![img](figures/zh-cn_image_0000002021121901.png)
3.**Create Key Store**窗口中,填写密钥库信息后,点击**OK**
- **Key Store File**:选择密钥库文件存储路径。
- **Password**:设置密钥库密码,必须由大写字母、小写字母、数字和特殊符号中的两种以上字符的组合,长度至少为8位。请记住该密码,后续签名配置需要使用。
- **Confirm Password**:再次输入密钥库密码。
![img](figures/zh-cn_image_0000002021121902.png)
4.**Generate Key**界面中,继续填写密钥信息后,点击**Next**
- **Alias**:密钥的别名信息,用于标识密钥名称。请记住该别名,后续签名配置需要使用。
- **Password**:密钥对应的密码,与密钥库密码保持一致,无需手动输入。
- **Validity**:证书有效期,建议设置为25年及以上,覆盖应用的完整生命周期。
- **Certificate**:输入证书基本信息,如组织、城市或地区、国家码等。
![img](figures/zh-cn_image_0000002021121903.png)
5.**Generate CSR**界面,选择密钥和设置CSR文件存储路径。
![img](figures/zh-cn_image_0000002021121904.png)
6. 点击**OK**按钮,创建CSR文件成功,可以在存储路径下获取生成的密钥库文件(.p12)和证书请求文件(.csr)。
![img](figures/zh-cn_image_0000002021121905.png)
### 使用命令行工具生成证书请求文件
使用Open JDK携带的Keytool工具生成证书请求文件。
1. 使用管理员身份运行命令行工具。
![img](figures/zh-cn_image_0000002021121906.png)
2. 切换到keytool工具所在路径,实际路径请根据DevEco Studio安装目录进行修改。
![img](figures/zh-cn_image_0000002021121907.png)
<a name="label001"/>
3. 执行如下命令,生成公私钥文件。例如,生成的密钥库名称为ide_demo_app.p12,以存储到D盘根目录下为例
```
keytool -genkeypair -alias "ide_demo_app" -keyalg EC -sigalg SHA256withECDSA -dname "C=CN,O=HUAWEI,OU=HUAWEI IDE,CN=ide_demo_app" -keystore d:\\idedemokey.p12 -storetype pkcs12 -validity 9125 -storepass 123456Abc -keypass 123456Abc
```
生成公私钥文件的参数说明如下:
> ![](public_sys-resources/icon-note.gif)说明
>
> 请记录下**alias、storepass和keypass**的值,在后续[配置签名信息](#配置应用签名信息)操作会使用到。
- **alias**:密钥的别名信息,用于标识密钥名称。
- **sigalg**:签名算法,固定为**SHA256withECDSA**
- **dname**:按照操作界面提示进行输入。
- C:国家/地区代码,如CN。
- O:组织名称,如HUAWEI。
- OU:组织单位名称,如HUAWEI IDE。
- CN:名字与姓氏,建议与别名一致。
- **validity**:证书有效期,建议设置为9125(25年)。
- **storepass**:设置密钥库密码,必须由大写字母、小写字母、数字和特殊符号中的两种以上字符的组合,长度至少为8位。请记住该密码,后续签名配置需要使用。
- **keypass**:设置密钥的密码,请与**storepass**保持一致。
4. 执行如下命令,执行后需要输入**storepass**密码,生成证书请求文件,后缀格式为.csr。
```
keytool -certreq -alias "ide_demo_app" -keystore d:\\idedemokey.p12 -storetype pkcs12 -file d:\\idedemokey.csr
```
生成证书请求文件的参数说明如下:
- **alias**:与[3](#label001)中输入的alias保持一致。
- **file**:生成的证书请求文件名称,后缀为.csr。
OpenHarmony应用通过数字证书(.cer文件)和Profile文件(.p7b文件)来保证应用的完整性,需要通过DevEco Studio来生成密钥文件(.p12文件)和证书请求文件(.csr文件)。同时,也可以使用命令行工具的方式来生成密钥文件和证书请求文件。具体操作请参考[生成密钥和证书请求文件](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/publish_app-0000001053223745#section9752152162813)
## 生成应用证书文件
使用[生成密钥和证书请求文件](#生成密钥和证书请求文件)中生成的证书请求文件,来生成应用签名所需的数字证书文件。生成方法如下:
进入DevEco Studio安装目录的 **Sdk\toolchains\lib**文件夹下(该SDK目录只能是OpenHarmony SDK,配置方法可参考[配置OpenHarmony SDK](../quick-start/configuring-openharmony-sdk.md)),打开命令行工具,执行如下命令(如果keytool命令不能执行,请在系统环境变量中添加JDK的环境变量)。其中,只需要修改输入和输出即可快速生成证书文件,即修改 **-infile**指定证书请求文件csr文件路径, **-outfile**指定输出证书文件名及路径。
进入DevEco Studio安装目录的**Sdk\toolchains\lib**文件夹下(该SDK目录只能是OpenHarmony SDK,配置方法可参考[配置OpenHarmony SDK](../quick-start/configuring-openharmony-sdk.md)),打开命令行工具,执行如下命令(如果keytool命令不能执行,请在系统环境变量中添加JDK的环境变量)。其中,只需要修改输入和输出即可快速生成证书文件,即修改**-infile**指定证书请求文件csr文件路径,**-outfile**指定输出证书文件名及路径。
```
keytool -gencert -alias "OpenHarmony Application CA" -infile myApplication_ohos.csr -outfile myApplication_ohos.cer -keystore OpenHarmony.p12 -sigalg SHA384withECDSA -storepass 123456 -ext KeyUsage:"critical=digitalSignature" -validity 3650 -rfc
......@@ -119,7 +34,7 @@ keytool -gencert -alias "OpenHarmony Application CA" -infile myApplication_ohos.
- **outfile**:输出证书链文件名及路径。
- **keystore**:签发证书的CA密钥库路径,OpenHarmony密钥库文件名为OpenHarmony.p12,文件在OpenHarmony SDK中 **Sdk\toolchains\lib**路径下,该参数不能修改。请注意,该OpenHarmony.p12文件并不是[生成密钥和证书请求文件](#生成密钥和证书请求文件)中生成的.p12文件。
- **keystore**:签发证书的CA密钥库路径,OpenHarmony密钥库文件名为OpenHarmony.p12,文件在OpenHarmony SDK中**Sdk\toolchains\lib**路径下,该参数不能修改。请注意,该OpenHarmony.p12文件并不是[生成密钥和证书请求文件](#生成密钥和证书请求文件)中生成的.p12文件。
- **sigalg**:证书签名算法,该参数不能修改。
......@@ -136,7 +51,7 @@ keytool -gencert -alias "OpenHarmony Application CA" -infile myApplication_ohos.
Profile文件包含OpenHarmony应用的包名、数字证书信息、描述应用允许申请的证书权限列表,以及允许应用调试的设备列表(如果应用类型为Release类型,则设备列表为空)等内容,每个应用包中均必须包含一个Profile文件。
进入 **Sdk\toolchains\lib**目录下,打开命令行工具,执行如下命令。
进入**Sdk\toolchains\lib**目录下,打开命令行工具,执行如下命令。
```
java -jar provisionsigtool.jar sign --in UnsgnedReleasedProfileTemplate.json --out myApplication_ohos_Provision.p7b --keystore OpenHarmony.p12 --storepass 123456 --alias "OpenHarmony Application Profile Release" --sigAlg SHA256withECDSA --cert OpenHarmonyProfileRelease.pem --validity 365 --developer-id ohosdeveloper --bundle-name 包名 --permission 受限权限名(可选) --permission 受限权限名(可选) --distribution-certificate myApplication_ohos.cer
......@@ -144,13 +59,13 @@ java -jar provisionsigtool.jar sign --in UnsgnedReleasedProfileTemplate.json --o
关于该命令的参数说明如下:
- **provisionsigtool**:Profile文件生成工具,文件在OpenHarmony SDK的 **Sdk\toolchains\lib**路径下。
- **provisionsigtool**:Profile文件生成工具,文件在OpenHarmony SDK的**Sdk\toolchains\lib**路径下。
- **in**:Profile模板文件所在路径,文件在OpenHarmony SDK中 **Sdk\toolchains\lib**路径下,该参数不能修改。
- **in**:Profile模板文件所在路径,文件在OpenHarmony SDK中**Sdk\toolchains\lib**路径下,该参数不能修改。
- **out**:输出的Profile文件名和路径。
- **keystore**:签发证书的密钥库路径,OpenHarmony密钥库文件名为OpenHarmony.p12,文件在OpenHarmony SDK中 **Sdk\toolchains\lib**路径下,该参数不能修改。
- **keystore**:签发证书的密钥库路径,OpenHarmony密钥库文件名为OpenHarmony.p12,文件在OpenHarmony SDK中**Sdk\toolchains\lib**路径下,该参数不能修改。
- **storepass**:密钥库密码,密码为123456,该参数不能修改。
......@@ -158,7 +73,7 @@ java -jar provisionsigtool.jar sign --in UnsgnedReleasedProfileTemplate.json --o
- **sigalg**:证书签名算法,该参数不能修改。
- **cert**:签名Profile的证书文件路径,文件在OpenHarmony SDK中 **Sdk\toolchains\lib**路径下,该参数不能修改。
- **cert**:签名Profile的证书文件路径,文件在OpenHarmony SDK中**Sdk\toolchains\lib**路径下,该参数不能修改。
- **validity**:证书有效期,自定义天数。
......@@ -175,15 +90,14 @@ java -jar provisionsigtool.jar sign --in UnsgnedReleasedProfileTemplate.json --o
在真机设备上调试前,需要使用到制作的私钥(.p12)文件、证书(.cer)文件和Profile(.p7b)文件对调试的模块进行签名。
打开 **File &gt; Project Structure**,点击 **Project &gt; Signing Configs &gt; debug**窗口中,去除勾选“Automatically generate signing”,然后配置指定模块的调试签名信息。
打开**File &gt; Project Structure**,点击**Project &gt; Signing Configs &gt; debug**窗口中,去除勾选“Automatically generate signing”,然后配置指定模块的调试签名信息。
- **Store File**:选择密钥库文件,文件后缀为.p12,该文件为[生成密钥和证书请求文件](#生成密钥和证书请求文件)中生成的.p12文件。
- **Store Password**:输入密钥库密码,该密码为[生成密钥和证书请求文件](#生成密钥和证书请求文件)中填写的密钥库密码保持一致。
- **Key Alias**:输入密钥的别名信息,与[生成密钥和证书请求文件](#生成密钥和证书请求文件)中填写的别名保持一致。
- **Key Password**:输入密钥的密码,与 **Store Password**保持一致。
- **Key Password**:输入密钥的密码,与**Store Password**保持一致。
- **Sign Alg**:签名算法,固定为SHA256withECDSA。
......@@ -193,7 +107,7 @@ java -jar provisionsigtool.jar sign --in UnsgnedReleasedProfileTemplate.json --o
![zh-cn_image_0000001155643492](figures/zh-cn_image_0000001155643492.png)
设置完签名信息后,点击 **OK**进行保存,然后可以在工程下的build.gradle中查看签名的配置信息。
设置完签名信息后,点击**OK**进行保存,然后可以在工程下的build.gradle中查看签名的配置信息。
![zh-cn_image_0000001202722349](figures/zh-cn_image_0000001202722349.png)
......
# 配置OpenHarmony SDK
- [前提条件](#前提条件)
- [配置SDK信息](#配置sdk信息)
- [配置SDK信息](#配置SDK信息)
- [参考信息](#参考信息)
- [配置DevEco Studio代理](#配置deveco-studio代理)
- [配置NPM代理](#配置npm代理)
- [设置Gradle代理](#设置gradle代理)
- [配置DevEco Studio代理](#配置DevEco-Studio代理)
- [配置NPM代理](#配置NPM代理)
- [设置Gradle代理](#设置Gradle代理)
在设置OpenHarmony应用开发环境时,需要开发者在DevEco Studio中配置对应的SDK信息。
>![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**<br/>
>请注意,OpenHarmony SDK版本精简了部分工具链,因此不适用于HarmonyOS应用开发。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 请注意,OpenHarmony SDK版本精简了部分工具链,因此不适用于HarmonyOS应用开发。
## 前提条件
......@@ -26,34 +26,29 @@ DevEco Studio通过SDK Manager统一管理SDK及工具链,OpenHarmony包含如
| 类别 | 包名 | 说明 |
| -------- | -------- | -------- |
| SDK | JS | JS语言SDK包。 |
| eTS | eTS(Extended&nbsp;TypeScript)&nbsp;SDK包。 |
| SDK&nbsp;Tool | Toolchains | SDK工具链,OpenHarmony应用开发必备工具集,包括编译、打包、签名、数据库管理等工具的集合。 |
| | Previewer | OpenHarmony应用预览器,可以在应用开发过程中查看界面UI布局效果。 |
| Previewer | OpenHarmony应用预览器,可以在应用开发过程中查看界面UI布局效果。 |
1. 运行已安装的DevEco Studio,首次使用,请选择 **Do not import settings**,点击OK。
2. 进入配置向导页面,设置 **npm registry**,DevEco Studio已预置对应的仓,直接点击 **Start using DevEco Studio**进入下一步。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**<br/>
> 如果配置向导界面出现的是设置 **Set up HTTP Proxy**界面,说明网络受限,请根据[参考信息](#参考信息)配置DevEco Studio代理、NPM代理和Gradle代理后,再下载OpenHarmony SDK。
1. 运行已安装的DevEco Studio,首次使用,请选择**Do not import settings**,点击OK。
2. 进入配置向导页面,设置**npm registry**,DevEco Studio已预置对应的仓,直接点击**Start using DevEco Studio**进入下一步。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 如果配置向导界面出现的是设置**Set up HTTP Proxy**界面,说明网络受限,请根据[参考信息](#参考信息)配置DevEco Studio代理、NPM代理和Gradle代理后,再下载OpenHarmony SDK。
![zh-cn_image_0000001163314102](figures/zh-cn_image_0000001163314102.png)
3. DevEco Studio向导指引开发者下载SDK,默认下载OpenHarmony SDK。SDK下载到user目录下,也可以指定对应的存储路径,SDK存储路径不支持中文字符,然后点击 **Next**
3. DevEco Studio向导指引开发者下载SDK,默认下载OpenHarmony SDK。SDK下载到user目录下,也可以指定对应的存储路径,SDK存储路径不支持中文字符,然后点击**Next**
![zh-cn_image_0000001208394019](figures/zh-cn_image_0000001208394019.png)
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**<br/>
> 如果不是首次安装DevEco Studio,可能无法查看进入该界面,可通过欢迎页的 **Configure (** **或**![zh-cn_image_0000001208274069](figures/zh-cn_image_0000001208274069.png) **图标** **)&gt; Settings &gt; SDK Manager &gt; OpenHarmony SDK**界面,点击 **OpenHarmony SDK Location**加载SDK。
4. 在弹出的SDK下载信息页面,点击 **Next**,并在弹出的 **License Agreement**窗口,点击 **Accept**开始下载SDK。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**<br/>
> 下载SDK过程中,如果出现下载JS SDK失败,提示“Install js dependencies failed”,请根据[JS SDK安装失败处理指导](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/faq-development-environment-0000001168829643#section1311117111474)进行处理。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 如果不是首次安装DevEco Studio,可能无法查看进入该界面,可通过欢迎页的**Configure (或**![zh-cn_image_0000001208274069](figures/zh-cn_image_0000001208274069.png)**图标)&gt; Settings &gt; SDK Manager &gt; OpenHarmony SDK**界面,点击**OpenHarmony SDK Location**加载SDK。
4. 在弹出的SDK下载信息页面,点击**Next**,并在弹出的**License Agreement**窗口,点击**Accept**开始下载SDK。
![zh-cn_image_0000001163472654](figures/zh-cn_image_0000001163472654.png)
5. 等待OpenHarmony SDK及工具下载完成,点击 **Finish**,界面会进入到DevEco Studio欢迎页。
5. 等待OpenHarmony SDK及工具下载完成,点击**Finish**,界面会进入到DevEco Studio欢迎页。
![zh-cn_image_0000001163632602](figures/zh-cn_image_0000001163632602.png)
......@@ -63,22 +58,22 @@ DevEco Studio开发环境需要依赖于网络环境,需要连接上网络才
一般来说,如果使用的是个人或家庭网络,是不需要设置代理信息的;只有部分企业网络受限的情况下,才需要设置代理信息。
如果是第一次打开DevEco Studio,配置向导界面出现设置 **Set up HTTP Proxy**界面,说明网络受限,可以通过配置代理的方式来解决,需要配置DevEco Studio代理、NPM代理和Gradle代理。
如果是第一次打开DevEco Studio,配置向导界面出现设置**Set up HTTP Proxy**界面,说明网络受限,可以通过配置代理的方式来解决,需要配置DevEco Studio代理、NPM代理和Gradle代理。
![zh-cn_image_0000001166582138](figures/zh-cn_image_0000001166582138.png)
### 配置DevEco Studio代理
1. 启动DevEco Studio,配置向导进入 **Set up HTTP Proxy**界面,勾选 **Manual proxy configuration**,设置DevEco Studio的HTTP Proxy。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**<br/>
1. 启动DevEco Studio,配置向导进入**Set up HTTP Proxy**界面,勾选**Manual proxy configuration**,设置DevEco Studio的HTTP Proxy。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 如果非首次设置向导进入HTTP Proxy,可以通过如下方式进入HTTP Proxy配置界面:
>
> - 在欢迎页点击 **Configure(或**![zh-cn_image_0000001212142015](figures/zh-cn_image_0000001212142015.png) **图标) &gt; Settings &gt; Appearance &amp; Behavior &gt; System Settings &gt; HTTP Proxy**进入HTTP Proxy设置界面(Mac系统为 **Configure &gt; Preferences &gt; Appearance &amp; Behavior &gt; System Settings &gt; HTTP Proxy**)
> - 在欢迎页点击**Configure(或**![zh-cn_image_0000001212142015](figures/zh-cn_image_0000001212142015.png)**图标) &gt; Settings &gt; Appearance &amp; Behavior &gt; System Settings &gt; HTTP Proxy**进入HTTP Proxy设置界面(Mac系统为**Configure &gt; Preferences &gt; Appearance &amp; Behavior &gt; System Settings &gt; HTTP Proxy**)
>
> - 在打开了工程的情况下,可以点击 **File &gt; Settings &gt; Appearance &amp; Behavior &gt; System Settings &gt; HTTP Proxy**进入HTTP Proxy设置界面(Mac系统为 **DevEco Studio &gt; Preferences &gt; Appearance &amp; Behavior &gt; System Settings &gt; HTTP Proxy**)
> - 在打开了工程的情况下,可以点击**File &gt; Settings &gt; Appearance &amp; Behavior &gt; System Settings &gt; HTTP Proxy**进入HTTP Proxy设置界面(Mac系统为**DevEco Studio &gt; Preferences &gt; Appearance &amp; Behavior &gt; System Settings &gt; HTTP Proxy**)
- **HTTP**配置项,设置代理服务器信息。 **如果不清楚代理服务器信息,可以咨询你们的网络管理人员**
- **HTTP**配置项,设置代理服务器信息。**如果不清楚代理服务器信息,可以咨询你们的网络管理人员**
- **Host name**:代理服务器主机名或IP地址。
- **Port number**:代理服务器对应的端口号。
- **No proxy for**:不需要通过代理服务器访问的URL或者IP地址(地址之间用英文逗号分隔)。
......@@ -86,18 +81,19 @@ DevEco Studio开发环境需要依赖于网络环境,需要连接上网络才
- **Login**:访问代理服务器的用户名。
- **Password**:访问代理服务器的密码。
- **Remember**:勾选,记住密码。
![zh-cn_image_0000001212062065](figures/zh-cn_image_0000001212062065.png)
2. 配置完成后,点击 **Check connection**,输入网络地址(如:https://developer.harmonyos.com),检查网络连通性。提示Connection successful表示代理设置成功。
2. 配置完成后,点击**Check connection**,输入网络地址(如:https://developer.harmonyos.com),检查网络连通性。提示Connection successful表示代理设置成功。
3. 点击 **Next: Configure npm**继续设置NPM代理信息,请参考[配置NPM代理](#配置npm代理)
3. 点击**Next: Configure npm**继续设置NPM代理信息,请参考[配置NPM代理](#配置npm代理)
### 配置NPM代理
通过DevEco Studio的设置向导设置NPM代理信息,代理信息将写入用户“users/用户名/”目录下的 **.npmrc**文件。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**<br/>
> 该向导只有第一次安装DevEco Studio才会出现。如果未出现该向导,可以直接在“users/用户名/”目录下的 **.npmrc**文件中,添加代理配置信息。
通过DevEco Studio的设置向导设置NPM代理信息,代理信息将写入用户“users/用户名/”目录下的**.npmrc**文件。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 该向导只有第一次安装DevEco Studio才会出现。如果未出现该向导,可以直接在“users/用户名/”目录下的**.npmrc**文件中,添加代理配置信息。
- npm registry:设置npm仓的地址信息,建议勾选。
......@@ -107,13 +103,13 @@ DevEco Studio开发环境需要依赖于网络环境,需要连接上网络才
![zh-cn_image_0000001164577336](figures/zh-cn_image_0000001164577336.png)
然后点击 **Start using DevEco Studio**继续下一步操作。
然后点击**Start using DevEco Studio**继续下一步操作。
如果代理服务器需要认证(需要用户名和密码),请先根据如下指导配置代理服务器的用户名和密码信息,然后再下载OpenHarmony SDK;否则,请跳过该操作,参考[配置SDK信息](#配置sdk信息)进行操作即可。
![zh-cn_image_0000001209817299](figures/zh-cn_image_0000001209817299.png)
1. 进入用户的users目录,打开 **.npmrc**文件。
1. 进入用户的users目录,打开**.npmrc**文件。
2. 修改npm代理信息,在proxy和https-proxy中,增加user和password字段,具体取值请以实际代理信息为准。示例如下所示:
```
......@@ -121,7 +117,7 @@ DevEco Studio开发环境需要依赖于网络环境,需要连接上网络才
https-proxy=http://user:password@proxy.server.com:80
```
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**<br/>
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 如果password中存在特殊字符,如\@、\#、\*等符号,可能导致配置不生效,建议将特殊字符替换为ASCII码,并在ASCII码前加百分号%。常用符号替换为ASCII码对照表如下:
>
> - !:%21
......@@ -150,16 +146,16 @@ DevEco Studio开发环境需要依赖于网络环境,需要连接上网络才
### 设置Gradle代理
1. 打开“此电脑”,在文件夹地址栏中输入 **%userprofile%**(Mac系统请点击 **前往 &gt; 个人**),进入个人用户文件夹。
1. 打开“此电脑”,在文件夹地址栏中输入**%userprofile%**(Mac系统请点击**前往 &gt; 个人**),进入个人用户文件夹。
![zh-cn_image_0000001166740700](figures/zh-cn_image_0000001166740700.png)
2. 创建一个文件夹,命名为 **.gradle**。如果已有.gradle文件夹,请跳过此操作。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**<br/>
2. 创建一个文件夹,命名为**.gradle**。如果已有.gradle文件夹,请跳过此操作。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> macOS系统创建.gradle文件夹前,请将系统设置为“显示隐藏文件”。
3. 进入.gradle文件夹,新建一个文本文档,命名为 **gradle**,并修改后缀为 **.properties**
3. 进入.gradle文件夹,新建一个文本文档,命名为**gradle**,并修改后缀为**.properties**
4. 打开 **gradle.properties**文件中,添加如下脚本,然后保存。
4. 打开**gradle.properties**文件中,添加如下脚本,然后保存。
其中代理服务器、端口、用户名、密码和不使用代理的域名,请根据实际代理情况进行修改。其中不使用代理的nonProxyHosts的配置间隔符是 “|”。
```
systemProp.http.proxyHost=proxy.server.com
......
# 创建OpenHarmony工程
- **[使用工程向导创建新工程](use-wizard-to-create-project.md)**
- **[通过导入Sample方式创建新工程](import-sample-to-create-project.md)**
\ No newline at end of file
......@@ -2,28 +2,28 @@
- [总体说明](#总体说明)
- [使用约束](#使用约束)
- [DevEco Studio演进路标](#deveco-studio演进路标)
- [DevEco Studio演进路标](#DevEco-Studio演进路标)
## 总体说明
DevEco Studio 是 HarmonyOS 的配套的开发 IDE ,因为HarmonyOS 是基于OpenHarmony 开发的,因此,使用 DevEco Studio (配套 HarmonyOS )也可以进行 OpenHarmony 的应用开发。
DevEco Studio是HarmonyOS的配套的开发IDE,因为HarmonyOS是基于OpenHarmony开发的,因此,使用DevEco Studio(配套HarmonyOS)也可以进行OpenHarmony的应用开发。
使用DevEco Studio开发OpenHarmony应用的流程与开发HarmonyOS的流程完全一样,本文档仅描述OpenHarmony应用开发与HarmonyOS应用开发的差异点。
- **搭建开发环境差异**:OpenHarmony应用开发环境需要先安装OpenHarmony SDK,具体可参考[配置OpenHarmony SDK](../quick-start/configuring-openharmony-sdk.md)章节。
- **导入OpenHarmony工程**:OpenHarmony应用开发,只能通过导入Sample工程的方式来创建一个新工程,具体可参考[通过导入Sample方式创建新工程](../quick-start/import-sample-to-create-project.md)
- **创建OpenHarmony工程**:OpenHarmony应用开发,可以通过工程向导创建一个新工程,或通过导入Sample工程的方式来创建一个新工程,具体可参考[使用工程向导创建新工程](../quick-start/use-wizard-to-create-project.md)
- **调试签名配置**:OpenHarmony应用运行在真机设备上,需要对应用进行签名,关于OpenHarmony应用的签名指导请参考[配置OpenHarmony应用签名信息](../quick-start/configuring-openharmony-app-signature.md)
- **在真机设备上运行应用**需要使用hdc工具将OpenHarmony的hap包推送到真机设备上进行安装,具体可参考[安装运行OpenHarmony应用](../quick-start/installing-openharmony-app.md)
- **在真机设备上运行应用**:将OpenHarmony的hap包推送到真机设备上进行安装,具体可参考[安装运行OpenHarmony应用](../quick-start/installing-openharmony-app.md)
关于DevEco Studio的详细操作指导,请访问[HUAWEI DevEco Studio使用指南](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/tools_overview-0000001053582387)
## 使用约束
- OpenHarmony只支持使用JS语言开发应用,不支持Java、C/C++语言。
- OpenHarmony只支持使用eTS、JS语言开发应用,不支持Java、C/C++语言。
- OpenHarmony开发环境DevEco Studio暂只支持Windows系统。
......@@ -31,12 +31,11 @@ OpenHarmony与HarmonyOS的开发工具都是DevEco Studio,下表为OpenHarmony
| 特性名称 | HarmonyOS版本 | OpenHarmony版本 |
| -------- | -------- | -------- |
| 创建Module | **√** | **X** |
| 服务卡片 | **√** | **X** |
| 自动化签名 | **√** | **X** |
| 远程模拟器 | **√** | **X** |
| 本地模拟器 | **√** | **X** |
| 使用DevEco&nbsp;Studio运行调试、日志查看、调优 | **√** | **X** |
| 使用DevEco&nbsp;Studio进行日志查看、调优 | **√** | **X** |
| 云测试 | **√** | **X** |
| 安全测试 | **√** | **X** |
......
# 版本变更说明
- [V3.0 Beta1(2021-09-29)](#v3-0-beta1-2021-09-29-)
- [V3.0 Beta2(2021-12-31)](#V30-Beta22021-12-31)
- [版本兼容性](#版本兼容性)
- [版本变更说明](#版本变更说明)
- [V3.0 Beta1(2021-09-29)](#V30-Beta12021-09-29)
## V3.0 Beta2(2021-12-31)
### 版本兼容性
DevEco Studio 3.0 Beta2版本兼容性配套关系如下表所示。
| 组件 | 版本要求 | 说明 |
| -------- | -------- | -------- |
| Gradle | 7.3(最低版本要求7.2) | DevEco&nbsp;Studio已自带了Gradle7.3版本,开发者无需单独安装。 |
| JDK | 11.0.x | DevEco&nbsp;Studio已自带了JDK&nbsp;11版本,开发者无需单独安装。 |
| OpenHarmony&nbsp;SDK | 3.1.0.0(API&nbsp;Version&nbsp;8&nbsp;Beta) | 兼容历史版本SDK。 |
| Toolchinas | 3.1.0.0 | 建议更新至最新版本。 |
| hap插件 | 3.0.5.2 |
| decctest插件 | 1.2.7.2 |
### 版本变更说明
| |
| -------- |
| **新增特性:**<br/>-&nbsp;新增DevEco&nbsp;Studio支持界面功能菜单的汉化版本,默认显示为英文,如需开启汉化版本,请打开DevEco&nbsp;Studio的**Settings**界面,在**Plugins&nbsp;&gt;&nbsp;installed**中手动勾选“Chinese(Simplified)”插件,然后重新启动DevEco&nbsp;Studio即可生效。<br/>-&nbsp;新增支持OpenHarmony应用或服务的调试和运行,支持断点管理、变量查看、Step&nbsp;Into\Step&nbsp;Over\Step&nbsp;Out等单步调试功能。<br/>**增强特性:**<br/>-&nbsp;OpenHarmony&nbsp;SDK更新至3.1.0.0版本(API&nbsp;Version&nbsp;8&nbsp;Beta),配套的hap编译构建插件版本更新至3.0.5.2。<br/>-&nbsp;工程模板新增支持低代码开发的[Standard]Empty&nbsp;Ability模板。<br/>-&nbsp;支持eTS组件预览,要求compileSdkVersion为8或以上。<br/>-&nbsp;eTS实时预览支持边修改属性边展示预览效果,无需保存修改才生效,要求compileSdkVersion为8或以上。 |
## V3.0 Beta1(2021-09-29)
| |
| -------- |
| &nbsp;**新增特性:**<br/>-&nbsp;新增支持OpenHarmony&nbsp;SDK的管理,开发者可通过DevEco&nbsp;Studio的SDK&nbsp;Manager功能来下载和管理OpenHarmony&nbsp;SDK。<br/>-&nbsp;在编译构建HAP包时,新增支持对单个Module进行编译,对于多Module工程中只需要编译其中一个Module的场景,可以提升编译构建速度;同时还新增支持一键重构建HAP包,即在编译构建HAP前,会自动执行Clean&nbsp;Project操作。<br/>&nbsp;**增强特性:**<br/>-&nbsp;编译构建插件更新至3.0.3.2版本。<br/>-&nbsp;Json编辑器增强,资源索引错误支持快速修复,并支持快速查看资源的取值。<br/>-&nbsp;工程视图支持Ohos视图,默认视图为Project视图,开发者可手动切换。<br/>-&nbsp;OpenHarmony工程支持ark方舟编译。<br/>-&nbsp;OpenHarmony工程类型标识字段supportSystem&nbsp;"standard",由模块级build.gradle调整至工程级build.gradle。 |
| **新增特性:**<br/>-&nbsp;新增支持OpenHarmony&nbsp;SDK的管理,开发者可通过DevEco&nbsp;Studio的SDK&nbsp;Manager功能来下载和管理OpenHarmony&nbsp;SDK。<br/>-&nbsp;在编译构建HAP包时,新增支持对单个Module进行编译,对于多Module工程中只需要编译其中一个Module的场景,可以提升编译构建速度;同时还新增支持一键重构建HAP包,即在编译构建HAP前,会自动执行Clean&nbsp;Project操作。<br/>**增强特性:**<br/>-&nbsp;编译构建插件更新至3.0.3.2版本。<br/>-&nbsp;Json编辑器增强,资源索引错误支持快速修复,并支持快速查看资源的取值。<br/>-&nbsp;工程视图支持Ohos视图,默认视图为Project视图,开发者可手动切换。<br/>-&nbsp;OpenHarmony工程支持ark方舟编译。<br/>-&nbsp;OpenHarmony工程类型标识字段supportSystem&nbsp;"standard",由模块级build.gradle调整至工程级build.gradle。 |
# DevEco Studio(OpenHarmony)使用指南
- **[概述](deveco-studio-overview.md)**
- **[版本变更说明](deveco-studio-release-notes.md)**
......
# 通过导入Sample方式创建新工程
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 该功能适用于通过DevEco Studio 2.1 Release及以上版本,创建OpenHarmony工程。
OpenHarmony SDK配置完成后,便可以启动应用开发。针对OpenHarmony应用开发, **可以通过导入Sample工程的方式来创建一个新工程**
OpenHarmony SDK配置完成后,便可以启动应用开发。针对OpenHarmony应用开发,**可以通过导入Sample工程的方式来创建一个新工程**
1. 在DevEco Studio的欢迎页,进入 **Configure (** **或**![zh-cn_image_0000001118018452](figures/zh-cn_image_0000001118018452.png) **图标** **) &gt; Settings &gt; Version Control &gt; Git**界面,点击Test按钮检测是否安装Git工具。
- 已安装,请根据**步骤2**开始导入Sample。
1. 在DevEco Studio的欢迎页,进入**Configure (或**![zh-cn_image_0000001118018452](figures/zh-cn_image_0000001118018452.png)**图标) &gt; Settings &gt; Version Control &gt; Git**界面,点击Test按钮检测是否安装Git工具。
- 已安装,请根据[ERROR:Invalid link:zh-cn_topic_0000001163914943.xml#xref1062745524418,link:#li5947194711181](#li5947194711181)开始导入Sample。
![zh-cn_image_0000001118018088](figures/zh-cn_image_0000001118018088.png)
- 未安装,请点击 **Download and Install**,DevEco Studio会自动下载并安装。安装完成后,请根据**步骤2**开始导入Sample。
- 未安装,请点击**Download and Install**,DevEco Studio会自动下载并安装。安装完成后,请根据[ERROR:Invalid link:zh-cn_topic_0000001163914943.xml#xref1191414223536,link:#li5947194711181](#li5947194711181)开始导入Sample。
![zh-cn_image_0000001164498191](figures/zh-cn_image_0000001164498191.png)
2. 在DevEco Studio的欢迎页,点击 **Import Sample**按钮,导入Sample工程。
2. 在DevEco Studio的欢迎页,点击**Import Sample**按钮,导入Sample工程。
![zh-cn_image_0000001208006117](figures/zh-cn_image_0000001208006117.png)
3. 选择OpenHarmony Samples &gt; common下的 **JsHelloWorld**工程,然后点击 **Next**
3. 选择OpenHarmony Samples &gt; common下的**JsHelloWorld**工程,然后点击**Next**
![zh-cn_image_0000001152459178](figures/zh-cn_image_0000001152459178.png)
4. 设置 **App Name****Project Location**,然后点击 **Finish**,等待Sample工程导入完成。
4. 设置**App Name****Project Location**,然后点击**Finish**,等待Sample工程导入完成。
![zh-cn_image_0000001207744539](figures/zh-cn_image_0000001207744539.png)
5. 等待工程同步完成,同步成功后,便可以进行OpenHarmony应用开发了。
......
# 安装运行OpenHarmony应用
安装OpenHarmony应用需要使用hdc工具,通过手动执行命令行完成应用的安装。
hdc工具本身需要手动从开源仓中获取。然后使用工具将编译后的hap包发送至设备侧,然后通过hdc命令完成app的安装。
安装OpenHarmony应用可以通过DevEco Studio安装,也可以通过使用hdc工具进行手动安装。
相关命令如下:
- 通过DevEco Studio安装:将设备连接上DevEco Studio后,点击![zh-cn_image_0000001239855207](figures/zh-cn_image_0000001239855207.png)按钮即可安装。
- 通过hdc工具安装:手动执行命令行完成应用的安装。
hdc工具本身需要手动从开源仓中获取。然后使用工具将编译后的hap包发送至设备侧,然后通过hdc命令完成app的安装。
- 文件发送命令
**file send *localpath remotepath***
相关命令如下:
- 文件发送命令
**file send _localpath remotepath_**
命令示例:
```
hdc_std file send E:\hwadmin.hap /data/local/tmp/hwadmin.hap
```
- 安装命令
**install [-r/-d/-g] *package***
- 安装命令
**install [-r/-d/-g] _package_**
命令示例:
```
hdc_std install hwadmin.hap
```
- 日志抓取命令
- 日志抓取命令
**hilog**
命令示例:
......@@ -36,6 +37,4 @@ hdc工具本身需要手动从开源仓中获取。然后使用工具将编译
hdc_std hilog
```
完整的hdc工具使用指导及命令格式请参见[hdc_std使用指导](../../device-dev/subsystems/subsys-toolchain-hdc-guide.md)
完整的hdc工具使用指导及命令格式请参见[hdc_std使用指导](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/subsystems/subsys-toolchain-hdc-guide.md)
......@@ -14,32 +14,33 @@
## 操作步骤
1. 通过如下两种方式,打开工程创建向导界面。
- 如果当前未打开任何工程,可以在DevEco Studio的欢迎页,选择 **Create Project**开始创建一个新工程。
- 如果已经打开了工程,可以在菜单栏选择 **File &gt; New &gt; New Project**来创建一个新工程。
- 如果当前未打开任何工程,可以在DevEco Studio的欢迎页,选择**Create Project**开始创建一个新工程。
- 如果已经打开了工程,可以在菜单栏选择**File &gt; New &gt; New Project**来创建一个新工程。
2. 根据工程创建向导,选择 **[Standard]Empty Ability**模板,点击 **Next**
2. 根据工程创建向导,选择**[Standard]Empty Ability**模板,点击**Next**
![zh-cn_image_0000001162463400](figures/zh-cn_image_0000001162463400.png)
3. 点击 **Next**,进入到工程配置阶段,需要根据向导配置工程的基本信息。
- **Project Name**:工程的名称,可以自定义。
- **Project Type**:工程的类型,标识该工程是一个[原子化服务](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/atomic-service-definition-0000001090840664)(Service)或传统方式的需要安装的应用(Application)。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**<br/>
3. 点击**Next**,进入到工程配置阶段,需要根据向导配置工程的基本信息。
- **Project name**:工程的名称,可以自定义。
- **Project type**:工程的类型,标识该工程是一个[原子化服务](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/atomic-service-definition-0000001090840664)(Service)或传统方式的需要安装的应用(Application)。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 如果是创建的原子化服务,则:
>
> - 原子化服务调试、运行时,在设备桌面上没有应用图标,请使用DevEco Studio的调试和运行功能,来启动原子化服务。
>
> - 原子化服务是免安装的,config.json中自动添加 **installationFree**字段,取值为“true”。
> - 原子化服务是免安装的,config.json中自动添加**installationFree**字段,取值为“true”。
>
> - 如果entry模块的 **installationFree**字段为true,则其相关的所有hap模块的 **installationFree**字段都默认为true;如果entry模块的 **installationFree**字段为false,则其相关的所有hap模块可以配置为true或false。
> - 如果entry模块的**installationFree**字段为true,则其相关的所有hap模块的**installationFree**字段都默认为true;如果entry模块的**installationFree**字段为false,则其相关的所有hap模块可以配置为true或false。
>
> - 编译构建App时,每个hap包大小不能超过10MB。
- **Package Name**:软件包名称,默认情况下,应用ID也会使用该名称,应用发布时,应用ID需要唯一
- **Bundle name**:软件包名称,默认情况下,应用ID也会使用该名称,应用发布时,应用ID需要唯一。如果“Project Type”选择了Atomic Service,则Bundle Name的后缀名必须是**.hmservice**
- **Save Location**:工程文件本地存储路径。
- **Development mode**:选择开发模式,部分模板支持低代码开发,可选择Super Visual。
- **Language:**支持的开发语言。
- **Compatible API Version**:兼容的SDK最低版本。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**<br/>
> OpenHarmony工程如果配置了compileSdkVersion 7以上,对应模块默认使用方舟编译器进行编译,如果要修改编译方式为非方舟编译,在模块级build.gradle的 **ohos**闭包中添加 **arkEnable false**字段。
- **Language**:支持的开发语言。
- **Device Type**:该工程模板支持的设备类型。<br/>
![zh-cn_image_0000001208210505](figures/zh-cn_image_0000001208210505.png)
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> OpenHarmony工程如果配置了compileSdkVersion 7以上,对应模块默认使用方舟编译器进行编译,如果要修改编译方式为非方舟编译,在模块级build.gradle的**ohos**闭包中添加**arkEnable false**字段。
- **Device Type**:该工程模板支持的设备类型。
![zh-cn_image_0000001196050928](figures/zh-cn_image_0000001196050928.png)
4. 点击 **Finish**,工具会自动生成示例代码和相关资源,等待工程创建完成。
4. 点击**Finish**,工具会自动生成示例代码和相关资源,等待工程创建完成。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册