SpringMVC应用程序中的Thymeleaf模板布局，无扩展

在使用JSP / JSTL和Apache Tiles几年之后&＃xff0c;我开始为我的Spring MVC应用程序发现Thymeleaf。 Thymeleaf是一个非常出色的视图引擎&＃xff0c;尽管目前缺乏良好的IntelliJ&＃xff08;投票&＃xff1a;http: //youtrack.jetbrains.com/issue/IDEABKL-6713 &＃xff09;支持&＃xff0c;但它简化并加快了开发速度&＃xff08;有Eclipse&＃xff09;插件 &＃xff09;。 在学习如何使用Thymeleaf的同时&＃xff0c;我研究了使用布局的不同可能性。

除了本机片段包含机制之外 &＃xff0c;还至少有两个选项可用于布局&＃xff1a; Thymeleaf与Apache Tile的集成以及Thymeleaf Layout Dialect 。 两者似乎都可以正常工作&＃xff0c;但是受关于简单和自定义选项的评论的启发&＃xff0c;我尝试了一下。 在这篇文章中&＃xff0c;我将展示我创建了解决方案。

创建具有Thymeleaf支持的Spring MVC项目

为了快速入门&＃xff0c;我在Thymeleaf 2.1支持下使用了Spring MVC原型 。 我通过简单地调用原型创建了一个项目&＃xff0c;然后将其导入到IntellJ中。

创建布局文件

在WEB-INF / views目录中&＃xff0c;我创建了一个布局文件夹&＃xff0c;在其中放置了第一个名为default.html的布局文件&＃xff1a;$ {view}变量将包含&＃64;Controller返回的视图名称和$ {view}中的内容片段文件将放置在这里。

创建视图文件

我编辑了WEB-INF / views / homeNotSignedIn.html&＃xff0c;并按如下方式定义了内容片段&＃xff1a;因此&＃xff0c;唯一的更改是定义名为content的片段并删除重复的片段包含。 无需其他更改。 &＃64;Controller返回原始视图名称&＃xff0c;与之前一样&＃xff1a;

&＃64;Controller
class HomeController {&＃64;RequestMapping(value &＃61; "/", method &＃61; RequestMethod.GET)String index(Principal principal) {return principal !&＃61; null ? "home/homeSignedIn" : "home/homeNotSignedIn";}
}

我相应地改变了其他观点。

创建拦截器并与Spring MVC集成

为了完成“新布局框架”&＃xff0c;我创建了一个处理程序拦截器来完成工作&＃xff1a;

public class ThymeleafLayoutInterceptor extends HandlerInterceptorAdapter {private static final String DEFAULT_LAYOUT &＃61; "layouts/default";private static final String DEFAULT_VIEW_ATTRIBUTE_NAME &＃61; "view";&＃64;Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {if (!modelAndView.hasView()) {return;}String originalViewName &＃61; modelAndView.getViewName();modelAndView.setViewName(DEFAULT_LAYOUT);modelAndView.addObject(DEFAULT_VIEW_ATTRIBUTE_NAME, originalViewName);}
}

ThymeleafLayoutInterceptor获取从处理程序的方法返回的原始视图名称&＃xff0c;并将其替换为布局名称&＃xff08;在WEB-INF / views / layouts / default.html中定义&＃xff09;。 原始视图作为视图变量放置在模型中&＃xff0c;因此可以在布局文件中使用它。 我覆盖了postHandle方法&＃xff0c;因为它是在呈现视图之前执行的。

添加拦截器很容易&＃xff1a;

&＃64;Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {&＃64;Overrideprotected void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(new ThymeleafLayoutInterceptor());}
}

这就是基本配置。 此后没有火箭。 转到localhost&＃xff1a;8080后的结果。 这是我所期望的。 奇迹般有效。 因此&＃xff0c;我尝试注册一个帐户以及提交表单后看到的内容&＃xff1a;

500 returned for /signup with message Error resolving template "redirect:/", template might not exist or might not be accessible by any of the configured Template Resolvers

当然&＃xff0c;
重定向&＃xff1a;/提交表单后。 我需要像这样修改拦截器&＃xff1a;

public class ThymeleafLayoutInterceptor extends HandlerInterceptorAdapter {private static final String DEFAULT_LAYOUT &＃61; "layouts/default";private static final String DEFAULT_VIEW_ATTRIBUTE_NAME &＃61; "view";&＃64;Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {if (!modelAndView.hasView()) {return;}String originalViewName &＃61; modelAndView.getViewName();if (isRedirectOrForward(originalViewName)) {return;}modelAndView.setViewName(DEFAULT_LAYOUT);modelAndView.addObject(DEFAULT_VIEW_ATTRIBUTE_NAME, originalViewName);} private boolean isRedirectOrForward(String viewName) {return viewName.startsWith("redirect:") || viewName.startsWith("forward:");}
}

它按预期工作。 但是我意识到我需要定义和附加布局&＃xff0c;因为Signup和Signin之前&＃xff08;而不是在应用上述更改之后&＃xff09;使用了此布局。

创建其他布局

我创建了一个名为blank.html的新布局&＃xff0c;并将其放置到WEB-INF / views / layouts文件夹中。 但是如何使用选择布局&＃xff1f; 可能有很多方法可以做到这一点。 我最简单的方法之一就是通过简单地添加一个名为layout的模型属性来从&＃64;Controller返回布局名称。 如果未给出布局&＃xff0c;则使用默认布局&＃xff0c;否则使用给定布局。 简单。 但是我想要一个更强大的解决方案。 所以我想也许我可以这样使用注释&＃xff1a;

&＃64;Controller
class SigninController {&＃64;Layout(value &＃61; "layouts/blank")&＃64;RequestMapping(value &＃61; "signin")String signin() {return "signin/signin";}
}

对我来说&＃xff0c;这听起来像是一个很好的解决方案。 所以我实现了它。

选择布局

我创建了一个方法级别&＃64;Layout批注&＃xff0c;并将其放置在org.thymeleaf.spring.support包中&＃xff08;与ThymeleafLayoutInterceptor一起&＃xff09;&＃xff1a;

package org.thymeleaf.spring.support;import java.lang.annotation.*;&＃64;Target(ElementType.METHOD)
&＃64;Retention(RetentionPolicy.RUNTIME)
&＃64;Documented
public &＃64;interface Layout {String value() default "";
}

我将拦截器更改如下&＃xff1a;

public class ThymeleafLayoutInterceptor extends HandlerInterceptorAdapter {private static final String DEFAULT_LAYOUT &＃61; "layouts/default";private static final String DEFAULT_VIEW_ATTRIBUTE_NAME &＃61; "view";&＃64;Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {if (!modelAndView.hasView()) {return;}String originalViewName &＃61; modelAndView.getViewName();if (isRedirectOrForward(originalViewName)) {return;}String layoutName &＃61; getLayoutName(handler);modelAndView.setViewName(layoutName);modelAndView.addObject(DEFAULT_VIEW_ATTRIBUTE_NAME, originalViewName);}private boolean isRedirectOrForward(String viewName) {return viewName.startsWith("redirect:") || viewName.startsWith("forward:");}private String getLayoutName(Object handler) {HandlerMethod handlerMethod &＃61; (HandlerMethod) handler;Layout layout &＃61; handlerMethod.getMethodAnnotation(Layout.class);if (layout &＃61;&＃61; null) {return DEFAULT_LAYOUT;} else {return layout.value();}}
}

现在&＃xff0c;当使用&＃64;Layout注释对处理程序方法进行注释时&＃xff0c;它将获得其value属性。 效果很好。 但是&＃xff0c;当我开始更改SignupController时&＃xff0c;我意识到我需要注释这两种方法。 如果可以通过对&＃64;Controller类进行注释&＃xff0c;将我的注释一次用于所有方法&＃xff0c;那就更好了&＃xff1a;

&＃64;Controller
&＃64;Layout(value &＃61; "layouts/blank")
class SignupController {}

所以我做了。

最后的修饰

首先&＃xff0c;我更改了注释&＃xff0c;以便可以将其定位为类型级别&＃xff1a;

&＃64;Target({ElementType.METHOD, ElementType.TYPE})
&＃64;Retention(RetentionPolicy.RUNTIME)
&＃64;Documented
public &＃64;interface Layout {String value() default "";
}

和拦截器&＃xff1a;

public class ThymeleafLayoutInterceptor extends HandlerInterceptorAdapter {private static final String DEFAULT_LAYOUT &＃61; "layouts/default";private static final String DEFAULT_VIEW_ATTRIBUTE_NAME &＃61; "view";private String defaultLayout &＃61; DEFAULT_LAYOUT;private String viewAttributeName &＃61; DEFAULT_VIEW_ATTRIBUTE_NAME;public void setDefaultLayout(String defaultLayout) {Assert.hasLength(defaultLayout);this.defaultLayout &＃61; defaultLayout;}public void setViewAttributeName(String viewAttributeName) {Assert.hasLength(defaultLayout);this.viewAttributeName &＃61; viewAttributeName;}&＃64;Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {if (!modelAndView.hasView()) {return;}String originalViewName &＃61; modelAndView.getViewName();if (isRedirectOrForward(originalViewName)) {return;}String layoutName &＃61; getLayoutName(handler);modelAndView.setViewName(layoutName);modelAndView.addObject(this.viewAttributeName, originalViewName);}private boolean isRedirectOrForward(String viewName) {return viewName.startsWith("redirect:") || viewName.startsWith("forward:");}private String getLayoutName(Object handler) {HandlerMethod handlerMethod &＃61; (HandlerMethod) handler;Layout layout &＃61; getMethodOrTypeAnnotation(handlerMethod);if (layout &＃61;&＃61; null) {return this.defaultLayout;} else {return layout.value();}}private Layout getMethodOrTypeAnnotation(HandlerMethod handlerMethod) {Layout layout &＃61; handlerMethod.getMethodAnnotation(Layout.class);if (layout &＃61;&＃61; null) {return handlerMethod.getBeanType().getAnnotation(Layout.class);}return layout;}
}

如您所见&＃xff0c;方法级别注释比类型级别注释更重要&＃xff0c;这提供了一定的灵活性。 此外&＃xff0c;我还添加了配置拦截器的可能性。 我认为&＃xff0c;设置默认布局名称和视图属性名称可能会很有用。

摘要

提出的解决方案可能需要一些改进才能在生产中使用&＃xff0c;但是它显示了我们可以简单地构建模板布局而无需在项目中添加额外的库并仅利用Thymeleaf的核心功能。 请分享您对解决方案的评论和意见。

• 请在GitHub上找到源代码&＃xff1a; https : //github.com/kolorobot/thymeleaf-custom-layout

翻译自: https://www.javacodegeeks.com/2013/11/thymeleaf-template-layouts-in-spring-mvc-application-with-no-extensions.html