Sprinboot自定义拦截器

拦截器机制

拦截器主要是用于在用户请求控制中，对于请求识别，鉴权，以及区分资源是否可以被目标方法调用的安全机制。
要实现拦截器，SpringMvc 已经帮我集成好了，只需要实现 HandlerInterceptor 的接口，如果我们要写一个拦截器，就要实现这个 HandlerInterceptor 这个拦截器的标准接口；

拦截器使用场景

我们常用于购物网站，比如说京东商城中，加入购物车之后，如果要结算，就会跳转到登录界面，这个就是拦截器的作用，判断是否已经登录成功，区别访问的路径，细节就在接口的三个方法中；
适用场景：登录，鉴权，静态资源访问等
我们就以登录举例子，如果说用户要访问个人信息，验证当前是否已经登录，可以是 token 是否合法然后没有就要拦截器到未登录的页面，开始登录操作；

package com.atspring.config;

import com.atspring.intercepter.LoginInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;


/**
 * 配置web请求中的设置
 */
@Configuration
public class AdminWebConfig implements WebMvcConfigurer {


    /**
     * 1.编写一个拦截器，注册到容器中，addInterceptors
     * 2.指定拦截规则，如果拦截所有，所有资源包括静态资源都会被拦截
     * @param registry
     */

    //webconfig中的增加拦截器的方法，只需要重写就可以
    @Override
    public void addInterceptors(InterceptorRegistry registry) {

//        LoginInterceptor loginInterceptor=new LoginInterceptor();
//        registry.addInterceptor(loginInterceptor);

        registry.addInterceptor(new LoginInterceptor())
                //添加拦截器拦截的路径，/**全部放行，但在实际项目中可能是域名 /lucas/**
                .addPathPatterns("/**")
                //放行静态资源，以及登录
                .excludePathPatterns("/login","/css/**","/image/**","/js/**");
        
    }
}

配置拦截器：

package com.atspring.intercepter;

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

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

/**
 * 登录检查
 * 1.配置拦截器拦截哪些请求，
 * 2.把配置放在容器中Aop
 */
public class LoginInterceptor  implements HandlerInterceptor {

    /**
     * 处理方法之前，资源请求，
     * 检查等
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

       //登录检查,这里就利用session简单的存储了

        HttpSession  session=request.getSession();

        Object loginUser = session.getAttribute("loginUser");
        if (loginUser!=null){
            //放行
            return  true;
        }

        //拦截成功
        request.setAttribute("message","请先登录");
        //转发到登录页面去登录，并且返回
        request.getRequestDispatcher("/login").forward(request,response);
        return false;

    }

    /**
     * 处理方法之后，未返回页面之前
     * 对于数据处理
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }


    /**
     * 请求执行完成之后，
     * 对资源的关闭等
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }
}

拦截器原理

1. 根据当前请求，找到 HandlerExecutionChain【可以处理请求的 handler 以及 handler 的所有 拦截器】
2. 先来顺序执行 所有拦截器的 preHandle 方法

• 如果当前拦截器 prehandler 返回为 true。则执行下一个拦截器的 preHandle
• 如果当前拦截器返回为 false。直接 倒序执行所有已经执行了的拦截器的 afterCompletion；

3. 如果任何一个拦截器返回 false。直接跳出不执行目标方法
4. 所有拦截器都返回 True。执行目标方法
5. 倒序执行所有拦截器的 postHandle 方法。
6. 前面的步骤有任何异常都会直接倒序触发 afterCompletion
7. 页面成功渲染完成以后，也会倒序触发 afterCompletion

Sprinboot添加自定义拦截器后视图解析失败问题

我在使用Springboot2.0通过重载WebMvcConfigurationSupport和使用注解@Configuration的方法添加自定义拦截器后会出现一个bug，就是我们在application.properties配置的视图解析失效
我在application.properties的配置如下：

server.port=8086
server.servlet.context-path=/
spring.mvc.view.prefix=/views/
spring.mvc.view.suffix=.jsp

我的InterceptorConfig 代码如下：

@Configuration
public class InterceptorConfig extends WebMvcConfigurationSupport {

    @Autowired
    private LoginHandlerInterceptor loginHandlerInterceptor;

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/").setViewName("forward:/index");
        registry.setOrder(Ordered.HIGHEST_PRECEDENCE);
        super.addViewControllers(registry);
    }


    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 判断用户是否登录的拦截器
        registry.addInterceptor(loginHandlerInterceptor).addPathPatterns("/*/*");
        super.addInterceptors(registry);
    }

}

我推测应当是WebMvcConfigurationSupport 中创建了新的视图解析器，既然如此，我就直接自定义一个ViewResolver 放到WebMvcConfigurationSupport中，问题得到解决。

    private static final String VIEW_PREFIX = "/views/";// 视图前缀
    private static final String VIEW_SUFFIX = ".jsp";// 视图后缀
    private static final String VIEW_CONTENT_TYPE = "text/html;charset=UTF-8";//视图的内容类型。

    /**
     * 配置 视图解析器
     * @return
     */
    @Bean
    public ViewResolver viewResolver(){

        InternalResourceViewResolver resolver = new InternalResourceViewResolver();
        resolver.setCache(true);
        resolver.setPrefix(VIEW_PREFIX);
        resolver.setSuffix(VIEW_SUFFIX);
        resolver.setExposeContextBeansAsAttributes(true);
        resolver.setContentType(VIEW_CONTENT_TYPE);
        return resolver;
    }