前言:
大家好,我是良辰丫,今天我们要学习Spring Boot统一功能处理,什么叫统一功能呢?我们在javaEE初阶学习过前后端交互,约定交互时的统一格式,其中这种约定就是一个统一功能.💌💌💌
🧑个人主页:良辰针不戳
📖所属专栏:javaEE进阶篇之框架学习
🍎励志语句:生活也许会让我们遍体鳞伤,但最终这些伤口会成为我们一辈子的财富。
💦期待大家三连,关注,点赞,收藏。
💌作者能力有限,可能也会出错,欢迎大家指正。
💞愿与君为伴,共探Java汪洋大海。
目录
- 1. 用户的登录权限校验
- 1.1 传统的登录校验方式
- 1.2 Spring AOP ⽤户统⼀登录验证的问题
- 1.3 Spring 拦截器
- 1.3.1 熟悉多级路由
- 1.3.2 创建自定义拦截器
- 1.3.3 拦截器加到系统配置
- 1.3.4 测试拦截器
- 2. 拦截器的实现原理
- 2.1 图解分析
- 2.2 源码分析
- 2.3 添加前缀
- 2.3.1 系统的配置文中设置
- 2.3.2 在 application.properies中设置
1. 用户的登录权限校验
⽤户登录权限的发展从之前每个⽅法中⾃⼰验证⽤户登录权限,到现在统⼀的⽤户登录验证处理,它是⼀个逐渐完善和逐渐优化的过程。
1.1 传统的登录校验方式
package com.example.demo;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
@RestController
@RequestMapping("/get")
public class GetSession {
@RequestMapping("/login")
public String login(HttpServletRequest request) {
// 切记一定要加 false,这表示有 session 就获取,没有不会创建
HttpSession session = request.getSession(false);
if (session != null && session.getAttribute("ylc") != null) {
return "登录成功";
} else {
return "登录失败";
}
}
}
-
当我们建立一个会话信息的时候,它就会登录成功,我们在前面的文章有如何建立会话信息,在这里我就不再写了.
-
从上述代码可以看出,每个⽅法中都有相同的⽤户登录验证权限,它的缺点是:
- 每个⽅法中都要单独写⽤户登录验证的⽅法,即使封装成公共⽅法,也⼀样要传参调⽤和在⽅法中
进⾏判断。 - 添加控制器越多,调⽤⽤户登录验证的⽅法也越多,这样就增加了后期的修改成本和维护成本。
- 这些⽤户登录验证的⽅法和接下来要实现的业务⼏何没有任何关联,但每个⽅法中都要写⼀遍。
所以提供⼀个公共的 AOP ⽅法来进⾏统⼀的⽤户登录权限验证迫在眉睫。
1.2 Spring AOP ⽤户统⼀登录验证的问题
说到统⼀的⽤户登录验证,我们想到的第⼀个实现⽅案是 Spring AOP 前置通知或环绕通知来实现,具体实现代码如下:
选择和springboot版本相同的AOP框架依赖,springboot版本为2.7.13,那么AOP的框架也为2.7.13
<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-aop -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
<version>2.7.13</version>
</dependency>
在上一篇AOP的文章中我们学习了AOP的拦截方式
package com.example.demo;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;
//该注解表示这个类是一个切面
@Aspect
//该注解表示该类随着项目的启动而启动
@Component
public class UserAspect {
//定义切点,配置拦截规则
@Pointcut("execution(* com.example.demo.controller.*.*(..))")
public void pointcut() {
}
@Before("pointcut()")
public void beforeAdvice() {
System.out.println("我是前置通知");
}
@After("pointcut()")
public void afterAdvice() {
System.out.println("我是后置通知");
}
// 环绕⽅法
@Around("pointcut()")
public Object doAround(ProceedingJoinPoint joinPoint){
Object obj = null;
System.out.println("Around ⽅法开始执⾏");
try {
// 执⾏拦截⽅法
obj = joinPoint.proceed();
} catch (Throwable throwable) {
throwable.printStackTrace();
}
System.out.println("Around ⽅法结束执⾏");
return obj;
}
}
如果要在以上 Spring AOP 的切⾯中实现⽤户登录权限效验的功能,有以下两个问题:
- 在切面类中很难获取到 HttpSession 对象。
- 我们要对⼀部分⽅法进⾏拦截,⽽另⼀部分⽅法不拦截,这样的话排除⽅法的规则很难定义,甚⾄没办法定义.也就是定义拦截的规则(表达式)非常难.
于是乎,我们引入了拦截器 ! ! !
1.3 Spring 拦截器
对于以上问题 Spring 中提供了具体的实现拦截器:HandlerInterceptor,拦截器的实现分为以下两个步骤:
- 创建⾃定义拦截器,实现 HandlerInterceptor 接⼝的 preHandle(执⾏具体⽅法之前的预处理)⽅法。
- 将⾃定义拦截器加⼊ WebMvcConfigurer 的 addInterceptors ⽅法中。
1.3.1 熟悉多级路由
- 这个路由指的是我们的网站地址(多级地址),不是我们家里联网的路由器哈.
- java框架接近尾声,可能大家还是对路由不太熟悉,今天我们就来稍微讲一下.
package com.example.demo;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RequestMapping("/user")
@RestController
public class User {
@GetMapping
public String get(){
return "这是get请求";
}
@PostMapping
public String post(){
return "这是post请求";
}
}
接下来我们使用postman构造一个post请求观察结果.
- 我们会发现get与post的注解需要一级路由(只需要在类上加路由)就可以进行访问;但是一个类中有多个get(或者多个post),不加二级路由就不能正常访问了.
- 这种一级路由的方式很少用.
1.3.2 创建自定义拦截器
package com.example.demo;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
public class LoginInter implements HandlerInterceptor {
/**
* 该方法返回一个布尔类型的值
* 如果为真登录成功(验证通过),继续执行后序流程
* 反之登录失败,后面的流程将不再执行
*/
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
//false表示有会话信息得到会话信息
//没有会话信息也不需要创建会话信息
HttpSession session = request.getSession(false);
if(session != null && session.getAttribute("user") != null){
//说明用户登录成功
return true;
}
//否则登录失败
//登录失败的情况可以做很多事情
//比如跳转到登录页面或者返回一个401/403没有权限的状态码
//具体怎么做取决于产品需求
//下面表示重定向,跳转到登录页面
// response.sendRedirect("/login.html");
response.setStatus(401);
return false;
}
}
1.3.3 拦截器加到系统配置
package com.example.demo;
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 Config implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LoginInter())
//设置拦截规则
.addPathPatterns("/**")//拦截所有请求
.excludePathPatterns("/**/user/login")//排除不拦截的请求
.excludePathPatterns("/**/*.html");
}
}
1.3.4 测试拦截器
- 首先创一个User类
package com.example.demo;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RequestMapping("/user")
@RestController
public class User {
@RequestMapping("/login")
public String login(){
return "执行了login";
}
@RequestMapping("/get")
public String get(){
return "执行了get";
}
}
- 通过网页进行测试
默认为全部拦截
addPathPatterns:表示需要拦截的 URL,“**”表示拦截任意⽅法(也就是所有⽅法)。
excludePathPatterns:表示需要排除的 URL。
说明:以上拦截规则可以拦截此项⽬中的使⽤ URL,包括静态⽂件(图⽚⽂件、JS 和 CSS 等⽂件)
2. 拦截器的实现原理
2.1 图解分析
- 没有拦截器的时候
- 加入拦截器后
2.2 源码分析
我们就运行我们上面的拦截器代码,然后通过浏览器访问观察控制台.
- 我们可以从控制台得到的信息是所有的 Controller 执⾏都会通过⼀个调度器 DispatcherServlet 来实现.
- 所有⽅法都会执⾏ DispatcherServlet 中的 doDispatch 调度⽅法
接下来我们来看一个doDispatch的源码.
protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
HttpServletRequest processedRequest = request;
HandlerExecutionChain mappedHandler = null;
boolean multipartRequestParsed = false;
WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);
try {
try {
ModelAndView mv = null;
Object dispatchException = null;
try {
processedRequest = this.checkMultipart(request);
multipartRequestParsed = processedRequest != request;
mappedHandler = this.getHandler(processedRequest);
if (mappedHandler == null) {
this.noHandlerFound(processedRequest, response);
return;
}
HandlerAdapter ha = this.getHandlerAdapter(mappedHandler.getHandler());
String method = request.getMethod();
boolean isGet = HttpMethod.GET.matches(method);
if (isGet || HttpMethod.HEAD.matches(method)) {
long lastModified = ha.getLastModified(request, mappedHandler.getHandler());
if ((new ServletWebRequest(request, response)).checkNotModified(lastModified) && isGet) {
return;
}
}
//调用预处理
//咱们在写拦截器的时候重写的方法就是PreHandle
//这是拦截器原理,如果不是真的话,直接拦截退出
//不会执行下面的东西
if (!mappedHandler.applyPreHandle(processedRequest, response)) {
return;
}
//执行controller的业务
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
if (asyncManager.isConcurrentHandlingStarted()) {
return;
}
this.applyDefaultViewName(processedRequest, mv);
mappedHandler.applyPostHandle(processedRequest, response, mv);
} catch (Exception var20) {
dispatchException = var20;
} catch (Throwable var21) {
dispatchException = new NestedServletException("Handler dispatch failed", var21);
}
this.processDispatchResult(processedRequest, response, mappedHandler, mv, (Exception)dispatchException);
} catch (Exception var22) {
this.triggerAfterCompletion(processedRequest, response, mappedHandler, var22);
} catch (Throwable var23) {
this.triggerAfterCompletion(processedRequest, response, mappedHandler, new NestedServletException("Handler processing failed", var23));
}
} finally {
if (asyncManager.isConcurrentHandlingStarted()) {
if (mappedHandler != null) {
mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response);
}
} else if (multipartRequestParsed) {
this.cleanupMultipart(processedRequest);
}
}
}
从上述源码可以看出在开始执⾏ Controller 之前,会先调⽤ 预处理⽅法 applyPreHandle,⽽
applyPreHandle ⽅法的实现源码如下:
boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {
for(int i = 0; i < this.interceptorList.size(); this.interceptorIndex = i++) {
HandlerInterceptor interceptor = (HandlerInterceptor)this.interceptorList.get(i);
if (!interceptor.preHandle(request, response, this.handler)) {
this.triggerAfterCompletion(request, response, (Exception)null);
return false;
}
}
return true;
}
- 上面的代码中运用了循环,它会把你所有的拦截规则循环一次,判断哪些该拦截,哪些不该拦截,每次循环拿一个拦截器.
- 在我们的项目中可以有多个拦截器,也就是通过 registry再添加一个拦截规则.
//一个类中可以配置多个拦截器
registry.addInterceptor(new LoginInter()).addPathPatterns();
registry.addInterceptor(new LoginInter()).addPathPatterns();
registry.addInterceptor(new LoginInter()).addPathPatterns();
- 通过上⾯的源码分析,我们可以看出,Spring 中的拦截器也是通过动态代理和环绕通知的思想实现的.
- 用户在调用目标方法的时候首先要通过代理对象,代理对象帮助我们去调用.
2.3 添加前缀
2.3.1 系统的配置文中设置
package com.example.demo;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.PathMatchConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class Config implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LoginInter())
//设置拦截规则
// .addPathPatterns("/**")//拦截所有请求
.excludePathPatterns("/**/user/login")//排除不拦截的请求
.excludePathPatterns("/**/user/get")
.excludePathPatterns("/**/*.html");
}
//所有的接口添加前缀信息
@Override
public void configurePathMatch(PathMatchConfigurer configurer) {
//c->true是固定语法
//所有的地址都添加这个前缀
configurer.addPathPrefix("liangchen",c->true);
}
}
此时我们再按照之前的访问方式就不能正常访问了.
接下来我们再地址中添加前缀可以正常访问
2.3.2 在 application.properies中设置
注意我们在设置之前把刚才的第一种方式设置的前缀进行注释,防止干扰我们的结果.
接下来在我们的application.properies中设置
server.servlet.context-path=/liangchen
接下来观察我们的浏览器访问路径,还是有laingchen的前缀.