对于AEM中的单页应用程序,应用程序负责路由。 本文档介绍了传送机制、合同和可用选项。
单页应用程序(SPA)编辑器功能需要AEM 6.4 Service Pack 2或更高版本。
对于需要基于SPA框架的客户端渲染(例如,React或Angular)的项目,推荐使用SPA编辑器解决方案。
应用程序拥有路由,然后由项目前端开发人员实施。 本文档介绍了特定于AEM服务器返回的模型的路由。 页面模型数据结构会公开基础资源的URL。 前端项目可以使用提供路由功能的任何自定义或第三方库。 当路由需要模型的片段时,调用 PageModelManager.getData()
函数。 当模型路由发生更改时,必须触发事件以警告监听库,如页面编辑器。
有关详细说明,请参阅 PageModelManager 部分。
的 ModelRouter
— 启用时 — 封装HTML5历史API函数 pushState
和 replaceState
以保证预取和可访问给定的模型片段。 然后,通知注册的前端组件模型已被修改。
的 ModelRouter
自动获取模型的片段。 但是,作为任何自动化工具,它都有其局限性。 如果需要, ModelRouter
可以禁用或配置为使用元属性忽略路径(请参阅 SPA页面组件 文档)。 然后,前端开发人员可以通过请求 PageModelManager
使用 getData()
函数。
目前,We.Retail Journal示例React项目说明了自动化方法,而Angular项目则说明了手动方法。 半自动化方法也是有效的用例。
的当前版本 ModelRouter
仅支持使用指向Sling模型入口点实际资源路径的URL。 它不支持使用虚URL或别名。
当前实施基于以下假设:SPA项目使用HTML5历史API路由到不同的应用程序页面。
的 ModelRouter
在模型路由侦听时支持模型路由的概念 pushState
和 replaceState
调用预取模型片段。 在内部,它会触发 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)(.*)"/>