Detailed explanation of Thymeleaf and FreeMarker template engines for Spring Boot series web development

黄舟

Release： 2018-05-11 14:45:10

Original

6313 people have browsed it

The previous articles introduced a good RESTful API that returns json data. Next, we introduce how to render the processed data onto the page.

Spring Boot uses template engines

Spring Boot recommends using template engines such as Thymeleaf, FreeMarker, Velocity, Groovy, and Mustache. JSP is not recommended.

Spring Boot provides good default configurations for the above engines. The default src/main/resources/templates directory is the configuration path of the above template engines.

1. Thymeleaf template engine used in Spring Boot

Introduction: Thymeleaf is a template engine similar to Velocity and FreeMarker. It can be used for application development in Web and non-Web environments, and can be completely replaced JSP.

1. Add dependencies to pom.xml

<!-- thymeleaf 模板引擎-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

Copy after login

2. Write controller

/**
 * @author sam
 * @since 2017/7/16
 */
@Controller
public class HomeController {

    @RequestMapping("/home")
    public String home(ModelMap modelMap) {

        modelMap.put("name", "Magical Sam");

        List<String> list = new ArrayList<>();
        list.add("sam a");
        list.add("sam b");
        list.add("sam c");
        list.add("sam d");
        modelMap.put("list", list);

        return "home";
    }

}

Copy after login

3. Write html code, where th:text="${name}" is thymeleaf For the syntax, please refer to: Thymeleaf official documentation

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8"/>
    <title>Home</title>
</head>
<body>
    <span th:text="${name}"></span>
    <ul>
        <li th:each="item : ${list}" th:text="${item}"></li>
    </ul>
</body>
</html>

Copy after login

Start the application and visit: http://localhost:8080/home to get the corresponding results.

If you need to modify the default configuration of thymeleaf, you can add in application.properties:

# ================================================
#                   Thymeleaf配置
# ================================================
# 是否启用thymeleaf模板解析
spring.thymeleaf.enabled=true
# 是否开启模板缓存（建议：开发环境下设置为false，生产环境设置为true）
spring.thymeleaf.cache=false 
# Check that the templates location exists.
spring.thymeleaf.check-template-location=true 
# 模板的媒体类型设置，默认为text/html
spring.thymeleaf.content-type=text/html
# 模板的编码设置，默认UTF-8
spring.thymeleaf.encoding=UTF-8
# 设置可以被解析的视图，以逗号,分隔
#spring.thymeleaf.view-names=
# 排除不需要被解析视图，以逗号,分隔
#spring.thymeleaf.excluded-view-names=
# 模板模式设置，默认为HTML5
#spring.thymeleaf.mode=HTML5 
# 前缀设置，SpringBoot默认模板放置在classpath:/template/目录下
spring.thymeleaf.prefix=classpath:/templates/ 
# 后缀设置，默认为.html
spring.thymeleaf.suffix=.html
# 模板在模板链中被解析的顺序
#spring.thymeleaf.template-resolver-order=

Copy after login

2. Use FreeMarker template engine in Spring Boot

1. Add pom.xml Depend on

<!-- freemarker 模板引擎 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>

Copy after login

2. Write controller

同上。

Copy after login

3. Create a new home.ftl file under templates and write html code. For freemarker syntax, please refer to: FreeMarker official document

home.ftl

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <span>${name}</span>
    <ul>
    <#list list as item >
        <li>${item}</li>
    </#list>
    </ul>
</body>
</html>

Copy after login

Start the application and visit: http://localhost:8080/home to get the corresponding results.

If you need to modify the default configuration of freemarker, you can add:

# ================================================
#                   FreeMarker配置
# ================================================
# 是否开启模板缓存
spring.freemarker.cache=true
# 编码格式
spring.freemarker.charset=UTF-8
# 模板的媒体类型设置
spring.freemarker.content-type=text/html
# 前缀设置 默认为 ""
spring.freemarker.prefix=
# 后缀设置 默认为 .ftl
spring.freemarker.suffix=.ftl
#spring.freemarker.allow-request-override=false
#spring.freemarker.check-template-location=true
#spring.freemarker.expose-request-attributes=false
#spring.freemarker.expose-session-attributes=false
#spring.freemarker.expose-spring-macro-helpers=false
#spring.freemarker.request-context-attribute=
#spring.freemarker.template-loader-path=classpath:/templates/
#spring.freemarker.view-names=

Copy after login

in application.properties

The above is the detailed content of Detailed explanation of Thymeleaf and FreeMarker template engines for Spring Boot series web development. For more information, please follow other related articles on the PHP Chinese website!