根据 Sling 选择器在 Sightly 中显示不同的标记

Display different markup in Sightly based on a Sling selector

上下文

我正在开发一个使用 Sightly 作为模板语言的 AEM 6 项目。我遇到一个用例,我想根据 Sling 选择器的存在来显示或隐藏标记的某些部分。

例如,对 /content/my-project/my-page.html 的请求应该产生一个基本的页面视图,当向 /content/my-project/my-page.ubermode.html 发出请求时,Sling 应该 return 相同的内容由略有不同的HTML 文档。

根据 the Sling Cheat Sheet,应该可以使用不同的脚本。

我通过放置两个 Sightly 脚本 mycomponent.htmlubermode.html(以选择器命名)设法在组件中实现了这一点

/apps/(...)/mycomponent
            |- .content.xml
            |- _cq_editConfig.xml
            |- dialog.xml
            |- mycomponent.html
            |- ubermode.html

当涉及到 HTML 结构时,这确实需要一些代码重复,但它工作正常。

但是,在这种特殊情况下,我需要在渲染器级别进行相同的思考(我们称之为 myapp/core/renderers/fancyPageRenderer)。更重要的是,渲染器有一个不同的渲染器作为它的sling:resourceSuperType(我们称这个父渲染器myapp/core/renderers/genericPageRenderer)并且依赖于一系列适度复杂的包含(data-sly-include)。

fancyPageRenderer 中,我覆盖了最初定义并包含在 genericPageRenderer 中的脚本之一。这是我希望在使用 ubermode 选择器时有所不同的部分。我们称这个脚本为 mainColumn.html

我尝试了不同的命名约定来匹配选择器,但 none 的命名约定令人满意。

这是初始结构

/apps/(...)/renderers/fancyPageRenderer
                      |- .content.xml
                      |- mainColumn.html //this overrides a script included by a parent renderer

这是我尝试过的:

/apps/(...)/renderers/fancyPageRenderer
                      |- .content.xml
                      |- mainColumn.uber.html
                      |- mainColumn.html

这根本行不通,每次都会包含 mainColumn.html


/apps/(...)/renderers/fancyPageRenderer
                      |- .content.xml
                      |- uber.html
                      |- mainColumn.html

这导致使用 uber.html 脚本,但生成的页面不包含在 genericPageRenderer

中包含的其他脚本中定义的任何标记

我想我可以将所有相关脚本和包含内容复制到 fancyPageRenderer,但这会导致大量且完全不可接受的代码重复。

我也知道可以手动 add, remove or replace selectors using data-sly-resource 或只使用原始选择器,但就我而言,广泛使用的是 data-sly-include 而不是 data-sly-resource

是否有解决此问题的优雅方法?

最终,我放弃了使用脚本命名约定来解决这个问题,并在我的渲染器的 Sightly 脚本中暴露了一个非常简单的 Sling 模型。

这是 fancyPageRenderer 的当前结构(与原来的结构没有变化):

/apps/(...)/renderers/fancyPageRenderer
                      |- .content.xml
                      |- mainColumn.html //this overrides a script included by the parent renderer

这是我在 mainColumn.html Sightly 脚本中使用的内容:

 <div class="fancy main-column" data-sly-use.uberMode="com.foo.bar.myapp.fancy.UberMode">
     <div data-sly-test="uberMode.enabled" >Uber-mode-only-content</div>
     <!-- Lots of markup here -->
     <div data-sly-test="!uberMode.enabled" >Explicitly non-uber-mode content</div>
     <div>Common content (but some uber-mode-dependend, nested divs as well, rendered the same way as above)</div>
 </div>

和基础吊索模型,UberMode

@Model(adaptables = SlingHttpServletRequest.class)
public class UberMode {

    @Inject
    SlingHttpServletRequest request;

    private boolean enabled = false;

    @PostConstruct
    public void postConstruct() {
        if (request != null) {
            List<String> selectors = Arrays.asList(request.getRequestPathInfo().getSelectors());
            enabled = selectors.contains("ubermode");
        }
    }

    public boolean isEnabled() {
        return enabled;
    }
}

这使我能够避免 Sightly 中的代码重复,并使 selector-based 逻辑 unit-testable。此外,在我需要多个选择器来决定要呈现什么的情况下,依赖命名约定会变得非常棘手。相比之下,向此 class 添加对另一个相关选择器的支持将非常简单。

它也给我留下了很多重构选项。我可以从使用选择器切换到查询参数或 header,只写几行代码,甚至不触及实际上是我的 class.

的客户端代码的 Sigthly 脚本

添加文件 ubermode.html 如果存在 Sling Selector ubermode,将调用该文件。为避免代码重复,提取公共部分(header.html、footer.html 等)并在需要的地方包含它们。

对于 mainColumn.html 的情况,您可以尝试将其放入名为 ubermode (/ubermode/mainColumn.html) 的子目录中。这是捕捉选择器的另一种方式。