SPA 藍圖 spa-blueprint

若要讓作者能夠使用AEM SPA編輯器來編輯SPA的內容，SPA必須滿足幾項要求。

簡介 introduction

本檔案說明任何SPA架構都應該履行的一般合約(即AEM支援層的型別)，以便您在AEM中實作可編輯的SPA元件。

若要讓作者能使用AEM頁面編輯器來編輯單頁應用程式架構所公開的資料，專案必須能夠解譯代表為AEM存放庫中應用程式儲存之資料語意的模型結構。 為了達成此目標，提供了兩個與架構無關的資料庫： PageModelManager和ComponentMapping。

PageModelManager pagemodelmanager

PageModelManager程式庫是以NPM封裝的形式提供，以供SPA專案使用。 它可與SPA搭配使用，並作為資料模型管理員。

它會代表SPA抽象化代表實際內容結構的JSON結構的擷取和管理。 此外也負責與SPA同步，以便在必須重新呈現元件時通知。

檢視NPM套件@adobe/aem-spa-model-manager

初始化PageModelManager時，程式庫會先載入應用程式提供的根模型（透過引數、中繼屬性或目前的URL）。 如果元件庫識別目前頁面的模型不是其擷取的根模型的一部分，並包含它作為子頁面的模型。

元件對應 componentmapping

ComponentMapping模組是以NPM封裝形式提供給前端專案。 它會儲存前端元件，並提供SPA將前端元件對應至AEM資源型別的方法。 如此一來，在剖析應用程式的JSON模型時，就能啟用元件的動態解析。

模型中每個專案都包含公開AEM資源型別的:type欄位。 掛載時，前端元件可使用從基礎程式庫收到的模型片段來轉譯自身。

動態模型到元件對應 dynamic-model-to-component-mapping

如需如何在AEM的JavaScript SPA SDK中發生動態模型到元件對應的詳細資訊，請參閱文章SPA的動態模型到元件對應。

框架特定層 framework-specific-layer

必須為每個前端框架實作第三層。 此第三個程式庫負責與基礎程式庫互動，並提供一系列整合良好且簡單易用的入口點，以便與資料模型互動。

本檔案的其餘部分說明此中介架構特定層的需求，並渴望與架構無關。 遵循下列需求，即可為專案元件提供架構專用層，以便與負責管理資料模型的基礎程式庫互動。

一般概念 general-concepts

頁面模型 page-model

頁面的內容結構儲存在AEM中。 頁面模型可用來對應及例項化SPA元件。 SPA開發人員建立對應至SPA元件的AEM元件。 為此，它們使用資源型別(或AEM元件的路徑)作為唯一索引鍵。

SPA元件必須和頁面模型同步，並更新以相應地變更其內容。 使用動態元件的陣列必須用來按照提供的頁面模型結構即時例項化元件。

中繼欄位 meta-fields

頁面模型使用JSON模型匯出程式，其本身是以Sling模型 API為基礎。 可匯出的Sling模型會顯示下列欄位清單，以啟用基礎程式庫來解譯資料模型：

另請參閱AEM Content Services快速入門。

框架特定模組 framework-specific-module

區隔關注點有助於促進專案實施。 因此，應該提供npm專屬套件。 此套件負責彙總及公開基本模組、服務和元件。 這些元件必須封裝資料模型管理邏輯，並提供專案元件所預期資料的存取權。 此模組也負責暫時公開基礎程式庫的實用進入點。

為了促進程式庫的互通性，Adobe建議框架特定的模組將下列程式庫捆綁。 如有必要，圖層可以在將底層API公開至專案之前，先進行封裝和調整。

實作 implementations

React react

npm模組： @adobe/aem-react-editable-components

angular angular

npm模組： @adobe/aem-angular-editable-components

主要服務與元件 main-services-and-components

下列實體應根據每個框架的特定准則進行實施。 根據框架架構，實作可能會有很大的差異，但必須提供所描述的功能。

模型提供者 the-model-provider

專案元件必須將模型片段的存取權委派給模型提供者。 然後，模型提供者會負責監聽對模型的指定片段所做的變更，並將更新的模型傳回委派元件。

為此，模型提供者必須向PageModelManager註冊。 然後當變更發生時，它會接收更新後的資料並傳遞至委派元件。 根據慣例，可用於將承載模型片段的委派元件的屬性名為cqModel。 實作可免費為元件提供此屬性，但應考量與框架架構整合、可發現性和易用性等層面。

元件HTML裝飾器 the-component-html-decorator

「元件裝飾器」負責以「頁面編輯器」所預期的一系列資料屬性和類別名稱，裝飾每個元件例項之元素的外部HTML。

元件宣告 component-declaration

下列中繼資料必須新增至專案元件產生的外部HTML元素。 它們可讓頁面編輯器擷取對應的編輯設定。

編輯功能宣告和預留位置 editing-capability-declaration-and-placeholder

下列中繼資料和類別名稱必須新增至專案元件產生的外部HTML元素。 它們可讓頁面編輯器提供相關功能。

空白元件的​ 預留位置

每個元件都必須延伸使用功能，以便在將元件識別為空白時，使用預留位置專用的資料屬性和類別名稱以及相關覆蓋來裝飾外部HTML元素。

關於元件的空白

容器 container

容器是用來包含和轉譯子元件的元件。 若要這麼做，容器會反複執行其模型的:itemsOrder、:items和:children屬性。

容器會從ComponentMapping資料庫的存放區動態取得子元件。 容器接著會使用「模型提供者」功能擴充子元件，最後例項化它。

頁面 page

Page元件會擴充Container元件。 容器是用來包含和轉譯子元件（包括子頁面）的元件。 若要這麼做，容器會反複執行其模型的:itemsOrder、:items和:children屬性。 Page元件會從ComponentMapping資料庫的存放區動態取得子元件。 Page負責具現化子元件。

回應式格線 responsive-grid

回應式格線元件是容器。 它包含模型提供者的特定變體，代表其欄。 回應式格線及其欄負責以模型中所包含的特定類別名稱裝飾專案元件的外部HTML元素。

回應式格線元件應預先對應至其AEM對應元件，因為此元件很複雜且很少自訂。

特定模型欄位 specific-model-fields

另請參閱npm資源@adobe/aem-react-editable-components

回應式格線的預留位置 placeholder-of-the-responsive-grid

SPA元件會對應至圖形容器（例如回應式格線），且必須在編寫內容時新增虛擬子預留位置。 當頁面編輯器正在編寫SPA的內容時，該內容會使用iframe嵌入到編輯器中，並且data-cq-editor屬性會新增到該內容的檔案節點中。 當data-cq-editor屬性出現時，容器必須包含HTMLElement，以代表將新元件插入頁面時，作者互動的區域。

例如：

<div data-cq-data-path={"path/to/the/responsivegrid/*"} className="new section aem-Grid-newComponent"/>

元件對應 component-mapping

基礎的Component Mapping程式庫及其MapTo函式可以封裝和延伸，以提供與目前元件類別隨附的編輯組態相關的函式。

const EditConfig = {

    emptyLabel: 'My Component',

    isEmpty: function() {
        return !this.props || !this.props.cqModel || this.props.cqModel.isEmpty;
    }
};

class MyComponent extends Component {

    render() {
        return <div className={'my-component'}></div>;
    }
}

MapTo('component/resource/path')(MyComponent, EditConfig);

在上述實作中，專案元件會在元件對應存放區中實際登入之前，先以空白功能擴充。 這是透過封裝和擴充ComponentMapping程式庫來完成，以引入EditConfig設定物件的支援：

/**
 * Configuration object in charge of providing the necessary data expected by the page editor to initiate the authoring. The provided data is decorating the associated component
 *
 * @typedef {{}} EditConfig
 * @property {String} [dragDropName]       If defined, adds a specific class name enabling the drag and drop functionality
 * @property {String} emptyLabel           Label to be displayed by the placeholder when the component is empty. Optionally returns an empty text value
 * @property {function} isEmpty            Should the component be considered empty. The function is called using the context of the wrapper component giving you access to the component model
 */

/**
 * Map a React component with the given resource types. If an {@link EditConfig} is provided the <i>clazz</i> is wrapped to provide edition capabilities on the AEM Page Editor
 *
 * @param {string[]} resourceTypes                      - List of resource types for which to use the given <i>clazz</i>
 * @param {class} clazz                                 - Class to be instantiated for the given resource types
 * @param {EditConfig} [editConfig]                     - Configuration object for enabling the edition capabilities
 * @returns {class}                                     - The resulting decorated Class
 */
ComponentMapping.map = function map (resourceTypes, clazz, editConfig) {};

與頁面編輯器訂約 contract-with-the-page-editor

專案元件必須至少產生下列資料屬性，才能讓編輯器與其互動。

簡而言之，若要由頁面編輯器解譯為可編輯，專案元件必須符合下列合約：

典型HTML元素結構 typical-html-element-structure

以下片段說明頁面內容結構的典型HTML表示法。 以下是一些重要事項：

<div data-cq-data-path="/content/page">
    <div class="aem-Grid aem-Grid--12 aem-Grid--default--12">
        <div class="aem-container aem-GridColumn aem-GridColumn--default--12" data-cq-data-path="/content/page/jcr:content/root/responsivegrid">
            <div class="aem-Grid aem-Grid--12 aem-Grid--default--12">
                <div class="cmp-image cq-dd-image aem-GridColumn aem-GridColumn--default--12" data-cq-data-path="/root/responsivegrid/image">
                    <img src="/content/we-retail-spa-sample/react/jcr%3acontent/root/responsivegrid/image.img.jpeg/1512113734019.jpeg">
                </div>
            </div>
        </div>
    </div>
</div>

導覽與路由 navigation-and-routing

應用程式擁有路由。 前端開發人員必須先實作導覽元件(對應至AEM導覽元件)。 此元件會轉譯URL連結，以便搭配顯示或隱藏內容片段的一系列路由使用。

基礎PageModelManager程式庫及其ModelRouter模組（預設為啟用）負責預先擷取並提供與指定資源路徑關聯之模型的存取權。

這兩個實體與路由的概念有關，但ModelRouter只負責以與目前應用程式狀態同步的結構化資料模型載入PageModelManager。

如需詳細資訊，請參閱文章SPA模型路由。

SPA運作中 spa-in-action

繼續下列檔案，自行瞭解簡單SPA的運作和實驗SPA：

延伸閱讀 further-reading

如需AEM中SPA的詳細資訊，請參閱下列檔案：