拦截器的概念
SpringMVC的处理器拦截器类似于Servlet开发中的过滤器Filter,用于对处理器进行预处理和后处理。开发者可以自己定义一些拦截器来实现特定的功能。
过滤器与拦截器的区别:拦截器是AOP思想的具体应用。过滤器是servlet规范中的一部分,任何java web工程都可以使用在url-pattern中配置了/*之后,可以对所有要访问的资源进行拦截,拦截器是SpringMVC框架自己的,只有使用了SpringMVC框架的工程才能使用,拦截器只会拦截访问的控制器方法, 如果访问的是jsp/html/css/image/js是不会进行拦截的。
spring boot的拦截器底层是基于springmvc的interceptor,但是实现spring boot的拦截器相比springmvc简化了很多,相比于在配置文件中配置拦截器,springboot利用自己的框架结构有一套自己的拦截器框架类,通过这个拦截器类,可以快速的配置出想要拦截的路径,在项目开发中必不可少。
接口HandlerInterceptor
在spring boot中实现拦截器功能首先创建自己的拦截器类,然后继承接口HandlerInterceptor,继承接口后实现接口中的三个方法,但是通常我们只会用到其中的一个preHandle方法,在这个方法中我们书写我们自己的拦截器
** 定义处理器拦截器 */
public class LoginInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
Object uid = request.getSession().getAttribute("uid");
if (uid==null){
//拦截器发现没有登录的情况下是会跳转到登录页面的
response.sendRedirect("/web/login.html");
return false;
}
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
Object handler, Exception ex) throws Exception {
HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
}
}
在这个方法中书写自己的实现方法,具体功能可随需求书写,当拦截器中访问要求满足条件时,放行,如果不满足要求,则直接返回软件的登录页面。
WebMvcConfigurer
WebMvcConfigurer也是spring boot底层基于springmvc配置文件衍生的配置接口,当创建我们自己配置类继承这个接口的时候,我们可以在类中配置软件实际的配置属性,不仅仅是拦截器的配置,过滤器,分页插件......都可以在这个类中配置。
接下来才是拦截器的重点内容,当新创建的类实现了WebMvcConfigurer接口后,CRTL+O重载addInterceptor方法,在这个方法中配置我们自己的拦截内容,拦截路径。
代码实现
@Configuration
public class myWebMvcConfigurer implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
HandlerInterceptor interceptor=new LoginInterceptor();
//白名单,放置我们不需要拦截的静态资源以及用户登录页面
List<String> path=new ArrayList<>();
path.add("/bootstrap3/**");
path.add("/css/**");
path.add("/images/**");
path.add("/js/**");
path.add("/web/register.html");
path.add("/web/login.html");
path.add("/web/index.html");
path.add("/web/product.html");
path.add("/users/reg");
path.add("/users/login");
path.add("/districts/**");
path.add("/products/**");
// 通过注册工具添加拦截器
registry.addInterceptor(interceptor).addPathPatterns("/**")//这里是需要拦截的所有路径
.excludePathPatterns(path);//下面是放行的路径
}
}
配置到这一步,重启项目,拦截器就可以运行啦,在实际项目中用来解决用户为登录就访问不能访问的页面。
注:以上的拦截路径仅供参考,是我自己的spring boot项目需要的拦截路径,如果项目不同,拦截路径根据自己的项目路径更改。