赞
踩
在后续的请求当中,都会在请求头中携带JWT令牌到服务端,而服务端需要统一拦截所有的请求,从而判断是否携带的有合法的JWT令牌。 那怎么样来统一拦截到所有的请求校验令牌的有效性呢?
这里我们会学习两种解决方案:
Filter过滤器
Interceptor拦截器
通过这两个技术,我们可以在请求访问到接口前和访问到接口后进行一些操作,不止是jwt认证。还有打印日志,存变量之类的操作。
Filter表示过滤器,是 JavaWeb三大组件(Servlet、Filter、Listener)之一。
过滤器可以把对资源的请求拦截下来,从而实现一些特殊的功能
使用了过滤器之后,要想访问web服务器上的资源,必须先经过滤器,过滤器处理完毕之后,才可以访问对应的资源。
过滤器一般完成一些通用的操作,比如:登录校验、统一编码处理、敏感字符处理还有打印字符等操作。
下面我们通过Filter快速入门程序掌握过滤器的基本使用操作:
定义一个类,实现 Filter 接口,并重写其所有方法。
- //定义一个类,实现一个标准的Filter过滤器的接口
- public class DemoFilter implements Filter {
- @Override //初始化方法, 只调用一次
- public void init(FilterConfig filterConfig) throws ServletException {
- System.out.println("init 初始化方法执行了");
- }
-
- @Override //拦截到请求之后调用, 调用多次
- public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
- System.out.println("Demo 拦截到了请求...放行前逻辑");
- //放行
- chain.doFilter(request,response);
- }
-
- @Override //销毁方法, 只调用一次
- public void destroy() {
- System.out.println("destroy 销毁方法执行了");
- }
- }
init方法:过滤器的初始化方法。在web服务器启动的时候会自动的创建Filter过滤器对象,在创建过滤器对象的时候会自动调用init初始化方法,这个方法只会被调用一次。
doFilter方法:这个方法是在每一次拦截到请求之后都会被调用,所以这个方法是会被调用多次的,每拦截到一次请求就会调用一次doFilter()方法。
destroy方法: 是销毁的方法。当我们关闭服务器的时候,它会自动的调用销毁方法destroy,而这个销毁方法也只会被调用一次。
Filter类上加 @WebFilter 注解,配置拦截资源的路径。引导类上加 @ServletComponentScan 开启Servlet组件支持。
在定义完Filter之后,Filter其实并不会生效,还需要完成Filter的配置,Filter的配置非常简单,只需要在Filter类上添加一个注解:@WebFilter,并指定属性urlPatterns,通过这个属性指定过滤器要拦截哪些请求:
- @WebFilter(urlPatterns = "/*") //配置过滤器要拦截的请求路径( /* 表示拦截浏览器的所有请求 )
- public class DemoFilter implements Filter {
- ...
- }
当我们在Filter类上面加了@WebFilter注解之后,接下来我们还需要在启动类上面加上一个注解@ServletComponentScan,通过这个@ServletComponentScan注解来开启SpringBoot项目对于Servlet组件的支持。
注意事项:
在过滤器Filter中,如果不执行放行操作,将无法访问后面的资源。 放行操作:chain.doFilter(request, response);
执行流程我们搞清楚之后,接下来再来介绍一下过滤器的拦截路径,Filter可以根据需求,配置不同的拦截资源路径。
例:
拦截路径 | urlPatterns值 | 含义 |
---|---|---|
拦截具体路径 | /login | 只有访问 /login 路径时,才会被拦截 |
目录拦截 | /emps/* | 访问/emps下的所有资源,都会被拦截 |
拦截所有 | /* | 访问所有资源,都会被拦截 |
所谓过滤器链指的是在一个web应用程序当中,可以配置多个过滤器,多个过滤器就形成了一个过滤器链。
这个链上的过滤器在执行的时候会一个一个的执行,会先执行第一个Filter,放行之后再来执行第二个Filter,如果执行到了最后一个过滤器放行之后,才会访问对应的web资源。
访问完web资源之后,按照我们刚才所介绍的过滤器的执行流程,还会回到过滤器当中来执行过滤器放行后的逻辑,而在执行放行后的逻辑的时候,顺序是反着的。
先要执行过滤器2放行之后的逻辑,再来执行过滤器1放行之后的逻辑,最后在给浏览器响应数据。
- @Slf4j
- @WebFilter(urlPatterns = "/*") //拦截所有请求
- public class LoginCheckFilter implements Filter {
-
- @Override
- public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain chain) throws IOException, ServletException {
- //前置:强制转换为http协议的请求对象、响应对象 (转换原因:要使用子类中特有方法)
- HttpServletRequest request = (HttpServletRequest) servletRequest;
- HttpServletResponse response = (HttpServletResponse) servletResponse;
-
- //1.获取请求url
- String url = request.getRequestURL().toString();
- log.info("请求路径:{}", url); //请求路径:http://localhost:8080/login
-
-
- //2.判断请求url中是否包含login,如果包含,说明是登录操作,放行
- if(url.contains("/login")){
- chain.doFilter(request, response);//放行请求
- return;//结束当前方法的执行
- }
-
-
- //3.获取请求头中的令牌(token)
- String token = request.getHeader("token");
- log.info("从请求头中获取的令牌:{}",token);
-
-
- //4.判断令牌是否存在,如果不存在,返回错误结果(未登录)
- if(!StringUtils.hasLength(token)){
- log.info("Token不存在");
-
- Result responseResult = Result.error("NOT_LOGIN");
- //把Result对象转换为JSON格式字符串 (fastjson是阿里巴巴提供的用于实现对象和json的转换工具类)
- String json = JSONObject.toJSONString(responseResult);
- response.setContentType("application/json;charset=utf-8");
- //响应
- response.getWriter().write(json);
-
- return;
- }
-
- //5.解析token,如果解析失败,返回错误结果(未登录)
- try {
- JwtUtils.parseJWT(token);
- }catch (Exception e){
- log.info("令牌解析失败!");
-
- Result responseResult = Result.error("NOT_LOGIN");
- //把Result对象转换为JSON格式字符串 (fastjson是阿里巴巴提供的用于实现对象和json的转换工具类)
- String json = JSONObject.toJSONString(responseResult);
- response.setContentType("application/json;charset=utf-8");
- //响应
- response.getWriter().write(json);
-
- return;
- }
-
-
- //6.放行
- chain.doFilter(request, response);
-
- }
- }
是一种动态拦截方法调用的机制,类似于过滤器。
拦截器是Spring框架中提供的,用来动态拦截控制器方法的执行。
拦截器的作用:
拦截请求,在指定方法调用前后,根据业务需要执行预先设定的代码。
在拦截器当中,我们通常也是做一些通用性的操作,比如:我们可以通过拦截器来拦截前端发起的请求,将登录校验的逻辑全部编写在拦截器当中。在校验的过程当中,如发现用户登录了(携带JWT令牌且是合法令牌),就可以直接放行,去访问spring当中的资源。如果校验时发现并没有登录或是非法令牌,就可以直接给前端响应未登录的错误信息。
下面我们通过快速入门程序,来学习下拦截器的基本使用。拦截器的使用步骤和过滤器类似,也分为两步:
1.定义拦截器
2.注册配置拦截器
实现HandlerInterceptor接口,并重写其所有方法
- //自定义拦截器
- @Component
- public class LoginCheckInterceptor implements HandlerInterceptor {
- //目标资源方法执行前执行。 返回true:放行 返回false:不放行
- @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 .... ");
- }
- }
注意:
preHandle方法:目标资源方法执行前执行。 返回true:放行 返回false:不放行
postHandle方法:目标资源方法执行后执行
afterCompletion方法:视图渲染完毕后执行,最后执行
实现WebMvcConfigurer接口,并重写addInterceptors方法。使用addPathPatterns方法配置拦截路径。
- @Configuration
- public class WebConfig implements WebMvcConfigurer {
-
- //自定义的拦截器对象
- @Autowired
- private LoginCheckInterceptor loginCheckInterceptor;
-
-
- @Override
- public void addInterceptors(InterceptorRegistry registry) {
- //注册自定义拦截器对象
- registry.addInterceptor(loginCheckInterceptor).addPathPatterns("/**");//设置拦截器拦截的请求路径( /** 表示拦截所有请求)
- }
- }
拦截器的入门程序完成之后,接下来我们来介绍拦截器的使用细节。拦截器的使用细节我们主要介绍两个部分:
1.拦截器的拦截路径配置
2.拦截器的执行流程
首先我们先来看拦截器的拦截路径的配置,在注册配置拦截器的时候,我们要指定拦截器的拦截路径,通过addPathPatterns("要拦截路径")
方法,就可以指定要拦截哪些资源。
在入门程序中我们配置的是/**
,表示拦截所有资源,而在配置拦截器时,不仅可以指定要拦截哪些资源,还可以指定不拦截哪些资源,只需要调用excludePathPatterns("不拦截路径")
方法,指定哪些资源不需要拦截。
- @Configuration
- public class WebConfig implements WebMvcConfigurer {
-
- //拦截器对象
- @Autowired
- private LoginCheckInterceptor loginCheckInterceptor;
-
- @Override
- public 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 |
介绍完拦截路径的配置之后,接下来我们再来介绍拦截器的执行流程。通过执行流程,大家就能够清晰的知道过滤器与拦截器的执行时机。
当我们打开浏览器来访问部署在web服务器当中的web应用时,此时我们所定义的过滤器会拦截到这次请求。拦截到这次请求之后,它会先执行放行前的逻辑,然后再执行放行操作。而由于我们当前是基于springboot开发的,所以放行之后是进入到了spring的环境当中,也就是要来访问我们所定义的controller当中的接口方法。
Tomcat并不识别所编写的Controller程序,但是它识别Servlet程序,所以在Spring的Web环境中提供了一个非常核心的Servlet:DispatcherServlet(前端控制器),所有请求都会先进行到DispatcherServlet,再将请求转给Controller。
当我们定义了拦截器后,会在执行Controller的方法之前,请求被拦截器拦截住。执行
preHandle()
方法,这个方法执行完成后需要返回一个布尔类型的值,如果返回true,就表示放行本次操作,才会继续访问controller中的方法;如果返回false,则不会放行(controller中的方法也不会执行)。在controller当中的方法执行完毕之后,再回过来执行
postHandle()
这个方法以及afterCompletion()
方法,然后再返回给DispatcherServlet,最终再来执行过滤器当中放行后的这一部分逻辑的逻辑。执行完毕之后,最终给浏览器响应数据。
简而言之,Filter过滤器在Interceptor前面。
两者的区别:
接口规范不同:过滤器需要实现Filter接口,而拦截器实现HandlerInterceptor接口。
拦截范围不同:过滤器Filter会拦截所有的资源,而Interceptor只会拦截Spring环境中的资源。
和上面的Filter过滤器实现登录校验的基本逻辑一致。
编写Interceptor过滤器:
- //自定义拦截器
- @Component //当前拦截器对象由Spring创建和管理
- @Slf4j
- public class LoginCheckInterceptor implements HandlerInterceptor {
- //前置方式
- @Override
- public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
- System.out.println("preHandle .... ");
- //1.获取请求url
- //2.判断请求url中是否包含login,如果包含,说明是登录操作,放行
-
- //3.获取请求头中的令牌(token)
- String token = request.getHeader("token");
- log.info("从请求头中获取的令牌:{}",token);
-
- //4.判断令牌是否存在,如果不存在,返回错误结果(未登录)
- if(!StringUtils.hasLength(token)){
- log.info("Token不存在");
-
- //创建响应结果对象
- Result responseResult = Result.error("NOT_LOGIN");
- //把Result对象转换为JSON格式字符串 (fastjson是阿里巴巴提供的用于实现对象和json的转换工具类)
- String json = JSONObject.toJSONString(responseResult);
- //设置响应头(告知浏览器:响应的数据类型为json、响应的数据编码表为utf-8)
- response.setContentType("application/json;charset=utf-8");
- //响应
- response.getWriter().write(json);
-
- return false;//不放行
- }
-
- //5.解析token,如果解析失败,返回错误结果(未登录)
- try {
- JwtUtils.parseJWT(token);
- }catch (Exception e){
- log.info("令牌解析失败!");
-
- //创建响应结果对象
- Result responseResult = Result.error("NOT_LOGIN");
- //把Result对象转换为JSON格式字符串 (fastjson是阿里巴巴提供的用于实现对象和json的转换工具类)
- String json = JSONObject.toJSONString(responseResult);
- //设置响应头
- response.setContentType("application/json;charset=utf-8");
- //响应
- response.getWriter().write(json);
-
- return false;
- }
-
- //6.放行
- return true;
- }
注册拦截器:
- @Configuration
- public class MvcConfig implements WebMvcConfigurer {
- @Override
- public void addInterceptors(InterceptorRegistry registry) {
- registry.addInterceptor(new LoginCheckInterceptor));
- }
- }
Filter和Interceptor作用相似,都起到拦截过滤和在请求前后进行一系列操作的作用。
不同的是前者由sevlet提供,对所有资源起作用,后者由springboot提供,对spring中资源器作用。
还有Filter位于Interceptor前。
Copyright © 2003-2013 www.wpsshop.cn 版权所有,并保留所有权利。