SpringMVC 的Interceptor(拦截器)

参考: https://blog.youkuaiyun.com/zhangpower1993/article/details/89016503
http://c.biancheng.net/view/4431.html

定义一个拦截器可以通过两种方式：一种是通过实现 HandlerInterceptor 接口或继承 HandlerInterceptor 接口的实现类来定义；另一种是通过实现 WebRequestInterceptor 接口或继承 WebRequestInterceptor 接口的实现类来定义。

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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

@Component
public class UserAuthInterceptor implements HandlerInterceptor {

   private static final String TOKEN_BACKUP_PREFIX = "sys:token:backup:";

   //preHandle：在业务处理器处理请求之前被调用。预处理，可以进行编码、安全控制、权限校验等处理；
   @Override
   public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
         throws Exception {
      System.out.println("preHandle：在业务处理器处理请求之前被调用。预处理，可以进行编码、安全控制、权限校验等处理；");
      return true;
   }

   //仅在prehandle返回true执行
   //postHandle：在业务处理器处理请求执行完成后，生成视图之前执行。（调用了Service并返回ModelAndView，但未进行页面渲染），有机会修改ModelAndView；
   @Override
   public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
                     ModelAndView modelAndView) throws Exception {
      System.out.println("postHandle：在业务处理器处理请求执行完成后，生成视图之前执行。（调用了Service并返回ModelAndView，但未进行页面渲染），有机会修改ModelAndView；");
   }


   仅在prehandle返回true执行
   //afterCompletion：在DispatcherServlet完全处理完请求后被调用，可用于清理资源等
   @Override
   public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
         throws Exception {
      System.out.println("afterCompletion：在DispatcherServlet完全处理完请求后被调用，可用于清理资源等");
   }
}

WebMvcConfigurer配置类其实是Spring内部的一种配置方式，采用JavaBean的形式来代替传统的xml配置文件形式进行针对框架个性化定制，可以自定义一些Handler，Interceptor，ViewResolver，MessageConverter。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.ResourceUtils;
import org.springframework.web.servlet.config.annotation.*;

@Configuration
public class WebAppConfig implements WebMvcConfigurer {


    /**
     * 不需要登录拦截的url
     */
    final String[] notLoginInterceptPaths = {"/static/**", "/admin/login"};


    @Autowired
    UserAuthInterceptor userAuthInterceptor;


    /*
    * 拦截器配置
    * 可以添加多个拦截器
    * addInterceptor：需要一个实现HandlerInterceptor接口的拦截器实例
    * addPathPatterns：用于设置拦截器的过滤路径规则；addPathPatterns("/**")对所有请求都拦截
    * excludePathPatterns：用于设置不需要拦截的过滤规则
    */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //
        // 添加登录拦截器
        registry.addInterceptor(userAuthInterceptor).addPathPatterns("/**")
                .excludePathPatterns(notLoginInterceptPaths)
                .excludePathPatterns("/swagger-resources/**", "/webjars/**", "/swagger-ui.html/**", "/login/**", "/static/**");
    }



    /**
     * 配置不需要经过controller就跳转到登录页面
     *
     * 视图跳转控制器
     */
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        //访问 /dologin时  会跳转到/user/name1上   等于  http://localhost:8080//user/name1
        registry.addViewController("/dologin").setViewName("/user/name1");
        //访问 /goin  会自动跳转到 resources/static/login.html  等于http://localhost:8080/login.html
        registry.addViewController("/goin").setViewName("login.html");
        //访问 /demo  会访问 resources/static/demo.txt  等同于http://localhost:8080/demo.txt
        registry.addViewController("/demo").setViewName("demo.txt");
        //访问 /long  会访问 resources/static/long.html  等同于http://localhost:8080/long.html 或 http://localhost:8080/images/long.png
        registry.addViewController("/long").setViewName("long.html");
    }



    /***
     * 自定义静态资源映射目录
     * addResoureHandler：指的是对外暴露的访问路径
     * addResourceLocations：指的是内部文件放置的目录
     * 访问如同访问 resources/static
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 可以直接访问resource/mapper目录下的文件   http://localhost:8080/static/XXXXX.xml
        registry.addResourceHandler("/static/**").addResourceLocations(ResourceUtils.CLASSPATH_URL_PREFIX + "/mapper/");
        WebMvcConfigurer.super.addResourceHandlers(registry);
    }


    /* 默认静态资源处理器 */
    // 没搞明白这个是干啥的
    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
     //  configurer.enable("defaultServletName");
    }
}

小知识:
request.getParameter(“username”)
获取的内容是:

<form name="form" method="post" action="/v1/randomCode/checkUser">
    请输入用户姓名：<input type="text" name="username">
    <input type="submit" name="Submit" value="提交">
</form>
等同于 POST请求 Body中form-fata 键值对 username : xxx

2) 谷歌浏览器插件版的postman是不能修改Cookies的!!!