客户端上下文详细信息 client-context-in-detail

Client Context表示动态组合的用户数据集合。 您可以使用数据来确定在给定情况（内容定位）下要在网页上显示的内容。 这些数据还可用于网站分析，以及页面上的任何JavaScript。

Client Context主要包括以下几个方面：

创建独立会话存储并将其添加到Client Context，或创建与上下文存储组件绑定的会话存储。 Adobe Experience Manager (AEM)安装了多个可以立即使用的上下文存储组件。 您可以使用这些组件作为组件的基础。

有关打开Client Context、配置其显示的信息以及模拟用户体验的信息，请参阅Client Context。

会话存储 session-stores

Client Context包括包含用户数据的各种会话存储。 存储数据来自以下源：

Client Context Framework提供了一个JavaScript API，您可以使用该API与会话存储进行交互以读取和写入用户数据，以及侦听和响应存储事件。 您还可以为用于内容定位或其他目的的用户数据创建会话存储。

会话存储数据保留在客户端上。 Client Context不会将数据写回服务器。 要向服务器发送数据，请使用表单或开发自定义JavaScript。

每个会话存储都是属性值对的集合。 会话存储表示（任何类型的）数据集合，其概念含义可由设计人员、开发人员或两者决定。 以下示例JavaScript代码定义了一个对象，该对象表示会话存储可能包含的配置文件数据：

{
  age: 20,
  authorizableId: "aparker@geometrixx.info",
  birthday: "27 Feb 1992",
  email: "aparker@geometrixx.info",
  formattedName: "Alison Parker",
  gender: "female",
  path: "/home/users/geometrixx/aparker@geometrixx.info/profile"
}

会话存储可以在浏览器会话间保留，也可以仅针对在其中创建会话的浏览器会话保留。

上下文存储组件 context-store-components

上下文存储组件是可以添加到客户端上下文的CQ组件。 通常，上下文存储组件显示与其关联的会话存储中的数据。 但是，上下文存储组件显示的信息并不限于会话存储数据。

上下文存储组件可以包括以下项目：

有关可以添加到上下文存储的已安装上下文存储组件的说明，请参阅可用的客户端上下文组件。

目标内容投放 targeted-content-delivery

配置文件信息还用于传递目标内容。

向页面添加客户端上下文 adding-client-context-to-a-page

将Client Context组件包括在网页的正文部分以启用Client Context。 客户端上下文组件节点的路径是/libs/cq/personalization/components/clientcontext。 要包含该组件，请将以下代码添加到页面组件的JSP文件中，该文件位于页面的body元素正下方：

<cq:include path="clientcontext" resourceType="cq/personalization/components/clientcontext"/>

clientcontext组件使页面加载实施Client Context的客户端库。

客户端上下文UI仅在创作实例上可用。

扩展客户端上下文 extending-client-context

要扩展Client Context，请创建一个会话存储区，并选择性地显示存储区数据：

创建会话存储 creating-a-session-store

为必须添加到的数据创建会话存储，并从Client Context中检索。 通常，使用以下过程创建会话存储：

在personalization.stores.kernel客户端库中包含JavaScript会导致在加载Client Context Framework时创建存储。

会话存储的类型 types-of-session-stores

会话存储是在浏览器会话期间创建并可用的，或者保留在浏览器存储或Cookie中。 Client Context JavaScript API定义了多个类，这些类表示两种类型的数据存储：

API还提供了专门用于存储JSON数据或JSONP数据的这些类的扩展：

创建会话存储对象 creating-the-session-store-object

客户端库文件夹的JavaScript将创建和初始化会话存储。 必须使用上下文存储管理器注册会话存储。 以下示例创建并注册CQ_Analytics.SessionStore对象。

//Create the session store
if (!CQ_Analytics.MyStore) {
    CQ_Analytics.MyStore = new CQ_Analytics.SessionStore();
    CQ_Analytics.MyStore.STOREKEY = "MYSTORE";
    CQ_Analytics.MyStore.STORENAME = "mystore";
    CQ_Analytics.MyStore.data={};
}
//register the session store
if (CQ_Analytics.ClientContextMgr){
    CQ_Analytics.ClientContextMgr.register(CQ_Analytics.MyStore)
}

为了存储JSON数据，以下示例创建并注册一个CQ_Analytics.JSONStore对象。

if (!CQ_Analytics.myJSONStore) {
    CQ_Analytics.myJSONStore = CQ_Analytics.JSONStore.registerNewInstance("myjsonstore",{});
}

创建上下文存储组件 creating-a-context-store-component

创建上下文存储组件以在Client Context中呈现会话存储数据。 创建后，您可以将上下文存储组件拖动到Client Context上以呈现会话存储中的数据。 上下文存储组件由以下项目组成：

扩展提供的上下文存储组件 extending-the-provided-context-store-components

AEM提供了可以扩展的genericstore和genericstoreproperties上下文存储组件。 存储数据的结构决定了要扩展的组件：

配置Sidekick中的外观 configuring-the-appearance-in-sidekick

编辑Client Context时，上下文存储组件以Sidekick显示。 与所有组件一样，客户端上下文组件的componentGroup和jcr:title属性决定了组件的组和名称。

默认情况下，componentGroup属性值为Client Context的所有组件都会出现在Sidekick中。 如果为componentGroup属性使用其他值，则必须使用“设计”模式手动将组件添加到Sidekick。

上下文存储组件实例 context-store-component-instances

将上下文存储组件添加到Client Context时，将在/etc/clientcontext/default/content/jcr:content/stores下创建一个表示该组件实例的节点。 此节点包含使用组件的编辑对话框配置的属性值。

初始化Client Context时，将处理这些节点。

初始化关联的会话存储 initializing-the-associated-session-store

将init.js.jsp文件添加到组件中以生成JavaScript代码，该代码初始化您的上下文存储组件使用的会话存储。 例如，使用初始化脚本检索组件的配置属性，并使用这些属性填充会话存储。

在创作实例和发布实例上的页面加载上初始化客户端上下文时，生成的JavaScript会添加到页面中。 此JSP在上下文存储组件实例加载和渲染之前执行。

代码必须将文件的mime类型设置为text/javascript，否则不会执行。

以下过程创建init.js.jsp脚本文件并添加用于设置正确mime类型的代码。 随后是执行存储初始化的代码。

呈现用于genericstoreproperties组件的会话存储数据 rendering-session-store-data-for-genericstoreproperties-components

使用一致的格式在Client Context中显示会话存储数据。

显示属性数据 displaying-property-data

个性化taglib提供了personalization:storePropertyTag标记，该标记显示会话存储中的属性值。 要使用标记，请在JSP文件中包含以下代码行：

<%@taglib prefix="personalization" uri="https://www.day.com/taglibs/cq/personalization/1.0" %>

标记具有以下格式：

<personalization:storePropertyTag propertyName="property_name" store="session_store_name"/>

propertyName属性是要显示的存储属性的名称。 store属性是已注册的存储的名称。 以下示例标记显示profile存储的authorizableId属性的值：

<personalization:storePropertyTag propertyName="authorizableId" store="profile"/>

HTML 结构 html-structure

personalization.ui客户端库文件夹(https://experienceleague.adobe.com/etc/clientlibs/foundation/personalization/ui/themes/default?lang=zh-Hans)提供了客户端上下文用于设置HTML代码格式的CSS样式。 以下代码说明了用于显示存储数据的建议结构：

<div class="cq-cc-store">
   <div class="cq-cc-thumbnail">
      <div class="cq-cc-store-property">
           <!-- personalization:storePropertyTag for the store thumbnail image goes here -->
      </div>
   </div>
   <div class="cq-cc-content">
       <div class="cq-cc-store-property cq-cc-store-property-level0">
           <!-- personalization:storePropertyTag for a store property goes here -->
       </div>
       <div class="cq-cc-store-property cq-cc-store-property-level1">
           <!-- personalization:storePropertyTag for a store property goes here -->
       </div>
       <div class="cq-cc-store-property cq-cc-store-property-level2">
           <!-- personalization:storePropertyTag for a store property goes here -->
       </div>
       <div class="cq-cc-store-property cq-cc-store-property-level3">
           <!-- personalization:storePropertyTag for a store property goes here -->
       </div>
   </div>
   <div class="cq-cc-clear"></div>
</div>

/libs/cq/personalization/components/contextstores/profiledata上下文存储组件使用此结构来显示配置文件会话存储中的数据。 cq-cc-thumbnail类放置缩略图图像。 cq-cc-store-property-level*x*类将字母数字数据格式化：

渲染泛型存储组件的会话存储数据 rendering-session-store-data-for-genericstore-components

要使用genericstore组件呈现存储数据，您必须执行以下操作：

标识泛型存储会话存储 identifying-the-genericstore-session-store

个性化taglib提供了personalization:storePropertyTag标记，该标记显示会话存储中的属性值。 要使用标记，请在JSP文件中包含以下代码行：

<%@taglib prefix="personalization" uri="https://www.day.com/taglibs/cq/personalization/1.0" %>

标记具有以下格式：

<personalization:storeRendererTag store="store_name"/>

实现会话存储渲染方法 implementing-the-session-store-renderer-method

您的会话存储需要每当必须呈现组件时都调用的“renderer”方法。 使用以下两个参数调用渲染器函数：

与会话存储区交互 interacting-with-session-stores

使用JavaScript与会话存储交互。

访问会话存储 accessing-session-stores

获取会话存储对象以将数据读取或写入存储。 CQ_Analytics.ClientContextMgr根据存储名称提供对存储的访问权限。 获取后，使用CQ_Analytics.SessionStore或CQ_Analytics.PersistedSessionStore的方法与存储数据进行交互。

以下示例获取profile存储，然后从存储中检索formattedName属性。

function getName(){
   var profilestore = CQ_Analytics.ClientContextMgr.getRegisteredStore("profile");
   if(profilestore){
      return profilestore.getProperty("formattedName", false);
   } else {
      return null;
   }
}

创建侦听器以响应会话存储更新 creating-a-listener-to-react-to-a-session-store-update

会话会存储触发事件，因此可以添加侦听器并根据这些事件触发事件。

会话存储基于Observable模式构建。 它们扩展了提供 [addListener](/docs/experience-manager-65/content/implementing/developing/personlization/client-context/ccjsapi.md#addlistener-event-fct-scope)方法的CQ_Analytics.Observable。

以下示例将侦听器添加到profile会话存储的update事件。

var profileStore = ClientContextMgr.getRegisteredStore("profile");
if( profileStore ) {
  //callback execution context
  var executionContext = this;

  //add "update" event listener to store
  profileStore.addListener("update",function(store, property) {
    //do something on store update

  },executionContext);
}

检查是否已定义和初始化会话存储 checking-that-a-session-store-is-defined-and-initialized

在加载会话存储并使用数据初始化会话存储之前，会话存储不可用。 以下因素可能会影响会话存储可用性的时间：

使用CQ_Analytics.ClientContextUtils对象的onStoreRegistered和onStoreInitialized方法，仅在会话存储可用时访问它们。 这些方法使您能够注册对会话注册和初始化事件做出反应的事件侦听器。

以下示例使用profile会话存储区的onStoreRegistered事件。 注册存储后，侦听器将添加到会话存储的update事件。 更新存储后，页面上<div class="welcome">元素的内容将使用profile存储中的名称进行更新。

//listen for the store registration
CQ_Analytics.ClientContextUtils.onStoreRegistered("profile", listen);

//listen for the store's update event
function listen(){
 var profilestore = CQ_Analytics.ClientContextMgr.getRegisteredStore("profile");
    profilestore.addListener("update",insertName);
}

//insert the welcome message
function insertName(){
 $("div.welcome").text("Welcome "+getName());
}

//obtain the name from the profile store
function getName(){
 var profilestore = CQ_Analytics.ClientContextMgr.getRegisteredStore("profile");
 if(profilestore){
  return profilestore.getProperty("formattedName", false);
    } else {
        return null;
    }
}

从sessionpersistence Cookie排除属性 excluding-a-property-from-the-sessionpersistence-cookie

要阻止保留PersistedSessionStore的属性（即从sessionpersistence Cookie中将其排除），请将该属性添加到保留会话存储的非保留属性列表中。

查看 [CQ_Analytics.PersistedSessionStore.setNonPersisted(propertyName)](/docs/experience-manager-65/content/implementing/developing/personlization/client-context/ccjsapi.md#setnonpersisted-name)

CQ_Analytics.ClientContextUtils.onStoreRegistered("surferinfo", function(store) {
  //this will exclude the browser, OS and resolution properties of the surferinfo session store from the
  store.setNonPersisted("browser");
  store.setNonPersisted("OS");
  store.setNonPersisted("resolution");
});

配置设备滑块 configuring-the-device-slider

条件 conditions

当前页面必须具有对应的移动设备页面；仅当页面具有配置了移动设备转出配置的LiveCopy时（rolloutconfig.path.toLowerCase包含mobile）才会确定此情况。

配置 configuration

从桌面页面切换到移动设备等效页面时：

例如：

window.CQMobileSlider["geometrixx-outdoors"] = {
  //CSS used by desktop that need to be removed when mobile
  DESKTOP_CSS: [
    "/etc/designs/${app}/clientlibs_desktop_v1.css"
  ],

  //CSS used by mobile that need to be removed when desktop
  MOBILE_CSS: [
    "/etc/designs/${app}/clientlibs_mobile_v1.css"
  ],

  //id of the content that needs to be removed when mobile
  DESKTOP_MAIN_ID: "main",

  //id of the content that needs to be removed when desktop
  MOBILE_MAIN_ID: "main",

  //body classes used by desktop that need to be removed when mobile
  DESKTOP_BODY_CLASS: [
    "page"
  ],

  //body classes used by mobile that need to be removed when desktop
  MOBILE_BODY_CLASS: [
    "page-mobile"
  ]
};

示例：创建自定义上下文存储组件 example-creating-a-custom-context-store-component

在此示例中，您将创建一个上下文存储组件，该组件从外部服务检索数据并将其存储在会话存储中：

添加地理位置组件 add-the-geoloc-component

创建CQ应用程序并添加geoloc组件。

创建“地理位置编辑”对话框 create-the-geoloc-edit-dialog

上下文存储组件需要一个“编辑”对话框。 地理位置编辑对话框包含一条静态消息，指示没有要配置的属性。

创建初始化脚本 create-the-initialization-script

将init.js.jsp文件添加到geoloc组件中，并使用它来创建会话存储、检索位置数据并将其添加到存储中。

init.js.jsp文件在页面加载Client Context时执行。 此时，已加载Client Context JavaScript API并且可供您的脚本使用。

呈现geoloc会话存储数据 render-the-geoloc-session-store-data

将代码添加到geoloc组件的JSP文件中，以在Client Context中呈现存储数据。

将组件添加到客户端上下文 add-the-component-to-client-context

将位置存储组件添加到客户端上下文，以便在页面加载时进行初始化。

请参阅客户端上下文中的位置信息 see-the-location-information-in-client-context

在编辑模式下打开Geometrixx Outdoors主页，然后打开Client Context以查看位置存储组件中的数据。

创建自定义的客户端上下文 creating-a-customized-client-context

要创建第二个客户端上下文，请复制分支：

/etc/clientcontext/default

要使用自定义的客户端上下文，请编辑属性
path
客户端上下文组件的设计样式中（如页面模板中所示）。 例如，作为标准位置：
/libs/cq/personalization/components/clientcontext/design_dialog/items/path