可持续升级 sustainable-upgrades
Customization Framework customization-framework
体系结构(功能/基础架构/内容/应用程序) architecture-functional-infrastructure-content-application
自定义框架功能旨在帮助减少代码(如API)或内容(如叠加图)的非可扩展区域中的违规,这些区域对升级不友好。
自定义框架有两个组件: API表面 和 内容分类。
API表面 api-surface
在Adobe Experience Manager (AEM)的早期版本中,许多API通过Uber Jar公开。 其中一些API并非打算供客户使用,而是公开支持各个捆绑包中的AEM功能。 今后,Java™ API将标记为“公用”或“专用”,以向客户指示在升级环境中可以安全使用哪些API。 其他具体包括:
-
标记为
Public
的Java™ API可由自定义实施捆绑包使用和引用。 -
公共API向后兼容兼容兼容包的安装。
-
兼容性包包含一个兼容性Uber JAR,以确保向后兼容性
-
标记为
Private
的Java™ API仅供AEM内部捆绑包使用,而不供自定义捆绑包使用。
Private
和Public
的概念与公共类和私有类的Java™概念。
内容分类 content-classifications
AEM长期以来使用叠加和Sling资源合并器的主体,允许客户扩展和自定义AEM功能。 为AEM控制台和UI提供支持的预定义功能存储在 /libs 中。 客户永远不会修改 /libs 下的任何内容,但可以在 /apps 下添加其他内容以叠加和扩展 /libs 中定义的功能(有关更多信息,请参阅使用叠加进行开发)。 在升级AEM时,这仍会导致许多问题,因为 /libs 中的内容可能会发生更改,从而导致覆盖功能以意外方式中断。 客户还可以通过sling:resourceSuperType
的继承来扩展AEM组件,或直接通过sling:resourceType引用 /libs 中的组件。 在引用和覆盖用例时,可能会出现类似的升级问题。
为了让客户更安全轻松地了解 /libs 的哪些区域可以安全使用和叠加 /libs 中的内容已使用以下mixin进行分类:
-
公共(granite:PublicArea) — 将节点定义为公共,以便可以覆盖、继承(
sling:resourceSuperType
)或直接使用(sling:resourceType
)。 标记为Public的/libs下的节点可以安全升级,并且添加了兼容包。 通常,客户应仅使用标记为“公共”的节点。 -
抽象(granite:AbstractArea) — 将节点定义为抽象。 节点可以覆盖或继承(
sling:resourceSupertype
),但不能直接使用(sling:resourceType
)。 -
Final (granite:FinalArea) — 将节点定义为最终节点。 最好分类为最终节点的节点不应覆盖或继承。 最终节点可以通过
sling:resourceType
直接使用。 默认情况下,最终节点下的子节点被视为内部节点。 -
内部(granite:InternalArea) *- *将节点定义为内部节点。 理想情况下,分类为内部节点的节点不应重叠、继承或直接使用。 这些节点仅用于AEM的内部功能
-
无批注 — 节点根据树层次结构继承分类。 /根默认为Public。 父级被分类为“内部”或“最终”的节点也将被视为“内部”节点。
Internal
,但仍可以与标准clientlib包含一起使用。 在这些情况下,客户必须继续遵守内部分类。CRXDE Lite内容类型指示器 crxde-lite-content-type-indicators
应用于CRXDE Lite的Mixin显示标记为INTERNAL
的内容节点和树呈灰色(灰显)。 对于FINAL
,只有图标灰显。 这些节点的子节点也显示为灰色。 在这两种情况下,都会禁用覆盖节点功能。
公共
最终
内部
内容运行状况检查
AEM 6.5附带运行状况检查,如果以与内容分类不一致的方式使用叠加或引用的内容,该检查会提醒客户。
Sling/Granite Content Access Check 是一项新的运行状况检查,用于监视存储库以查看客户代码是否未正确访问AEM中的受保护节点。
此操作扫描 /应用程序,通常需要几秒钟才能完成。
要访问此新的运行状况检查,请执行以下操作:
-
在AEM主屏幕中,导航到 工具>操作>运行状况报告
-
单击 Sling/Granite内容访问检查。
扫描完成后,将显示一个警告列表,通知最终用户未正确引用了受保护节点:
修复违规后,它会返回到绿色状态:
运行状况检查显示后台服务收集的信息,每当在所有Sling搜索路径上使用叠加或资源类型时,后台服务就会异步检查这些信息。 如果内容mixin使用不正确,它会报告冲突。