Thymeleaf 学习笔记

曦曦boy

已于 2022-03-17 14:18:36 修改

阅读量492

点赞数

文章标签：学习 spring java

于 2022-03-17 14:11:50 首次发布

本文链接：https://blog.csdn.net/qq_42974177/article/details/123548728

版权

概述

Thymeleaf是一款用于渲染XML/XHTML/HTML5内容的模板引擎。类似JSP，Velocity，FreeMaker 等，它也可以轻易的与Spring MVC等Web框架进行集成作为Web应用的模板引擎。它的主要作用是在静态页面上渲染显示动态数据
特点
- SpringBoot官方推荐使用的视图模板技术，和SpringBoot完美整合。

物理视图和逻辑视图

概述

物理视图：请求转发到一个资源时使用的绝对路径
逻辑视图：物理视图=视图前缀+逻辑视图+视图后缀
- 视图前缀：物理视图中最大的公共前缀
- 视图后缀：物理视图中最大的公共后缀

举例

thymeleaf入门

开发步骤

①引入thymeleaf的相关jar包
②编写web.xml
- 配置视图前缀
- 配置视图后缀
③定义ViewBaseServlet类
④定义Servlet类继承ViewBaseServlet类
⑤编写html页面
- 使用thymeleaf渲染页面

<!--视图前缀-->
<context-param>
    <param-name>view-prefix</param-name>
    <param-value>/pages/</param-value>
</context-param>

<!--视图后缀-->
<context-param>
    <param-name>view-suffix</param-name>
    <param-value>.html</param-value>
</context-param>

定义ViewBaseServlet类

public class ViewBaseServlet extends HttpServlet {
    private TemplateEngine templateEngine;

    @Override
    public void init() throws ServletException {

        // 1.获取ServletContext对象
        ServletContext servletContext = this.getServletContext();

        // 2.创建Thymeleaf解析器对象
        ServletContextTemplateResolver templateResolver = new ServletContextTemplateResolver(servletContext);

        // 3.给解析器对象设置参数
        // ①HTML是默认模式，明确设置是为了代码更容易理解
        templateResolver.setTemplateMode(TemplateMode.HTML);

        // ②设置前缀
        String viewPrefix = servletContext.getInitParameter("view-prefix");

        templateResolver.setPrefix(viewPrefix);

        // ③设置后缀
        String viewSuffix = servletContext.getInitParameter("view-suffix");

        templateResolver.setSuffix(viewSuffix);

        // ④设置缓存过期时间（毫秒）
        templateResolver.setCacheTTLMs(60000L);

        // ⑤设置是否缓存
        templateResolver.setCacheable(true);

        // ⑥设置服务器端编码方式
        templateResolver.setCharacterEncoding("utf-8");

        // 4.创建模板引擎对象
        templateEngine = new TemplateEngine();

        // 5.给模板引擎对象设置模板解析器
        templateEngine.setTemplateResolver(templateResolver);

    }


    /**
     * 执行视图
     * @param templateName : 逻辑视图
     * @param req : 请求
     * @param resp : 响应
     * @throws IOException
     */
    protected void processTemplate(String templateName, HttpServletRequest req, HttpServletResponse resp) throws IOException {
        // 1.设置响应体内容类型和字符集
        resp.setContentType("text/html;charset=UTF-8");

        // 2.创建WebContext对象
        WebContext webContext = new WebContext(req, resp, getServletContext());

        // 3.处理模板数据
        templateEngine.process(templateName, webContext, resp.getWriter());
    }
}

定义Servlet类继承ViewBaseServlet类

@WebServlet("/demo01")
public class Demo01Servlet extends ViewBaseServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        String errorMsg = "用户名已经存在!";
        req.setAttribute("errorMsg", errorMsg);
        //转发到demo01.html
        processTemplate("demo01", req, resp);
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        doGet(req, resp);
    }
}

编写html页面

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>04-thymeleaf入门</title>
</head>
<body>

<font color="red" th:text="${errorMsg}"></font>

</body>
</html>

注意事项
- 如果要使用thymeleaf指令，必须要通过ViewBaseServlet