SPA和伺服器端演算

注意

「單頁應用程式(SPA)編輯器」功能需要AEM 6.4 Service Pack 2或更新版本。

SPA編輯器是建議的解決方案,適用於需要以SPA架構為基礎的用戶端轉換(例如React或Angular)的專案。

注意

必須有AEM 6.4.5.0或更新版本才能使用SPA伺服器端轉譯功能,如本檔案所述。

概覽

單頁應用程式(SPA)可為使用者提供多樣化的動態體驗,以熟悉的方式反應和運作,通常就像原生應用程式一樣。 這是透過依賴用戶端在前面載入內容,然後進行繁重的使用者互動處理,從而將用戶端與伺服器之間所需的通訊量降至最低,使應用程式更具反應性而實現的。

不過,這可能會延長初始載入時間,尤其是當SPA大而內容豐富時。 為了最佳化載入時間,有些內容可在伺服器端轉譯。 使用伺服器端轉譯(SSR)可加速頁面的初始載入,並進一步將轉譯傳遞給用戶端。

何時使用SSR

並非所有項目都需要SSR。 Althgouh AEM完全支援SPA的JS SSR,Adobe不建議針對每個專案系統實作它。

在決定實施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建議針對每個AEM環境(作者、發佈、舞台等)使用個別的Adobe I/O Runtime執行個體。

遠程內容渲染器配置

AEM必須知道可擷取遠端轉譯內容的位置。 不論您選擇為SSR](#adobe-io-runtime)實作的[型號,您都需要指定AEM如何存取此遠端轉譯服務。

這是通過​RemoteContentRenderer - Configuration Factory OSGi服務完成的。 在http://<host>:<port>/system/console/configMgr的Web控制台配置控制台中搜索字串"RemoteContentRenderer"。

下列欄位可用於設定:

  • 內容路徑模式 -規則運算式,以符合內容的一部分(如有需要)
  • 遠端端點URL —— 負責產生內容之端點的URL
    • 如果不在本地網路中,請使用安全的HTTPS協定。
  • 其他請求標題 -要新增至傳送至遠端端點之請求的其他標題
    • 模式:key=value
  • 請求超時 -遠程主機請求超時(以毫秒為單位)
注意

無論您選擇實作AEM導向的通訊流Adobe I/O Runtime導向的通訊流,您都必須定義遠端內容轉譯器設定。

如果您選擇使用自訂Node.js伺服器,也必須定義此設定。

注意

此配置利用遠程內容渲染器,該配置具有其他擴展和自定義選項。

AEM驅動的通信流

使用SSR時,AEM中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

Adobe I/O Runtime導向的通訊流程

AEM-Driven Communication Flow一節說明在AEM中針對SPA執行伺服器端轉譯的標準和建議實作,其中AEM會執行內容的引導和伺服。

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

這兩種機型都有效,且受AEM支援。 但是,在實施特定模式之前,應先考慮各自的優缺點。

引導 優勢 缺點
透過AEM AEM會在需要時管理注入程式庫
僅需在AEM上維護資源
SPA開發人員可能不熟悉
透過Adobe I/O Runtime SPA開發人員更熟悉 AEM開發人員必須透過allowProxy屬性
讓應用程式所需的Clientlib資源可供CSS和JavaScript等應用程式使用。資源必須在AEM和Adobe I/O Runtime
之間同步。若要啟用SPA的編寫,可能需要Adobe I/O Runtime的代理伺服器

SSR規劃

通常只需要轉換應用程式的一部分, 常見的範例是,在頁面初始載入時將顯示在折疊上方的內容需要轉譯為伺服器端。 如此可將已轉譯的內容傳送至用戶端,以節省時間。 當使用者與SPA互動時,用戶端會轉譯其他內容。

當您考慮為SPA實作伺服器端演算時,您需要檢閱應用程式中需要SSR的哪些部分。

使用SSR開發SPA

SPA元件可由用戶端(在瀏覽器中)或伺服器端轉譯。 在轉譯伺服器端時,瀏覽器屬性(例如視窗大小和位置)不存在。 因此,SPA元件應該是同構的,對於它們的渲染位置不作任何假設。

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

AEM中SPA的SSR

AEM中SSR的SPA需要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 Project Archetype,它支援使用React或Angular的SPA專案,並運用SPA SDK。

使用Node.js

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

對於On-Premesis 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配置

預設處理程式的配置必須按照 Remote Content Renderer Configuration一節中的說明進行配置。

遠端內容轉譯器使用

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

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

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

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

要求

Servlet運用Sling Model Exporter序列化元件資料。 依預設,com.adobe.cq.export.json.ContainerExportercom.adobe.cq.export.json.ComponentExporter都支援做為Sling Model適配器。 如有必要,您可以新增類,讓請求適用於使用RemoteContentRendererServlet並實作RemoteContentRendererRequestHandler#getSlingModelAdapterClasses。 其他類必須擴展ComponentExporter

本頁內容