新增ContextHub至頁面及存取商店

上次更新： 2023-05-04
  • 主題：
  • Developing
    檢視有關此主題的更多資訊
  • 建立對象：
  • Developer
注意

AEM 6.4已結束延伸支援，本檔案不再更新。 如需詳細資訊，請參閱 技術支援期. 尋找支援的版本 此處.

將ContextHub新增至您的頁面以啟用ContextHub功能並連結至ContextHub Javascript資料庫

ContextHub Javascript API可讓您存取ContextHub管理的內容資料。 本頁簡要說明API用於存取及處理內容資料的主要功能。 請依照API參考檔案的連結，查看詳細資訊和程式碼範例。

將ContextHub新增至頁面元件

若要啟用ContextHub功能並連結至ContextHub Javascript程式庫，請在 head 區段。 頁面元件的JSP程式碼類似下列範例：

<head>
   <sling:include path="contexthub" resourceType="granite/contexthub/components/contexthub" />
</head>

請注意，您也需要設定ContextHub工具列是否顯示在「預覽」模式中。 請參閱 顯示和隱藏ContextHub UI.

關於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，則會使用工作階段持續性。 如果瀏覽器不支援或允許HTML5sessionStorage，則使用Window.name持久性。

存放資料

在內部，將資料儲存為樹結構，以便將值添加為主要類型或複雜對象。 添加要儲存的複雜對象時，對象屬性在資料樹中形成分支。 例如，下列複雜物件會新增至名為位置的空白存放區：

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.parse 和 JSON.stringify 函式。

與ContextHub商店互動

使用 ContextHub 以Javascript物件形式取得商店。 取得儲存物件後，您就可以控制其包含的資料。 使用 getAllStores 或 getStore 函式來取得存放區。

存取儲存資料

此 ContexHub.Store.Core Javascript類別定義了與儲存資料互動的數個函式。 以下函式儲存和檢索對象中包含的多個資料項：

個別資料項目會儲存為一組索引鍵/值組。 要儲存和檢索值，請指定相應的鍵：

請注意，自訂存放區候選項可定義其他功能，以提供存取儲存資料的權限。

注意

ContextHub預設不會知道目前在發佈伺服器上使用的登入，且ContextHub會將這類使用者視為「匿名」。

您可以依照 We.Retail參考網站. 請參閱 此處顯示GitHub的相關程式碼.

ContextHub事件

ContextHub包含事件架構，可讓您自動回應以儲存事件。 每個儲存對象都包含 ContextHub.Utils.Eventing 可作為商店的 eventing 屬性。 使用 on 或 once 函式來將Javascript函式系結至儲存事件。

使用ContextHub來操控Cookie

Context Hub Javascript API提供跨瀏覽器支援，可處理瀏覽器Cookie。 此 ContextHub.Utils.Cookie namespace定義了建立、操控和刪除cookie的多個函式。

決定解析的ContextHub區段

ContextHub區段引擎可讓您判斷目前內容中要解析的已註冊區段。 使用 ContextHub.SegmentEngine.SegmentManager 類別來擷取解析的區段。 然後，使用 getName 或 getPath 函式 ContextHub.SegmentEngine.Segment 要測試區段的類別。

已安裝的區段

ContextHub區段會安裝在 /conf/we-retail/settings/wcm/segments 節點。

  • 女性
  • 30歲以上女性
  • 30歲以下女性
  • 男性
  • 男30歲以上
  • 男30歲以下
  • order-value-75-to-100
  • order-value-over-100
  • 30歲以上
  • 夏季
  • 夏女
  • 30歲以上夏季女性
  • 30歲以下夏季女性
  • 夏男
  • 30歲以上夏季男性
  • 30歲以下的夏季男性
  • 30歲以下
  • 冬季
  • 冬女
  • 冬季 — 女30歲以上
  • 冬季 — 女性–30歲以下
  • 冬男
  • 冬季男30歲以上
  • 20歲以下的冬季男性

用以解決這些區段的規則摘要如下：

  • 由 gender 資料項 設定檔 儲存。

  • 年齡由設定檔存放區的年齡資料項目決定。

  • 季數由 地理位置 儲存，以及surferinfo儲存區的月資料項目。

警告

安裝的區段會作為參考設定提供，協助您為專案建立專屬的設定，因此不應直接使用。

記錄ContextHub的除錯訊息

設定AdobeGranite ContextHub OSGi服務(PID = com.adobe.granite.contexthub.impl.ContextHubImpl)，記錄開發時非常實用的詳細除錯訊息。

若要設定服務，您可以使用 Web主控台 或使用 儲存庫中的JCR節點:

  • Web控制台：若要記錄除錯訊息，請選取除錯屬性。
  • JCR節點：若要記錄除錯訊息，請設定布林值 com.adobe.granite.contexthub.debug 屬性 true.

請參閱ContextHub架構概觀

ContextHub提供 診斷頁 您可在其中看到ContextHub架構的概觀。

上一頁
Next page

此頁面上的