AEM:查询参数排序不一致会影响ETag和缓存

本文介绍了在Adobe Experience Manager中,资产交付API或核心图像组件生成的图像URL中的查询参数具有非确定性排序,可能会导致ETags不稳定和缓存效率低下。 它提供了解决问题的步骤。

描述 description

环境

Adobe Experience Manager as a Cloud Service(所有版本)

问题/症状

  • 在投放层上发现HTML页面缓存失效和不一致的ETag值。
  • 有些If-None-Match请求返回200 OK而不是304 Not Modified,从而导致不必要的下载并降低缓存效率。
  • 资产交付API或核心图像组件生成的图像URL包括查询参数,例如width、quality和preferwebp,其顺序不确定。 这会导致文本HTML响应正文在请求之间更改,即使内容在功能上完全相同也是如此。

参数排序不一致示例:

  • /adobe/dynamicmedia/deliver/path/to/image?width=1600&quality=85&preferwebp=true
  • /adobe/dynamicmedia/deliver/path/to/image?quality=85&preferwebp=true&width=1600

原因

用于生成查询参数的无序集合(如HashMap、HashSet或Collectors.toMap())导致非确定性排序。 这会导致HTML输出在请求之间发生变化,并破坏基于ETag的缓存。

解决方法 resolution

请按照以下步骤解决问题:

  1. 确定负责在受影响的组件中生成图像URL的Sling模型或HTL代码,例如主页主页主页或轮播。

  2. 检查查询参数是否使用无序集合(如HashMap、HashSet或Collectors.toMap())装配。

  3. 重构代码以确保确定性参数排序:

    • 使用TreeMap按键对参数进行排序,确保排序一致。
    • 如果必须保留插入顺序,请使用LinkedHashMap并确保各个请求中的插入顺序一致。
  4. 部署更新的组件。

  5. 验证生成的图像URL在所有发布实例和请求中具有一致的查询参数顺序。

  6. 确认同一页面的ETags在Publish实例中完全相同,并且CDN/浏览器缓存可按预期工作,即在适当时返回304 Not Modified响应。

相关阅读

recommendation-more-help
experience-cloud-kcs-help-kbarticles