SPA和伺服器端轉譯

注意

若專案需要SPA架構的用戶端轉譯(例如React或Angular),SPA Editor是建議的解決方案。

注意

AEM 6.5.1.0或更新版本是使用SPA伺服器端轉譯功能的必要條件，如本檔案所述。

概觀

單頁應用程式(SPA)可為使用者提供豐富的動態體驗，以熟悉的方式回應和運作，通常就像原生應用程式。 這是通過依靠客戶端將內容預先載入，然後進行用戶交互的繁重提升來實現的 從而將客戶端與伺服器之間所需的通訊量降至最低，使應用程式更具反應性。

不過，這可能會導致較長的初始載入時間，尤其是如果SPA很大且內容豐富。 為了最佳化載入時間，某些內容可在伺服器端轉譯。 使用伺服器端轉譯(SSR)可以加速頁面的初始載入，然後將轉譯傳遞給用戶端。

何時使用SSR

並非所有項目都需要SSR。 雖然AEM完全支援SPA適用的JS SSR，但Adobe不建議針對每個專案系統實作。

在決定實施SSR時，首先必須估計SSR的實際代表是什麼額外的複雜性、工作量和成本增加，包括長期維護。 只有當增值明顯超過估計成本時，才應選擇SSR架構。

SSR通常在下列任一問題都有明確的「是」時提供一些值：

  • SEO: 您的網站是否仍需要SSR才能由帶來流量的搜尋引擎正確編列索引？ 請記住，主要搜尋引擎編目程式現在會評估JS。
  • 頁面速度： SSR是否在真實環境中提供了可衡量的速度改進，並增加了總體用戶體驗？

只有在這兩個問題中至少有一個以明確的「是」回答，您的專案才會Adobe建議實作SSR。 以下各節將說明如何使用Adobe I/O Runtime執行此作業。

Adobe I/O Runtime

若您 確信您的項目需要實施SSR,Adobe的建議解決方案是使用Adobe I/O Runtime。

如需Adobe I/O Runtime的詳細資訊，請參閱

以下幾節將詳細說明如何使用Adobe I/O Runtime，在兩種不同的模型中為SPA實作SSR:

注意

Adobe建議每個環境（預備、生產、測試等）分別使用Adobe I/O Runtime工作區。 這允許典型的系統開發生命週期(SDLC)模式，將不同版本的單個應用程式部署到不同的環境。 請參閱檔案 適用於Project Firefly應用程式的CI/CD 以取得更多資訊。

每個例項（製作、發佈）不需要個別的工作區，除非每個例項類型在執行階段實施中有差異。

遠程轉譯器配置

AEM必須知道可在何處擷取遠端轉譯的內容。 無論 您選擇對SSR實施的模型， 您需要指定AEM如何存取此遠端呈現服務。

這是透過 RemoteContentRenderer — 配置工廠OSGi服務. 在Web控制台配置控制台中搜索字串"RemoteContentRenderer"(位於 http://<host>:<port>/system/console/configMgr.

轉譯器配置

下列欄位適用於設定：

  • 內容路徑模式 — 必要的規則運算式，以匹配部分內容
  • 遠端端點URL — 負責產生內容的端點URL
    • 如果本地網路中沒有，請使用安全的HTTPS協定。
  • 其他請求標題 — 要新增至傳送至遠端端點之請求的其他標題
    • 模式: key=value
  • 請求逾時 — 遠程主機請求超時（毫秒）
注意

無論您是否選擇實作 AEM驅動的通信流 或 Adobe I/O Runtime驅動的流， 您必須定義遠端內容轉譯器設定。

如果您選擇 使用自訂Node.js伺服器。

注意

此設定會利用 遠端內容轉譯器、 其他擴充功能和自訂選項可供使用。

AEM導向的通訊流程

使用SSR時， 元件交互工作流 的SPA包含在Adobe I/O Runtime上產生應用程式初始內容的階段。

  1. 瀏覽器會向AEM要求SSR內容。

  2. AEM會將模型發佈至Adobe I/O Runtime。

  3. Adobe I/O Runtime會傳回產生的內容。

  4. AEM會透過後端頁面元件的HTL範本，提供Adobe I/O Runtime傳回的HTML。

伺服器端轉譯 — cms-drivenaemnode-adobeio

Adobe I/O Runtime驅動的通訊流

上一節將說明針對AEM中的SPA而執行伺服器端轉譯的標準和建議實作，AEM會執行內容的引導及服務。

或者，SSR可以實現，使Adobe I/O Runtime負責引導，有效地逆轉通信流。

這兩種模型均有效，且受AEM支援。 然而，在實施特定模式之前，應考慮每種模式的利弊。

引導 優點 缺點
透過AEM
  • AEM會視需要管理注入程式庫
  • 只需在AEM上維護資源
  • 可能不熟悉SPA開發人員
透過Adobe I/O Runtime
  • 更熟悉SPA開發人員
  • 應用程式所需的Clientlib資源（例如CSS和JavaScript）將需要由AEM開發人員透過 allowProxy 屬性
  • 必須在AEM和Adobe I/O Runtime之間同步資源
  • 若要啟用SPA的編寫功能，可能需要Adobe I/O Runtime的代理伺服器

SSR規劃

通常，只有應用程式的一部分需要呈現在伺服器端。 常見的範例是，在頁面初始載入時，會在折頁上方顯示的內容會呈現在伺服器端。 這樣可將已呈現的內容傳送給用戶端，節省時間。 當使用者與SPA互動時，用戶端會轉譯其他內容。

當您考慮為SPA實作伺服器端轉譯時，需要檢閱應用程式的哪些部分是必要的。

用SSR開發SPA

SPA元件可由用戶端（在瀏覽器中）或伺服器端轉譯。 呈現伺服器端時，瀏覽器屬性（例如視窗大小和位置）不存在。 因此，SPA元件應為同構，不須假設其轉譯位置。

若要運用SSR，您必須在AEM和Adobe I/O Runtime中部署程式碼，後者負責伺服器端轉譯。 大部分的程式碼會相同，但伺服器特定的工作會有所不同。

AEM中SPA的SSR

AEM中的SPA適用的SSR需要Adobe I/O Runtime，這是轉譯應用程式內容伺服器端所呼叫的功能。 在應用程式的HTL內，會呼叫Adobe I/O Runtime上的資源來呈現內容。

正如AEM可立即支援Angular和React SPA架構，Angular和React應用程式也支援伺服器端轉譯。 如需詳細資訊，請參閱這兩個架構的NPM檔案。

如需簡單化的範例，請參閱 We.Retail Journal應用程式. 它會呈現整個應用程式伺服器端。 雖然這不是現實中的例子，但它確實說明了實施SSR需要什麼。

注意

此 We.Retail Journal應用程式 僅供展示之用，因此會使用Node.js作為簡單範例，而非建議的Adobe I/O Runtime。 此範例不應用於任何專案工作。

注意

任何AEM專案皆應運用 AEM專案原型，可支援使用React或Angular的SPA專案，並運用SPA SDK。

使用Node.js

Adobe I/O Runtime是在AEM中實作SPA SSR的建議解決方案。

若為內部部署的AEM例項，您也可以使用與上述相同的方式，使用自訂Node.js例項來實作SSR。 雖然Adobe支援此功能，但不建議使用。

注意

托管於Adobe的AEM例項不支援Node.js。

注意

如果SSR必須透過Node.js實作，Adobe建議為每個AEM環境（製作、發佈、預備等）使用個別的Node.js例項。

遠端內容轉譯器

此 遠端內容轉譯器設定 在AEM中搭配SPA使用SSR時，需要點選更廣泛的轉譯服務，這些服務可擴充及自訂，以符合您的需求。

RemoteContentRenderingService

RemoteContentRenderingService 是OSGi服務，用於擷取在遠端伺服器上轉譯的內容，例如從Adobe I/O。傳送至遠端伺服器的內容是根據所傳遞的要求參數。

RemoteContentRenderingService 可在需要進行其他內容操作時，透過相依性反轉插入自訂Sling模型或servlet中。

此服務由 RemoteContentRendererRequestHandlerServlet.

RemoteContentRendererRequestHandlerServlet

此 RemoteContentRendererRequestHandlerServlet 可用來以程式設計方式設定要求設定。 DefaultRemoteContentRendererRequestHandlerImpl，提供預設請求處理常式實作，可讓您建立多個OSGi設定，以將內容結構中的位置對應至遠端端點。

若要新增自訂請求處理常式，請實作 RemoteContentRendererRequestHandler 介面。 請務必將 Constants.SERVICE_RANKING 元件屬性轉換為高於100的整數，這是 DefaultRemoteContentRendererRequestHandlerImpl.

@Component(immediate = true,
        service = RemoteContentRendererRequestHandler.class,
        property={
            Constants.SERVICE_RANKING +":Integer=1000"
        })
public class CustomRemoteContentRendererRequestHandlerImpl implements RemoteContentRendererRequestHandler {}

配置預設處理程式的OSGi配置

預設處理常式的設定必須依照一節所述進行設定 遠端內容轉譯器設定.

遠端內容轉譯器用途

若要讓servlet擷取並傳回可插入頁面的某些內容：

  1. 確保您的遠程伺服器可訪問。
  2. 將下列其中一個程式片段新增至AEM元件的HTL範本。
  3. （可選）建立或修改OSGi設定。
  4. 瀏覽您網站的內容

頁面元件的HTL範本通常是此類功能的主要收件者。

<sly data-sly-resource="${resource @ resourceType='cq/remote/content/renderer/request/handler'}" />

要求

servlet會利用Sling模型匯出工具來序列化元件資料。 依預設， com.adobe.cq.export.json.ContainerExporter 和 com.adobe.cq.export.json.ComponentExporter 支援作為Sling型號轉接器。 如有必要，您可以新增類，讓要求適應使用 RemoteContentRendererServlet 和 RemoteContentRendererRequestHandler#getSlingModelAdapterClasses. 其他類必須擴展 ComponentExporter.

本頁內容