使用SAPCommerce Cloud进行开发 developing-with-sap-commerce-cloud

NOTE
电子商务框架可与任何电子商务解决方案一起使用。 此处处理的特定细节和示例请参阅hybris解决方案。

集成框架包括带有API的集成层。 这允许您:

  • 插入电子商务系统并将产品数据提取到Adobe Experience Manager (AEM)

  • 为独立于特定电子商务引擎的商务功能构建AEM组件

chlimage_1-11

NOTE
API文档也可用。

提供了多个现成的AEM组件以使用集成层。 目前,这些方法包括:

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

对于搜索,提供了一个集成挂接,允许您使用AEM搜索、电子商务系统搜索、第三方搜索或它们的组合。

电子商务引擎选择 ecommerce-engine-selection

电子商务框架可与任何电子商务解决方案一起使用,使用的引擎必须由AEM识别:

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

    • 可以使用commerceProvider服务属性区分引擎
  • AEM支持CommerceServiceProductResource.adaptTo()

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

      • 如果找到,该值将用于筛选Commerce服务查找。

      • 如果未找到,则使用排名最高的商务服务。

    • 已使用cq:Commerce mixin,以便将cq:commerceProvider添加到强类型资源。

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

    • 例如,值为hybriscq:commerceProvider属性与​ Day CQ Commerce Factory for Hybris (com.adobe.cq.commerce.hybris.impl.HybrisServiceFactory)的OSGi配置相关联,其中参数commerceProvider也具有值hybris

    • 此处可以配置其他属性,如​ 目录版本(在适当且可用时)。

请参阅以下示例:

cq:commerceProvider = geometrixx
在标准AEM安装中,需要特定实施。 例如,Geometrixx示例,其中包括通用API的最小扩展
cq:commerceProvider = hybris
hybris实现

示例 example

/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
NOTE
通过使用CRXDE Lite,您可以看到在hybris实施的产品组件中如何处理这种情况:
/apps/geometrixx-outdoors/components/hybris/product/product.jsp

为hybris 4开发 developing-for-hybris

更新了eCommerce Integration Framework的hybris扩展,以支持Hybris 5,同时保持与Hybris 4的向后兼容性。

代码中的默认设置是针对Hybris 5调整的。

要为Hybris 4开发,需要满足以下条件:

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

    -P hybris4

    它下载预配置的Hybris 4分发并将其嵌入到捆绑包cq-commerce-hybris-server中。

  • 在OSGi配置管理器中:

    • 禁用对默认响应分析器服务的Hybris 5支持。

    • 确保Hybris基本身份验证处理程序服务的服务排名低于Hybris OAuth处理程序服务。

会话处理 session-handling

hybris使用用户会话来存储信息,如客户的购物车。 会话ID从JSESSIONID Cookie中的hybris返回,该Cookie必须在后续请求中发送到hybris。 为了避免将会话id存储在存储库中,会将其编码到购物者的浏览器中存储的另一个Cookie中。 执行以下步骤:

  • 在第一个请求中,购物者的请求未设置Cookie;因此会向hybris实例发送请求以创建会话。

  • 会话Cookie是从响应中提取的,编码在新的Cookie中(例如,hybris-session-rest),并在对购物者的响应中设置。 新Cookie中的编码是必需的,因为原始Cookie仅对特定路径有效,否则在后续请求中不会从浏览器发送回。 必须将路径信息添加到Cookie的值中。

  • 在后续请求中,将从hybris-session-<*xxx*> Cookie中解码Cookie,并在用于从Hybris请求数据的HTTP客户端上设置这些Cookie。

NOTE
当原始会话不再有效时,将创建一个新的匿名会话。

CommerceSession commercesession

  • 此会话“拥有”购物车

    • 执行添加/删除/等

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

      commerceSession.getProductPrice(Product product)

  • 拥有​ 订单 ​数据的​ 存储位置

    CommerceSession.getUserContext()

  • 拥有​ 付款 ​处理连接

  • 拥有​ 履行 ​连接

产品同步和发布 product-synchronization-and-publishing

在Hybris中维护的产品数据必须在AEM中可用。 已实施以下机制:

  • ID的初始加载由hybris作为馈送提供。 此信息源可能有更新。
  • hybris通过信息源(AEM轮询)提供更新信息。
  • 当AEM使用产品数据时,它会向hybris发送有关当前数据的请求(使用上次修改日期的条件get请求)。
  • 在Hybris上,可以声明方式指定馈送内容。
  • 将馈送结构映射到AEM内容模型会在AEM端的馈送适配器中进行。

chlimage_1-12

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

  • hybris中的目录更改通过信息源指示给AEM,然后传播到AEM (b)

    • 添加/删除/更改了有关目录版本的产品。

    • 产品已批准。

  • hybris扩展提供了一个轮询导入程序(“hybris”方案),可以将其配置为按指定的时间间隔(例如,每24小时将更改导入AEM,其中时间间隔以秒为单位):

    code language-javascript
        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中的目录配置可识别​ 暂存 ​和​ 联机 ​目录版本。

  • 在目录版本之间同步产品需要激活或停用相应的AEM页面(a、c)

    • 将产品添加到​ Online ​目录版本需要激活产品页面。

    • 删除产品需要停用。

  • 在AEM ©中激活页面需要选中(b),并且仅当满足以下条件时才能激活

    • 产品位于产品页面的​ Online ​目录版本中。

    • 引用的产品可用于其他页面(如促销活动页面)的​ Online ​目录版本中。

  • 激活的产品页面必须访问产品数据的​ 联机 ​版本(d)。

  • AEM Publish实例需要访问hybris以检索产品和个性化数据(d)。

架构 architecture

产品和变体的架构 architecture-of-product-and-variants

单个产品可以有多个变体;例如,它可能因颜色和/或大小而异。 产品必须定义哪些属性驱动变体;Adobe词这些​ 变体轴

但是,并非所有属性都是变量轴。 变体也可能会影响其他属性;例如,价格可能取决于大小。 购物者无法选择这些属性,因此不被视为变量轴。

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

产品/变型资源并不总是包含实际产品数据。 它可能是其他系统(如hybris)上保留的数据的表示形式。 例如,产品描述和定价不会存储在AEM中,而是从电子商务引擎中实时检索。

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

NOTE
实际上,变量轴由Product.getVariantAxes()返回的任何值确定:
  • hybris为hybris实现定义它
虽然产品(通常)可以具有多个变体轴,但现成的产品组件仅处理两个变体轴:
  1. size

  2. 再加一个

通过产品引用的variationAxis属性选择此附加变体(通常Geometrixx Outdoors为color)。

产品引用和产品数据 product-references-and-product-data

通常,产品数据位于/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接口 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 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,
 * for example, 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;
    }
}
  • 常规存储机制

    • 产品节点为nt:unstructured

    • 产品节点可以是:

      • 引用,将产品数据存储在其他位置:

        • 产品引用包含productData属性,该属性指向产品数据(通常在/etc/commerce/products下)。

        • 产品数据是分层的;产品属性继承自产品数据节点的祖先。

        • 产品引用还可以包含本地属性,这些属性将覆盖产品数据中指定的属性。

      • 产品本身:

        • 没有productData属性。

        • 在本地保存所有属性(并且不包含productData属性)的product节点直接从自己的祖先继承product属性。

  • AEM-generic产品结构

    • 每个变体必须具有自己的叶节点。

    • 产品界面既表示产品,又表示变体,但相关的存储库节点特定于它。

    • product节点描述产品属性和变体轴。

示例 example-1

+ 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

购物车的架构 architecture-of-the-shopping-cart

组件

  • 购物车属于CommerceSession:

    • CommerceSession执行添加或删除等操作。
    • CommerceSession还在购物车上执行各种计算。"
  • 虽然不直接与购物车相关,但CommerceSession还必须提供目录定价信息(因为它拥有定价)

    • 定价可能有几个修饰符:

      • 数量折扣。
      • 不同的货币。
      • 应缴纳增值税且免纳增值税。
    • 修饰符是开放的,接口如下:

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

存储

  • 存储

    • 在hybris示例中,hybris服务器拥有购物车。
    • 在AEM一般情况下,购物车存储在ClientContext中。

个性化

  • 始终通过ClientContext推动个性化。

  • 在所有情况下都将创建购物车的ClientContext/version/

    • 应使用CommerceSession.addCartEntry()方法添加产品。
  • 下面说明了ClientContext车中的购物车信息示例:

chlimage_1-13

结账的架构 architecture-of-checkout

购物车和订单数据

CommerceSession拥有三个元素:

  1. 购物车内容

  2. 定价

  3. 订单详细信息

  4. 购物车内容

    购物车内容架构由API修复:

    code language-java
    public void addCartEntry(Product product, int quantity);
    public void modifyCartEntry(int entryNumber, int quantity);
    public void deleteCartEntry(int entryNumber);
    
  5. 定价

    定价模式也由API修复:

    code language-java
    public String getCartPreTaxPrice();
    public String getCartTax();
    public String getCartTotalPrice();
    public String getOrderShipping();
    public String getOrderTotalTax();
    public String getOrderTotalPrice();
    
  6. 订单详细信息

    但是,订单详细信息​ 不是API修复的

    code language-java
    public void updateOrderDetails(Map<String, String> orderDetails);
    public Map<String, String> getOrderDetails();
    public void submitOrder();
    

配送计算

  • 订单通常必须提供多种送货选项(和价格)。

  • 价格可能基于物料和订单详细信息,如重量和/或交货地址。

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

    • CommerceSession拥有配送定价。
    • 可使用updateOrder(Map<String, Object> delta)检索/更新投放详细信息
NOTE
您可以实施送货选择器;例如:
yourProject/commerce/components/shippingpicker
  • 这基本上可以是foundation/components/form/radio的副本,但是具有对CommerceSession的回调:

  • 检查方法是否可用

  • 添加定价信息

  • 允许购物者在AEM中更新订单页面(包括配送方法的超集以及描述这些方法的文本),同时仍具有公开相关CommerceSession信息的控制权。

付款处理

  • CommerceSession还拥有付款处理连接。

  • 实施人员应将特定调用(添加到其选择的付款处理服务)添加到CommerceSession实施。

订单履行

  • CommerceSession还拥有履行连接。
  • 实施人员必须将特定调用(添加到其选择的付款处理服务)添加到CommerceSession实施。

搜索定义 search-definition

遵循标准服务API模型,电子商务项目提供一组搜索相关的API,它们可以由商业引擎实现。

NOTE
目前,只有hybris引擎可开箱即用地实施搜索API。
但是,搜索API是通用的,可以由每个CommerceService单独实施。

电子商务项目包含以下位置中的默认搜索组件:

/libs/commerce/components/search

chlimage_1-14

这将使用搜索API查询选定的商务引擎(请参阅电子商务引擎选择):

搜索API search-api

核心项目提供了几个通用/帮助程序类:

  1. CommerceQuery

    描述搜索查询(包含有关查询文本、当前页面、页面大小、排序和所选彩块化的信息)。 所有实施搜索API的电子商务服务都接收此类的实例以执行其搜索。 可以从请求对象(HttpServletRequest)实例化CommerceQuery

  2. FacetParamHelper

    是一个实用程序类,它提供一个静态方法(toParams),用于从一个Facet列表和一个切换值生成GET参数字符串。 这在UI端很有用,您必须为每个Facet的每个值显示超链接,以便当用户单击超链接时,将切换相应的值。 也就是说,如果选定它,则会将其从查询中删除,否则会添加。 这解决了处理多个/单值Facet、覆盖值等操作的所有逻辑。

搜索API的入口点是返回CommerceResult对象的CommerceService#search方法。 有关此主题的更多信息,请参阅API文档

用户集成 user-integration

在AEM和各种电子商务系统之间提供集成。 这就要求有一种策略来同步不同系统之间的购买者,以便特定于AEM的代码只需了解AEM,反之亦然:

  • 身份验证

    AEM被假定为​ 仅限 Web前端,因此执行​ 所有 ​身份验证。

  • Hybris中的帐户

    AEM为每个购物者在hybris中创建相应的(下属)帐户。 该帐户的用户名与AEM的用户名相同。 加密随机密码是在AEM中自动生成并存储(加密)的。

预先存在的用户 pre-existing-users

AEM前端可以位于现有hybris实施的前面。 此外,还可以在现有AEM安装中添加一个hybris引擎。 要实现此目的,系统必须能够正常处理任一系统中的现有用户:

  • AEM >hybris

    • 登录到hybris时,如果AEM用户不存在:

      • 使用加密随机密码创建hybris用户
      • 将hybris用户名存储在AEM用户的用户目录中
    • 查看:com.adobe.cq.commerce.hybris.impl.HybrisSessionImpl#login()

  • hybris > AEM

    • 在登录到AEM时,如果系统可以识别用户:

      • 尝试使用提供的用户名/密码登录hybris
      • 如果成功,请在AEM中创建具有相同密码的用户(AEM特定的salt将导致AEM特定的哈希)
    • 上述算法在Sling AuthenticationInfoPostProcessor中实现

      • 查看:com.adobe.cq.commerce.hybris.impl.user.LazyUserImporter.java

自定义导入流程 customizing-the-import-process

要基于现有功能构建自定义导入处理程序,请执行以下操作:

  • 必须实施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 if there is a 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
{
...
}
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2