基于Sling选择器在Sightly中显示不同的标记

时间:2015-02-17 21:54:31

标签: aem sling sightly sling-models

上下文

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

例如,对/content/my-project/my-page.html的请求应该产生基本页面视图,当向/content/my-project/my-page.ubermode.html发出请求时,Sling应该返回由稍微不同的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

我尝试了不同的命名约定来匹配选择器,但没有一个以令人满意的方式工作。

这是初始结构

/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

有一种优雅的方法可以解决这个问题吗?

2 个答案:

答案 0 :(得分:3)

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

这是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>

和底层Sling模型,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中的代码重复,并使基于选择器的逻辑单元可测试。此外,在我需要多个选择器来决定渲染内容的情况下,依赖命名约定会变得非常棘手。相比之下,为这个类添加对另一个相关选择器的支持将非常简单。

它也给我留下了很多重构选项。我可以从使用选择器切换到查询参数或标题,只编写几行代码,甚至没有触及有效的类我的客户端代码的Sigthly脚本。

答案 1 :(得分:0)

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

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