啟用漸進式網頁應用程式功能 enabling-pwa
透過簡單的設定,內容作者現在可以為在AEM Sites中建立的體驗啟用漸進式網頁應用程式(PWA)功能。
- PWA知識
- 瞭解您的網站和內容結構
- 瞭解快取策略
- 來自開發團隊的支援
簡介 introduction
漸進式網頁應用程式(PWA)可讓AEM網站在本機儲存在使用者電腦上,並可離線存取,藉此啟用類似應用程式的沈浸式體驗。 即使失去網際網路連線,使用者也可以在行動中瀏覽網站。 即使網路遺失或不穩定,PWA也能提供順暢的體驗。
內容作者不需要重新錄製網站,而是能夠將PWA屬性設定為網站頁面屬性中的額外索引標籤。
- 儲存或發佈時,此設定會觸發寫出資訊清單檔案的事件處理常式,以及啟用網站PWA功能的Service Worker。
- 也會維護Sling對應,以確保從應用程式的根提供Service Worker,以啟用代理內容,允許應用程式內的離線功能。
透過PWA,使用者擁有網站的本機副本,即使沒有網際網路連線,也能提供應用程式般的體驗。
先決條件 prerequisites
若要能夠針對您的網站使用PWA功能,您的專案環境有兩個要求:
- 使用核心元件以利用此功能
- 調整您的Dispatcher規則以公開必要的檔案
這些是作者必須與開發團隊協調的技術步驟。 每個網站只需執行這些步驟一次。
使用核心元件 adjust-components
核心元件2.15.0版及更新版本完全支援AEM網站的PWA功能。 由於AEMaaCS一律包含最新版本的核心元件,因此您可以使用現成的PWA功能。 您的AEMaaCS專案會自動滿足此要求。
調整您的Dispatcher adjust-dispatcher
PWA功能會產生並使用/content/<sitename>/manifest.webmanifest
個檔案。 依預設,Dispatcher不會公開這類檔案。 若要公開這些檔案,開發人員必須將下列設定新增至您的網站專案。
File location: [project directory]/dispatcher/src/conf.dispatcher.d/filters/filters.any >
# Allow webmanifest files
/0102 { /type "allow" /extension "webmanifest" /path "/content/*/manifest" }
根據您的專案,您可能想要在重寫規則中包含不同型別的擴充功能。 當您匯入隱藏及重新導向要求至/content/<projectName>
的規則時,webmanifest
擴充功能將包含在重新寫入條件中會很有用。
RewriteCond %{REQUEST_URI} (.html|.jpe?g|.png|.svg|.webmanifest)$
為您的網站啟用PWA enabling-pwa-for-your-site
滿足必要條件後,內容作者就可以輕鬆啟用網站PWA功能。 以下是如何進行此操作的基本概述。 個別選項在詳細選項一節中詳細說明。
-
登入AEM。
-
從主功能表中選取 導覽 > 網站。
-
選取您的網站專案,然後選取 屬性 或使用快速鍵
p
。 -
選取 漸進式網頁應用程式 標籤,並設定適用的屬性。 您至少需要:
-
選取選項 啟用PWA。
-
定義 啟動URL
-
將512x512 png圖示上傳至DAM,並參照該圖示作為應用程式的圖示。
-
設定您希望Service Worker離線使用的路徑。 典型路徑為:
/content/<sitename>
/content/experiencefragements/<sitename>
/content/dam/<sitename>
- 任何協力廠商字型參照
/etc/clientlibs/<sitename>
-
-
選取「儲存並關閉」。
您的網站現在已設定,您可以將它安裝為本機應用程式。
使用已啟用PWA的網站 using-pwa-enabled-site
現在您已將設定您的網站以支援PWA,您可以親自體驗它。
- 在支援的瀏覽器中存取網站。
- 您會在瀏覽器的位址列看到新圖示,表示網站可安裝為本機應用程式。
- 圖示可能會依瀏覽器而有所不同,且瀏覽器也可能會顯示通知(例如橫幅或對話方塊),指出可作為本機應用程式安裝。
- 安裝應用程式。
- 應用程式會安裝在裝置的主畫面上。
- 開啟應用程式、瀏覽一點,然後檢視頁面是否可供離線使用。
詳細選項 detailed-options
以下章節提供當設定您的網站以進行PWA時,可用選項的詳細資訊。
設定安裝體驗 configure-installable-experience
這些設定可讓您的網站安裝在訪客的主畫面上並離線存取,以便像原生應用程式一樣運作。
-
啟用PWA — 這是啟用網站PWA的主要切換按鈕。
-
啟動URL — 這是使用者載入本機安裝的應用程式時,應用程式開啟的偏好的啟動URL。
- 這可以是內容結構中的任何路徑。
- 這不一定是根目錄,且通常是應用程式的專屬歡迎頁面。
- 如果此URL是相對的,則資訊清單URL會作為基礎URL來解析。
- 若保留為空白,功能會使用安裝應用程式的來源網頁位址。
- 建議您設定值。
-
顯示模式 — 啟用PWA的應用程式仍然是透過瀏覽器傳送的AEM網站。 這些顯示選項會定義如何隱藏瀏覽器,或如何以其他方式顯示給本機裝置上的使用者。
- 獨立 — 使用者看不到瀏覽器,而且它看起來像是原生應用程式。 這是預設值。
- 有了此選項,您必須使用網站頁面上的連結和元件,完全能夠透過您的內容進行應用程式導覽,而不需要使用瀏覽器的導覽控制項。
- 瀏覽器 — 瀏覽器在造訪網站時會如常顯示。
- 最小化UI — 瀏覽器大部分是隱藏的,就像原生應用程式一樣,但會顯示基本導覽控制項。
- 全熒幕 — 瀏覽器是隱藏的,就像原生應用程式,但會以全熒幕模式呈現。
- 有了此選項,您必須使用網站頁面上的連結和元件,完全能夠透過您的內容進行應用程式導覽,而不需要使用瀏覽器的導覽控制項。
- 獨立 — 使用者看不到瀏覽器,而且它看起來像是原生應用程式。 這是預設值。
-
熒幕方向 — 作為本機應用程式,PWA必須知道如何處理裝置方向。
- 任何 — 應用程式會調整成使用者裝置的方向。 這是預設值。
- 縱向 — 這會強制應用程式以縱向配置開啟,無論使用者裝置的方向為何。
- 橫向 — 這會強制應用程式以橫向配置開啟,無論使用者裝置的方向為何。
-
佈景主題色彩 — 這會定義應用程式🔗的色彩,會影響本機使用者的作業系統顯示原生UI工具列和導覽控制項的方式。 視瀏覽器而定,它可能會影響其他應用程式簡報元素。
- 使用色槽快顯視窗來選取顏色。
- 顏色也可以由十六進位或RGB值定義。
-
背景色彩 — 這會定義應用程式🔗的背景色彩,會在應用程式載入時顯示。
- 使用色槽快顯視窗來選取顏色。
- 顏色也可以由十六進位或RGB值定義。
- 某些瀏覽器會自動從應用程式名稱、背景顏色和圖示建立啟動畫面。
-
圖示 — 這會定義代表使用者裝置上應用程式的圖示。
- 圖示必須是大小為512x512畫素的png檔案。
- 圖示必須是儲存在DAM中。
快取管理(進階) offline-configuration
這些設定可讓此網站的部分內容可離線使用,並可在訪客的裝置上在本機使用。 這可控制網頁應用程式的快取,以最佳化網路要求並支援離線體驗。
-
快取策略與內容重新整理頻率 — 此設定會定義PWA的快取模型。
- 適度 - 此設定適用於大多數網站,且為預設值。
- 透過此設定,使用者首先檢視的內容將從快取中載入,當使用者使用該內容時,快取中的其餘內容將會重新驗證。
- 經常 — 這適用於拍賣行等需要快速更新的網站。
- 透過此設定,應用程式會先透過網路尋找最新內容,如果無法取得,則會退回本機快取。
- 很少 — 這適用於幾乎靜態的網站,例如參考頁面。
- 透過此設定,應用程式會先在快取中尋找內容,如果沒有,則會退回網路來擷取內容。
- 適度 - 此設定適用於大多數網站,且為預設值。
-
檔案預先快取 — 這些在AEM上託管的檔案會在安裝Service Worker時和使用它之前儲存到本機瀏覽器快取。 這可確保網頁應用程式在離線時可完全正常運作。
-
路徑包含 — 已攔截定義路徑的網路要求,並根據設定的 快取策略與內容重新整理頻率 傳回快取的內容。
-
快取排除專案 — 無論在 檔案預先快取 和 路徑包含專案 下的設定為何,都不會快取這些檔案。
限制和建議 limitations-recommendations
並非所有PWA功能都可用於AEM Sites。 這些是幾項值得注意的限制。
- 如果使用者未使用應用程式,頁面不會自動同步或更新。
實作Adobe時,PWA也建議下列事項。
將預先快取的資源數量減到最少。 minimize-precache
Adobe建議您限制要預先快取的頁數。
- 內嵌程式庫,以減少預先快取時要管理的專案數量。
- 限制要預先快取的影像變化數量。
在專案指令碼和樣式表穩定後啟用PWA。 pwa-stabilized
使用者端程式庫已連同快取選擇器一起傳送,並遵循下列模式lc-<checksumHash>-lc
。 每當構成程式庫的其中一個檔案(和相依性)變更時,此選取器就會變更。 如果您列出要由service-worker預先快取的使用者端程式庫,且想參照新版本,請手動擷取並更新專案。 因此,Adobe建議您在穩定專案指令碼和樣式表之後,將網站設定為PWA。
將影像變數的數量減到最少。 minimize-variations
AEM核心元件的影像元件會決定要擷取的前端最佳轉譯。 此機制也包含與該資源上次修改時間對應的時間戳記。 此機制會使PWA預先快取的設定複雜化。
設定預先快取時,使用者必須列出所有可擷取的路徑變數。 這些變化是由品質和寬度等引數所組成。 建議您將這些變數的數量減少到最多三個:小、中、大。 您可以透過影像元件的內容原則對話方塊來執行此操作。
若未妥善設定,記憶體與網路耗用量可能會嚴重影響PWA的效能。 此外,如果您打算預先快取50個影像,且每個影像有三個寬度,則維護網站的使用者必須在頁面屬性的PWA預先快取區段中,維護最多150個專案的清單。
Adobe也建議您在使用影像的專案穩定後將網站設定為PWA。