网站备案信息传,商城网站建设要求,淄博网站建设企业,重庆市施工安全管理网拦截器Interceptor
拦截器我们主要分为三个方面进行讲解#xff1a;
介绍下什么是拦截器#xff0c;并通过快速入门程序上手拦截器拦截器的使用细节通过拦截器Interceptor完成登录校验功能
1. 快速入门
什么是拦截器#xff1f;
是一种动态拦截方法调用的机制#xff…
拦截器Interceptor
拦截器我们主要分为三个方面进行讲解
介绍下什么是拦截器并通过快速入门程序上手拦截器拦截器的使用细节通过拦截器Interceptor完成登录校验功能
1. 快速入门
什么是拦截器
是一种动态拦截方法调用的机制类似于过滤器。拦截器是Spring框架中提供的用来动态拦截控制器方法的执行。
拦截器的作用
拦截请求在指定方法调用前后根据业务需要执行预先设定的代码。
在拦截器当中我们通常也是做一些通用性的操作比如我们可以通过拦截器来拦截前端发起的请求将登录校验的逻辑全部编写在拦截器当中。在校验的过程当中如发现用户登录了(携带JWT令牌且是合法令牌)就可以直接放行去访问spring当中的资源。如果校验时发现并没有登录或是非法令牌就可以直接给前端响应未登录的错误信息。
下面我们通过快速入门程序来学习下拦截器的基本使用。拦截器的使用步骤和过滤器类似也分为两步 定义拦截器 注册配置拦截器
**自定义拦截器**实现HandlerInterceptor接口并重写其所有方法
//自定义拦截器
Component
public class LoginCheckInterceptor implements HandlerInterceptor {//目标资源方法执行前执行。 返回true放行 返回false不放行Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {System.out.println(preHandle .... );return true; //true表示放行}//目标资源方法执行后执行Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {System.out.println(postHandle ... );}//视图渲染完毕后执行最后执行Overridepublic void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {System.out.println(afterCompletion .... );}
}注意 preHandle方法目标资源方法执行前执行。 返回true放行 返回false不放行 postHandle方法目标资源方法执行后执行 afterCompletion方法视图渲染完毕后执行最后执行 注册配置拦截器实现WebMvcConfigurer接口并重写addInterceptors方法
Configuration
public class WebConfig implements WebMvcConfigurer {//自定义的拦截器对象Autowiredprivate LoginCheckInterceptor loginCheckInterceptor;Overridepublic void addInterceptors(InterceptorRegistry registry) {//注册自定义拦截器对象registry.addInterceptor(loginCheckInterceptor).addPathPatterns(/**);//设置拦截器拦截的请求路径 /** 表示拦截所有请求}
}2. Interceptor详解
拦截器的入门程序完成之后接下来我们来介绍拦截器的使用细节。拦截器的使用细节我们主要介绍两个部分
拦截器的拦截路径配置拦截器的执行流程
2.1 拦截路径
首先我们先来看拦截器的拦截路径的配置在注册配置拦截器的时候我们要指定拦截器的拦截路径通过addPathPatterns(要拦截路径)方法就可以指定要拦截哪些资源。
在入门程序中我们配置的是/**表示拦截所有资源而在配置拦截器时不仅可以指定要拦截哪些资源还可以指定不拦截哪些资源只需要调用excludePathPatterns(不拦截路径)方法指定哪些资源不需要拦截。
Configuration
public class WebConfig implements WebMvcConfigurer {//拦截器对象Autowiredprivate LoginCheckInterceptor loginCheckInterceptor;Overridepublic void addInterceptors(InterceptorRegistry registry) {//注册自定义拦截器对象registry.addInterceptor(loginCheckInterceptor).addPathPatterns(/**)//设置拦截器拦截的请求路径 /** 表示拦截所有请求.excludePathPatterns(/login);//设置不拦截的请求路径}
}在拦截器中除了可以设置/**拦截所有资源外还有一些常见拦截路径设置
拦截路径
含义
举例
/*
一级路径
能匹配/depts/emps/login不能匹配 /depts/1
/**
任意级路径
能匹配/depts/depts/1/depts/1/2
/depts/*
/depts下的一级路径
能匹配/depts/1不能匹配/depts/1/2/depts
/depts/**
/depts下的任意级路径
能匹配/depts/depts/1/depts/1/2不能匹配/emps/1
下面主要来演示下/**与/*的区别 修改拦截器配置把拦截路径设置为/* Configuration public class WebConfig implements WebMvcConfigurer { //拦截器对象
Autowired
private LoginCheckInterceptor loginCheckInterceptor;Override
public void addInterceptors(InterceptorRegistry registry) {//注册自定义拦截器对象registry.addInterceptor(loginCheckInterceptor).addPathPatterns(/*).excludePathPatterns(/login);//设置不拦截的请求路径
}}
2.2 执行流程
介绍完拦截路径的配置之后接下来我们再来介绍拦截器的执行流程。通过执行流程大家就能够清晰的知道过滤器与拦截器的执行时机。 当我们打开浏览器来访问部署在web服务器当中的web应用时此时我们所定义的过滤器会拦截到这次请求。拦截到这次请求之后它会先执行放行前的逻辑然后再执行放行操作。而由于我们当前是基于springboot开发的所以放行之后是进入到了spring的环境当中也就是要来访问我们所定义的controller当中的接口方法。 Tomcat并不识别所编写的Controller程序但是它识别Servlet程序所以在Spring的Web环境中提供了一个非常核心的ServletDispatcherServlet前端控制器所有请求都会先进行到DispatcherServlet再将请求转给Controller。 当我们定义了拦截器后会在执行Controller的方法之前请求被拦截器拦截住。执行preHandle()方法这个方法执行完成后需要返回一个布尔类型的值如果返回true就表示放行本次操作才会继续访问controller中的方法如果返回false则不会放行controller中的方法也不会执行。 在controller当中的方法执行完毕之后再回过来执行postHandle()这个方法以及afterCompletion() 方法然后再返回给DispatcherServlet最终再来执行过滤器当中放行后的这一部分逻辑的逻辑。执行完毕之后最终给浏览器响应数据。
接下来我们就来演示下过滤器和拦截器同时存在的执行流程 开启LoginCheckInterceptor拦截器 Component public class LoginCheckInterceptor implements HandlerInterceptor { Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println(preHandle … ); return true; //true表示放行
}Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {System.out.println(postHandle ... );
}Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {System.out.println(afterCompletion .... );
}} Configuration public class WebConfig implements WebMvcConfigurer { //拦截器对象
Autowired
private LoginCheckInterceptor loginCheckInterceptor;Override
public void addInterceptors(InterceptorRegistry registry) {//注册自定义拦截器对象registry.addInterceptor(loginCheckInterceptor).addPathPatterns(/**)//拦截所有请求.excludePathPatterns(/login);//不拦截登录请求
}} 开启DemoFilter过滤器 WebFilter(urlPatterns “/*”) public class DemoFilter implements Filter { Override public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException { System.out.println(“DemoFilter 放行前逻辑…”); //放行请求filterChain.doFilter(servletRequest,servletResponse);System.out.println(DemoFilter 放行后逻辑.....);
}} 以上就是拦截器的执行流程。通过执行流程分析大家应该已经清楚了过滤器和拦截器之间的区别其实它们之间的区别主要是两点
接口规范不同过滤器需要实现Filter接口而拦截器需要实现HandlerInterceptor接口。拦截范围不同过滤器Filter会拦截所有的资源而Interceptor只会拦截Spring环境中的资源。
