AEM 技术基础 aem-technical-foundations
AEM是一个基于经验证、可扩展且灵活的技术而构建的强大平台。 本文档详细概述了构成AEM的各个部分,旨在作为全栈AEM开发人员的技术附录。 本指南并非旨在作为入门指南。 如果您是AEM开发的新手,请参阅作为第一步AEM Sites开发入门 — WKND教程。
基础知识 fundamentals
作为现代内容管理系统,AEM依赖于标准的Web技术:
- request-response (XMLHttpRequest / XMLHttpResponse)循环
- HTML
- CSS
- JavaScript
底层内容存储库和业务逻辑层是围绕Java™技术构建的:
- JCR
- Sling
- osgi
Java™内容存储库 java-content-repository
Java™ Content Repository (JCR)标准JSR 283指定了一种独立于供应商且独立于实施的方法,用于在内容存储库内的粒度级别双向访问内容。 规范牵头机构为Adobe研究(瑞士) AG。
JCR API 2.0包javax.jcr.*
用于直接访问和处理存储库内容。
AEM基于JCR构建。
Apache Jackrabbit Oak jackrabbit-oak
Apache Jackrabbit Oak是可扩展的高性能分层内容存储库的实现,用于现代世界级网站和其他要求苛刻的内容应用程序的基础,符合JCR标准。
Jackrabbit Oak(也简称为Oak)是实施JCR标准,AEM构建基于此标准。
Sling请求处理 sling-request-processing
AEM是使用Sling构建的,该Web应用程序框架基于REST原则,可轻松开发面向内容的应用程序。 Sling使用Apache Jackrabbit Oak等JCR存储库作为其数据存储。 Sling已加入到Apache Software Foundation — 有关详细信息,请访问Apache。
Sling简介 introduction-to-sling
使用Sling时,要呈现的内容类型不是第一个处理注意事项。 相反,主要考虑的问题是URL是否解析为内容对象,然后可以找到该内容对象的脚本来执行渲染。 此过程为Web内容作者提供了极佳的支持,让他们能够根据自己的需求轻松自定义页面。
在包含各种不同内容元素的应用程序中,或者在您需要可以轻松自定义的页面时,这种灵活性的优势非常明显。 尤其是在实施Web内容管理系统(如AEM)时。
有关使用Sling进行开发的第一步,请参阅在15分钟内发现Sling。
下图说明了Sling脚本解析。 它展示了如何从HTTP请求获取到内容节点、从内容节点获取到资源类型、从资源类型获取到脚本以及可用的脚本变量。
下图说明了可与SlingPostServlet
(所有POST请求的默认处理程序)一起使用的隐藏但功能强大的请求参数。 该处理程序为您提供了在存储库中创建、修改、删除、复制和移动节点的无限选项。
Sling以内容为中心 sling-is-content-centric
Sling以 内容为中心。 这意味着处理侧重于内容,因为每个(HTTP)请求都映射到JCR资源(存储库节点)形式的内容:
- 第一个目标是保存内容的资源(JCR节点)
- 第二,表示法或脚本从资源属性中定位,带有请求的某些部分(例如,选择器和/或扩展)
RESTful Sling restful-sling
由于其以内容为中心的理念,Sling实现了面向REST的服务器,从而在Web应用程序框架中引入了新概念。 其优点是:
-
RESTful,而不仅仅是在曲面上;资源和表示在服务器内正确建模
-
删除一个或多个数据模型
- 其他内容管理框架可能需要URL结构、业务对象、数据库架构才能访问资源。
- 使用Sling将其减少为:URL =资源= JCR结构
URL分解 url-decomposition
在Sling中,处理由用户请求的URL驱动。 它定义相应的脚本要显示的内容,并会从URL中提取信息。
正在分析以下URL:
https://myhost/tools/spy.printable.a4.html/a/b?x=12
您可以将它分解为其复合部分:
https://
myhost
/
tools/spy
.printable.a4.
html
/
a/b
?
x=12
- 协议 - HTTPS
- 主机 — 网站的域
- 内容路径 — 指定要渲染的内容并与扩展一起使用的路径。 在此示例中,它将转换为
tools/spy.html
- 选择器 — 用于呈现内容的替代方法;在本例中为A4格式的打印机友好版本
- 扩展 — 内容格式;还指定用于渲染的脚本
- 后缀 — 可用于指定其他信息
- 参数 — 动态内容所需的任何参数
从URL到内容和脚本 from-url-to-content-and-scripts
使用URL分解原理:
- 映射使用从请求提取的内容路径来定位资源。
- 找到相应的资源后,将提取sling资源类型,并用于定位要用于呈现内容的脚本。
下图说明了所使用的机构,以下几节将对此进行更详细的讨论。
使用Sling,您可以指定哪个脚本呈现特定实体(通过在JCR节点中设置sling:resourceType
属性)。 此机制提供的自由度比脚本访问数据实体的自由度要多(PHP脚本中的SQL语句就是这样),因为资源可以具有多个格式副本。
将请求映射到资源 mapping-requests-to-resources
对请求进行细分,提取出必要的信息。 在存储库中搜索请求的资源(内容节点):
- 第一个Sling检查请求中指定的位置是否存在节点;例如,
../content/corporate/jobs/developer.html
- 如果未找到节点,则将丢弃该扩展并重复搜索;例如,
../content/corporate/jobs/developer
- 如果未找到节点,则Sling返回http代码404(未找到)。
Sling还允许将JCR节点以外的内容作为资源,但此功能是一项高级功能。
查找脚本 locating-the-script
找到相应的资源(内容节点)后,将提取 sling资源类型。 此路径将查找用于呈现内容的脚本。
sling:resourceType
指定的路径可以是:
- 绝对
- 相对于配置参数
所有Sling脚本都存储在/apps
(可变用户脚本)或/libs
(不可变,系统脚本)的子文件夹中,将按此顺序搜索这些子文件夹。
其他几点需要注意的是:
- 当需要方法(GET、POST)时,将按照HTTP规范以大写形式指定该方法,例如
jobs.POST.esp
- 虽然支持各种脚本引擎,但常见的推荐脚本是HTL和JavaScript。
Felix管理控制台(http://<host>:<port>/system/console/slingscripting
)上列出了给定的AEM实例支持的脚本引擎列表。
使用上一个示例,如果sling:resourceType
为hr/jobs
,则对于:
-
以
.html
结尾的GET/HEAD请求和URL(默认请求类型,默认格式)- 脚本是
/apps/hr/jobs/jobs.esp
;sling:resourceType
的最后一个部分构成了文件名。
- 脚本是
-
POST请求(除GET/HEAD之外的所有请求类型,方法名称必须大写)
- POST在脚本名称中使用。
- 脚本为
/apps/hr/jobs/jobs.POST.esp
。
-
其他格式的URL,结尾不是
.html
- 例如,
../content/corporate/jobs/developer.pdf
- 脚本为
/apps/hr/jobs/jobs.pdf.esp
;后缀已添加到脚本名称中。
- 例如,
-
带有选择器的URL
- 选择器可用于以替代格式显示相同的内容。 例如,打印机友好版本、rss馈送或摘要。
- 如果您查看打印机友好版本,其中选择器可能是
print
;如在../content/corporate/jobs/developer.print.html
中 - 脚本为
/apps/hr/jobs/jobs.print.esp
;选择器已添加到脚本名称中。
-
如果不是,则定义
sling:resourceType
,然后:- 内容路径用于搜索适当的脚本(如果基于路径的
ResourceTypeProvider
处于活动状态)。 - 例如,
../content/corporate/jobs/developer.html
的脚本将在/apps/content/corporate/jobs/
中生成搜索。 - 使用主节点类型。
- 内容路径用于搜索适当的脚本(如果基于路径的
-
如果根本找不到脚本,则使用默认脚本。
- 支持以纯文本(
.txt
)、HTML(.html
)和JSON (.json
)的形式呈现默认演绎版,所有这些演绎版都列出了节点的属性(格式适当)。 扩展.res
或没有请求扩展名的请求的默认演绎版是假脱机资源(如果可能)。
- 支持以纯文本(
-
对于http错误处理(代码403或404),Sling会在以下位置查找脚本:
- 自定义脚本的位置
/apps/sling/servlet/errorhandler
- 或标准脚本
/libs/sling/servlet/errorhandler/404.jsp
的位置
- 自定义脚本的位置
如果给定请求应用了多个脚本,则会选择具有最佳匹配的脚本。 匹配项越具体,其效果就越好;换句话说,无论请求扩展名或方法名称是否匹配,选择器越匹配越好。
例如,考虑访问资源的请求
/content/corporate/jobs/developer.print.a4.html
类型
sling:resourceType="hr/jobs"
假设您在正确的位置拥有以下脚本列表:
GET.esp
jobs.esp
html.esp
print.esp
print.html.esp
print/a4.esp
print/a4/html.esp
print/a4.html.esp
则优先顺序为(8)-(7)-(6)-(5)-(4)-(3)-(2)-(1)。
除了资源类型(主要由sling:resourceType
属性定义)之外,还有资源超级类型。 sling:resourceSuperType
属性指示此类型。 在尝试查找脚本时,也会考虑这些超类型。 资源超级类型的优点在于,它们可以形成资源的层次结构,其中默认资源类型sling/servlet/default
(由默认servlet使用)有效地作为根。
可以通过两种方式定义资源的资源超级类型:
- 按资源的
sling:resourceSuperType
属性。 sling:resourceType
指向的节点的sling:resourceSuperType
属性。
例如:
-
/
-
a
-
b
sling:resourceSuperType = a
-
c
sling:resourceSuperType = b
-
x
sling:resourceType = c
-
y
sling:resourceType = c
sling:resourceSuperType = a
-
类型层次结构:
/x
- 为
[ c, b, a, <default>]
- 为
- 为
/y
时段- 层次结构为
[ c, a, <default>]
- 层次结构为
原因在于/y
具有sling:resourceSuperType
属性,而/x
没有,因此其超类型取自其资源类型。
无法直接调用Sling脚本 sling-scripts-cannot-be-called-directly
在Sling中,无法直接调用脚本,因为这会破坏REST服务器的严格概念;您将混合使用资源和表示法。
如果直接调用表示形式(脚本),则会在脚本中隐藏资源,因此框架(Sling)不再知道该表示形式。 因此,您将失去某些特征:
-
自动处理GET以外的http方法,包括:
- 使用sling默认实现处理的POST、PUT、DELETE
sling:resourceType
位置中的POST.jsp
脚本
-
您的代码架构不再像以前那样干净或结构清晰;这对于大规模开发至关重要
Sling API sling-api
使用Sling API包org.apache.sling.*
和标记库。
使用sling:include引用现有元素 referencing-existing-elements-using-sling-include
最后需要考虑的是需要引用脚本中的现有元素。
更复杂的脚本(聚合脚本)可访问多个资源(例如,导航、侧栏、页脚、列表元素),具体方法是包含 资源。
在这种情况下,您可以使用sling:include("/<path>/<resource>")
命令。 它有效地包含了被引用资源的定义。
osgi osgi
OSGi(开放服务网关计划)定义了一种用于开发和部署模块化应用程序和库(也称为Java™动态模块系统)的架构。 OSGi容器允许您将应用程序分成单独的模块(是具有其他元信息的jar文件,在OSGi术语中称为捆绑包),并通过以下方式管理它们之间的交叉依赖关系:
- 在容器中实施的服务
- 容器与您的应用程序之间的合同
这些服务和合同提供了一个体系结构,使各个元素能够动态地发现彼此进行协作。
然后,OSGi框架为您提供这些捆绑包的动态加载/卸载、配置和控制 — 无需重新启动。
此架构允许您通过应用程序特定的模块扩展Sling。 Sling以及AEM使用OSGi的Apache Felix实现。 它们都是在OSGi框架内运行的OSGi捆绑包的集合。
通过此功能,您可以对安装中的任意包执行以下操作:
- 安装
- 开始
- 停止
- 更新
- 卸载
- 查看最新状态
- 访问有关特定捆绑包的更多详细信息,例如符号名称、版本和位置
有关详细信息,请参阅为AEM as a Cloud Service配置OSGi。
存储库中的结构 structure-within-the-repository
以下列表概述了您在存储库中看到的结构。
/apps
— 与应用程序相关;包含特定于您网站的组件定义。 您开发的组件可以基于/libs/core/wcm/components
提供的现成组件。/content
— 为您的网站创建的内容。/etc
/home
— 用户和组信息。/libs
— 属于AEM核心的库和定义。/libs
中的子文件夹表示现成的AEM功能。 无法修改/libs
中的内容。 您网站的特定功能应在/apps
下创建。/tmp
— 临时工作区。/var
— 系统更改和更新的文件;如审核日志、统计数据、事件处理。
/libs
路径中的任何内容。 对于配置和其他更改,请将项目从/libs
复制到/apps
,并在/apps
内进行任何更改。