拦截器的使用

79 阅读2分钟

开启掘金成长之旅!这是我参与「掘金日新计划 · 2 月更文挑战」的第 9 天,点击查看活动详情

 在用户未登录时有些网页不能访问,如果用户通过某条路径发送请求,我们需要将其拦截并重定向到login页面,如何实现这个需求呢?在SpringMVC是通过HandlerInterceptor来实现的,下面来展示他的用法:

创建拦截器类

 首先创建一个拦截器类来实现HandlerInterceptor接口,这个拦截器类中的preHandle拦截器方法会在处理器方法执行前执行,因此经常在此方法里做一些初始化操作或者预处理,这个方法的返回值决定了请求是否执行下去,如果返回值为true,则继续执行下一个Interceptor或者处理器方法,反之结束当前请求。在SpringMVC中Interceptor的调用是链式调用,可以设置多个拦截器,执行的顺序是声明的顺序,在拦截器类中,除了preHandle()方法还有postHandle()方法和afterCompletion方法,postHandle方法与preHandle方法相反,他在处理器方法执行后执行,并且它的调用顺序与preHandle方法相反,先声明的后执行。afterCompletion方法主要做资源清理工作。

package com.cy.store.interceptor;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
​
/** 定义处理器拦截器 */
public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (request.getSession().getAttribute("uid") == null) {
            response.sendRedirect("/web/login.html");
            return false;
        }
        return true;
    }
}

 定义完拦截器后还需要创建一个实现了WebMvcConfigurer类的配置类,用来配置拦截器。其中核心方法是addInterceptors(InterceptorRegistry registry)用来添加拦截器。

/** 注册处理器拦截器 */
@Configuration
public class LoginInterceptorConfigurer implements WebMvcConfigurer {
    /** 拦截器配置 */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 创建拦截器对象
        HandlerInterceptor interceptor = new LoginInterceptor();
​
        // 白名单
        List<String> patterns = new ArrayList<String>();
        patterns.add("/bootstrap3/**");
        patterns.add("/css/**");
        patterns.add("/images/**");
        patterns.add("/js/**");
        patterns.add("/web/register.html");
        patterns.add("/web/login.html");
        patterns.add("/web/index.html");
        patterns.add("/web/product.html");
        patterns.add("/users/reg");
        patterns.add("/users/login");
        patterns.add("/districts/**");
        patterns.add("/products/**");
​
        // 通过注册工具添加拦截器
        registry.addInterceptor(interceptor).addPathPatterns("/**").excludePathPatterns(patterns);
    }
}