十一，Spring Boot 当中配置拦截器的“两”种方式

魏晓东 · 2024-9-14 15:06:05

十一，Spring Boot 当中配置拦截器的“两”种方式

@
目录

在Spring Boot项目中，拦截器是开发中常用本领，要来做登录验证，性能检查，日记记录等。

基本步调：

编写一个拦截器实现HandlerInterceptor接口

拦截器注册到配置类中(实现WebMvcConfigurer的addInterceptors)

指定拦截规则

回顾SpringMVC中讲解的 Interceptor✏️✏️✏️ Spring MVC 中的拦截器的使用“拦截器基本配置” 和 “拦截器高级配置”_springmvc拦截器配置步调-CSDN博客

1. 准备工作：

在 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>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.5.3</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<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 target="_blank" href="https://www.cnblogs.com/#">返回管理界面</a> <a target="_blank" href="https://www.cnblogs.com/#">安全推出</a>
<hr>
<h1>管理员</h1>
<table border="1px" cellspacing="0" bordercolor="green" >
<tr bgcolor="pink">
<td>id</td>
<td>name</td>
<td>pwd</td>
<td>email</td>
<td>age</td>
</tr>
<tr bgcolor="#7fffd4" 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>
</body>
</html>

复制代码

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>login</title>
</head>
<body>
<h1>用户登录</h1>
<form action="#" th:action="@{/login}" method="post">
<label th:text="${msg}"></label>
用户名: <input type="text" name="name">
密码: <input type="password" name="password">
<input type="submit" value="登录">
<input type="reset" value="重新填写">
</form>
</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";
}
}

复制代码

演示：拦截器：这里我们演示，登录页面的拦截：

当用户没有登录过的时候，不可以访问后面的内容

当用户登录过了，就可以访问后面的内容了。

2. Spring Boot当中配置拦截器的第一种方式：通过配置类的方式

首先我们需要定义一个类，而且该类要实现 implements HandlerInterceptor 接口，同时重写其中的：preHandle( )，postHandle( )，afterCompletion( ) 的三个方法。根据业务拦截的需要，在这个三个方法中，编写，拦截的业务处理。

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

复制代码

定义一个配置类，在配置类当中，编写我们要拦截哪些请求路径映射，放行哪些请求路径的映射。

注意：

添加上：@Configuration 注解 // 标注是配置类

该类要实现：implements WebMvcConfigurer 类

重写其中的：public void addInterceptors(InterceptorRegistry registry) 方法。

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/**了。
}
}

复制代码

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

// 还要放行视图的内容，因为上面是
      // 拦截所有，注意不要: templates ，因为sprinboot的默认配置，就是以templates为根路径往下找的
      // 所以添加就错了，就成了 /templates/templates/images/**了。
复制代码
注意：配置了拦截器的话，图片之类的一些静态资源的访问以及一些文件上传下载，也是要注意放行的，已经视图解析器也是放行的，要放行视图的内容，由于上面是addPathPatterns("/**")  // 拦截所有的请求拦截所有，注意不要: templates ，由于sprinboot的默认配置，就是以templates为根路径往下找的，所以再添加 templates 就错了，就成了 /templates/templates/images 了。
简朴的就是：记着注意好 Spring Boot的根路径是从哪里开始的，以哪里为根路径的，大概有多个标准/参照路径。

3. Spring Boot 当中配置拦截器的第二种方式：

基于第一种方式修改，webconfig 配置类即可。

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 {
@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/**");
}
};
}
}

复制代码

4. 增补：URI 和 URL 的区别

1.URI 和 URL 的区别
URI = Universal Resource Identifier
URL = Universal Resource Locator

// 为了让大家看到访问的URI
String requestURI = request.getRequestURI(); // preHandle 拦截到的请求URI=/manage.html
String requestURL = request.getRequestURL().toString(); // preHandle 拦截到的请求URL=http://localhost:8080/manage.html

复制代码

5. 总结：

// 还要放行视图的内容，因为上面是
// 拦截所有，注意不要: templates ，因为sprinboot的默认配置，就是以templates为根路径往下找的
// 所以添加就错了，就成了 /templates/templates/images/**了。

复制代码

注意：配置了拦截器的话，图片之类的一些静态资源的访问以及一些文件上传下载，也是要注意放行的，已经视图解析器也是放行的，要放行视图的内容，由于上面是addPathPatterns("/**") // 拦截所有的请求拦截所有，注意不要: templates ，由于sprinboot的默认配置，就是以templates为根路径往下找的，所以再添加 templates 就错了，就成了 /templates/templates/images 了。
简朴的就是：记着注意好 Spring Boot的根路径是从哪里开始的，以哪里为根路径的，大概有多个标准/参照路径。
6. 最后：

“在这个最后的篇章中，我要表达我对每一位读者的感激之情。你们的关注和回复是我创作的动力源泉，我从你们身上吸取了无尽的灵感与勇气。我会将你们的鼓励留在心底，继续在其他的领域奋斗。感谢你们，我们总会在某个时刻再次相遇。”

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

		自动登录	找回密码
密码			立即注册

十一，Spring Boot 当中配置拦截器的“两”种方式

本帖子中包含更多资源

0 个回复

快速回复

楼主热帖

标签云