Thymeleaf中的模块化模板解析器

时间:2012-11-24 17:50:24

标签: java spring spring-mvc thymeleaf

我正在阅读Thymeleaf + Spring 3 Tutorial并尝试构建模块化应用程序。我的目标是能够从类路径中的Jars加载百万富翁模板。

为此,我在下一个xml中配置了SpringTemplateEngine

<bean id="templateEngine" class="org.thymeleaf.spring3.SpringTemplateEngine">
    <property name="templateResolvers">
        <util:set>
            <ref bean="servletContextTemplateResolver" />
            <ref bean="classpathPluginTemplateResolver" />
        </util:set>
    </property>
</bean>

<bean id="classpathPluginTemplateResolver"
    class="org.mael.codex.arcana.web.thymeleaf.templates.ClasspathPluginTemplateResolver">
    <property name="prefix" value="/META-INF/codexarcana/plugin/views" />
    <property name="suffix" value=".html" />
    <property name="templateMode" value="HTML5" />
</bean>

ClasspathPluginTemplateResolver代码:

public class ClasspathPluginTemplateResolver extends TemplateResolver {

public ClasspathPluginTemplateResolver() {
    super();
    super.setResourceResolver(new ClasspathTemplateResolver());
}

@Override
public void setResourceResolver(IResourceResolver resourceResolver) {
    throw new ConfigurationException("Cannot set a resource resolver on "
            + this.getClass().getName() + ". If "
            + "you want to set your own resource resolver, use "
            + TemplateResolver.class.getName() + "instead");
}
}

ClasspathTemplateResolver:

public class ClasspathTemplateResolver implements IResourceResolver {

@Override
public String getName() {
    return this.getClass().getSimpleName();
}

@Override
public InputStream getResourceAsStream(
        TemplateProcessingParameters templateProcessingParameters,
        String resourceName) {

    if (resourceName == null || resourceName.isEmpty()) {
        throw new IllegalArgumentException("Resource name cannot be null");
    }

    try {
        return new ClassPathResource(resourceName).getInputStream();
    } catch (IOException e) {
        throw new RuntimeException("Cannot open resource '" + resourceName
                + "'", e);
    }
}

}

如何避免ClasspathPluginTemplateResolver解析的模板中的名称冲突?

示例:

假设我有2个具有此目录结构的插件:

codexarcana-poll-plugin.jar
    ----/META-INF/codexarcana/plugin/views/wizard.html

codexarcana-gravatar-plugin.jar
    ----/META-INF/codexarcana/plugin/views/wizard.html

在这种情况下,我认为ClasspathTemplateResolver将返回错误的视图,或者会有解决此类问题的冲突。

1 个答案:

答案 0 :(得分:9)

扩展基础ITemplateResolver类的org.thymeleaf.templateresolver.AbstractTemplateResolver接口的实现(与所有开箱即用的实现一样)具有resolvablePatterns属性,允许您指定一个系列将用于确定哪些视图将被该特定模板引擎视为 resolvable 的模式。这应该可以帮助您避免碰撞。

您可以在其中指定通配模式,例如admin/*user/*/create等。

请注意,这些模式适用于视图名称,而不适用于模板文件名本身。例如,如果您的模板为/WEB-INF/templates/index.html且视图解析程序添加了前缀/WEB-INF/templates/和后缀.html,则您的视图名称index,因此像*.html这样的可解析模式永远不会匹配。

此外,还有一个order属性,用于确定要求模板解析器解析视图的顺序。

免责声明,根据StackOverflow规则的要求:我是Thymeleaf的作者。