Stage模型應(yīng)用配置文件

應(yīng)用配置文件中包含應(yīng)用配置信息、應(yīng)用組件信息、權(quán)限信息、開發(fā)者自定義信息等，這些信息在編譯構(gòu)建、分發(fā)和運行解決分別提供給編譯工具、應(yīng)用市場和操作系統(tǒng)使用。

在基于Stage模型開發(fā)的應(yīng)用項目代碼下，都存在app.json5（一個）及module.json5（一個或多個）兩種配置文件，常用配置項請參見[應(yīng)用/組件級配置]。

應(yīng)用/組件級配置

在開發(fā)應(yīng)用時，需要配置應(yīng)用的一些標(biāo)簽，例如應(yīng)用的包名、圖標(biāo)等標(biāo)識特征的屬性。本文描述了在開發(fā)應(yīng)用需要配置的一些關(guān)鍵標(biāo)簽。

應(yīng)用包名配置

應(yīng)用需要在工程的AppScope目錄下的[app.json5配置文件]中配置bundleName標(biāo)簽，該標(biāo)簽用于標(biāo)識應(yīng)用的唯一性。推薦采用反域名形式命名（如com.example.demo，建議第一級為域名后綴com，第二級為廠商/個人名，第三級為應(yīng)用名，也可以多級）。

圖標(biāo)和標(biāo)簽配置

圖標(biāo)和標(biāo)簽通常一起配置，可以分為應(yīng)用圖標(biāo)、應(yīng)用標(biāo)簽和入口圖標(biāo)、入口標(biāo)簽，分別對應(yīng)[app.json5配置文件]和[module.json5配置文件]中的icon和label標(biāo)簽。

應(yīng)用圖標(biāo)和標(biāo)簽通常用于標(biāo)識整個應(yīng)用，可以在標(biāo)識應(yīng)用的界面使用該類型圖標(biāo)和標(biāo)簽。比如：

• 設(shè)置應(yīng)用中，需要展示應(yīng)用列表時
• 在隱私管理中，需要展示應(yīng)用申請的權(quán)限時
• 在狀態(tài)欄顯示通知消息時

入口圖標(biāo)和標(biāo)簽是應(yīng)用安裝完成后可以在設(shè)備桌面上顯示出來的，如下圖所示。入口圖標(biāo)是以[UIAbility]為粒度，支持同一個應(yīng)用存在多個入口圖標(biāo)和入口標(biāo)簽，點擊后進(jìn)入對應(yīng)的UIAbility界面。比如：

• 桌面上需要顯示圖標(biāo)時
• 最近任務(wù)列表中顯示時

圖1 圖標(biāo)和標(biāo)簽

應(yīng)用圖標(biāo)和標(biāo)簽配置

應(yīng)用圖標(biāo)需要在工程的AppScope目錄下的[app.json5配置文件]中配置icon標(biāo)簽。應(yīng)用圖標(biāo)需配置為圖片的資源索引，配置完成后，該圖片即為應(yīng)用的圖標(biāo)。

應(yīng)用標(biāo)簽需要在工程的AppScope模塊下的[app.json5配置文件]中配置label標(biāo)簽。標(biāo)識應(yīng)用對用戶顯示的名稱，需要配置為字符串資源的索引。

{
  "app": {
    "icon": "$media:app_icon",
    "label": "$string:app_name"
    ...
  }
}

入口圖標(biāo)和標(biāo)簽配置

入口圖標(biāo)和標(biāo)簽配置方式

Stage模型支持對組件配置入口圖標(biāo)和入口標(biāo)簽。入口圖標(biāo)和入口標(biāo)簽會顯示在桌面上。

入口圖標(biāo)需要在[module.json5配置文件]中配置，在abilities標(biāo)簽下面有icon標(biāo)簽。例如希望在桌面上顯示該UIAbility的圖標(biāo)，則需要在skills標(biāo)簽下面的entities中添加"entity.system.home"、actions中添加"ohos.want.action.home"。同一個應(yīng)用有多個UIAbility配置上述字段時，桌面上會顯示出多個圖標(biāo)，分別對應(yīng)各自的UIAbility。

{
  "module": {
    ...
    "abilities": [
      {
        "icon": "$media:icon",
        "label": "$string:EntryAbility_label",
        "skills": [
          {
            "entities": [
              "entity.system.home"
            ],
            "actions": [
              "ohos.want.action.home"
            ]
          }
        ],
      }
    ]
  }
}

入口圖標(biāo)和標(biāo)簽管控規(guī)則

系統(tǒng)對無圖標(biāo)應(yīng)用實施嚴(yán)格管控，防止一些惡意應(yīng)用故意配置無入口圖標(biāo)，導(dǎo)致用戶找不到軟件所在的位置，無法操作卸載應(yīng)用，在一定程度上保證用戶終端設(shè)備的安全。

如果應(yīng)用確需隱藏入口圖標(biāo)，需要配置AllowAppDesktopIconHide應(yīng)用特權(quán)。詳細(xì)的入口圖標(biāo)及入口標(biāo)簽的顯示規(guī)則如下。

• HAP中包含UIAbility

  • 在module.json5配置文件的abilities標(biāo)簽中設(shè)置了入口圖標(biāo)
    • 該應(yīng)用沒有隱藏圖標(biāo)的特權(quán)
      • 系統(tǒng)將使用該UIAbility配置的icon作為入口圖標(biāo)，并顯示在桌面上。用戶點擊該圖標(biāo)，頁面跳轉(zhuǎn)到該UIAbility首頁。
      • 系統(tǒng)將使用該UIAbility配置的label作為入口標(biāo)簽，并顯示在桌面上，如果沒有配置label，系統(tǒng)將使用app.json5中的label作為入口標(biāo)簽，并顯示在桌面上。
    • 該應(yīng)用具有隱藏圖標(biāo)的特權(quán)
      • 桌面應(yīng)用查詢時不返回應(yīng)用信息，不會在桌面上顯示對應(yīng)的入口圖標(biāo)和標(biāo)簽。
  • 在module.json5配置文件的abilities標(biāo)簽中未設(shè)置入口圖標(biāo)
    • 該應(yīng)用沒有隱藏圖標(biāo)的特權(quán)
      • 系統(tǒng)將使用app.json5中的icon作為入口圖標(biāo)，并顯示在桌面上。用戶點擊該圖標(biāo)，頁面跳轉(zhuǎn)到應(yīng)用管理中對應(yīng)的應(yīng)用詳情頁面，如下圖所示。
      • 系統(tǒng)將使用app.json5中的label作為入口標(biāo)簽，并顯示在桌面上。
    • 該應(yīng)用具有隱藏圖標(biāo)的特權(quán)
      • 桌面應(yīng)用查詢時不返回應(yīng)用信息，不會在桌面上顯示對應(yīng)的入口圖標(biāo)和標(biāo)簽。

• HAP中不包含UIAbility

  • 該應(yīng)用沒有隱藏圖標(biāo)的特權(quán)
    • 系統(tǒng)將使用app.json5中的icon作為入口圖標(biāo)，并顯示在桌面上。用戶點擊該圖標(biāo)，頁面跳轉(zhuǎn)到應(yīng)用管理中對應(yīng)的應(yīng)用詳情頁面，如下圖所示。
    • 系統(tǒng)將使用app.json5中的label作為入口標(biāo)簽，并顯示在桌面上。
  • 該應(yīng)用具有隱藏圖標(biāo)的特權(quán)
    • 桌面應(yīng)用查詢時不返回應(yīng)用信息，不會在桌面上顯示對應(yīng)的入口圖標(biāo)和標(biāo)簽。
    • 開發(fā)前請熟悉鴻蒙開發(fā)指導(dǎo)文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]點擊或者復(fù)制轉(zhuǎn)到。

  
  圖2 應(yīng)用的詳情頁示意圖
  

應(yīng)用版本聲明配置

應(yīng)用版本聲明需要在工程的AppScope目錄下的[app.json5配置文件]中配置versionCode標(biāo)簽和versionName標(biāo)簽。versionCode用于標(biāo)識應(yīng)用的版本號，該標(biāo)簽值為32位非負(fù)整數(shù)。此數(shù)字僅用于確定某個版本是否比另一個版本更新，數(shù)值越大表示版本越高。versionName標(biāo)簽標(biāo)識版本號的文字描述。

Module支持的設(shè)備類型配置

Module支持的設(shè)備類型需要在[module.json5配置文件]中配置[deviceTypes標(biāo)簽]，如果deviceTypes標(biāo)簽中添加了某種設(shè)備，則表明當(dāng)前的Module支持在該設(shè)備上運行。

Module權(quán)限配置

Module訪問系統(tǒng)或其他應(yīng)用受保護(hù)部分所需的權(quán)限信息需要在[module.json5配置文件]中配置[requestPermissions標(biāo)簽]。該標(biāo)簽用于聲明需要申請權(quán)限的名稱、申請權(quán)限的原因以及權(quán)限使用的場景。