跳至主要內容

安装DevEco Studio与工程介绍

blogresHarmonyOSHarmonyOS鸿蒙2024/1/13约 3411 字大约 11 分钟

DevEco Studio提供开箱即用的开发体验，将HarmonyOS SDK、Node.js、Hvigor、OHPM、模拟器平台等进行合一打包，简化DevEco Studio安装配置流程。提供了一站式的HarmonyOS生态应用开发能力。是面向全场景多设备提供的一站式开发平台，支持多端双向预览、分布式调优、分布式调试、超级终端模拟、低代码可视化开发等能力，帮助开发者降低成本、提升效率、提高质量。

HarmonyOS基础之安装DevEco Studio与工程介绍

技术架构

安装DevEco Studio

  1. 下载: DevEco Studio huawei.com

  2. 下载完成后，双击下载的“deveco-studio-xxxx.exe”，进入DevEco Studio安装向导。

    image-20260106051656174
    image-20260106051656174

  3. 在如下安装选项界面勾选DevEco Studio后，单击Next，直至安装完成。

    image-20260106051747723
    image-20260106051747723

  4. 安装完成后，单击Finish完成安装。

  5. 诊断开发环境

    在欢迎页面单击Diagnose进行诊断；也可以在菜单栏单击Help > Diagnostic Tools > Diagnose Development Environment进行诊断。

    image-20260109073442530
    image-20260109073442530

  6. 启用中文化插件

    从DevEco Studio 6.0.0 Beta1版本开始，中文化插件Chinese默认启用。

    若DevEco Studio 6.0.0 Beta1之前版本，请在菜单栏进入File > Settings （macOS为DevEco Studio > Preferences ）> Plugins，选择Installed页签，在搜索框输入“Chinese”，搜索结果里将出现Chinese(Simplified)，在右侧单击Enable，点击OK，在弹窗中单击Restart，重启DevEco Studio后即可生效。

安装Github和Gitee

构建HarmonyOS应用(ArkTS)

image-20260109074927536
image-20260109074927536

Application应用开发，Atomic Service对应为元服务开发。选择模板Empty Ability

ArkTS工程目录结构（Stage模型）

工程级目录

image-20260109080501878
image-20260109080501878

其中详细如下：

  • AppScope：中存放应用全局所需要的资源文件。
  • entry：HarmonyOS工程模块，编译构建生成一个HAP包。是应用的主模块，存放HarmonyOS应用的代码、资源等。
  • oh_modules：用于存放三方库依赖信息。
  • build-profile.json5：是工程级配置信息，包括签名、产品配置等。
  • hvigorfile.ts：工程级编译构建任务脚本。
  • oh-package.json5：主要用来描述全局配置，如：依赖覆盖（overrides）、依赖关系重写（overrideDependencyMap）和参数化配置（parameterFile）等。

在AppScope，其中有resources文件夹和配置文件app.json5。AppScope>resources>base 中包含element和media两个文件夹，

  • element：文件夹主要存放公共的字符串、布局文件等资源。
  • media：存放全局公共的多媒体资源文件。
AppScope
|---resources
|	|---base
|	|   |---element // 存放公共的字符串、布局文件等资源。
|	|   |   |---string.json
|	|   |---media // 存放全局公共的多媒体资源文件。
|	|   |   |---background.png
|	|   |   |---foreground.png
|	|   |   |---layered_image.json
|---app.json5 // 应用的全局配置信息

layered_image.json 内容如下

{
  "layered-image":
  {
    "background" : "$media:background",
    "foreground" : "$media:foreground"
  }
}

AppScope-app.json5

AppScope>app.json5

应用的全局配置信息，详见app.json5配置文件。

{
  "app": {
    "bundleName": "com.aniuger.lesson1",
    "vendor": "example",
    "versionCode": 1000000,
    "versionName": "1.0.0",
    "icon": "$media:layered_image",
    "label": "$string:app_name"
  }
}

主要包含以下内容：

  • 应用的全局配置信息，包含应用的包名、开发厂商、版本号等基本信息。
  • 特定设备类型的配置信息。

其中配置信息如下：

  • bundleName：包名。
  • vendor：应用程序供应商。
  • versionCode：用于区分应用版本。
  • versionName：版本号。
  • icon：对应于应用的显示图标。
  • label：应用名。

模块级目录

image-20260109083351897
image-20260109083351897

  • entry：应用/服务模块，编译构建生成一个HAP。

    entry > src > main > module.json5：模块配置文件。具体介绍参考下面的 module.json5

    entry > src > main > ets：用于存放ArkTS源码。

    entry > src > main > ets > entryability：应用/服务的入口，存放Ability文件，用于当前Ability应用逻辑和生命周期管理。

    entry > src > main > ets > entrybackupability：应用提供扩展的备份恢复能力。

    entry > src > main > ets > pages：应用/服务包含的页面。存放UI界面相关代码文件，初始会生成一个Index页面。

    entry > src > main > resources：用于存放应用/服务所用到的资源文件，如图形、多媒体、字符串、布局文件等。详细说明请参考资源分类与访问。

resources
|---base  // 默认存在的目录
|   |---element
|   |   |---string.json // 字符串资源
|   |---media
|   |   |---icon.png // 图片、视频等媒体资源文件
|   |---profile
|   |   |---test_profile.json // 自定义profile文件，文件内容可自定义
|---en_GB-vertical-car-mdpi // 自定义限定词目录示例，由开发者创建
|   |---element
|   |   |---string.json
|   |---media
|   |   |---icon.png
|   |---profile
|   |   |---test_profile.json
|---rawfile // 其他类型文件，原始文件形式保存，不会被集成到resources.index文件中。文件名可自定义。
|---resfile // 其他类型文件，原始文件形式保存，不会被集成到resources.index文件中。文件名可自定义。
资源目录资源文件说明
base>element包括字符串、整型数、颜色、样式等资源的json文件。（目录下仅支持文件类型）-boolean，布尔型 -color，颜色 -float，浮点型，范围是-2128到2128 -intarray，整型数组 -integer，整型，范围是-231到231-1 -plural，复数形式 -strarray，字符串数组 -string，字符串
base>media多媒体文件，如图形、视频、音频等文件，支持的文件格式包括：.png、.gif、.mp3、.mp4等。
base>profile表示自定义配置文件，其文件内容可通过包管理接口获取（目录下只支持json文件类型）。
rawfile和resfile其他类型文件，用于存储任意格式的原始资源文件，不会被集成到resources.index文件中。文件名可自定义。不会根据设备的状态去匹配不同的资源，需要指定文件路径和文件名进行引用。

entry > src > ohosTest：单元测试目录。
entry > build-profile.json5：模块级配置信息 、编译信息配置项，包括buildOption、targets配置等。
entry > hvigorfile.ts：模块级编译构建任务脚本。
entry > oh-package.json5：用来描述包名、版本、入口文件（类型声明文件）和依赖项等信息。
entry > obfuscation-rules.txt：混淆规则文件。混淆开启后，在使用Release模式进行编译时，会对代码进行编译、混淆及压缩处理，保护代码资产。详见开启代码混淆。

module.json5

在FA 模型对应config.json

entry>src>main>module.json5 模块配置文件。主要包含HAP包的配置信息、应用/服务在具体设备上的配置信息以及应用/服务的全局配置信息。详见module.json5配置文件。

{
  "module": {
    "name": "entry",
    "type": "entry",
    "description": "$string:module_desc",
    "mainElement": "EntryAbility",
    "deviceTypes": [
      "phone"
    ],
    "deliveryWithInstall": true,
    "installationFree": false,
    "pages": "$profile:main_pages",
    "abilities": [
      {
        "name": "EntryAbility",
        "srcEntry": "./ets/entryability/EntryAbility.ets",
        "description": "$string:EntryAbility_desc",
        "icon": "$media:layered_image",
        "label": "$string:EntryAbility_label",
        "startWindowIcon": "$media:startIcon",
        "startWindowBackground": "$color:start_window_background",
        "exported": true,
        "skills": [
          {
            "entities": [
              "entity.system.home"
            ],
            "actions": [
              "ohos.want.action.home"
            ]
          }
        ]
      }
    ],
    "extensionAbilities": [
      {
        "name": "EntryBackupAbility",
        "srcEntry": "./ets/entrybackupability/EntryBackupAbility.ets",
        "type": "backup",
        "exported": false,
        "metadata": [
          {
            "name": "ohos.extension.backup",
            "resource": "$profile:backup_config"
          }
        ],
      }
    ]
  }
}

主要包含以下内容：

  • Module的基本配置信息，例如Module名称、类型、描述、支持的设备类型等基本信息。
  • 应用组件信息，包含 UIAbility 组件和 ExtensionAbility 组件的描述信息。
  • 应用运行过程中所需的权限信息。

其中module对应的是模块的配置信息，一个模块对应一个打包后的hap包，hap包全称是HarmonyOS Ability Package，其中包含了ability、第三方库、资源和配置文件。其具体属性及其描述可以参照下表1。

表1 module.json5默认配置属性及描述

属性描述
name该标签标识当前module的名字，module打包成hap后，表示hap的名称，标签值采用字符串表示（最大长度31个字节），该名称在整个应用要唯一。
type表示模块的类型，类型有三种，分别是entry、feature和har。
srcEntry当前模块的入口文件路径。
description当前模块的描述信息。
mainElement该标签标识hap的入口ability名称或者extension名称。只有配置为mainElement的ability或者extension才允许在服务中心露出。
deviceTypes该标签标识hap可以运行在哪类设备上，标签值采用字符串数组的表示。
deliveryWithInstall标识当前Module是否在用户主动安装的时候安装，表示该Module对应的HAP是否跟随应用一起安装。- true：主动安装时安装。- false：主动安装时不安装。
installationFree标识当前Module是否支持免安装特性。- true：表示支持免安装特性，且符合免安装约束。- false：表示不支持免安装特性。
pages对应的是main_pages.json文件，用于配置ability中用到的page信息。
abilities是一个数组，存放当前模块中所有的ability元能力的配置信息，其中可以有多个ability。

表2 abilities中对象的默认配置属性及描述

属性描述
name该标签标识当前ability的逻辑名，该名称在整个应用要唯一，标签值采用字符串表示（最大长度127个字节）。
srcEntryability的入口代码路径。
descriptionability的描述信息。
iconability的图标。该标签标识ability图标，标签值为资源文件的索引。该标签可缺省，缺省值为空。如果ability被配置为MainElement，该标签必须配置。
labelability的标签名。
startWindowIcon启动页面的图标。
startWindowBackground启动页面的背景色。
visibleability是否可以被其他应用程序调用，true表示可以被其它应用调用， false表示不可以被其它应用调用。
skills标识能够接收的意图的action值的集合，取值通常为系统预定义的action值，也允许自定义。
entities标识能够接收的Want的Action值的集合，取值通常为系统预定义的action值，也允许自定义。
actions标识能够接收Want的Entity值的集合。

main_pages.json

entry/src/main/resources/base/profile/main_pages.json文件保存的是页面page的路径配置信息，所有需要进行路由跳转的page页面都要在这里进行配置。

oh-package.json5

工程级 oh-package.json5 和 模块级 entry/oh-package.json5

///////////工程级
{
  "modelVersion": "6.0.1",
  "description": "Please describe the basic information.",
  "dependencies": {
  },
  "devDependencies": {
    "@ohos/hypium": "1.0.24",
    "@ohos/hamock": "1.0.0"
  }
}

///////////模块级
{
  "name": "entry",
  "version": "1.0.0",
  "description": "Please describe the basic information.",
  "main": "",
  "author": "",
  "license": "",
  "dependencies": {}
}
oh-package.json5包含字段字段说明说明
name软件包名称必选字段，若package.json文件中未指明，需在oh-package.json5添加补齐
version软件包版本必选字段，若package.json文件中未指明，需在oh-package.json5添加补齐
description软件包简介必选字段，若package.json文件中未指明，需在oh-package.json5添加补齐
keywords软件包关键字-
homepage主页链接-
license开源协议-
author软件包作者-
main软件包入口-
repository仓库地址-
dependencies生产依赖该字段处理方式请参阅下方说明内容
devDependencies开发依赖-
types类型定义-
artifactType共享包类型可选项： original：源码，即发布源码(.ts/.ets)。 obfuscation：混淆代码，即源码经过混淆之后发布上传。

说明

  • 工程的package.json文件的dependencies字段处理方式如下：
    • @ohos/hypium：测试框架的依赖，迁移时需要放到oh-package.json5文件的devDependencies字段下；
    • 删除 @ohos/hvigor 和 @ohos/hvigor-ohos-plugin字段，无需迁移到oh-package.json5中；
    • 其他依赖可直接复制到oh-package.json5的dependencies字段中。
  • 除表格中呈现的字段外，package.json中其余字段暂不支持迁移。如您在历史工程中使用到其余字段，请反馈您所使用的字段（选中文本，点击“意见反馈”）。

APP 包结构

Stage 模型和 FA 模型开发的应用，应用程序包结构并不相同

Entry.hap 相当于window的 .exe 文件

FeatureX.hap 相当于window的 .dll 文件

Stage 模型

  • Stage模型应用程序包结构如下图所示：

ArkTS 工程目录结构（API Version 8-9）

在基于Stage模型开发的应用项目代码下，都存在一个app.json5及一个或多个module.json5这两种配置文件。

FA 模型

  • FA模型应用程序包结构如下图所示：

ArkTS 工程目录结构（API Version 8-9）

API Version 8工程目录结构图：

API Version 9工程目录结构图：

  • entry：应用/服务模块，编译构建生成一个HAP。

    • src > main > ets：用于存放ArkTS源码。
    • src > main > ets > MainAbility：应用/服务的入口。
    • src > main > ets > MainAbility > pages：MainAbility包含的页面。
    • src > main > ets > MainAbility > app.ets：承载Ability生命周期。
    • src > main > resources：用于存放应用/服务所用到的资源文件，如图形、多媒体、字符串、布局文件等。
    资源目录资源文件说明
    base>element包括字符串、整型数、颜色、样式等资源的json文件。每个资源均由json格式进行定义，例如： boolean.json：布尔型 color.json：颜色 float.json：浮点型 intarray.json：整型数组 integer.json：整型 pattern.json：样式 plural.json：复数形式 strarray.json：字符串数组 string.json：字符串值
    base>media多媒体文件，如图形、视频、音频等文件，支持的文件格式包括：.png、.gif、.mp3、.mp4等。
    rawfile用于存储任意格式的原始资源文件。rawfile不会根据设备的状态去匹配不同的资源，需要指定文件路径和文件名进行引用。
    • src > main > config.json：模块配置文件，主要包含HAP的配置信息、应用在具体设备上的配置信息以及应用的全局配置信息。

其他工程目录结构请查看

其他工程目录结构请查看

更新日志

2026/1/14 22:13
查看所有更新日志
  • 4f8f3-docs 更新harmonyos目录结构于
  • 59d7d-docs 删除headerDepth于
  • a112e-docs 更新HarmonyOS部分内容于
  • e2e3a-docs init于
Copyright © 2026 blogres