可持续升级

自定义框架

架构(功能/基础架构/内容/应用程序)

自定义框架功能旨在帮助减少不友好升级的代码(如API)或内容(如叠加图)的不可扩展区域中的违规。

自定义框架有两个组件:API Surface​和​内容分类

API Surface

在以前的AEM版本中,许多API都通过Uber Jar公开。 其中一些API并不打算由客户使用,但已公布到各种包中支持AEM功能。 今后,Java API将标记为公共或专用,以向客户指示哪些API在升级环境中是安全的。 其他具体细节包括:

  • 标记为Public的Java API可供自定义实施包使用和引用。

  • 公共API将向后兼容安装的兼容包。

  • 兼容包将包含一个兼容性Uber JAR,以确保向后兼容

  • 标记为Private的Java API仅供AEM内部包使用,不应供自定义包使用。

注意

在此背景下,不应将PrivatePublic的概念与公共类和私有类的Java概念混淆。

image2018-2-12_23-52-48

内容分类

AEM长期以来一直使用叠加和Sling资源合并器的原理,以允许客户扩展和自定义AEM功能。 为AEM控制台和UI提供支持的预定义功能存储在​/libs​中。 客户永远不会修改​/libs​下的任何内容,但可以在​/apps​下添加其他内容,以叠加和扩展在​/libs​中定义的功能(有关更多信息,请参阅使用叠加进行开发)。 在将AEM升级为​/libs​中的内容时,这仍然会导致许多问题,这些问题可能会发生更改,从而导致叠加功能以意外方式中断。 客户还可以通过sling:resourceSuperType继承来扩展AEM组件,或者只需通过sling:resourceType直接引用​/libs​中的组件即可。 使用引用和覆盖用例可能会出现类似的升级问题。

为了使客户更安全、更轻松地了解​/libs​的哪些区域是安全的,并且已使用以下混合内容对​/libs​中的内容进行了分类:

  • Public(granite:PublicArea) — 将节点定义为公共节点,以便它可以覆盖、继承( sling:resourceSuperType)或直接使用( sling:resourceType)。添加兼容包后,/libs下标记为“Public”的节点将安全升级。 通常,客户应仅利用标记为“Public”的节点。

  • 抽象(granite:AbstractArea) — 将节点定义为抽象。节点可以叠加或继承(sling:resourceSupertype),但不得直接使用(sling:resourceType)。

  • 最终(granite:FinalArea) — 将节点定义为最终节点。分类为最终节点的节点不能叠加或继承。 最终节点可直接通过sling:resourceType使用。 默认情况下,最终节点下的子节点被视为内部节点

  • 内部(granite:InternalArea) — 将节点定义为内部节点。分类为内部的节点不能直接覆盖、继承或使用。 这些节点仅用于AEM的内部功能

  • 无注释 — 节点会根据树层次结构继承分类。默认情况下,/ root为Public。 父项被分类为“内部”或“最终”的节点也将被视为“内部”。

注意

这些策略仅针对基于Sling搜索路径的机制强制实施。 /libs(如客户端库)的其他区域可能标记为Internal,但仍可以与标准clientlib包含一起使用。 在这些情况下,客户必须继续遵守内部分类。

CRXDE Lite内容类型指示器

在CRXDE Lite中应用的混合将显示标记为INTERNAL的内容节点和树灰显。 对于FINAL,只有图标呈灰显状态。 这些节点的子项也将显示为灰色。 在这两种情况下,覆盖节点功能都处于禁用状态。

公共

image2018-2-8_23-34-5

最终

image2018-2-8_23-34-56

内部

image2018-2-8_23-38-23

内容运行状况检查

AEM 6.4附带一个运行状况检查,如果覆盖或引用的内容的使用方式与内容分类不一致,则会向客户发出警报。

Sling/Granite内容访问检查​是一项新的运行状况检查,用于监视存储库以查看客户代码是否错误地访问AEM中受保护的节点。

这将扫描​/apps,通常需要几秒钟才能完成。

要访问此新的运行状况检查,您需要执行以下操作:

  1. 从AEM主屏幕中,导航到​工具>操作>运行状况报告

  2. 单击​Sling/Granite内容访问检查,如下所示:

    screen_shot_2017-12-14at55648pm

扫描完成后,将显示警告列表,通知受保护节点的最终用户未正确引用该节点:

屏幕截图 — 2018-2-5healthreports

修复违规后,将返回绿色状态:

屏幕截图 — 2018-2-5healthreports-violations

运行状况检查显示由后台服务收集的信息,当在所有Sling搜索路径中使用叠加或资源类型时,后台服务会异步检查这些信息。 如果内容混合使用不正确,它会报告违规。

在此页面上