欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识！
您现在的位置是： 首页  >  IT编程

Spring Boot实战之模板引擎

程序员文章站 2023-12-16 11:06:04
虽然现在很多开发，都采用了前后端完全分离的模式，即后端只提供数据接口，前端通过ajax请求获取数据，完全不需要用的模板引擎。这种方式的优点在于前后端完全分离，并且随着近几年...

虽然现在很多开发，都采用了前后端完全分离的模式，即后端只提供数据接口，前端通过ajax请求获取数据，完全不需要用的模板引擎。这种方式的优点在于前后端完全分离，并且随着近几年前端工程化工具和mvc框架的完善，使得这种模式的维护成本相对来说也更加低一点。但是这种模式不利于seo，并且在性能上也会稍微差一点，还有一些场景，使用模板引擎会更方便，比如说邮件模板。这篇文章主要讨论spring boot与模板引擎thymeleaf、freemaker以及jsp的集成。

一、集成thymeleaf

第一步：引入jar包（thymeleaf对应的starter）：

<dependency>
  <groupid>org.springframework.boot</groupid>
  <artifactid>spring-boot-starter-thymeleaf</artifactid>
</dependency>

第二步：配置thymeleaf：

spring:
 thymeleaf:
  prefix: classpath:/templates/
  check-template-location: true
  cache: false
  suffix: .html
  encoding: utf-8
  content-type: text/html
  mode: html5

prefix：指定模板所在的目录

check-tempate-location: 检查模板路径是否存在

cache: 是否缓存，开发模式下设置为false，避免改了模板还要重启服务器，线上设置为true，可以提高性能。

encoding&content-type：这个大家应该比较熟悉了，与servlet中设置输出对应属性效果一致。

mode：这个还是参考官网的说明吧，并且这个是2.x与3.0不同，本文自动引入的包是2.15。

第三步 编写thymeleaf模板文件：

<!doctype html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="http://www.thymeleaf.org">
<head>
  <meta content="text/html;charset=utf-8"/>
</head>
<body>
<h6>thymeleaf 模板引擎</h6>

<table border="1" bgcolor="#f0ffff">
  <thead>
  <tr>
    <th>序号</th>
    <th>标题</th>
    <th>摘要</th>
    <th>创建时间</th>
  </tr>
  </thead>
  <tbody th:each="article : ${list}">
  <tr>
    <td th:text="${article.id}"></td>
    <td th:text="${article.title}"></td>
    <td th:text="${article.summary}"></td>
    <td th:text="${article.createtime}"></td>
  </tr>
  </tbody>
</table>
</body>
</html>

大家可以看到，thymeleaf还是比较简单的，并且最大的特点就是的标签是作为html元素的属性存在的，也就是说，该页面是可以直接通过浏览器来预览的，只是没有数据而已，这个很方便大家进行调试。

第四步 配置controller：

@controller
@requestmapping("/article")
public class articlecontroller {
  @autowired
  private articleservice articleservice;

  @requestmapping("/articlelist.html")
  public string getarticlelist(model model, string title, @requestparam(defaultvalue = "10") integer pagesize,
                 @requestparam(defaultvalue = "1") integer pagenum) {
    int offset = (pagenum - 1) * pagesize;
    list<article> list = articleservice.getarticles(title, 1l, offset, pagesize);
    model.addattribute("list", list);
    return "article/articlelist";
  }
}

注意，这里用的注解是@controller，而不是@restcontroller，因为@restcontroller会自动将返回结果转为字符串。

第五步 查看结果

Spring Boot实战之模板引擎

二、spring boot与freemarker的集成

1、引入jar包（freemarker对应的starter）

<dependency>
  <groupid>org.springframework.boot</groupid>
  <artifactid>spring-boot-starter-freemarker</artifactid>
</dependency>

2、配置freemarker：

spring:
 freemarker:
  template-loader-path: classpath:/templates/
  suffix: .ftl
  content-type: text/html
  charset: utf-8
  settings:
   number_format: '0.##'

除了settings外，其他的配置选项和thymeleaf类似。settings会对freemarker的某些行为产生影响，如日期格式化，数字格式化等，感兴趣的同学可以参考官网提供的说明：https://freemarker.apache.org/docs/api/freemarker/template/configuration.html#setsetting-java.lang.string-java.lang.string-

3、编写freemarker模板文件：

<html>
  <title>文章列表</title>
<body>
<h6>freemarker 模板引擎</h6>
  <table border="1">
    <thead>
      <tr>
        <th>序号</th>
        <th>标题</th>
        <th>摘要</th>
        <th>创建时间</th>
      </tr>
    </thead>
    <#list list as article>
      <tr>
        <td>${article.id}</td>
        <td>${article.title}</td>
        <td>${article.summary}</td>
        <td>${article.createtime?string('yyyy-mm-dd hh:mm:ss')}</td>
      </tr>
    </#list>
  </table>
</body>
</html>

4、编写controller：

@controller
@requestmapping("/article")
public class articlecontroller {

  @autowired
  private articleservice articleservice; 

  @requestmapping("/list.html")
  public string getarticles(model model, string title, @requestparam(defaultvalue = "10") integer pagesize, integer pagenum) {
    if (pagesize == null) {
      pagesize = 10;

    }
    if (pagenum == null) {
      pagenum = 1;
    }
    int offset = (pagenum - 1) * pagesize;
    list<article> list = articleservice.getarticles(title, 1l, offset, pagesize);
    model.addattribute("list", list);
    return "article/list";
  }
}

5、访问页面：

Spring Boot实战之模板引擎

三、sring boot与jsp集成：

在正式的项目开发中，现在已经极少用jsp模板了，所以spring boot对jsp的支持也不是很好，因此配置起来比thymeleaf和freemaker相对来说就更复杂一点。

第一步 引入jar包：

<dependency>
  <groupid>javax.servlet</groupid>
  <artifactid>jstl</artifactid>
</dependency>

<dependency>
  <groupid>org.apache.tomcat.embed</groupid>
  <artifactid>tomcat-embed-jasper</artifactid>
</dependency>

第一个jstl的依赖用于支持el表达式，第二个依赖用于支持jsp。注意，如果是在外部的tomcat中运行，需要将scope设置为provide，防止jar包冲突。

第二步 手动创建webapp目录：

需要手动在main目录下创建一个webapp的目录，结构如下：

Spring Boot实战之模板引擎

第三步 jsp路劲配置：

在application.yml中添加如下配置：

spring:
 mvc:
  view:
   prefix: /web-inf/jsp/
   suffix: .jsp

了解spring mvc的应该很熟悉上面的配置。

第四步 编写jsp页面：

<%@ page contenttype="text/html;charset=utf-8" language="java" %>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%>
<html>
<head>
  <title>title</title>
</head>
<body>
  <table border="1">
    <c:foreach var="article" items="${list}">
      <tr>
        <td>${article.id}</td>
        <td>${article.title}</td>
        <td>${article.summary}</td>
        <td>${article.createtime}</td>
      </tr>
    </c:foreach>
  </table>
</body>
</html>

第五步 编写controller：

@requestmapping("/listjsp")
  public string getarticlelistjsp(model model, string title, @requestparam(defaultvalue = "10") integer pagesize, integer pagenum) {
    if (pagesize == null) {
      pagesize = 10;
    }
    if (pagenum == null) {
      pagenum = 1;

    }
    int offset = (pagenum - 1) * pagesize;
    list<article> list = articleservice.getarticles(title, 1l, offset, pagesize);
    model.addattribute("list", list);
    return "articles";
  }

第六步 访问结果页面：

Spring Boot实战之模板引擎

四、总结

总体来讲，spring boot对thymeleaf和freemaker支持比较友好，配置相对也简单一点，在实际的开发中，大多也以这两种模板引擎为主，很少有用jsp的，jsp现在可能更多是在实验或者学习阶段使用。jsp配置比较麻烦一点的事情是不像前两者，网上的说法基本一致，但是对jsp的配置有很多种说法，比如说是不是需要将jar包改成war包？jsp的依赖是否需要设置为provide等等，这个主要依赖于你是否最后要将程序部署到外部的tomcat还是直接运行jar？因为本文都是直接在idea下直接运行application类，所以这些操作就不需要了。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。

上一篇：

下一篇：

推荐阅读