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

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

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

将ContextHub添加到页面组件

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

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

请注意，您还需要配置ContextHub工具栏是否在“预览”模式下显示。 参见 显示和隐藏ContextHub用户界面.

关于ContextHub存储

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

所有存储类型都是 ContextHub.Store.Core 类。 有关创建新存储类型的信息，请参见 创建自定义商店. 有关示例存储类型的信息，请参见 示例ContextHub存储候选项.

持久性模式

Context Hub存储使用以下持久性模式之一：

  • 本地： 使用HTML5 localStorage保留数据。 本地存储跨会话保留在浏览器上。
  • 会话： 使用HTML5 sessionStorage保留数据。 会话存储会在浏览器会话期间持续保留，并且可用于所有浏览器窗口。
  • Cookie： 使用浏览器对数据存储的Cookie的本机支持。 Cookie数据通过HTTP请求发送到服务器，或从服务器发送。
  • Window.name： 使用window.name属性保留数据。
  • 内存： 使用Javascript对象来保留数据。

默认情况下，Context Hub使用本地持久性模式。 如果浏览器不支持或不允许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对象添加到存储中或从存储中获取它们之前，使用此类的函数对其进行处理。

此外， ContextHub.Utils.JSON 类提供了将对象序列化为字符串以及将字符串反序列化为对象的函数。 此类用于处理JSON数据，以支持本身不包含 JSON.parse 和 JSON.stringify 函数。

与ContextHub存储区交互

使用 ContextHub 用于获取存储作为Javascript对象的Javascript对象。 获取存储对象后，您可以处理它包含的数据。 使用 getAllStores 或 getStore 函数以获取存储。

访问存储数据

此 ContexHub.Store.Core Javascript类定义了用于与存储数据交互的多个函数。 以下函数存储和检索对象中包含的多个数据项：

单个数据项作为一组键/值对进行存储。 要存储和检索值，请指定相应的键：

请注意，自定义候选存储区可以定义其他提供存储数据访问权限的功能。

注意

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

您可以通过加载配置文件存储区，使ContextHub感知已登录的用户。 请参阅 此处为GitHub上的示例代码.

ContextHub事件

ContextHub包括一个事件框架，可让您自动对存储事件做出反应。 每个存储对象包含 ContextHub.Utils.Eventing 可用作商店的对象 eventing 属性。 使用 on 或 once 函数将Javascript函数绑定到存储事件。

使用Context Hub处理Cookie

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

确定已解析的ContextHub区段

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

ContextHub 区段

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

以下区段随 WKND教程网站。

  • 夏天
  • 冬季

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

  • 首先 地理位置 存储用于确定用户的纬度。
  • 然后，的月份数据项 surferinfo存储 确定该纬度中的哪个季节。
警告

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

调试ContextHub

调试ContextHub有许多选项，包括生成日志。 参见 配置ContextHub以了解更多信息。

请参阅ContextHub框架概述

ContextHub提供 诊断页面 其中，您可以查看ContextHub框架的概述。

在此页面上