具有内容同步的移动设备 mobile-with-content-sync

使用内容同步来打包内容，以便将其用在本机移动设备应用程序中。 在AEM中创作的页面可用作应用程序内容，即使设备处于离线状态也是如此。 此外，由于AEM页面基于Web标准，因此它们可以跨平台工作，从而可以将它们嵌入到任何本机包装器中。 此策略可减少开发工作，并让您能够轻松更新应用程序内容。

内容同步框架会创建一个包含Web内容的存档文件。 内容可以是简单页面、图像和PDF文件或整个Web应用程序中的任何内容。 内容同步API允许从移动设备应用程序或构建流程中访问存档文件，以便能够检索内容并将其包含在应用程序中。

以下步骤顺序说明了内容同步的典型用例：

开发内容同步处理程序 developing-the-content-sync-handlers

开发内容同步处理程序的一些准则如下：

配置内容同步内容 configuring-the-content-sync-content

创建内容同步配置，以指定要交付给客户端的ZIP文件的内容。 您可以创建任意数量的内容同步配置。 每个配置都有一个用于标识的名称。

要创建内容同步配置，请添加 cq:ContentSyncConfig 节点到存储库， sling:resourceType 属性设置为 contentsync/config. 的 cq:ContentSyncConfig 节点可以位于存储库中的任意位置，但AEM发布实例上的用户必须可以访问该节点。 因此，您应将节点添加到下面 /content.

要指定内容同步ZIP文件的内容，请将子节点添加到cq:ContentSyncConfig节点。 每个子节点的以下属性标识要包含的内容项目以及添加该内容项目时如何处理该内容项目：

请参阅 内容同步配置示例 以了解更多信息。

创建内容同步配置后，该配置会显示在内容同步控制台中。

配置对内容同步下载的访问 configuring-access-to-content-sync-downloads

指定可从内容同步下载的用户或组。 您可以配置默认用户或组，以从所有内容同步缓存中下载该用户或组，并且可以覆盖默认用户或组，并配置对特定内容同步配置的访问权限。

安装AEM后，管理员组的成员默认可以从内容同步下载。

设置内容同步下载的默认访问权限 setting-the-default-access-for-content-sync-downloads

Day CQ内容同步管理器服务控制对内容同步的访问。 配置此服务以指定默认可从内容同步下载的用户或组。

如果您 使用Web控制台配置服务，键入用户或组的名称作为回退缓存可授权属性的值。

如果您 在存储库中配置，请使用有关服务的以下信息：

覆盖内容同步缓存的下载访问 overriding-download-access-for-a-content-sync-cache

要为特定内容同步配置配置下载访问权限，请将以下属性添加到 cq:ContentSyncConfig 节点：

例如，您的应用程序允许用户直接从内容同步安装更新。 要使所有用户能够下载更新，请将可授权属性的值设置为 everyone.

如果 cq:ContentSyncConfig 节点没有可授权属性，为Day CQ内容同步管理器服务的回退缓存可授权属性配置的默认用户或组将决定可以下载的人员。

配置用户以更新内容同步缓存 configuring-the-user-for-updating-a-content-sync-cache

当用户对内容同步缓存执行更新时，特定用户帐户代表用户执行该操作。 默认情况下，匿名用户会更新所有内容同步缓存。

您可以覆盖默认用户并指定更新特定内容同步缓存的用户或组。

要覆盖默认用户，请通过向cq:ContentSyncConfig节点添加以下属性来指定执行特定内容同步配置更新的用户或组：

如果 cq:ContentSyncConfig 节点没有 updateuser 属性，默认 anonymous 用户更新缓存。

配置类型 configuration-types

处理过程可能包括渲染简单的JSON，以及完全渲染页面（包括其引用的资产）。 本节列出了可用的配置类型及其特定参数：

复制 只需复制文件和文件夹即可。

内容 使用标准渲染内容 Sling请求处理.

clientlib 打包Javascript或CSS客户端库。

资产

收集资产的原始演绎版。

图像 收集图像。

图像类型用于在zip文件中包含We Retail徽标。

页面 呈现AEM页面并收集引用的资产。

重写 重写节点定义链接在导出的页面中的重写方式。 重写的链接可以指向zip文件中包含的文件，也可以指向服务器上的资源。

的 rewrite 节点需要位于 page 节点。

的 rewrite 节点可以具有以下一个或多个属性：

每个属性可以具有以下值之一：

名为的AEM服务 PathRewriterTransformerFactory 用于配置将被重写的特定html属性。 该服务可以在Web控制台中配置，并且为 rewrite 节点： clientlibs, images 和 links.

此功能已在AEM 5.5中添加。

内容同步配置示例 example-content-sync-configuration

下面列出了内容同步的示例配置。

+ weretail_go [cq:ContentSyncConfig]
  - sling:resourceType = "contentsync/config"

  + etc.designs.default [nt:unstructured]
    - path = "/etc/designs/default"
    - type = "copy"

  + etc.designs.mobile [nt:unstructured]
    - path = "/etc/designs/mobile"
    - type = "copy"

  + events.plist [nt:unstructured]
    - path = "/content/weretail_mobile/en/events/jcr:content/par/events"
    - type = "content"
    - extension = "plist"

  + events.touch.html [nt:unstructured]
    - path = "/content/weretail_mobile/en/events"
    - type = "pages"
    - extension = "html"
    - selector = "touch"

  + logo [nt:unstructured]
    - path = "/etc/designs/mobile/jcr:content/mobilecontentpage/logo"
    - type = "logo"

  + manifest [nt:unstructured]
    - indexPage = "/content/weretail_mobile/en/events.touch.html"
    - metadataPlist = "/content/weretail_mobile/en/events/_jcr_content/par/events.plist"

  + ...

etc.designs.default等.designs.mobile 配置的前两个条目应该非常明显。 由于我们将包含许多移动页面，因此需要/etc/designs下的相关设计文件。 由于不需要额外处理，因此复制就足够了。

events.plist 这个条目有点特别。 如导言中所述，应用程序应提供包含事件位置标记的地图视图。 我们将以PLIST格式作为单独的文件提供必要的位置信息。 要使其正常工作，在索引页上使用的事件列表组件具有一个名为plist.jsp的脚本。 当使用.plist扩展名请求组件的资源时，将执行此脚本。 与往常一样，组件路径在path属性中给定，类型设置为content，因为我们想要利用 Sling请求处理.

events.touch.html 接下来是应用程序中将显示的实际页面。 路径属性将设置为事件的根页面。 该页面下的所有事件页面也将包含在内，因为深层属性默认为true。 我们将页面用作配置类型，以便包含可能从页面上的图像或下载组件引用的任何图像或其他文件。 此外，设置触屏选择器还为我们提供了页面的移动版本。 功能包中的配置包含更多此类条目，但为方便起见，此处未列出这些条目。

徽标 目前尚未提到徽标配置类型，并且它不是内置类型。 但是，内容同步框架在一定程度上是可扩展的，这是一个示例，将在下一节中介绍。

清单 通常需要在zip文件中包含某种类型的元数据，例如内容的开始页面。 但是，对此类信息进行硬编码会阻止您稍后轻松更改该信息。 内容同步框架通过在配置中查找清单节点来支持此用例，清单节点仅通过名称进行标识，不需要配置类型。 在该特定节点上定义的每个属性都会添加到文件中，该文件也称为清单，并位于zip文件的根中。

在示例中，事件列表页面应为初始页面。 此信息在 indexPage 属性，因此可以随时轻松更改。 第二个属性定义 events.plist 文件。 正如我们稍后将看到的，客户端应用程序现在可以读取清单并根据清单执行操作。

设置配置后，可以使用浏览器或任何其他HTTP客户端下载内容，或者，如果您正在为iOS进行开发，则可以使用专用的WAppKitSync客户端库。 下载位置由配置的路径和 .zip 扩展，例如使用本地AEM实例时： http://localhost:4502/content/weretail_go.zip

内容同步控制台 the-content-sync-console

“内容同步”控制台列出了存储库中的所有“内容同步”配置（所有类型的节点） cq:ContentSyncConfig)，并且对于每个配置，您可以执行以下操作：

它可用于开发和疑难解答。

控制台可从以下位置访问：

http://localhost:4502/libs/cq/contentsync/content/console.html

如下所示：

扩展内容同步框架 extending-the-content-sync-framework

尽管配置选项的数量已经非常多，但它可能并不涵盖特定用例的所有要求。 本节介绍内容同步框架的扩展点以及如何创建自定义配置类型。

对于每种配置类型，都有 内容更新处理程序，这是为该特定类型注册的OSGi组件工厂。 这些处理程序会收集内容、处理内容并将其添加到由内容同步框架维护的缓存中。 实现以下接口或抽象基类：

将类注册为OSGi组件工厂，并将其部署在包中的OSGi容器中。 可以使用 Maven SCR插件 使用JavaDoc标记或批注。 以下示例显示JavaDoc版本：

/*
 * @scr.component metatype="no"
 * factory="com.day.cq.contentsync.handler.ContentUpdateHandler/customtype"
 */
public class CustomTypeUpdateHandler implements ContentUpdateHandler {
    // add your code here
}

/*
 * @scr.component metatype="no" inherit="true"
 * factory="com.day.cq.contentsync.handler.ContentUpdateHandler/othertype"
 */
public class OtherTypeUpdateHandler extends AbstractSlingResourceUpdateHandler {
    // add your code here
}

请注意， 工厂 定义包含通用界面和以斜杠分隔的自定义类型。 此策略使内容同步框架能够查找和创建自定义类的实例，因为它识别配置条目中的自定义类型。 下一节提供了自定义更新处理程序的具体示例。

实施自定义更新处理程序 implementing-a-custom-update-handler

当然，每个We.Retail Mobile页面的左上角都包含一个要包含在zip文件中的徽标。 但是，对于缓存优化， AEM不会引用图像文件在存储库中的实际位置，这会阻止我们仅使用 复制 配置类型。 相反，我们需要做的是提供我们自己的 徽标 使图像在AEM请求的位置可用的配置类型。 以下代码列表显示了徽标更新处理程序的完整实施：

LogoUpdateHandler.java logoupdatehandler-java

package com.day.cq.wcm.apps.weretail.impl;

import javax.jcr.Node;
import javax.jcr.RepositoryException;
import javax.jcr.Session;

import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.jcr.resource.JcrResourceResolverFactory;

import com.day.cq.commons.jcr.JcrUtil;
import com.day.cq.contentsync.config.ConfigEntry;
import com.day.cq.contentsync.handler.ContentUpdateHandler;
import com.day.cq.wcm.foundation.Image;
import com.day.text.Text;

/**
 * The <code>LogoUpdateHandler</code> is used to update the content sync cache
 * with a page logo added using a logo component.
 *
 * @scr.component metatype="no"
 * factory="com.day.cq.contentsync.handler.ContentUpdateHandler/logo"
 */
public class LogoUpdateHandler implements ContentUpdateHandler {

    private static final Logger log = LoggerFactory.getLogger(LogoUpdateHandler.class);

    /** @scr.reference policy="static" */
    protected JcrResourceResolverFactory resolverFactory;

    public boolean updateCacheEntry(ConfigEntry configEntry, Long lastUpdated, String configCacheRoot, Session admin, Session session) {
        ResourceResolver resolver = resolverFactory.getResourceResolver(admin);
        Resource resource = resolver.getResource(configEntry.getContentPath());

        Image img = new Image(resource);
        img.setItemName(Image.NN_FILE, "image");
        img.setItemName(Image.PN_REFERENCE, "imageReference");
        img.setSelector("img");

        try {
            if(img.getLastModified() == null || lastUpdated < img.getLastModified().getTime().getTime()) {
                String src = img.getSrc();
                String parentPath = configCacheRoot + Text.getRelativeParent(src, 1);

                Node parent = JcrUtil.createPath(parentPath, "sling:Folder", admin);
                Node image = resolver.getResource(resource.getPath() + "/image").adaptTo(Node.class);
                JcrUtil.copy(image, parent, Text.getName(src));

                admin.save();

                return true;
            }
        } catch (RepositoryException e) {
            log.error("Unexpected error while updating logo: ", e);
        }

        return false;
    }
}

的 LogoUpdateHandler 类实现 ContentUpdateHandler 界面 updateCacheEntry(ConfigEntry, Long, String, Session, Session) 方法，它采用多个参数：

要实施自定义处理程序，请首先根据配置条目中给定的资源创建Image类的实例。 这基本上与我们页面上实际的徽标组件执行的操作过程相同。 它可确保图像的目标路径与从页面引用的路径相同。

接下来，检查自上次更新后是否修改了资源。 自定义实施应避免对缓存进行不必要的更新，并在没有发生任何更改时返回false。 如果资源已修改，请将图像复制到与缓存根目录相关的预期目标位置。 最后， true 返回，以向框架指示缓存已更新。

在客户端上使用内容 using-the-content-on-the-client

要在内容同步提供的移动设备应用程序中使用内容，您需要通过HTTP或HTTPS连接请求内容。 因此，可以提取检索到的内容（打包成ZIP文件）并将其存储在移动设备上的本地。 请注意，内容不仅指数据，还指逻辑，即完整的Web应用程序；从而使得移动用户即使在没有网络连接的情况下也能执行检索到的web应用和相应的数据。

内容同步以智能方式交付内容：只传送自上次成功数据同步以来的数据更改，从而减少数据传输所需的时间。 自1970年1月1日起，在首次运行应用程序时请求数据更改，随后只请求自上次成功同步以来更改的数据。 AEM利用iOS的客户端通信框架来简化数据通信和传输，从而需要最少量的本机代码才能启用基于iOS的web应用程序。

所有传输的数据都可以提取到同一目录结构中，因此在提取数据时无需执行其他步骤（如依赖项检查）。 对于iOS，所有数据都存储在iOS应用程序Documents文件夹的子文件夹中。

基于iOS的AEM Mobile应用程序的典型执行路径：

如果无法建立连接，则会显示之前下载的数据。

其他资源 additional-resources

要了解管理员和作者的角色和职责，请参阅以下资源：