将ContextHub添加到页面并访问存储

将ContextHub添加到您的页面以启用ContextHub功能并链接到ContextHub Javascript库。

ContextHub Javascript API提供对ContextHub管理的上下文数据的访问权限。 本页简要介绍了API用于访问和处理上下文数据的主要功能。 请查看API参考文档的链接,以查看详细信息和代码示例。

将ContextHub添加到页面组件

要启用ContextHub功能并链接到ContextHub Javascript库,请在页面的head部分中包含contexthub组件。 页面组件的HTL代码应类似于以下示例:

<sly data-sly-resource="${'contexthub' @ resourceType='granite/contexthub/components/contexthub'}"/>

请注意,您还需要配置ContextHub工具栏是否显示在“预览”模式下。 请参阅显示和隐藏ContextHub UI

关于ContextHub存储

使用ContextHub存储保留上下文数据。 ContextHub提供以下类型的存储,这些存储构成了所有存储类型的基础:

所有存储类型都是ContextHub.Store.Core类的扩展。 有关创建新存储类型的信息,请参阅创建自定义存储。 有关示例存储类型的信息,请参阅示例ContextHub存储候选项

持久性模式

ContextHub存储使用以下持久模式之一:

  • 本地: 使用HTML5 localStorage保留数据。本地存储会在各会话期间在浏览器上持久保留。
  • 会话: 使用HTML5 sessionStorage保留数据。会话存储在浏览器会话期间会持续保留,并可用于所有浏览器窗口。
  • Cookie: 使用浏览器对Cookie的本机支持进行数据存储。在HTTP请求中,Cookie数据会从服务器发送到服务器。
  • Window.name: 使用window.name属性保留数据。
  • 内存: 使用Javascript对象保留数据。

默认情况下,ContextHub使用本地持久性模式。 如果浏览器不支持或允许HTML5 localStorage,则使用会话持久性。 如果浏览器不支持或允许HTML5 sessionStorage,则使用Window.name持久性。

存储数据

在内部,将数据存储为树结构,从而可以将值添加为主要类型或复杂对象。 添加要存储的复杂对象时,对象属性会在数据树中形成分支。 例如,将以下复杂对象添加到名为location的空存储区:

Object {
   number: 321,
   data: {
      city: "Basel",
      country: "Switzerland",
      details: {
         population: 173330,
         elevation: 260
      }
   }
}

存储数据的树结构可概念化如下:

/
|- number
|- data
      |- city
      |- country
      |- details
            |- population
            |- elevation

树结构将存储中的数据项定义为键/值对。 在上例中,键/number与值321对应,键/data/country与值Switzerland对应。

处理对象

ContextHub提供ContextHub.Utils.JSON.tree类以处理Javascript对象。 在将Javascript对象添加到存储区之前,或从存储区获取Javascript对象后,使用此类的函数处理这些对象。

此外,ContextHub.Utils.JSON类还提供用于将对象序列化为字符串,以及将字符串反序列化为对象的函数。 使用此类处理JSON数据,以支持本机不包含JSON.parseJSON.stringify函数的浏览器。

与ContextHub存储交互

使用ContextHub Javascript对象获取作为Javascript对象的存储。 获取存储对象后,即可处理该存储对象包含的数据。 使用getAllStoresgetStore函数获取存储。

访问存储数据

ContexHub.Store.Core Javascript类定义了与存储数据交互的若干函数。 以下函数存储并检索对象中包含的多个数据项:

单个数据项将存储为一组键/值对。 要存储和检索值,请指定相应的键:

请注意,自定义存储候选者可以定义其他函数,以提供对存储数据的访问。

注意

默认情况下, ContextHub不会感知发布服务器上当前已登录的用户,并且ContextHub会将此类用户视为“匿名”。

您可以通过加载用户档案存储,使ContextHub了解已登录的用户。 请在此处🔗参阅GitHub上的示例代码。

ContextHub事件

ContextHub包含一个事件框架,通过该框架,您可以自动对存储事件做出反应。 每个存储对象都包含一个ContextHub.Utils.Eventing对象,该对象可用作存储的eventing属性。 使用ononce函数将Javascript函数绑定到存储事件。

使用ContextHub处理Cookie

ContextHub Javascript API提供跨浏览器支持来处理浏览器Cookie。 ContextHub.Utils.Cookie命名空间定义用于创建、处理和删除Cookie的多个函数。

确定已解析的ContextHub区段

ContextHub区段引擎允许您确定在当前上下文中解析的已注册区段。 使用ContextHub.SegmentEngine.SegmentManager类的getResolvedSegments函数检索已解析的区段。 然后,使用ContextHub.SegmentEngine.Segment类的getNamegetPath函数来测试区段。

ContextHub 区段

ContextHub区段安装在/conf/<site>/settings/wcm/segments节点下。

以下区段随WKND教程站点一起安装。

  • 夏季

用于解析这些区段的规则概述如下:

警告

已安装的区段作为参考配置提供,以帮助您为项目构建自己的专用配置,因此不应直接使用。

调试ContextHub

有许多用于调试ContextHub的选项,包括生成日志。 有关详细信息,请参阅配置ContextHub 。

请参阅ContextHub框架概述

ContextHub提供了诊断页面 ,您可以在其中看到ContextHub框架的概述。

在此页面上