使用SAPCommerce Cloud開發

整合架構包含具有API的整合層。 這可讓您：

• 插入電子商務系統，並將產品資料提取至AEM
• 針對商務功能建立AEM元件，不受特定電子商務引擎影響

提供許多現成可用的AEM元件以使用整合層。 目前包括：

• 產品顯示元件
• 購物車
• 結帳

為了搜索，提供了一個整合鈎子，它允許您使用AEM搜索、電子商務系統的搜索、第三方搜索(類似Search&Promote)或其組合。

電子商務引擎選擇

電子商務架構可與任何電子商務解決方案搭配使用，所使用的引擎需由AEM識別：

• 電子商務引擎是支援CommerceService介面的OSGi服務

  • 引擎可由commerceProvider服務屬性區分

• AEM支援CommerceService和Product的Resource.adaptTo()

  • adaptTo實作會在資源的階層中尋找cq:commerceProvider屬性：

    • 如果找到，則值會用來篩選商務服務查閱。
    • 若找不到，則會使用排名最高的商務服務。

  • 使用cq:Commerce mixin，可將cq:commerceProvider新增至強類型資源。

• cq:commerceProvider屬性還用於參考相應的商務工廠定義。

  • 例如，值hybris的cq:commerceProvider屬性將與​Day CQ Commerce Factory for Hybris(com.adobe.cq.com.hybris.impl.HybrisServiceFactory) — 其中參數commerceProvider也具有值hybris的OSGi配置相關。

  • 此處可以配置其他屬性，如​目錄版本（如果適當且可用）。

請參閱下列範例：

範例

/content/store
+ cq:commerceProvider = hybris
  + mens
    + polo-shirt-1
    + polo-shirt-2
    + employee
+ cq:commerceProvider = jcr
  + adobe-logo-shirt
    + cq:commerceType = product
    + price = 12.50
  + adobe-logo-shirt_S
    + cq:commerceType = variant
    + size = S
  + adobe-logo-shirt_XL
    + cq:commerceType = variant
    + size = XL
    + price = 14.50

為hybris 4開發

已更新電子商務整合架構的hybris擴充功能，以支援Hybris 5，同時維持與Hybris 4的向後相容性。

針對Hybris 5調整程式碼中的預設設定。

若要針對Hybris 4開發，需具備下列條件：

• 調用maven時，將以下命令行參數添加到命令中

  -P hybris4

  它會下載預先設定的Hybris 4發佈，並內嵌在套件中：

  cq-commerce-hybris-server
  

• 在OSGi配置管理器中：

  • 停用預設回應剖析器服務的Hybris 5支援。
  • 請確定Hybris Basic Authentication Handler服務的服務排名低於Hybris OAuth Handler服務。

會話處理

hybris使用使用者工作階段來儲存資訊，例如客戶的購物車。 工作階段ID會從JSESSIONID Cookie中的hybris傳回，而後續的hybris請求需要傳送該ID。 為了避免將工作階段ID儲存在存放庫中，會將其編碼至儲存在購物者瀏覽器中的其他Cookie中。 會執行下列步驟：

• 在第一個請求時，不會對購物者的請求設定Cookie;因此，會傳送要求至hybris例項以建立工作階段。
• 工作階段Cookie會從回應中擷取，並以新Cookie編碼（例如hybris-session-rest），並在對購物者的回應上設定。 新Cookie中的編碼為必要，因為原始Cookie僅對特定路徑有效，且在後續請求中不會從瀏覽器傳回。 路徑資訊也必須新增至Cookie的值。
• 在後續的請求中，會從hybris-session-<*xxx*> Cookie解碼Cookie，並設定在用於從Hybris請求資料的HTTP用戶端上。

商務會話

• 此會話「擁有」購物車

  • 執行添加/刪除等

  • 對購物車執行各種計算；

    commerceSession.getProductPrice(Product product)

• 擁有​order​資料的​儲存位置

  CommerceSession.getUserContext()

• 還擁有​payment​處理連接

• 還擁有​fulfillment​連接

產品同步和發佈

以hybris維護的產品資料必須可在AEM中使用。 已實施下列機制：

• hybris會以動態消息的形式提供ID的初始載入。 此摘要可能有更新。
• hybris將透過摘要(AEM輪詢)提供更新資訊。
• AEM使用產品資料時，會將要求傳回至目前資料的hybris（使用上次修改日期的條件式取得要求）。
• 在Hybris上，可以宣告性方式指定摘要內容。
• 將摘要結構對應至AEM內容模型會在AEM端的摘要適配器中發生。

• 匯入工具(b)用於目錄中AEM的頁面樹結構初始設定。

• hybris中的目錄變更會透過摘要指示給AEM，然後會傳播至AEM(b)

  • 針對目錄版本新增/刪除/變更產品。
  • 產品已核准。

• hybris擴充功能提供輪詢匯入工具（「hybris」配置」），此工具可設定為以指定間隔將變更匯入AEM(例如，每24小時指定間隔（以秒為單位）:

    http://localhost:4502/content/geometrixx-outdoors/en_US/jcr:content.json
     {
     * "jcr:mixinTypes": ["cq:PollConfig"],
     * "enabled": true,
     * "source": "hybris:outdoors",
     * "jcr:primaryType": "cq:PageContent",
     * "interval": 86400
     }
  

• AEM中的目錄配置可識別​Staged​和​Online​目錄版本。

• 在目錄版本之間同步產品時，需要（取消）啟動對應的AEM頁面(a、c)

  • 若要將產品新增至​Online​目錄版本，必須啟動產品的頁面。
  • 移除產品需要停用。

• 在AEM©中啟動頁面需要檢查(b)，且只有在

  • 產品位於產品頁面的​線上​目錄版本中。
  • 其他頁面（例如促銷活動頁面）的​線上​目錄版本中提供參考的產品。

• 已激活的產品頁需要訪問產品資料的​Online​版本(d)。

• AEM發佈例項需要存取hybris以擷取產品和個人化資料(d)。

架構

產品和變型的架構

單一產品可能有多種變化；例如，可能會因顏色和/或大小而異。 產品必須定義驅動變化的屬性；我們將這些​變體軸​定義。

但是，並非所有屬性都是變型軸。 變化也會影響其他屬性；例如，價格可能取決於規模。 購物者無法選取這些屬性，因此不視為變型軸。

每個產品和/或變體都由資源表示，因此會將1:1對應至儲存庫節點。 由此推論，特定產品和/或變體可通過其路徑唯一標識。

產品/變型資源不一定會保留實際產品資料。它可能是實際保留在其他系統（例如hybris）上的資料的表示。 例如，產品說明、定價等不會儲存在AEM中，而是從電子商務引擎即時擷取。

任何產品資源都可以用Product API表示。 產品API中的大部分呼叫都是變異專用的（雖然變異可能繼承來自上階的共用值），但也有列出變異集（getVariantAxes()、getVariants()等）的呼叫。

產品參考資料和產品資料

一般而言：

• 產品資料位於/etc下

• 和/content下的產品參考。

產品變異和產品資料節點之間必須有1:1對應。

產品參考也必須為呈現的每個變異包含一個節點，但不需要呈現所有變異。 例如，如果產品有S、M、L變數，則產品資料可能是：

etc
  commerce
    products
      shirt
        shirt-s
        shirt-m
        shirt-l

雖然「大而高」目錄可能只有：

content
  big-and-tall
    shirt
      shirt-l

最後，不需要使用產品資料。 您可以將所有產品資料放在目錄中的參考下；但是，如果不複製所有產品資料，就無法真正擁有多個目錄。

API

com.adobe.cq.commerce.api.Product介面

public interface Product extends Adaptable {

    public String getPath();            // path to specific variation
    public String getPagePath();        // path to presentation page for all variations
    public String getSKU();             // unique ID of specific variation

    public String getTitle();           // shortcut to getProperty(TITLE)
    public String getDescription();     // shortcut to getProperty(DESCRIPTION)
    public String getImageUrl();        // shortcut to getProperty(IMAGE_URL)
    public String getThumbnailUrl();    // shortcut to getProperty(THUMBNAIL_URL)

    public <T> T getProperty(String name, Class<T> type);

    public Iterator<String> getVariantAxes();
    public boolean axisIsVariant(String axis);
    public Iterator<Product> getVariants(VariantFilter filter) throws CommerceException;
}

com.adobe.cq.commerce.api.VariantFilter

/**
 * Interface for filtering variants and AxisFilter provided as common implementation
 *
 * The <code>VariantFilter</code> is used to filter variants,
 * e.g. when using {@link Product#getVariants(VariantFilter filter)}.
 */
public interface VariantFilter {
    public boolean includes(Product product);
}

/**
 * A {@link VariantFilter} for filtering variants by the given
 * axis and value. The following example returns a list of
 * variant products that have a value of <i>blue</i> on the
 * <i>color</i> axis.
 *
 * <p>
 * <code>product.getVariants(new AxisFilter("color", "blue"));</code>
 */
public class AxisFilter implements VariantFilter {

    private String axis;
    private String value;

    public AxisFilter(String axis, String value) {
        this.axis = axis;
        this.value = value;
    }

    /**
     * {@inheritDoc}
     */
    public boolean includes(Product product) {
        ValueMap values = product.adaptTo(ValueMap.class);

        if(values != null) {
            String v = values.get(axis, String.class);

            return v != null && v == value;
        }

        return false;
    }
}

• 一般儲存機制

  • 產品節點不是非結構化的。

  • 產品節點可以是：

    • 參考，其中產品資料儲存在其他位置：

      • 產品參考包含productData屬性，指向產品資料（通常位於/etc/commerce/products下）。
      • 產品資料是分層的；產品屬性繼承自產品資料節點的祖先。
      • 產品參考也可包含本機屬性，這會覆寫其產品資料中指定的屬性。

    • 產品本身：

      • 沒有productData屬性。
      • 在本地保留所有屬性（且不包含productData屬性）的產品節點會直接從自己的祖先繼承產品屬性。

• AEM — 一般產品結構

  • 每個變體都必須有自己的葉節點。
  • 產品介面既代表產品和變體，也代表相關存放庫節點，但節點是特定的。
  • 產品節點描述產品屬性和變型軸。

範例

+ banyan_shirt
    - cq:commerceType = product
    - cq:productAttributes = [jcr:title, jcr:description, size, price, color]
    - cq:productVariantAxes = [color, size]
    - jcr:title = Banyan Shirt
    - jcr:description = Flowery, all-cotton shirt.
    - price = 14.00
    + banyan_shirt_s
        - cq:commerceType = variant
        - size = S
        + banyan_shirt_s_red
            - cq:commerceType = variant
            - color = red
        + banyan_shirt_s_blue
            - cq:commerceType = variant
            - color = blue
    + banyan_shirt_m
        - cq:commerceType = variant
        - size = M
        + banyan_shirt_m_red
            - cq:commerceType = variant
            - color = red
        + banyan_shirt_m_blue
            - cq:commerceType = variant
            - color = blue
    + banyan_shirt_l
        - cq:commerceType = variant
        - size = L
        + banyan_shirt_l_red
            - cq:commerceType = variant
            - color = red
        + banyan_shirt_l_blue
            - cq:commerceType = variant
            - color = blue
    + banyan_shirt_xl
        - cq:commerceType = variant
        - size = XL
        - price = 18.00

購物車架構

元件

• 購物車歸CommerceSession:所有

  • CommerceSession執行add/remove/etc.
  • CommerceSession也會對購物車執行各種計算。"

• CommerceSession不直接與購物車相關，但還必須提供目錄定價資訊（因為它擁有定價）

  • 定價可能有幾個修改量：

    • 數量折扣。
    • 不同的貨幣。
    • 免增值稅和免增值稅。

  • 修飾元完全開放，介面如下：

    • int CommerceSession.getQuantityBreakpoints(Product product)
    • String CommerceSession.getProductPrice(Product product)

儲存

• 儲存

  • 在hybris案例中， hybris伺服器擁有購物車。
  • 在AEM-generic案例中，購物車儲存在ClientContext中。

個性化

• 個人化應一律透過ClientContext來驅動。

• 所有情況下，都會建立購物車的ClientContext/version/:

  • 應使用CommerceSession.addCartEntry()方法新增產品。

• 以下說明ClientContext車中的購物車資訊範例：

結帳架構

購物車和訂購資料

CommerceSession擁有三個元素：

1. 購物車內容

2. 定價

3. 訂單詳細資訊

4. 購物車內容

   購物車內容結構已由API修正：

       public void addCartEntry(Product product, int quantity);
       public void modifyCartEntry(int entryNumber, int quantity);
       public void deleteCartEntry(int entryNumber);
   

5. 定價

   API也會修正定價結構：

       public String getCartPreTaxPrice();
       public String getCartTax();
       public String getCartTotalPrice();
       public String getOrderShipping();
       public String getOrderTotalTax();
       public String getOrderTotalPrice();
   

6. 訂單詳細資料

   不過，訂單詳細資料是由API修正的​not:

       public void updateOrderDetails(Map<String, String> orderDetails);
       public Map<String, String> getOrderDetails();
       public void submitOrder();
   

運費計算

• 訂單通常需要提供多種運送選項（和價格）。

• 價格可能基於訂單的項目和詳細資訊，例如重量和/或交貨地址。

• CommerceSession可存取所有相依性，因此可以以與產品定價類似的方式處理：

  • CommerceSession擁有運費定價。
  • 可使用updateOrder(Map<String, Object> delta)擷取/更新傳送詳細資料

付款處理

• CommerceSession還擁有支付處理連接。
• 實作者需要將特定呼叫（至其選擇的付款處理服務）新增至CommerceSession實作。

訂單履行

• CommerceSession還擁有履行連接。
• 實作者需要將特定呼叫（加入其選擇的付款處理服務）新增至CommerceSession實作。

搜索定義

遵循標準服務API模型，電子商務專案提供一組可由個別商務引擎實作的搜尋相關API。

電子商務項目包含預設搜索元件，位於：

/libs/commerce/components/search

這利用搜尋API來查詢選取的商務引擎（請參閱電子商務引擎選取項目）:

搜尋API

核心專案提供數個一般/協助程式類別：

1. CommerceQuery

   用於描述搜索查詢（包含有關查詢文本、當前頁、頁面大小、排序和選定刻面的資訊）。 所有實作搜尋API的電子商務服務都會收到此類別的例項，以執行其搜尋。 可以從請求物件(HttpServletRequest)實例化CommerceQuery。

2. FacetParamHelper

   是實用程式類，提供一種靜態方法 — toParams -，用於從Facet清單和一個切換的值生成GET參數字串。 這在UI端很實用，您需要針對每個面向的每個值顯示超連結，這樣當使用者點按超連結時，就會切換個別值（亦即，如果選取了該值，則會從查詢中移除，否則會新增）。 這會處理處理多/單值Facet、覆寫值等的所有邏輯。

搜尋API的入口點是傳回CommerceResult物件的CommerceService#search方法。 如需本主題的詳細資訊，請參閱 API檔案。

用戶整合

AEM與各種電子商務系統之間提供整合。 這需要一種策略來同步不同系統之間的購物者，讓AEM專屬的程式碼只需知道AEM，反之亦然：

• 驗證

  AEM假定為​only web前端，因此會執行​all​驗證。

• Hybris帳戶

  AEM會為每個購物者以hybris建立對應（從屬）帳戶。 此帳戶的使用者名稱與AEM使用者名稱相同。 會自動產生密碼隨機密碼並儲存（加密）至AEM。

預存用戶

AEM前端可位於現有Hybris實作之前。 您也可以將hybris引擎新增至現有的AEM安裝。 要執行此操作，系統必須能夠正常處理任一系統中的現有用戶：

• AEM -> hybris

  • 登入hybris時，如果AEM使用者尚未存在：

    • 使用密碼隨機密碼建立新的hybris使用者
    • 將hybris使用者名稱儲存在AEM使用者的使用者目錄中

  • 請參閱: com.adobe.cq.commerce.hybris.impl.HybrisSessionImpl#login()

• hybris -> AEM

  • 登入AEM時，如果系統辨識到使用者：

    • 嘗試使用提供的用戶名/pwd登錄hybris
    • 如果成功，請在AEM中使用相同密碼建立新使用者(AEM專屬的salt會產生AEM專屬的雜湊)

  • 以上演算法是在Sling AuthenticationInfoPostProcessor中實作

    • 請參閱: com.adobe.cq.commerce.hybris.impl.user.LazyUserImporter.java

自定義導入進程

若要在現有功能基礎上建置自訂匯入處理常式：

• 必須實作ImportHandler介面

• 可以擴展DefaultImportHandler

/**
 * Services implementing the <code>ImportHandler</code> interface are
 * called by the {@link HybrisImporter} to create actual commerce entities
 * such as products.
 */
public interface ImportHandler {

    /**
     * Not used.
     */
    public void createTaxonomie(ImporterContext ctx);

    /**
     * Creates a catalog with the given name.
     * @param ctx   The importer context
     * @param name  The catalog's name
     * @return Path of created catalog
     */
    public String createCatalog(ImporterContext ctx, String name) throws Exception;

    /**
     * Creates a product from the given values.
     * @param ctx                The importer context
     * @param values             The product's properties
     * @param parentCategoryPath The containing category's path
     * @return Path of created product
     */
    public String createProduct(ImporterContext ctx, ValueMap values, String parentCategoryPath) throws Exception;

    /**
     * Creates a variant product from the given values.
     * @param ctx             The importer context
     * @param values          The product's properties
     * @param baseProductPath The base product's path
     * @return Path of created product
     */
    public String createVariantProduct(ImporterContext ctx, ValueMap values, String baseProductPath) throws Exception;

    /**
     * Creates an asset for a product. This is usually a product
     * image.
     * @param ctx             The importer context
     * @param values          The product's properties
     * @param baseProductPath The product's path
     * @return Path of created asset
     */
    public String createAsset(ImporterContext ctx, ValueMap values, String productPath) throws Exception;

    /**
     * Creates a category from the given values.
     * @param ctx           The importer context
     * @param values        The category's properties
     * @param parentPath    Path of parent category or base path of import in case of root category
     * @return Path of created category
     */
    public String createCategory(ImporterContext ctx, ValueMap values, String parentCategoryPath) throws Exception;
}

匯入工具必須指定值大於0的service.ranking屬性，以讓您的自訂處理常式可供識別；例如：

@Component
@Service
@Property(name = "service.ranking", value = 100)
public class MyImportHandler extends DefaultImportHandler {
    ...
}