HAP Build Guide

Overview

Basic Concepts

Function

The HAP provides HAP build functions and supports FA and stage models.

How to Develop

OpenHarmony Templates

ohos_hap

This template declares a HAP target, which generates a HAP that will be packaged into the system image.

ohos_app_scope

Declares the AppScope module of the HAP. The app_profile and sources variables of the target will be concatenated to a specific entry for build. This template is used only in the stage model.

ohos_js_assets

Provides JS or eTS code, which is stored in the assets/js/default directory after built. In the stage model, this template is stored in the assets/js or assets/ets directory, depending on the programming language.

ohos_assets

Provides raw assets, which are directly copied to the assets directory of the HAP.

ohos_resources

Resource files, which are stored in the assets/entry/resources directory for the FA model and in the resources directory for the stage model.

Procedure

1. Save the developed application example to the applications/standard/ directory.

2. Configure the GN script applications/standard/example/BUILD.gn.
   The following is an example of the FA model. For details about more BUILD.gn configurations, see GN Script Configuration Example.

   import("//build/ohos.gni") # Import ohos.gni.
   
   ohos_hap("example") {
     hap_profile = "./src/main/config.json" # config.json
     js_assets = ["./src/main/js/default"]
     raw_assets = ["./raw_assets"]
     resources = ["./src/main/resources"]
     shared_libraries = [
       "//third_party/libpng:libpng", # Native library
     ]
     certificate_profile = "../signature/systemui.p7b" # Certificate profile
     hap_name = "SystemUI-NavigationBar" # HAP name
     part_name = "prebuilt_hap"
     subsystem_name = "applications"
   }
   

3. Modify the applications/standard/hap/ohos.build file.
   The following is an example:

   {
     "subsystem": "applications",
     "parts": {
       "prebuilt_hap": {
         "module_list": [
           ...
           "//applications/standard/example:example" # Add a build target.
         ]
       }
     }
   }
   

4. Start build.

   # Perform full building.
   ./build.sh --product-name {product_name}
   
   # Build the HAP only.
   ./build.sh --product-name {product_name} --build-target applications/standard/example:example
   

The build target is generated. The following shows the decompressed HAP in the FA model.

  Length      Date    Time    Name
---------  ---------- -----   ----
     1439  2009-01-01 00:00   assets/raw_assets                                 -----> raw_assets
      354  2009-01-01 00:00   assets/entry/resources.index                      ------> resources
        1  2009-01-01 00:00   assets/entry/resources/base/media/attributes.key  ------> resources
        1  2009-01-01 00:00   assets/entry/resources/base/media/constants.key   ------> resources
        1  2009-01-01 00:00   assets/entry/resources/base/media/contents.key    ------> resources
     6790  2009-01-01 00:00   assets/entry/resources/base/media/icon.png        ------> resources
        1  2009-01-01 00:00   assets/entry/resources/base/media/nodes.key       ------> resources
    11170  2009-01-01 00:00   assets/js/default/app.js                          ------> js_assets
       48  2009-01-01 00:00   assets/js/default/i18n/en-US.json                 ------> js_assets
       50  2009-01-01 00:00   assets/js/default/i18n/zh-CN.json                 ------> js_assets
      224  2009-01-01 00:00   assets/js/default/manifest.json                   ------> js_assets
    41481  2009-01-01 00:00   assets/js/default/pages/index/index.js            ------> js_assets
      909  2009-01-01 00:00   config.json                                       ------> hap_profile
   266248  2009-01-01 00:00   libs/libpng.z.so                                  ------> shared_libraries

GN Script Configuration Example

• Example of multiple abilities in the FA model

  import("//build/ohos.gni")
  
  ohos_hap("dataability") {
    hap_profile = "entry/src/main/config.json"
    deps = [
      ":dataability_js_assets",
      ":dataability_resources",
    ]
    certificate_profile = "signature/openharmony_sx.p7b"
    hap_name = "dataability"
    part_name = "prebuilt_hap"
    subsystem_name = "applications"
  }
  
  ohos_js_assets("dataability_js_assets") {
    ets2abc = true
    source_dir = "entry/src/main/ets"
    hap_profile = "entry/src/main/config.json"
  }
  
  ohos_resources("dataability_resources") {
    sources = [
      "entry/src/main/resources",
    ]
    hap_profile = "entry/src/main/config.json"
  }
  
  

• Example of a JS widget in the FA model

  import("//build/ohos.gni")
  
  ohos_hap("FormOfFaJs") {
    hap_profile = "entry/src/main/config.json"
    deps = [
      ":FormOfFaJs_js_assets",
      ":FormOfFaJs_resources",
    ]
    certificate_profile = "signature/openharmony_sx.p7b"
    hap_name = "FormOfFaJs"
    part_name = "prebuilt_hap"
    subsystem_name = "applications"
  }
  
  ohos_js_assets("FormOfFaJs_js_assets") {
    hap_profile = "entry/src/main/config.json"
    js2abc = true
    source_dir = "entry/src/main/js"
  }
  
  ohos_resources("FormOfFaJs_resources") {
    sources = [
      "entry/src/main/resources",
    ]
    hap_profile = "entry/src/main/config.json"
  }
  

• Example of an eTS widget in the FA model

  import("//build/ohos.gni")
  
  ohos_hap("FormOfFaEts") {
    hap_profile = "entry/src/main/config.json"
    deps = [
      ":FormOfFaEts_js_assets",
      ":FormOfFaEts_form_js_assets",
      ":FormOfFaEts_resources",
    ]
    certificate_profile = "signature/openharmony_sx.p7b"
    hap_name = "FormOfFaEts"
    part_name = "prebuilt_hap"
    subsystem_name = "applications"
  }
  
  ohos_js_assets("FormOfFaEts_js_assets") {
    hap_profile = "entry/src/main/config.json"
    ets2abc = true
    source_dir = "entry/src/main/ets"
  }
  
  ohos_js_assets("FormOfFaEts_form_js_assets") {
    hap_profile = "entry/src/main/config.json"
    js2abc = true
    source_dir = "entry/src/main/js"
  }
  
  ohos_resources("FormOfFaEts_resources") {
    sources = [
      "entry/src/main/resources",
    ]
    hap_profile = "entry/src/main/config.json"
  }
  

• Example of the stage model

  import("//build/ohos.gni")
  
  ohos_hap("actmoduletest") {
    hap_profile = "entry/src/main/module.json"
    deps = [
      ":actmoduletest_js_assets",
      ":actmoduletest_resources",
    ]
    certificate_profile = "signature/openharmony_sx.p7b"
    hap_name = "actmoduletest"
    part_name = "prebuilt_hap"
    subsystem_name = "applications"
  }
  
  ohos_app_scope("actmoduletest_app_profile") {
    app_profile = "AppScope/app.json"
    sources = [ "AppScope/resources" ]
  }
  
  ohos_js_assets("actmoduletest_js_assets") {
    ets2abc = true
    source_dir = "entry/src/main/ets"
  }
  
  ohos_resources("actmoduletest_resources") {
    sources = [
      "entry/src/main/resources",
    ]
    deps = [
      ":actmoduletest_app_profile",
    ]
    hap_profile = "entry/src/main/module.json"
  }
  

• Example of a widget in the stage model

  import("//build/ohos.gni")
  
  ohos_hap("FormOfStageEts") {
    hap_profile = "entry/src/main/module.json"
    deps = [
      ":FormOfStageEts_js_assets",
      ":FormOfStageEts_form_js_assets",
      ":FormOfStageEts_resources",
    ]
    js_build_mode = "debug" # The default value is release.
    certificate_profile = "signature/openharmony_sx.p7b"
    hap_name = "FormOfStageEts"
    part_name = "prebuilt_hap"
    subsystem_name = "applications"
  }
  
  ohos_js_assets("FormOfStageEts_js_assets") {
    hap_profile = "entry/src/main/module.json"
    ets2abc = true
    source_dir = "entry/src/main/ets"
  }
  
  ohos_js_assets("FormOfStageEts_form_js_assets") {
    hap_profile = "entry/src/main/module.json"
    js2abc = true
    source_dir = "entry/src/main/js"
  }
  
  ohos_app_scope("FormOfStageEts_app_profile") {
    app_profile = "AppScope/app.json"
    sources = [ "AppScope/resources" ]
  }
  
  ohos_resources("FormOfStageEts_resources") {
    sources = [
      "entry/src/main/resources",
    ]
    deps = [
      ":FormOfStageEts_app_profile",
    ]
    hap_profile = "entry/src/main/module.json"
  }