SPA模型路由

对于AEM中的单页应用程序,应用程序负责路由。 本文档介绍了传送机制、合同和可用选项。

注意

对于需要基于SPA框架的客户端渲染(例如,React或Angular)的项目,推荐使用SPA编辑器解决方案。

项目路由

应用程序拥有路由,然后由项目前端开发人员实施。 本文档介绍了特定于AEM服务器返回的模型的路由。 页面模型数据结构会公开基础资源的URL。 前端项目可以使用提供路由功能的任何自定义或第三方库。 一旦路由需要模型的片段,就可以调用PageModelManager.getData()函数。 当模型路由发生更改时,必须触发事件以警告监听库,如页面编辑器。

架构

有关详细说明,请参阅SPA Blueprint文档的PageModelManager部分。

ModelRouter

ModelRouter — 启用后 — 封装HTML5历史API函数pushStatereplaceState,以确保预取和访问给定的模型片段。 然后,通知注册的前端组件模型已被修改。

手动与自动模型路由

ModelRouter会自动获取模型的片段。 但是,作为任何自动化工具,它都有其局限性。 如果需要,可以禁用ModelRouter或将配置为忽略使用元属性的路径(请参阅SPA页面组件文档的元属性部分)。 然后,前端开发人员可以通过请求PageModelManager使用getData()函数加载任何给定的模型片段来实施自己的模型路由层。

注意

目前,We.Retail Journal示例React项目说明了自动化方法,而Angular项目则说明了手动方法。 半自动化方法也是有效的用例。

注意

ModelRouter的当前版本仅支持使用指向Sling模型入口点实际资源路径的URL。 它不支持使用虚URL或别名。

路由合同

当前实施基于以下假设:SPA项目使用HTML5历史记录API路由到不同的应用程序页面。

配置

ModelRouter在侦听pushStatereplaceState调用以预取模型片段时支持模型路由的概念。 在内部,它会触发PageModelManager以加载与给定URL对应的模型,并触发其他模块可以侦听的cq-pagemodel-route-changed事件。

默认情况下,此行为会自动启用。 要禁用此功能,SPA应呈现以下元属性:

<meta property="cq:pagemodel_router" content="disable"\>

请注意,SPA的每条路由都应与AEM中的可访问资源(例如“ /content/mysite/mypage"”)相对应,因为一旦选择了该路由,PageModelManager将自动尝试加载相应的页面模型。 但是,如果需要,SPA还可以定义路由的“阻止列表”,该路由应被PageModelManager忽略:

<meta property="cq:pagemodel_route_filters" content="route/not/found,^(.*)(?:exclude/path)(.*)"/>

在此页面上