使用SAPCommerce Cloud进行开发

该集成框架包含一个带有API的集成层。 这允许您：

• 插入电子商务系统并将产品数据拉入AEM
• 构建AEM组件，使其能够独立于特定的eCommerce引擎

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

• 产品展示组件
• 购物车
• 结帐

为了搜索，提供了一个集成挂钩，它允许您使用AEM搜索、电子商务系统的搜索、第三方搜索(如Search&Promote)或其组合。

电子商务引擎选择

电子商务框架可与任何电子商务解决方案一起使用，所使用的引擎需要由AEM进行识别：

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

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

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

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

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

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

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

  • 例如，cq:commerceProvider属性with the value hybris will correate to the OSGi configuration for Day CQ Commerce Factory for Hybris(com.adobe.cq.com.hymerce.impl.HybrisServiceFactory)-其中参数commerceProvider也有值hybris。

  • 在此可以配置其他属性，如​目录版本（如果适用并可用）。

请参阅以下示例：

示例

/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

Developing for hybris 4

The hybris extension of the eCommerce Integration Framework has beed updated to support Hybris 5, while maintaining backward compatibility with Hybris 4.

The default settings in the code are tuned for Hybris 5.

To develop for Hybris 4 the following is required:

• 调用maven时，将以下命令行参数添加到命令

  -P hybris4

  It downloads the pre-configured Hybris 4 distribution and embeds it in the bundle:

  cq-commerce-hybris-server
  

• 在OSGi配置管理器中：

  • 禁用Hybris 5支持Default Response Parser服务。
  • 确保Hybris Basic Authentication Handler服务的服务级别低于Hybris OAuth Handler服务。

会话处理

hybris uses a user session to store information such as the customer's shopping cart. The session id is returned from hybris in a JSESSIONID cookie that needs to be sent on theussend requests to hybris. 为避免将会话ID存储在存储库中，会话ID将编码到存储在购物者浏览器中的其他cookie中。 将执行以下步骤：

• 在第一个请求时，不会对购物者的请求设置cookie;so a request is sent to the hybris instance to create a session.
• 会话cookies从响应中提取，编码为新cookie（例如hybris-session-rest），并在对购物者的响应时进行设置。 新cookie中的编码是必需的，因为原始cookie仅对特定路径有效，否则在后续请求中不会从浏览器发回。 路径信息还必须添加到cookie的值中。
• 在后续请求中，cookies从hybris-session-<*xxx*> cookies中解码，并在用于从hybris请求数据的HTTP客户端上设置。

CommerceSession

• 此会话“拥有”购物车

  • 执行add/remove/etc

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

    commerceSession.getProductPrice(Product product)

• 拥有​order​数据的​存储位置

  CommerceSession.getUserContext()

• 还拥有​payment​处理连接

• 还拥有​履行​连接

产品同步和发布

Product data that is maintained in hybris needs to be available in AEM. 已实施以下机制：

• An initial load of IDs is provided by hybris as a feed. 此源可能有更新。
• hybris will supply update information via a feed(wish AEM pols)。
• 当AEM is using product data时，它将发送请求返回至hybris for the current data(conditional get request using last modified date)。
• On hybris is possible to specify feed contents in a declaporational way.
• 将供给结构映射到AEM内容模型会在AEM端的供给适配器中发生。

• 导入程序(b)用于AEM目录中页面树结构的初始设置。

• hybris中的目录更改通过源指示到AEM, thes propagate to AEM(b)

  • 与目录版本相关的产品已添加／删除／更改。
  • 已批准产品。

• The hybris extension provides a polling importer("hybris" scheme"), which can be configured to import changes into AEM at a specified interval(example, ever 24 hours where the interval is specified in seconds):

    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)的(de-)激活

  • 将产品添加到​联机​目录版本需要激活产品页面。
  • 删除产品需要取消激活。

• 在AEM©中激活页面需要选中(b)项，并且仅当

  • 该产品位于产品页面的​联机​目录版本中。
  • 引用的产品在​Online​目录版本中可用于其他页面(例如活动页面)。

• 已激活的产品页面需要访问产品数据的​在线​版本(d)。

• AEM publish instance requires access to hybris for the retrieval of product and personalized data(d)。

架构

产品和变体的架构

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

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

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

The product/variant resource does not always hold the actual product dataIt might be representation of data activally held on another system(such as 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 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执行add/remove/etc。
  • CommerceSession还在购物车上执行各种计算。"

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

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

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

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

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

存储

• 存储

  • In the hybris case, the hybris server owns the cart.
  • 在AEM-generic case购物车中，购物车存储在ClientContext中。

个性化

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

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

  • 应使用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修复：

       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，这些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假定为​仅 web前端，因此执行​所有​身份验证。

• Accounts in Hybris

  AEM creates a ecoped(下属)account in hybris for each shopper 此帐户的用户名与AEM用户名相同。 密码随机密码是自动生成并存储（加密）在AEM中的。

预存用户

AEM前端可定位在现有hybris实现的前面。 Asso a hybris engine can be added to an existing AEM installation. 为此，系统必须能够正常地处理任一系统中的现有用户：

• AEM -> hybris

  • 登录到hybris时，如果AEM user不已存在：

    • create new hybris user with a cryptographically random password
    • store hybris username in the user directory of the AEM user

  • 请参阅：com.adobe.cq.commerce.hybris.impl.HybrisSessionImpl#login()

• hybris -> AEM

  • 登录到AEM时，如果系统识别用户：

    • attemt log in to hybris with supplied username/pwd
    • 如果成功，请在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 {
    ...
}