SpringBoot入门学习笔记-9-Interceptor和Filter区别与使用

Interceptor和Filter都可以对请求进行拦截。

一、适用场景区别

如果不需要拦截静态资源，一般推荐用Interceptor。
如果需要拦截静态资源，用filter。

二、拦截顺序

先filter后Intercepted

过滤前 - 拦截前 -action执行 - 拦截后- 过滤后

三、登陆拦截器使用示例

1、配置登陆拦截器。

package com.cn.laoluobase.config.interceptor;


import org.springframework.http.HttpHeaders;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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


/*
 *  这是登陆拦截器，用于拦截所有请求，除特定接口外，都需要登陆，否则不允许访问。
 *  登陆的标志：请求头携带token,且token在有效期内。
 * */


public class AuthInterceptor implements HandlerInterceptor {

    private boolean reqAllow = false;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // Controller方法处理之前
        // setHeader 只能在preHandle中处理，在其他地方处理无效

        String token = request.getHeader("token");  //获得请求头内容，约定token作为交互内容
        System.out.println("token-***" + token);

        // 对token进行校验。如果符合要求则放行。实际业务中需要换成JWT之类的token验证。
        // 这里示例，进行简化，写死。
        if ("aaa".equals(token)) {
            reqAllow = true;
        }

        // 如果 ALLOW 为真，放行。否则拒绝返回401。
        if (reqAllow) {
            return true;
        } else {
            response.setStatus(401);  //通过response设置返回信息，比如status设置状态
            response.setCharacterEncoding("UTF-8");
            response.getWriter().write("401");
            return false;  //true 放行，false拒绝
        }

    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
      // Controller方法处理完之后.
        System.out.println("postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
      //  DispatcherServlet进行视图的渲染之后

    }

}

2 开启拦截器，添加拦截规则。

package com.cn.laoluobase.config.interceptor;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;


/*
 *   拦截器的适配器
 * */
@Configuration
public class config implements WebMvcConfigurer {

    /*
    * 拦截规则：
    * /open/*  开放访问
      /md5/*  开放访问，但是需要验证MD5有效，否则拒绝。
      /rsa/*  开放访问，但是需要验证rsa有效,未配置以前全部拒绝
      其他，全部拦截，需要token验证。
    **/

    //设置默认需要开放的路由列表；
    public static final String[] excludePathList = new String[]{"/*", "/md5/**", "/open/**"};

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 多个拦截器组成一个拦截器链

        // 添加MD5拦截
        registry.addInterceptor(new Md5Interceptor()).addPathPatterns("/md5/**");

        // 类添加MD5，添加更多拦截器，比如RSA拦截。

        // 添加统一拦截，除excludePath以外，都需要拦截。
        registry.addInterceptor(new AuthInterceptor()).addPathPatterns("/**").excludePathPatterns(excludePathList);

        // 拦截器挂载生效
        WebMvcConfigurer.super.addInterceptors(registry);
    }




}

3 配置md5拦截器(可选，addInterceptors不进行registry md5Interceptor即可)

package com.cn.laoluobase.config.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;

/*
 *  这是md5拦截器示例，未配置以前都拒绝
 * */


@Slf4j

public class Md5Interceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        log.info("************ Md5Interceptor preHandle  ****");

        response.setStatus(401);  //通过response设置返回信息，比如status设置状态
        // 跳转登录
        return false;  //true 放行，false拒绝
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }

}

四、请求接口时，如果未携带token，则会返回401

按照拦截规则，我们在请求头headers添加一个token为aaa再试一下，请求就可以正常访问了：