拦截器
preHandler(HttpServletRequest request, HttpServletResponse response, Object handler)
方法在请求处理之前被调用。该方法在 Interceptor 类中最先执行,用来进行一些前置初始化操作或是对当前请求做预处理,也可以进行一些判断来决定请求是否要继续进行下去。
该方法的返回至是 Boolean 类型,当它返回 false 时,表示请求结束,后续的 Interceptor 和 Controller 都不会再执行;
当它返回为 true 时会继续调用下一个 Interceptor 的 preHandle 方法,如果已经是最后一个 Interceptor 的时候就会调用当前请求的 Controller 方法。
postHandler(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
方法在当前请求处理完成之后,也就是 Controller 方法调用之后执行,
但是它会在 DispatcherServlet 进行视图返回渲染之前被调用,
所以我们可以在这个方法中对 Controller 处理之后的 ModelAndView 对象进行操作。
afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex)
方法需要在当前对应的 Interceptor 类的 postHandler 方法返回值为 true 时才会执行。
顾名思义,该方法将在整个请求结束之后,也就是在 DispatcherServlet 渲染了对应的视图之后执行。
此方法主要用来进行资源清理。
实际应用
在登录网站的时候我们会发现,如果没有登录,直接进入网站的核心网页,网站会强制跳转到登录界面。登录之后就从畅通无阻了。下面我们就使用Interceptor拦截器来实现这个功能
步骤
①创建拦截器类
②注册拦截器
1.创建拦截器类
思路:在拦截器的preHandle() 中实现业务逻辑
首先通过request对象获取请求头中的Authorization字段中的token信息
判断token信息是否为空
如果为空则返回错误信息
如果不为空则将token信息与redis中的token信息比对
比对成功则放行返回true,否则返回错误信息
@Component
public class LoginInterceptor implements HandlerInterceptor {
@Autowired
StringRedisTemplate redisTemplate;
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
String token = request.getHeader("Authorization");
ValueOperations<String, String> valueOperations = redisTemplate.opsForValue();
if(Strings.isEmpty(token)){
throw new NoTokenException("请求未携带token身份验证令牌");
}
String s = valueOperations.get(token);
if (Strings.isNotEmpty(s)) {
JSONObject jsonObject = JSON.parseObject(s);
if (jsonObject != null) {
return true;
}
}
throw new NotLoginException("用户未登录");//使用异常捕获,可以为前端返回自定义的信息
}
@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 {}
}
注意点:
①需要在拦截器类上添加 @Component 注解,将该拦截器类添加近ioc容器
②需要实现HandlerInterceptor接口,并重写其中的三个方法
2.注册拦截器
编写拦截器配置类
WebMvcConfigurer配置类其实是Spring内部的一种配置方式,采用JavaBean的形式来代替传统的xml配置文件形式进行针对框架个性化定制,可以自定义一些Handler,Interceptor,ViewResolver,MessageConverter。基于java-based方式的spring mvc配置,需要创建一个配置类并实现WebMvcConfigurer 接口;
在Spring Boot 1.5版本都是靠重写WebMvcConfigurerAdapter的方法来添加自定义拦截器,消息转换器等。SpringBoot 2.0 后,该类被标记为@Deprecated(弃用)。官方推荐直接实现WebMvcConfigurer或者直接继承WebMvcConfigurationSupport。
方式一 :实现WebMvcConfigurer接口(推荐)
方式二 :继承WebMvcConfigurationSupport类,具体实现可看这篇文章。 https://blog.csdn.net/fmwind/article/details/82832758
@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
@Autowired
LoginInterceptor loginInterceptor;
@Autowired
AccessLimitInterceptor accessLimitInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(loginInterceptor)
.addPathPatterns("/user/**")
.excludePathPatterns("/user/login", "/user/register","/user/test");
registry.addInterceptor(accessLimitInterceptor).addPathPatterns("/user/**");
}
}
注意点:
①在注册拦截器时,一定要使用我们放在ioc里面的拦截器,我们在拦截器类上添加了@Component,所以可以在ioc中找到
如果不使用ioc容器中的拦截器类,而是new一个对象
在程序运行时,调用拦截器就会出现空指针异常
因为此时拦截器配置类注册的是我们new出来的对象,而不是ioc容器中的,所以无法自动装配。
只有在ioc容器中的bean才能相互依赖