springboot-拦截器Interceptor

基本介绍

1.在Spring Boot项目中，拦截器是开发中常用手段，要来做登陆验证、性能检查、日志记录等。

2.基本步骤：

√编写一个拦截器实现HandlerInterceptor:接口

• 编写好了之后需要配置注册，否则不会生效，此时仅仅是个普通的类。

@Slf4j
public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String requestURI = request.getRequestURI();
        log.info("当前请求路径="+requestURI);
        HttpSession session = request.getSession();
        Object admin = session.getAttribute("admin");
        if(null != admin){
            return true;
        }
        request.setAttribute("msg","用户未登录，请按要求登录");
        request.getRequestDispatcher("/").forward(request,response);
        return false;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("postHandle已运行");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("afterCompletion已运行");
    }
}

√拦截器注册到配置类中(实现WebMvcConfigurer的addInterceptors)。后面有另一种实现方法。

@Configuration
public class WebConfigurer implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                .addPathPatterns("/**")
                .excludePathPatterns("/","/login","/images/**");
        // "/images/**"可以放行静态资源，否则无法加载。能够看到的原因是因为缓存
        // WebProperties.java里面已经设置了/static路径，所以在images前面不用再加了
    }
}

√指定拦截规则

• registry.addInterceptor(new LoginInterceptor()) //注册拦截器

.addPathPatterns("/**") //添加拦截规则，或者说拦截路径。"/**"表示拦截所有

.excludePathPatterns("/","/login") //不拦截哪些。可变参数，可以指定多个来匹配。

• PathPattern 翻译成：路径匹配器

√回顾SpringMVC中讲解的Interceptor。可翻阅笔记查看

---

使用场景：用户验证

按照以前的验证方式，需要在session中放入用户信息，然后在每个方法中进行验证是否已登录。操作起来繁琐且重复。这时候使用拦截器，可以进行统一配置，减少重复编码。

---

注意事项和细节

1、URI和URL的区别

URI = Universal Resource Identifier 统一资源标识符(描述符)

URL = Universal Resource Locator 统一资源定位器(定位符)

Identifier:标识符，Locator:定位器

从字面上来看，URI可以唯一标识一个资源，URL可以提供找到该资源的路径

举例说明：

String requestURI = request.getRequestURI（）;

输出案例：/manage.html

String requestURL = request.getRequestURL（）.toString（）;

输出案例：http://localhost:8080/manage.html

2、可以使用另外一种方法注册拦截器

注意使用@Configuration和@Bean来注解该配置

@Configuration
public class WebConfigurer2 {
    @Bean
    public WebMvcConfigurer webMvcConfigurer(){
        return new WebMvcConfigurer() {
            @Override
            public void addInterceptors(InterceptorRegistry registry) {
                registry.addInterceptor(new LoginInterceptor())
                        .addPathPatterns("/**")
                        .excludePathPatterns("/","/login","/images/**");
            }
        };
    }
}

---

注意事项

在servlet匹配全部是"/*"，在Spring-Boot是"/**"