SpringBoot系列教程web篇之Beetl环境搭建

前面两篇分别介绍了目前流行的模板引擎Freemaker和Thymeleaf构建web应用的方式，接下来我们看一下号称性能最好的国产模板引擎Beetl，如何搭建web环境

本文主要来自官方文档，如有疑问，推荐查看: http://ibeetl.com/guide/#beetl

I. 准备

1. 依赖

首先我们是需要一个springboot项目，基本的pom结构大都相似

1<parent>
2    <groupId>org.springframework.boot</groupId>
3    <artifactId>spring-boot-starter-parent</artifactId>
4    <version>2.0.4.RELEASE</version>
5    <relativePath/> <!-- lookup parent from update -->
6</parent>
7
8<properties>
9    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
10    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
11    <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
12    <java.version>1.8</java.version>
13</properties>
14
15<build>
16    <pluginManagement>
17        <plugins>
18            <plugin>
19                <groupId>org.springframework.boot</groupId>
20                <artifactId>spring-boot-maven-plugin</artifactId>
21            </plugin>
22        </plugins>
23    </pluginManagement>
24</build>
25<repositories>
26    <repository>
27        <id>spring-milestones</id>
28        <name>Spring Milestones</name>
29        <url>https://repo.spring.io/milestone</url>
30        <snapshots>
31            <enabled>false</enabled>
32        </snapshots>
33    </repository>
34</repositories>

在这个项目中，我们主要需要引入两个依赖包，一个web，一个官方提供的beetl-framework-starter，当前最新的版本为 1.2.12.RELEASE

1<dependencies>
2    <dependency>
3        <groupId>org.springframework.boot</groupId>
4        <artifactId>spring-boot-starter-web</artifactId>
5    </dependency>
6    <dependency>
7        <groupId>com.ibeetl</groupId>
8        <artifactId>beetl-framework-starter</artifactId>
9        <version>1.2.12.RELEASE</version>
10    </dependency>
11</dependencies>

2. 配置参数

通常我们直接使用默认的thymeleaf参数配置即可，下面给出几个常用的配置

1beetl:
2  enabled: true
3  suffix: btl
4beetl-beetlsql:
5  dev: true # 即自动检查模板变化

II. 项目搭建演示

1. 项目结构

搭建一个web项目和我们之前的纯后端项目有点不一样，前端资源放在什么地方，依赖文件怎么处理都是有讲究的，下面是一个常规的项目结构

项目结构

如上图，前端资源文件默认放在resources目录下，下面有两个目录

templates：存放模板文件，可以理解为我们编写的html，注意这个文件名不能有问题
static: 存放静态资源文件，如js,css,image等

2. Rest服务

我们这里提供了三个接口，主要是为了演示三种不同的数据绑定方式（和前面两篇博文基本一样）

1@Controller
2public class IndexController {
3
4    @GetMapping(path = {"", "/", "/index"})
5    public ModelAndView index() {
6        Map<String, Object> data = new HashMap<>(2);
7        data.put("name", "YiHui Beetl");
8        data.put("now", LocalDateTime.now().toString());
9        return new ModelAndView("index.btl", data);
10    }
11
12    private static String[] contents =
13            ("绿蚁浮觞香泛泛，黄花共荐芳辰。\n清霜天宇净无尘。\n登高宜有赋，拈笔戏成文。\n可奈园林摇落尽，悲秋意与谁论。\n眼中相识几番新。\n龙山高会处，落帽定何人。").split("\n");
14    private static Random random = new Random();
15
16    @GetMapping(path = "show1")
17    public String showOne(Model model) {
18        model.addAttribute("title", "临江仙");
19        model.addAttribute("content", contents[random.nextInt(6)]);
20        return "show1.btl";
21    }
22
23    @GetMapping(path = "show2")
24    public String showTow(Map<String, Object> data) {
25        data.put("name", "Show2---->");
26        data.put("now", LocalDateTime.now().toString());
27        return "show2.btl";
28    }
29}

上面的三种case中

第一个是最好理解的，在创建ModelAndView时，传入viewName和数据
第二个是通过接口参数Model，设置传递给view的数据
第三种则直接使用Map来传递数据

注意

如果和前面两篇博文进行对比，会发现一个显著的区别，之前的Freemaker, Thymeleaf指定视图名的时候，都不需要后缀，但是这里，必须带上后缀，否则会500错误

三个接口，对应的三个btl文件，如下

index.btl

1<!DOCTYPE html>
2<html>
3<head>
4    <meta charset="UTF-8">
5    <meta name="viewport" content="width=device-width, initial-scale=1">
6    <meta name="description" content="SpringBoot Beetl"/>
7    <meta name="author" content="YiHui"/>
8    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
9    <title>YiHui's SpringBoot Beetl Demo</title>
10    <link rel="stylesheet" href="index.css"/>
11</head>
12<body>
13
14<div>
15    <div class="title">hello world!</div>
16    <br/>
17    <div class="content">欢迎访问  ${name}</div>
18    <br/>
19    <div class="sign">当前时间 ${now}</div>
20    <br/>
21    <a href="show1">传参2测试</a> &nbsp;&nbsp;&nbsp;&nbsp;
22    <a href="show2">传参3测试</a>
23</div>
24</body>
25</html>

show1.btl

1<!DOCTYPE html>
2<html>
3<head>
4    <meta charset="UTF-8">
5    <meta name="viewport" content="width=device-width, initial-scale=1">
6    <meta name="description" content="SpringBoot Beetl"/>
7    <meta name="author" content="YiHui"/>
8    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
9    <title>YiHui's SpringBoot Beetl Demo</title>
10    <link rel="stylesheet" href="index.css"/>
11</head>
12<body>
13
14<div>
15    <div class="title">${title}</div>
16    <div class="content">${content}</div>
17</div>
18</body>
19</html>

show2.btl

1<!DOCTYPE html>
2<html xmlns:th="http://www.thymeleaf.org">
3<head>
4    <meta charset="UTF-8">
5    <meta name="viewport" content="width=device-width, initial-scale=1">
6    <meta name="description" content="SpringBoot Beetl"/>
7    <meta name="author" content="YiHui"/>
8    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
9    <title>YiHui's SpringBoot Beetl Demo</title>
10    <link rel="stylesheet" href="index.css"/>
11</head>
12<body>
13
14<div>
15    <div class="title">${name}</div>
16    <div class="content">${now}</div>
17</div>
18</body>
19</html>

在上面的模板文件中，需要注意引用css样式文件，路径前面并没有static，我们对应的css文件

index.css

1.title {
2    color: #c00;
3    font-weight: normal;
4    font-size: 2em;
5}
6
7.content {
8    color: darkblue;
9    font-size: 1.2em;
10}
11
12.sign {
13    color: lightgray;
14    font-size: 0.8em;
15    font-style: italic;
16}

3. 演示

启动项目后，可以看到三个页面的切换，模板中的数据根据后端的返回替换，特别是主页的时间，每次刷新都会随之改变

demo

II. 其他

0. 项目&系列文章

1. 一灰灰Blog

尽信书则不如，以上内容，纯属一家之言，因个人能力有限，难免有疏漏和错误之处，如发现bug或者有更好的建议，欢迎批评指正，不吝感激

下面一灰灰的个人博客，记录所有学习和工作中的博文，欢迎大家前去逛逛

一灰灰Blog个人博客 https://blog.hhui.top
一灰灰Blog-Spring专题博客 http://spring.hhui.top

一灰灰blog