Spring - Spring Boot - Thymeleaf - textual 模式

1. 概述

   1. thymeleaf 的 text 模式简单使用
   2. 过程会比较啰嗦, 需要结论的同学, 可以直接到底部去寻找

2. 背景

   1. 想尝试做一个简单的 模板工具

      1. 目的

         1. 自动生成一些简单的 重复文本

      2. 思路

         1. 尽量简单
            1. 使用 json 装填数据
               1. 这个可能会调整
            2. 用 restful 方式, 提交给 server
               1. spring-boot 集成, 很方便
            3. json 解析
               1. jackson 看了看, 还行
            4. 使用 模板 生成内容
               1. thymeleaf 应该能满足要求
               2. spring-boot 集成很方便
            5. 返回 模板生成内容
               1. 这个 第4步 顺手就做了

   2. 不过我比较生疏

      1. jackson 基本没用过
         1. 不过还算顺利
      2. thymeleaf 之前也是基本没用过
         1. 只会传最简单的 静态参数
         2. 本人前端苦手, 看见 html, js, css 就头晕

3. 环境

   1. os

      1. win10

   2. ide

      1. idea 2018.1

   3. 依赖

      1. jdk
         1. 1.8
      2. spring-boot
         1. 2.2.2
      3. maven
         1. 3.6

1. 准备

1. spring-boot 创建 maven 工程

   1. 略

2. spring-boot 创建 restful 服务

   1. 略

3. thymeleaf 模板与传参

   1. 知道传到 那个模板
   2. 知道参数写在哪, 怎么取

2. 尝试1: 使用 thymeleaf 的 text 模式尝试

1. controller

   1. model

      1. 添加属性

         model.addAttribute("var1", "value1");
         
         

   2. view

      1. 视图

         return "test";
         
         

2. test.html

   [(${var1})]
   
   

3. 结果

   1. 成功展示

3. 尝试2: 尝试循环

1. controller

   List<String> list = new ArrayList<>();
   
   list.add("a");
   
   list.add("b");
   
   model.addAttribute("list", list);
   
   

2. test.html

   [# th:each="item : ${list}"]
   
     - [(${item})]
   
   [/]
   
   

3. 结果

   1. 失败
      1. 直接原文显示

4. 疑问: 为啥会失败了呢?

   1. 问题
      1. 代码基本是 官网复制过来的
      2. 之前也没啥问题, 怎么会失败呢?

4. 尝试3: 在 test.html 添加 尝试1 里的代码

1. 结果

   1. var1 成功展示
   2. 后面的 循环, 还是没有成功

2. 疑问: 为啥会是这种呢

   1. 感觉像是 循环的语法, 没有被 正确识别的样子
   2. 语法识别, 是跟 模式 相关吗?

5. 尝试4: 设置模式

1. 发现

   1. thymeleaf 可以定义 html5 严格模式

      spring.thymeleaf.mode=LEGACYHTML5
      
      

   2. 其他的模式, 也是可以设置的

      1. ref2

2. 配置文件 application.properties

   1. 添加内容

      spring.thymeleaf.mode=TEXT
      
      

3. 结果

   1. 还是不行

4. 疑问

   1. 忽然发现, 官网的例子, 举的都是 邮件, js, css
      1. 我用的是 html, 会不会跟这个有关

6. 尝试5; 换 模板文件

1. 疑问

   1. thymeleaf 默认会给 模板名称结尾, 加上一个 .html

2. 处理

   1. 去掉 .html 的默认后缀

      1. application.properties

         spring.thymeleaf.suffix=
         
         

   2. 重命名 模板

      1. 改名为 "test"

   3. 重启服务器

3. 尝试

   1. ok

4. 后续

   1. 尝试1: 去掉 模式定义 的语句

      1. 又不能解析了

   2. 尝试2: 将 模板名称, 改回 "test.html"

      1. 还是不行

7. 结论

1. 想要使用 text 模式, 需要做以下操作

   1. application.properties

      spring.thymeleaf.mode=TEXT
      
      spring.thymeleaf.suffix=
      
      

   2. 模板

      1. 使用 text 模式的专用语法

   3. 如果其他地方, 想用 html

      1. 在 controller 方法的 返回值里, 使用 x.html 类似的视图名称

2. 过程, 感觉有点曲折

   1. 之前没怎么接触
   2. 真的想不到, 这个工作模式, 还会跟 模板的后缀名 做一个挂钩
   3. 而且还有一个开关
   4. 感觉这种盲猜真的很麻烦
      1. 照着官网抄都超不对, 体验真实差到了极点, 很容易收到打击...
      2. 不知道经验老到的同学, 在这块会不会遇到这种新手问题...前前后后, 花了个把小时, 感觉浪费很多时间的样子...
      3. 或者换个角度, thymeleaf 的开发者, 就不想在这种场景, 让用户使用 text 模式
         1. 这个角度也是收到了留言小伙伴的启发...

8. 猜测

1. text 模式语法

   1. 语法本身, 是 inline 模式
   2. html 支持部分 inline 模式的语法
      1. 支持变量提取
      2. 不支持 each

2. 模板解析

   1. 根据 模板的后缀, 选择合适的 解析器
   2. 每种解析器, 只能解析 有限的语法
      1. 解析 html 的解析器, 无法解析 text 模式的 each

ps

1. ref

   1. 13 Textual template modes

      1. 官网 文档
         1. 本身比较详细, 但是 textual 模式, 却说得比较略

   2. Thymeleaf 3 ten-minute migration guide

      1. 官网 文档
         1. 讲了些 spring 的代码配置
            1. 可惜版本是 spring4 的
            2. 我用的是 spring5, 可能会有点出入
         2. 大体结构是这样
            1. viewResolver: 视图解析器
               1. templateEngine: 模板引擎
                  1. templateResolver: 模板解析器
         3. 但是后面具体的调用机制, 我就不太熟悉了

   3. thymeleaf3-template-modes-example

      1. 官网 例子

         1. 大概给了三套

            1. 视图解析器, 模板引擎, 模板解析器

         2. 具体什么机制, 也没说明白

            1. 或者说, 我没看明白
            2. 比如说
               1. 这些 解析器, 什么时候调用哪个?
               2. 盲猜
                  1. 根据 controller 视图的后缀, 来确定使用哪个 模板解析器
                  2. 具体机制, 还没深入了解

2. 怎么说呢?

   1. 还是喜欢那种, 先学习, 后使用 的工作模式
      1. 这种 边用边查资料 的模式, 我不太喜欢
         1. 做东西太赶
            1. 做了前面, 容易给后面埋坑
         2. 学东西太着急
            1. 容易造成理解问题
      2. 不过这种方式, 应该是大多数公司的日常工作模式吧
         1. 反正我接触的, 基本是这样...
         2. 想想还有点难受

3. 如果用 其他模板引擎 做同样的事, 会有这么麻烦吗?

   1. jsp
   2. Velocity
   3. freemarker