在SpringBoot当中使用Thymeleaf视图解析器的详细教程

 更新时间:2024年09月13日 09:37:46   作者:RainbowSea  
Thymeleaf是一款开源的模板引擎,它允许前端开发者使用HTML与XML编写动态网页,hymeleaf的主要特点是将表达式语言嵌入到HTML结构中,它支持Spring框架,使得在Spring MVC应用中集成非常方便,本文给大家介绍了在SpringBoot当中使用Thymeleaf视图解析器的详细教程

在Spring Boot 当中使用 Thymeleaf 视图解析器

想要在 Spring Boot 当中使用 Thymeleaf 视图,就需要导入相关的 jar 依赖。在 pom.xml 文件中配置。

<!--        引入 thymeleaf-start ,项目会自动完成配置,-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>

在 Spring Boot当中的 Thymeleaf 相关的类是 :ThymeleafProperties.java 类。

注意:路径不可以随便改,要按照要求来,或者通过 application.yaml 进行修改。

spring:
  thymeleaf:
    prefix: "classpath:/填写自己想要的路径目录"
    # classpath:/ 类路径起手

对应 HTML页面上想要使用上 Thymeleaf 语法的需要加上如下的一行内容,才行。

<html lang="en" xmlns:th="http://www.thymeleaf.org">

案例举例:

在 pom.xml 文件当中,导入相关的 jar 包文件。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.rainbowsea</groupId>
    <artifactId>springboot_usersys</artifactId>
    <version>1.0-SNAPSHOT</version>


    <!--    导入SpringBoot 父工程-规定写法-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.3</version>
    </parent>

    <!--    导入web项目场景启动器:会自动导入和web开发相关的jar包所有依赖【库/jar】-->
    <!--    后面还会在说明spring-boot-starter-web 到底引入哪些相关依赖-->
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--引入lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <!--        引入 thymeleaf-start ,项目会自动完成配置,-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>

        <!--  引入 lombok 插件      -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>
</project>

编写相关项目的启动场景。

package com.rainbowsea.springboot;


import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication // 项目启动标志
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class,args);
    }
}

对应的 Bean 类

package com.rainbowsea.springboot.bean;


import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor  // 无参数
public class Admin {
    private String name;
    private String password;

}

package com.rainbowsea.springboot.bean;


import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor // 无参数
@AllArgsConstructor  // 全参数
public class User {
    private Integer id;
    private String name;
    private String password;
    private Integer age;
    private String email;

}

编写相关 thymeleaf 视图,HTML文件。

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>管理后台</title>
</head>
<body>
<a href="#" rel="external nofollow"  rel="external nofollow" >返回管理界面</a> <a href="#" rel="external nofollow"  rel="external nofollow" >安全推出</a>


<hr>
<div style="text-align: center">
    <h1>管理员</h1>
    <table border="1px" cellspacing="0" bordercolor="green" style="text-align: center">
        <tr bgcolor="pink">
            <td>id</td>
            <td>name</td>
            <td>pwd</td>
            <td>email</td>
            <td>age</td>
        </tr>
        <tr bgcolor="#7fffd4" style="text-align: center" th:each="user:${users}">
            <td th:text="${user.id}"></td>
            <td th:text="${user.name}"></td>
            <td th:text="${user.password}"></td>
            <td th:text="${user.email}"></td>
            <td th:text="${user.age}"></td>
        </tr>
    </table>
</div>
</body>
</html>
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>login</title>
</head>
<body>
<div style="text-align: center">
    <h1>用户登录</h1>
    <form action="#" th:action="@{/login}" method="post">
        <label style="color: red" th:text="${msg}"></label><br>
        用户名: <input type="text" style="width: 150px" name="name"><br>
        密码: <input type="password" style="width: 150px" name="password"><br>
        <input type="submit" value="登录"><br>
        <input type="reset" value="重新填写"><br>
    </form>
</div>

</body>
</html>

相关的 controller 控制器,处理请求内容。

package com.rainbowsea.springboot.controller;


import com.rainbowsea.springboot.bean.Admin;
import com.rainbowsea.springboot.bean.User;
import com.sun.org.apache.xpath.internal.operations.Mod;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;

import javax.jws.WebParam;
import javax.servlet.http.HttpSession;
import java.util.ArrayList;

@Controller
public class AdminController {


    @PostMapping("/login")
    public String login(Admin admin, HttpSession session, Model model) {




        // 验证用户是否合法
        if(StringUtils.hasText(admin.getName()) && "666".equals(admin.getPassword())) {
            // 将登录用户保险到 session会话域当中
            session.setAttribute("loginAdmin",admin);

            // 合法,重定向到manage.html
            // 请小伙伴回忆,Java web ,不使用请求转发是防止刷新页面会重复提交
            // 这里老师为什么写的是 manage.html,因为这样可以更加明确的表示到哪个页面
            // manage.html 表示要去找方法的映射路径为: manage.html
            return "redirect:/manage.html";
        } else {
            // 不合法,就重新登录,请求转发
            model.addAttribute("msg","账号/用户错误");
            return "adminLogin";  // 视图解析
        }

    }

    // 处理用户的请求到 manage.html
    // 是重定向——>get
    @GetMapping("/manage.html")
    public String mainPage(Model model,HttpSession session){

        // 可以这里集合~模板数据,放入到request域中,并显示
        ArrayList<User> users = new ArrayList<>();
        users.add(new User(1,"关羽","666",28,"gy@ohu.com"));
        users.add(new User(2,"关羽","666",28,"gy@ohu.com"));
        users.add(new User(3,"关羽","666",28,"gy@ohu.com"));
        users.add(new User(4,"关羽","666",28,"gy@ohu.com"));
        users.add(new User(5,"关羽","666",28,"gy@ohu.com"));
        model.addAttribute("users",users);  // 放入到请求域当中
        return "manage";  // 视图解析器

        // 拦截器处理
        // 获取到 session会话域当中的信息,判断用户是否登录过,进行一个过滤
        /*Object loginAdmin = session.getAttribute("loginAdmin");
        if(null != loginAdmin) {  // 说明成功登录过
            // 可以这里集合~模板数据,放入到request域中,并显示
            ArrayList<User> users = new ArrayList<>();
            users.add(new User(1,"关羽","666",28,"gy@ohu.com"));
            users.add(new User(2,"关羽","666",28,"gy@ohu.com"));
            users.add(new User(3,"关羽","666",28,"gy@ohu.com"));
            users.add(new User(4,"关羽","666",28,"gy@ohu.com"));
            users.add(new User(5,"关羽","666",28,"gy@ohu.com"));
            model.addAttribute("users",users);  // 放入到请求域当中

            return "manage";  // 视图解析器
        } else {
            // 说明没有登录过,
            // 这里就返回登录页,并给出提示
            model.addAttribute("msg","你没有登录/请登录");  // 请求域
            return "adminLogin"; // 请求转发到 adminLogin.html视图解析
        }*/


    }
}

package com.rainbowsea.springboot.controller;


import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class IndexController {

    // 编写方法,转发到登录页面
    /*
    解释:
    1.因为我们引入了 starter-thymeleaf
    2.这里就会直接使用视图解析到thymeleaf下的模板文件admin
     */
    @GetMapping(value = {"/","/login"})
    public String login(){
        return "adminLogin";
    }
}

配置的相关拦截器:

package com.rainbowsea.springboot.interceptor;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;


@Slf4j
public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        // 为了让大家看到访问的URI
        String requestURI = request.getRequestURI();
        String requestURL = request.getRequestURL().toString();
        log.info("preHandle 拦截到的请求URI={}", requestURI);
        log.info("preHandle 拦截到的请求URL={}", requestURL);

        // 进行登录的校验
        HttpSession session = request.getSession();
        Object loginAdmin = session.getAttribute("loginAdmin");
        if (null != loginAdmin) { // 说明该用户已经成功登录
            // 返回 true 就是放行
            return true;
        } else {
            // 拦截,重新返回到登录页面
            request.setAttribute("msg", "你没有登录/请登录~~~");
            // 注意:因为这里我们只有一个内容被拦截了,而且该内容的 uri路径就是我们要跳转进入的路径
            request.getRequestDispatcher("/").forward(request, response);  // 重定向
            return false; // 拦截了,不放行

        }


    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("postHandle执行了...");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("afterCompletion执行了...");

    }
}
// HandlerInterceptor

package com.rainbowsea.springboot.config;


import com.rainbowsea.springboot.interceptor.LoginInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration  // 配置拦截器
public class WebConfig
/*        implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注册自定义拦截器LoginInterceptor
        registry.addInterceptor(new LoginInterceptor())
                .addPathPatterns("/**")  // 拦截所有的请求
                .excludePathPatterns("/","/login","/images/**"); // 还要放行视图的内容,因为上面是
        // 拦截所有,注意不要: templates ,因为sprinboot的默认配置,就是以templates为根路径往下找的
        // 所以添加就错了,就成了 /templates/templates/images/**了。

    }*/
{

    @Bean
    public WebMvcConfigurer webMvcConfigurer() {
        return new WebMvcConfigurer() {
            @Override
            public void addInterceptors(InterceptorRegistry registry) {
                System.out.println("addInterceptors~~~");
                // 注册拦截器
                registry.addInterceptor(new LoginInterceptor())
                        .addPathPatterns("/**")
                        .excludePathPatterns("/","/login","/images/**");
            }
        };
    }
}

启动程序,打开浏览器运行测试

最后:

以上就是在SpringBoot当中使用Thymeleaf视图解析器的详细教程的详细内容,更多关于SpringBoot使用Thymeleaf的资料请关注脚本之家其它相关文章!

相关文章

  • MybatisPlus如何自动生成映射文件

    MybatisPlus如何自动生成映射文件

    这篇文章主要介绍了MybatisPlus如何自动生成映射文件,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-01-01
  • java 异常的实例详解

    java 异常的实例详解

    这篇文章主要介绍了java 异常的实例详解的相关资料,希望通过本文大家能彻底掌握java异常的使用方法,需要的朋友可以参考下
    2017-09-09
  • feign开启日志Logger.Level feignLoggerLevel()中Level爆红的解决

    feign开启日志Logger.Level feignLoggerLevel()中Level爆红的解决

    这篇文章主要介绍了feign开启日志Logger.Level feignLoggerLevel()中Level爆红的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06
  • 微信支付java版本之Native付款

    微信支付java版本之Native付款

    这篇文章主要为大家详细介绍了微信支付java版本之Native付款,感兴趣的小伙伴们可以参考一下
    2016-08-08
  • Java中如何编写一个数的n次方(幂运算)?

    Java中如何编写一个数的n次方(幂运算)?

    本文介绍了使用pow函数和自定义for循环计算幂的O(n)时间复杂度方法,然后重点讲解了快速幂算法的分治思想,以及从二进制角度的解释,包括如何通过位运算和循环迭代实现高效计算,给出了Java代码实现
    2024-07-07
  • 详解Java中NullPointerException的处理方法

    详解Java中NullPointerException的处理方法

    这篇文章将带大家来单独看一个很常见的异常--空指针异常,这个可以说是每个Java程序员都必知的异常,所以我们不得不单独学习一下,文中有详细的代码示例,需要的朋友可以参考下
    2023-08-08
  • java中判断字段真实长度的实例(中文2个字符,英文1个字符)

    java中判断字段真实长度的实例(中文2个字符,英文1个字符)

    下面小编就为大家带来一篇java中判断字段真实长度的实例(中文2个字符,英文1个字符)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-01-01
  • Java毕业设计实战项目之宠物商城系统的实现流程

    Java毕业设计实战项目之宠物商城系统的实现流程

    这是一个使用了java+Springboot+Maven+mybatis+Vue+mysql开发的宠物商城系统,是一个毕业设计的实战练习,具有宠物商城该有的所有功能,感兴趣的朋友快来看看吧
    2022-01-01
  • Java如何确定两个区间范围是否有交集

    Java如何确定两个区间范围是否有交集

    这篇文章主要介绍了Java如何确定两个区间范围是否有交集问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-12-12
  • Java后端用EL表达式改进JSP

    Java后端用EL表达式改进JSP

    EL 全名为Expression Language,EL的语法很简单,它最大的特点就是使用上很方便,本文带你用EL表达式改进JSP,感兴趣的朋友来看看吧
    2022-02-02

最新评论