启用前端管道 enable-front-end-pipeline
了解如何启用现有站点的前端管道以使用站点主题更快地自定义您的站点。
概述 overview
前端管道是一种机制,它可以根据站点主题和站点模板快速部署网站的前端代码。
此管道仅处理前端代码,这使得部署过程比全栈部署更快。 它允许前端开发人员轻松自定义您的站点,而无需了解AEM。
默认情况下,基于站点模板的站点可以利用前端管道。本文档描述了如何调整现有站点以利用前端管道。
AEM可以将站点配置为加载使用前端管道部署的主题,即使您的站点不是使用站点模板和主题创建的,方法是将其叠加到现有客户端库上。
技术详细信息 technical-details
在激活站点的前端管道时,AEM 会对站点结构进行以下更改。
- 站点的所有页面都包含一个额外的CSS和JS文件,可以通过专用的Cloud Manager前端管道部署更新来修改这些文件。
- 添加的CSS和JS文件最初是空的。 但是,您可以下载“主题源”文件夹以设置通过管道部署CSS和JS代码更新所需的文件夹结构。
- 只有开发人员可以通过删除此操作在
/conf/<site-name>/sling:configs
下创建的SiteConfig
和HtmlPageItemsConfig
节点来撤消更改。
要求 requirements
AEM 可以自动调整您的现有站点以使用前端管道。若要执行此工作流,您的网站必须使用核心组件🔗的v2或更高版本页面组件。
启用前端管道 enabling
请参阅 将 Cloud Manager IP 允许列表与前端管道结合使用。
使用站点边栏从站点控制台启用您的站点。
-
登录 AEM,然后通过 全局导航 > 站点 来导航到您的站点。
-
在控制台中选择您的站点。选择站点的根,而不是任何子页面。
-
选择您的站点后,打开左侧的边栏选择器,然后选择 站点。
-
在 站点 边栏中,单击 启用前端管道 按钮。
-
AEM会提示您确认所做的更改概述。 确认并调整您的网站。
现在,您的站点已准备好使用前端管道。 要了解有关前端管道和管理站点主题的更多信息,请参阅:
- 使用站点边栏管理站点主题
- 快速站点创建历程 – 本文档历程为您详尽概述了使用前端管道和快速站点创建工具来快速部署站点的过程。
- CI/CD 管道 – 本文档描述了全栈和 Web 层管道上下文中的前端管道。
前端管道和自定义域 custom-domains
前端管道可以与Cloud Manager的自定义域功能一起使用,但将这两项功能一起使用时,请注意以下要求。
静态前端文件 static-files
默认情况下,通过Front-End Pipeline部署的静态前端资源将由Adobe的预定义静态域提供服务。
如果前端资源需要自定义域,则可以在发布层上安装自定义域,并配置Dispatcher以将特定路径(如/static/
)路由到Adobe的静态托管位置。 此方法需要更新您的Dispatcher规则,以正确转发和缓存静态资源的请求。
配置自定义域和Dispatcher后,您可以配置AEM以从静态域为前端资源提供服务。
配置 configuration
如技术详细信息部分中所述,为站点激活前端管道功能会在/conf/<site-name>/sling:configs
下创建SiteConfig
和HtmlPageItemsConfig
节点。
如果您希望将适用于您的站点的Cloud Manager自定义域功能与用于状态资源的前端管道结合使用,则必须将其他属性添加到这些节点。
-
在
SiteConfig
中为站点设置customFrontendPrefix
属性。- 导航到
/conf/<site-name>/sling:configs/com.adobe.aem.wcm.site.manager.config.SiteConfig
。 - 添加或更新属性
customFrontendPrefix = "https://your-custom-domain.com/static/"
。
- 导航到
-
这会使用自定义域更新
HtmlPageItemsConfig
的prefixPath
值。-
导航到
/conf/<site-name>/sling:configs/com.adobe.cq.wcm.core.components.config.HtmlPageItemsConfig
。 -
验证
prefixPath
是否反映了您的自定义域,如prefixPath = "https://your-custom-domain.com/static/<hash>/..."
。
- 需要时也可以手动覆盖此值。
-
-
验证设置。
- 部署后,检查页面是否正确引用了自定义域中的主题工件。
- 打开浏览器的开发人员工具并检查
theme.css
和theme.js
文件路径以确认它们是从正确的域加载的。
站点的页面,然后引用该更新URL中的主题工件。 然后,Dispatcher将这些资源的请求路由到静态域。
面向前端开发人员的最佳实践 best-practices
如果在通过前端管道进行部署之前需要在本地开发和测试前端资产,请考虑以下方法:
- 使用站点主题生成器的代理模式在本地覆盖主题工件以进行测试。
- 从本地开发服务器手动提供主题文件并更新
HtmlPageItemsConfig
中的prefixPath
以匹配本地服务器地址。 - 确保在测试期间禁用浏览器缓存以查看实时更新。
有关本地前端开发的更多详细信息,请参阅站点主题生成器文档。