这篇文章主要介绍了Spring Boot thymeleaf模板引擎的使用详解,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
目录
1、thymeleaf的介绍
2、thymeleaf使用模板
3、thymeleaf的表达式语法
4、thymeleaf实例演示
5、国际化的配置
在早期开发的时候，我们完成的都是静态页面也就是html页面，随着时间轴的发展，慢慢的引入了jsp页面，当在后端服务查询到数据之后可以转发到jsp页面，可以轻松的使用jsp页面来实现数据的显示及交互，jsp有非常强大的功能，但是，在使用springboot的时候，整个项目是以jar包的方式运行而不是war包，而且还嵌入了tomcat容器，因此，在默认情况下是不支持jsp页面的。如果直接以纯静态页面的方式会给我们的开发带来很大的麻烦，springboot推荐使用模板引擎。
模板引擎有很多种，jsp,freemarker,thymeleaf，模板引擎的作用就是我们来写一个页面模板，比如有些值呢，是动态的，我们写一些表达式。而这些值，从哪来呢，我们来组装一些数据，我们把这些数据找到。然后把这个模板和这个数据交给我们模板引擎，模板引擎按照我们这个数据帮你把这表达式解析、填充到我们指定的位置，然后把这个数据最终生成一个我们想要的内容给我们写出去，这就是我们这个模板引擎，不管是jsp还是其他模板引擎，都是这个思想。只不过不同的模板引擎语法不同而已，下面重点学习下springboot推荐使用的thymeleaf模板引擎，语法简单且功能强大
1、thymeleaf的介绍
官网地址：https://www.thymeleaf.org/
thymeleaf在github的地址：https://github.com/thymeleaf/thymeleaf
中文网站：https://raledong.gitbooks.io/using-thymeleaf/content/
导入依赖：
org.thymeleafthymeleaf-Spring5org.thymeleaf.extrasthymeleaf-extras-java8time
在springboot中有专门的thymeleaf配置类：ThymeleafProperties
@ConfigurationProperties(prefix = "spring.thymeleaf") public class ThymeleafProperties { private static final Charset DEFAULT_ENCODING = StandardCharsets.UTF_8; public static final String DEFAULT_PREFIX = "classpath:/templates/"; public static final String DEFAULT_SUFFIX = ".html"; /** * Whether to check that the template exists before rendering it. */ private boolean checkTemplate = true; /** * Whether to check that the templates location exists. */ private boolean checkTemplateLocation = true; /** * Prefix that gets prepended to view names when building a URL. */ private String prefix = DEFAULT_PREFIX; /** * Suffix that gets appended to view names when building a URL. */ private String suffix = DEFAULT_SUFFIX; /** * Template mode to be applied to templates. See also Thymeleaf's TemplateMode enum. */ private String mode = "HTML"; /** * Template files encoding. */ private Charset encoding = DEFAULT_ENCODING; /** * Whether to enable template caching. */ private boolean cache = true;
2、thymeleaf使用模板
@RequestMapping("/hello") public String hello(Model model){ model.addAttribute("msg","Hello"); //classpath:/templates/hello.html return "hello"; }
Hello
3、thymeleaf的表达式语法
Simple expressions: Variable Expressions: ${...} Selection Variable Expressions: *{...} Message Expressions: #{...} Link URL Expressions: @{...} Fragment Expressions: ~{...} Literals Text literals: 'one text', 'Another one!',… Number literals: 0, 34, 3.0, 12.3,… Boolean literals: true, false Null literal: null Literal tokens: one, sometext, main,… Text operations: String concatenation: + Literal substitutions: |The name is ${name}| Arithmetic operations: Binary operators: +, -, *, /, % Minus sign (unary operator): - Boolean operations: Binary operators: and, or Boolean negation (unary operator): !, not Comparisons and equality: Comparators: >, =,
4、thymeleaf实例演示
1、th的常用属性值
一、th:text ：设置当前元素的文本内容，相同功能的还有th:utext，两者的区别在于前者不会转义html标签，后者会。优先级不高：order=7
二、th:value：设置当前元素的value值，类似修改指定属性的还有th:src，th:href。优先级不高：order=6
三、th:each：遍历循环元素，和th:text或th:value一起使用。注意该属性修饰的标签位置，详细往后看。优先级很高：order=2
四、th:if：条件判断，类似的还有th:unless，th:switch，th:case。优先级较高：order=3
五、th:insert：代码块引入，类似的还有th:replace，th:include，三者的区别较大，若使用不恰当会破坏html结构，常用于公共代码块提取的场景。优先级最高：order=1
六、th:fragment：定义代码块，方便被th:insert引用。优先级最低：order=8
七、th:object：声明变量，一般和*{}一起配合使用，达到偷懒的效果。优先级一般：order=4
八、th:attr：修改任意属性，实际开发中用的较少，因为有丰富的其他th属性帮忙，类似的还有th:attrappend，th:attrprepend。优先级一般：order=5
thymeleaf.html
Title
name:
age:
gender:
ThymeleafController.java
import org.springframework.stereotype.Controller; import org.springframework.ui.ModelMap; import org.springframework.web.bind.annotation.RequestMapping; @Controller public class ThymeleafController { @RequestMapping("thymeleaf") public String thymeleaf(ModelMap map){ map.put("thText","th:text设置文本内容 加粗"); map.put("thUText","th:utext 设置文本内容 加粗"); map.put("thValue","thValue 设置当前元素的value值"); map.put("thEach","Arrays.asList("th:each", "遍历列表")"); map.put("thIf","msg is not null"); map.put("thObject",new Person("zhangsan",12,"男")); return "thymeleaf"; } }
2、标准表达式语法
${...} 变量表达式，Variable Expressions
*{...} 选择变量表达式，Selection Variable Expressions
二、可以使用ctx，vars，locale，request，response，session，servletContext内置对象
session.setAttribute("user","zhangsan"); th:text="${session.user}"
三、可以使用dates，numbers，strings，objects，arrays，lists，sets，maps等内置方法
standardExpression.html
thymeleaf内置方法
#strings
Old Str :toupperCase :
toLowerCase :
equals :
equalsIgnoreCase :
indexOf :
substring :
replace :
startsWith :
contains :
#numbers
formatDecimal 整数部分随意，小数点后保留两位，四舍五入:formatDecimal 整数部分保留五位数，小数点后保留两位，四舍五入:
#bools
#arrays
length :contains :
containsAll :
#lists
size :contains :
sort :
#maps
size :containsKey :
containsValue :
#dates
format :custom format :
day :
month :
monthName :
year :
dayOfWeekName :
hour :
minute :
second :
createNow :
ThymeleafController.java
@RequestMapping("standardExpression") public String standardExpression(ModelMap map){ map.put("Str", "Blog"); map.put("Bool", true); map.put("Array", new Integer[]{1,2,3,4}); map.put("List", Arrays.asList(1,3,2,4,0)); Map hashMap = new HashMap(); hashMap.put("thName", "${#...}"); hashMap.put("desc", "变量表达式内置方法"); map.put("Map", hashMap); map.put("Date", new Date()); map.put("Num", 888.888D); return "standardExpression"; }
@{...} 链接表达式，Link URL Expressions
中文English
#{...} 消息表达式，Message Expressions
~{...} 代码块表达式，Fragment Expressions
fragment.html
Title 2019 The Good Thymes Virtual Grocery
© 2011 The Good Thymes Virtual Grocery
© 2011 The Good Thymes Virtual Grocery © 2011 The Good Thymes Virtual Grocery
5、国际化的配置
在很多应用场景下，我们需要实现页面的国际化，springboot对国际化有很好的支持， 下面来演示对应的效果。
1、在idea中设置统一的编码格式，file->settings->Editors->File Encoding,选择编码格式为utf-8
2、在resources资源文件下创建一个i8n的目录，创建一个login.properties的文件，还有login_zh_CN.properties,idea会自动识别国际化操作
3、创建三个不同的文件，名称分别是：login.properties，login_en_US.properties，login_zh_CN.properties
内容如下：
#login.properties login.password=密码1 login.remmber=记住我1 login.sign=登录1 login.username=用户名1 #login_en_US.properties login.password=Password login.remmber=Remember Me login.sign=Sign In login.username=Username #login_zh_CN.properties login.password=密码~ login.remmber=记住我~ login.sign=登录~ login.username=用户名~
4、配置国际化的资源路径
spring: messages: basename: i18n/login
5、编写html页面
初始html页面 Title
UsernamePassword
Remember Me
Sign in
中文English
Title
UsernamePassword
[[#{login.remmber}]]
Sign in
中文English
可以看到通过浏览器的切换语言已经能够实现，想要通过超链接实现的话，如下所示：
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.util.StringUtils; import org.springframework.web.servlet.LocaleResolver; import org.springframework.web.servlet.config.annotation.ViewControllerRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.util.Locale; @Configuration public class WebMVCConfig implements WebMvcConfigurer { @Override public void addViewControllers(ViewControllerRegistry registry) { registry.addViewController("/").setViewName("login"); registry.addViewController("/login.html").setViewName("login"); } @Bean public LocaleResolver localeResolver(){ return new NativeLocaleResolver(); } protected static class NativeLocaleResolver implements LocaleResolver{ @Override public Locale resolveLocale(HttpServletRequest request) { String language = request.getParameter("language"); Locale locale = Locale.getDefault(); if(!StringUtils.isEmpty(language)){ String[] split = language.split("_"); locale = new Locale(split[0],split[1]); } return locale; } @Override public void setLocale(HttpServletRequest request, HttpServletResponse response, Locale locale) { } } }
Title
UsernamePassword
[[#{login.remmber}]]
Sign in
中文English
国际化的源码解释：
//MessageSourceAutoConfiguration public class MessageSourceAutoConfiguration { private static final Resource[] NO_RESOURCES = new Resource[0]; public MessageSourceAutoConfiguration() { } @Bean @ConfigurationProperties(prefix = "spring.messages") //我们的配置文件可以直接放在类路径下叫： messages.properties， 就可以进行国际化操作了 public MessageSourceProperties messageSourceProperties() { return new MessageSourceProperties(); } @Bean public MessageSource messageSource(MessageSourceProperties properties) { ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource(); if (StringUtils.hasText(properties.getBasename())) { //设置国际化文件的基础名（去掉语言国家代码的） messageSource.setBasenames(StringUtils.commaDelimitedListToStringArray(StringUtils.trimAllWhitespace(properties.getBasename()))); } if (properties.getEncoding() != null) { messageSource.setdefaultencoding(properties.getEncoding().name()); } messageSource.setFallbackToSystemLocale(properties.isFallbackToSystemLocale()); Duration cacheDuration = properties.getCacheDuration(); if (cacheDuration != null) { messageSource.setCacheMillis(cacheDuration.toMillis()); } messageSource.setAlwaysUsemessageformat(properties.isAlwaysUsemessageformat()); messageSource.setUseCodeAsDefaultMessage(properties.isUseCodeAsDefaultMessage()); return messageSource; } } //WebMvcAutoConfiguration @Bean @ConditionalOnMissingBean @ConditionalOnProperty(prefix = "spring.mvc", name = "locale") public LocaleResolver localeResolver() { if (this.mvcProperties.getLocaleResolver() == WebMvcProperties.LocaleResolver.FIXED) { return new FixedLocaleResolver(this.mvcProperties.getLocale()); } AcceptHeaderLocaleResolver localeResolver = new AcceptHeaderLocaleResolver(); localeResolver.setDefaultLocale(this.mvcProperties.getLocale()); return localeResolver; } //AcceptHeaderLocaleResolver @Override public Locale resolveLocale(HttpServletRequest request) { Locale defaultLocale = getDefaultLocale(); if (defaultLocale != null && request.getHeader("Accept-Language") == null) { return defaultLocale; } Locale requestLocale = request.getLocale(); List supportedLocales = getSupportedLocales(); if (supportedLocales.isEmpty() || supportedLocales.contains(requestLocale)) { return requestLocale; } Locale supportedLocale = findSupportedLocale(request, supportedLocales); if (supportedLocale != null) { return supportedLocale; } return (defaultLocale != null ? defaultLocale : requestLocale); }
版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 dio@foxmail.com 举报，一经查实，本站将立刻删除。
