升级代码和自定义项 upgrading-code-and-customizations

在计划升级时,必须调查并解决实施的以下方面。

概述 overview

  1. 模式检测器 — 运行模式检测器,如升级计划中所述,并在此页面中详细描述。 您会获得一个模式检测器报告,该报告包含有关AEM Target版本中除了API/捆绑包不可用之外还必须解决的区域的更多详细信息。 模式检测报告会向您指示代码中的任何不兼容性。 如果不存在任何部署,则表明您的部署已经与6.5兼容。 您仍然可以选择为使用6.5功能执行新开发,但并非只是为了保持兼容性。 如果报告了不兼容情况,您可以选择在兼容模式下运行,并推迟开发新的6.5功能或兼容性。 或者,您可以在升级后决定进行开发,并转到步骤2。 有关更多详细信息,请参阅AEM 6.5中的向后兼容性。

  2. 开发6.5代码库 — 为Target版本的代码库创建专用分支或存储库。 使用升级前兼容性中的信息来规划要更新的代码区域。

  3. 使用6.5 Uber jar编译 — 更新代码库POM以指向6.5 uber jar并编译针对它的代码。

  4. 更新AEM自定义项* - *对AEM的任何自定义项或扩展都应进行更新/验证,以便在6.5中运行并添加到6.5代码库中。 包括UI Search Forms、Assets自定义,以及使用/mnt/overlay的任何内容

  5. 部署到6.5 Environment — 应在Dev/QA环境中显示AEM 6.5 (Author + Publish)的干净实例。 应部署更新后的代码库和有代表性的内容示例(来自当前生产)。

  6. QA验证和错误修复 - QA应在6.5的Author和Publish实例上验证应用程序。找到的任何错误都应修复并提交到6.5代码库。 根据需要重复Dev-Cycle,直到修复所有错误。

在继续升级之前,您应该有一个稳定的应用程序代码库,该代码库已针对AEM的目标版本进行了彻底测试。 根据测试中所做的观察,可以找到优化自定义代码的方法。 例如,其中可能包括重构代码以避免遍历存储库、自定义索引以优化搜索,或在JCR中使用无序节点等。

除了可以选择升级代码库和自定义以与新的AEM版本配合使用外,6.5还可以使用此页面中所述的“向后兼容性”功能更有效地管理您的自定义项。

如上所述和下图所示,在第一步运行模式检测器可以帮助您评估升级的整体复杂性。 它还可以帮助您决定是要以兼容模式运行,还是更新自定义项以使用所有新的AEM 6.5功能。 有关详细信息,请参阅AEM 6.5🔗中的向后兼容性。
opt_cropped

升级代码库 upgrade-code-base

在版本控制中为6.5代码创建专用分支 create-a-dedicated-branch-for-6.5-code-in-version-control

应使用某种形式的版本控制来管理实施AEM所需的所有代码和配置。 应创建版本控制中的专用分支,以管理目标版本AEM中的代码库所需的任何更改。 此分支管理针对AEM的目标版本迭代测试代码库以及后续错误修复。

更新AEM Uber Jar版本 update-the-aem-uber-jar-version

AEM Uber jar将所有AEM API作为单个依赖项包含在您的Maven项目的pom.xml中。 最佳做法始终是将Uber Jar作为单个依赖项包含在内,而不是包含单个AEM API依赖项。 升级代码库时,将Uber Jar的版本更改为指向AEM的目标版本。 如果您的项目是在Uber Jar存在之前的AEM版本上开发的,请删除所有单独的AEM API依赖项。 替换为包含AEM目标版本的Uber Jar的单个变量。 针对新版本的Uber Jar重新编译代码库。 更新任何已弃用的API或方法,以便与AEM的目标版本兼容。

<dependency>
    <groupId>com.adobe.aem</groupId>
    <artifactId>uber-jar</artifactId>
    <version>6.5.0</version>
    <classifier>apis</classifier>
    <scope>provided</scope>
</dependency>

逐步停止使用管理资源解析程序 phase-out-use-of-administrative-resource-resolver

在AEM 6.0之前的代码库中,通过SlingRepository.loginAdministrative()ResourceResolverFactory.getAdministrativeResourceResolver()使用管理会话的情况很普遍。出于安全原因,这些方法已被弃用,因为它们提供的访问级别过于宽泛。 在Sling的未来版本中,将删除这些方法。 强烈建议重构任何代码以改用服务用户。 有关服务用户和如何逐步停用管理会话的详细信息,请参阅此处

查询和Oak索引 queries-and-oak-indexes

在代码库中使用任何查询都必须作为升级代码库的一部分进行彻底测试。 对于从Jackrabbit 2(AEM 6.0之前的版本)升级的客户,此测试尤其重要,因为Oak不会自动为内容编制索引,并且应创建自定义索引。 如果从AEM 6.x版本升级,开箱即用的Oak索引定义可能已更改,并且可能影响现有查询。

以下工具可用于分析和检查查询性能:

经典UI创作 classic-ui-authoring

经典UI创作在AEM 6.5中仍然可用,但已被弃用。 可在此处找到更多信息。 如果您的应用程序在经典UI创作环境中运行,建议升级到AEM 6.5并继续使用经典UI。 然后,可以计划作为单独的项目迁移到Touch UI,以便通过多个开发周期完成。 要在AEM 6.5中使用经典UI,必须将多个OSGi配置提交到代码库。 有关如何进行配置的更多详细信息可在此处找到。

与6.5存储库结构保持一致 align-repository-structure

为了更轻松地进行升级并确保在升级期间不会覆盖配置,在6.4中重组了存储库,以将内容与配置分开。

因此,必须将多个设置移到不再像过去那样位于/etc下。 要查看AEM 6.4的更新版中必须审核和解决的整套存储库重构问题,请参阅AEM 6.4中的存储库重构。

AEM自定义 aem-customizations

必须标识AEM源版本中AEM创作环境的所有自定义项。 一旦标识,建议将每个自定义项都存储在版本控制中,或至少作为内容包的一部分进行备份。 在进行生产升级之前,应在运行目标版本的AEM的QA或暂存环境中部署和验证所有自定义项。

叠加一般信息 overlays-in-general

常见的做法是扩展AEM的开箱即用功能,方法是使用/apps下的其他节点覆盖/libs下的节点和/或文件。 应在版本控制中跟踪这些叠加,并针对AEM的目标版本进行测试。 如果文件(如JS、JSP、HTL)被覆盖,Adobe建议您就增强的功能发表评论,以便于对AEM的目标版本进行回归测试。 有关叠加图的详细信息,可在此处找到。 特定AEM叠加图的说明可在下面找到。

升级自定义搜索Forms upgrading-custom-search-forms

自定义搜索彩块化需要在升级后进行一些手动调整才能正常运行。 有关详细信息,请参阅升级自定义搜索Forms

Assets UI自定义 assets-ui-customizations

NOTE
只有从AEM 6.2之前的版本进行升级时,才需要执行此过程。

必须为升级准备已自定义Assets部署的实例。 要确保所有自定义内容与新的6.4节点结构兼容,必须执行此操作。

您可以通过执行以下操作为Assets UI准备自定义项:

  1. 在要升级的实例上,转到​ https://server:port/crx/de/index.jsp ​打开CRXDE Lite

  2. 转到以下节点:

    • /apps/dam/content
  3. 将内容节点重命名为​ content_backup,方法是右键单击窗口左侧的资源管理器窗格,然后选择​ 重命名

  4. 重命名节点后,在/apps/dam下创建一个名为​ content ​的名为content的节点,并将其节点类型设置为​ sling:Folder

  5. 通过右键单击资源管理器窗格中的每个子节点并选择​ 移动,将​ content_backup ​的所有子节点移动到新创建的内容节点。

  6. 删除​ content_backup ​节点。

  7. 理想情况下,/apps/dam下具有正确节点类型sling:Folder的已更新节点应保存到版本控制中,并使用代码库进行部署,或者至少作为内容包进行备份。

为现有Assets生成资源ID generating-asset-ids-for-existing-assets

要为现有资源生成资源ID,请在升级AEM实例以运行AEM 6.5时升级资源。启用Assets Insights功能需要此步骤。 有关详细信息,请参阅添加嵌入代码

要升级资产,请在JMX控制台中配置关联资产ID包。 根据存储库中的资源数,migrateAllAssets可能需要较长时间。 Adobe的内部测试估计,TarMK上的125000资产大约需要1小时。

1487758945977

如果您需要整个资产的子集的资产ID,请使用migrateAssetsAtPath API。

对于所有其他目的,请使用migrateAllAssets() API。

InDesign脚本自定义 indesign-script-customizations

Adobe建议将自定义脚本放在/apps/settings/dam/indesign/scripts位置。 有关InDesign脚本自定义设置的详细信息,请参阅此处

恢复ContextHub配置 recovering-contexthub-configurations

ContextHub配置受升级影响。 有关如何恢复现有ContextHub配置的说明,请参阅此处

工作流自定义 workflow-customizations

常用做法是编辑现成的工作流,以添加或删除不需要的功能。 自定义的常用工作流是DAM更新资产工作流。 自定义实施所需的所有工作流都应进行备份,并存储在版本控制中,因为升级期间可能会覆盖这些工作流。

可编辑模板 editable-templates

NOTE
仅当使用AEM 6.2中的可编辑模板进行站点升级时,才需要执行此过程

可编辑模板的结构在AEM 6.2和6.3之间发生了变化。如果要从6.2或更低版本升级,并且使用可编辑模板生成站点内容,则必须使用响应节点清理工具。 该工具旨在在​ 升级后运行 ​以清理内容。 在创作层和Publish层上运行它。

CUG实施更改 cug-implementation-changes

封闭用户组的实施发生了重大变化,以前的版本AEM在性能和可扩展性方面存在限制。 6.3中弃用了以前版本的CUG,并且仅在Touch UI中支持新的实施。 如果您是从6.2或更早版本升级,则可在此处找到有关迁移到新CUG实施的说明。

测试过程 testing-procedure

应该为测试升级准备全面的测试计划。 测试已升级的代码库和应用程序必须先在较低的环境中完成。 发现的错误应以迭代方式修复,直到代码库稳定为止,只有到那时才应升级更高级别的环境。

测试升级过程 testing-the-upgrade-procedure

此处概述的升级过程应在开发和QA环境中进行测试,如自定义运行手册中所述(请参阅计划升级)。 应重复升级过程,直到所有步骤都记录在升级运行手册中且升级过程顺利完成。

实施测试区域 implementation-test-areas-

以下是任何AEM实施的关键部分,在升级环境并部署升级后的代码库后,测试计划应涵盖这些关键部分。

功能测试区域
描述
已发布的站点
通过Dispatcher在发布层
上测试AEM实现和相关代码。 应包括页面更新和
缓存失效的条件。
创作
在创作层上测试AEM实现和相关代码。 应包括页面、组件创作和对话框。
与Experience Cloud解决方案集成
验证与Analytics、DTM和Target等产品的集成。
与第三方系统的集成
验证创作层和Publish层上的任何第三方集成。
身份验证、安全和权限
任何身份验证机制(如LDAP/SAML)都应进行验证。应在创作层和Publish
层上测试
权限和组。
查询
应测试自定义索引和查询以及查询性能。
UI自定义
创作环境中AEM UI的任何扩展或自定义设置。
工作流
自定义和/或现成的工作流和功能。
性能测试
负载测试应在模拟实际场景的Author层和Publish层上执行。

记录测试计划和结果 document-test-plan-and-results

应创建涵盖上述实施测试区域的测试计划。 通常,按作者和Publish任务列表划分测试计划是明智的。 此测试计划应在升级生产环境之前在开发、QA和暂存环境中执行。 测试结果和性能量度应在较低级别环境中捕获,以便在升级暂存环境和生产环境时进行比较。

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2