正在开发（一般）

该集成框架包含一个带有API的集成层。 这允许您为电子商务功能（独立于您的特定电子商务引擎）构建AEM组件。 它还允许您使用内部CRX数据库或插入电子商务系统并将产品数据拉入AEM。

提供了许多现成的AEM组件以使用集成层。 目前有：

• 产品显示组件
• 购物车
• Promotions and vouchers
• 目录和章节蓝图
• 结帐
• 搜索

为了搜索，提供了集成挂钩，它允许您使用AEM搜索、第三方搜索(如Search&Promote)或其组合。

电子商务引擎选择

电子商务框架可以与任何电子商务解决方案一起使用，所使用的引擎需要由AEM进行标识——即使使用AEM通用引擎时也是如此：

• 电子商务引擎是支持CommerceService接口的OSGi服务

  • 引擎可由commerceProvider服务属性进行区分

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

  • adaptTo实现在资源的层次结构中查找cq:commerceProvider属性：

    • 如果找到，则使用该值过滤商务服务查找。
    • 如果找不到，则使用排名最高的商务服务。

  • 使用cq:Commerce混音，以便将cq:commerceProvider添加到强类型资源。

• cq:commerceProvider属性还用于引用相应的商务工厂定义。

  • 例如，具有值geometrixx的cq:commerceProvider属性将与​Day CQ Commerce Factory for Outdoors(com.adobe.cq.commerce.hybris.impl.GeoCommerceServiceFactory)的OSGi配置相关联，其中参数commerceProvider也具有值geometrixx。
  • 此处还可以配置其他属性（如果适用并可用）。

在标准AEM安装中，需要特定实施，例如：

cq:commerceProvider = geometrixx	geometrixx示例；这包括通用API的最小扩展

示例

/etc/commerce/products/geometrixx-outdoors 
+ cq:commerceProvider = geometrixx 
  + 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

会话处理

用于存储与客户购物车相关信息的会话。

CommerceSession:

• 拥有​购物车

  • 执行add/remove/etc

  • 在购物车上执行各种计算；

    commerceSession.getProductPriceInfo(Product product, Predicate filter)

• 拥有​order​数据的持久性：

  CommerceSession.getUserContext()

• 可以使用updateOrder(Map<String, Object> delta)检索／更新投放详细信息

• 还拥有​payment​处理连接

• 还拥有​履行​连接

架构

产品和变体的架构

一个产品可以有多个变体；例如，它可能因颜色和／或大小而异。 产品必须定义驱动变化的属性；我们将这些​变型轴​定为术语。

但是，并非所有属性都是变型轴。 变化也会影响其他属性；例如，价格可能取决于大小。 Thesper properties cannot be selected by the shopper, and eso not be consured to variant axes.

每个产品和／或变体由资源表示，因此将1:1映射到存储库节点。 由此推论，特定产品和／或变体可以通过其路径唯一标识。

任何产品资源都可以用Product API表示。 产品API中的大多数调用都是特定于变体的（尽管变体可能继承祖先的共享值），但也有与变体集（getVariantAxes()、getVariants()等）列表的调用。

产品引用和PIM数据

一般而言：

• PIM数据位于/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 interface

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-generic产品结构

  • 每个变体必须有其自己的叶节点。
  • 产品界面表示产品和变型，但相关存储库节点特定于它。
  • 产品节点描述产品属性和变型轴。

示例

+ 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执行添加、删除等操作。
  • CommerceSession还在购物车上执行各种计算。
  • CommerceSession还将已触发的优惠券和促销应用到购物车。

• 虽然不直接与购物车相关，CommerceSession还必须提供目录定价信息（因为它拥有定价）

  • 定价可能包含多个修改量：

    • 数量折扣。
    • 不同货币。
    • 增值税免税。

  • 修饰符完全开放，具有以下界面：

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

存储

• 存储

  • 在AEM-generic case购物车中，购物车存储在ClientContext中

个性化

• 个性化应始终通过ClientContext来驱动。

• AClientContext/version/ of the cart is created in all cases:

  • 应使用CommerceSession.addCartEntry()方法添加产品。

• 以下说明了ClientContext车中购物车信息的示例：

结帐的架构

购物车和订购数据

CommerceSession拥有三个元素：

1. 购物车内容

   购物车内容模式由API修复：

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

2. 定价

   定价模式也由API修复：

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

3. 订单详细信息

   但是，订单详细信息​不​由API修复：

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

发运计算

• 订购表单通常需要提供多种送货方式（和价格）。

• 价格可能基于订单的项目和详细信息，如权重和／或投放地址。

• CommerceSession可以访问所有依赖项，因此可以采用与产品定价类似的方式处理它：

  • CommerceSession拥有送货价格。
  • 使用updateOrder(Map<String, Object> delta)检索／更新投放详细信息。

搜索定义

遵循标准服务API模型，电子商务项目提供一组与搜索相关的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文档。

开发促销和优惠券

• 优惠券:

  • A Voucher是使用网站控制台创建／编辑并存储在以下位置的基于页面的组件：

    /content/campaigns

  • Vouchers supply:

    • A voucher code(to be typed into the cart by the shopper)。
    • A voucher label(to be displayed after the shopper has entered it into the cart)。
    • A promotion path(which defines the action the voucher applies)。

  • 凭证没有其自己的开／关日期／时间，但使用其父活动的凭证。

  • 外部商务引擎还可以提供凭证；这些要求至少：

    • 优惠券代码
    • isValid()方法

  • 凭证​组件(/libs/commerce/components/voucher)提供：

    • 凭证管理的呈现器；这显示购物车中当前的所有凭证。
    • 用于管理（添加／删除）凭证的编辑对话框（表单）。
    • 添加／删除凭证至购物车／从购物车所需的操作。

• 促销活动:

  • 促销是使用网站控制台创建／编辑并存储在以下位置的基于页面的组件：

    /content/campaigns

  • 促销供应：

    • 优先级
    • 升级处理程序路径

  • 您可以将促销活动连接到活动以定义其开／关日期／时间。

  • 您可以将促销活动与体验关联，以定义其区段。

  • 未连接到体验的促销将不会自行触发，但仍可由Voucher触发。

  • 升级组件(/libs/commerce/components/promotion)包含：

    • promotion administration的renderers和dialogs
    • 用于渲染和编辑特定于升级处理程序的配置参数的子组件

  • 两个升级处理程序现已提供：

    • DiscountPromotionHandler，它应用购物车宽的绝对或百分比折扣
    • PerfectPartnerPromotionHandler，如果合作伙伴产品也在购物车中，则应用产品绝对或百分比折扣

  • ClientContextSegmentMgr解析区段，ClientContextCartMgr解析促销。 将触发每个受至少一个已解析区段约束的促销。

    • Fired Promotions are sent back to the server an AJAX call to re-calculate the cart.
    • Fired Promotions(and added Vouchers)也显示在ClientContext面板中。

通过CommerceSession API完成从购物车中添加／删除优惠券：

/**
 * Apply a voucher to this session's cart.
 * 
 * @param code the voucher's code
 * @throws CommerceException
 */
public void addVoucher(String code) throws CommerceException;

/**
 * Remove a voucher that was previously added with {@link #addVoucher(String)}.
 * 
 * @param code the voucher's code
 * @throws CommerceException
 */
public void removeVoucher(String code) throws CommerceException;

/**
 * Get a list of vouchers that were added to this cart via {@link #addVoucher(String)}.
 * 
 * @throws CommerceException
 */
public List<Voucher> getVouchers() throws CommerceException;

这样，CommerceSession负责检查凭证是否存在以及是否可以应用凭证。 这可能适用于仅在满足特定条件时才能应用的凭证；例如，当总购物车价格大于$100时)。 如果凭证因任何原因无法应用，addVoucher方法将引发异常。 此外，CommerceSession负责在添加／删除凭证后更新购物车的价格。

Voucher是类似Bean的类，它包含以下字段：

• 凭证代码
• 简短描述
• 引用指示折扣类型和值的相关促销

提供的AbstractJcrCommerceSession可以应用凭证。 类getVouchers()返回的凭证是cq:Page的实例，其中包含具有以下属性的jcr:content节点（等等）:

• sling:resourceType （字符串）-这需要 commerce/components/voucher

• jcr:title （字符串）-用于凭证的说明

• code （字符串）-用户必须输入以应用此凭证的代码

• promotion （字符串）-要应用的促销；例如， /content/campaigns/geometrixx-outdoors/article/10-bucks-off

促销处理程序是修改购物车的OSGi服务。 购物车将支持在PromotionHandler接口中定义的多个挂钩。

/**
 * Apply promotion to a cart line item. The method returns a discount
 * <code>PriceInfo</code> instance or <code>null</code> if no discount
 * was applied.
 * @param commerceSession The commerce session
 * @param promotion The configured promotion
 * @param cartEntry The cart line item
 * @return A discounted <code>PriceInfo</code> or <code>null</code>
 */
public PriceInfo applyCartEntryPromotion(CommerceSession commerceSession, 
                                         Promotion promotion, CartEntry cartEntry) 
    throws CommerceException;

/**
 * Apply promotion to an order. The method returns a discount
 * <code>PriceInfo</code> instance or <code>null</code> if no discount
 * was applied.
 * @param commerceSession The commerce session
 * @param promotion The configured promotion
 * @return A discounted <code>PriceInfo</code> or <code>null</code>
 */
public PriceInfo applyOrderPromotion(CommerceSession commerceSession, Promotion promotion) 
    throws CommerceException;

public PriceInfo applyShippingPromotion(CommerceSession commerceSession, Promotion promotion) 
    throws CommerceException;

/**
 * Allows a promotion handler to define a custom, author-oriented message for a promotion.
 * The {@link com.adobe.cq.commerce.common.promotion.PerfectPartnerPromotionHandler}, for instance,
 * uses this to list the qualifying pairs of products in the current cart.
 * @param commerceSession
 * @param promotion
 * @return A message to display
 * @throws CommerceException
 */
public String getMessage(SlingHttpServletRequest request, CommerceSession commerceSession, Promotion promotion) throws CommerceException;

/**
 * Informs the promotion handler that something under the promotions root has been edited, and the handler
 * should invalidate any caches it might be keeping.
 */
public void invalidateCaches();

提供了三个现成的升级处理程序：

• DiscountPromotionHandler 应用购物车范围的绝对或百分比折扣
• PerfectPartnerPromotionHandler 如果产品合作伙伴也在购物车中，则应用产品绝对或百分比折扣
• FreeShippingPromotionHandler 应用免费送货