springBoot拦截器的使用方法

springBoot拦截器的使用方法

拦截器：首先将所有的请求统一拦截到拦截器中，可以在拦截器中来定义过滤的规则，如果不满足系统中设置的过滤规则，统一的处理是重新打开login.html页面（重定向或转发：推荐重定向）

在springboot项目中拦截器的定义和使用。springboot是依靠springMVC来完成的。springMVC提供了一个HandlerInterceptor接口,用于表示定义一个拦截器。受限制自定义个类，在这个类实现这个接口。

1.首先自定义一个类在这个类实现HandlerInterceptor接口

package com.lgh.springboot_l_mall.interceptor;

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

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

/**
 * 定义一个拦截器
 */
public class LoginInterceptor implements HandlerInterceptor {

    /**
     * 检测全局session对象中是否有uid,有放行，没有重定向到login.html
     * @param request 请求对象
     * @param response 响应对象
     * @param handler 处理器（url+Controller:映射）
     * @return 如果返回值为true表示放行当前的请求，如果返回值为false则表示拦截器拦截当前的请求
     * @throws Exception
     */
    //在调用所有处理请求的方法之前被自动调用执行的方法
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //HttpServletRequest对象来获取session对象
        Object obj = request.getSession().getAttribute("uid");
        if(null==obj){
            //说明用户没有登录过系统重定向到login.html页面
            response.sendRedirect("/pages/web/login.html");
            //结束后续的调用
            return false;
        }
        //请求放行
        return true;
    }

    //在ModelAndView对象返回之后调用的方法
    @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 {

    }
}

2.注册过滤器：

• 添加白名单（那些资源可以在不登陆的情况下访问：login.html/index.html/register.html/product.html）
• 添加黑名单（在用户登录的状态才可以访问的页面资源）

3.注册过滤器的技术：借助WebMvcConfigure接口，可以将用户定义的拦截器进行注册，才可以保证拦截器能够生效和使用。定义一个类，然后让这个类实现WebMvcConfigure接口。配置信息建议存放在项目config包结构下.

package com.lgh.springboot_l_mall.config;

import com.lgh.springboot_l_mall.interceptor.LoginInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.util.ArrayList;
import java.util.List;

@Configuration //加载当前的拦截器并进行注册
public class LoginInterceptorConfigurer implements WebMvcConfigurer {

    /**
     * 配置拦截器
     * @param registry
     */
    //将自定义拦截器进行注册
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //创建自定义拦截器对象
        HandlerInterceptor interceptor=new LoginInterceptor();
        //配置白名单：存放在一个List集合
        List<String> patterns=new ArrayList<>();
        patterns.add("/pages/bootstrap3/**");
        patterns.add("/pages/css/**");
        patterns.add("/pages/images/**");
        patterns.add("/pages/js/**");
        patterns.add("/pages/js/**");
        patterns.add("/pages/web/register.html");
        patterns.add("/pages/web/login.html");
        patterns.add("/pages/web/index.html");
        patterns.add("/pages/web/product.html");
        patterns.add("/users/reg");
        patterns.add("/users/login");
        //完成拦截器的注册
        registry.addInterceptor(interceptor)
                .addPathPatterns("/**")//表示要拦截url是什么/**（拦截所有的）
                .excludePathPatterns(patterns);//表示不拦截什么（白名单）

    }
}