本文基于第一点进行介绍实现拦截器。
自定义拦截器
- #自定义拦截器,实现HandlerInterceptor接口,并实现其中的三个方法
preHandle方法:在业务处理器处理请求之前被调用,预处理,可以进行编码、安全控制、权限校验等处理换句话说就是请求在达到controller层之前会被拦截并运行preHandle方法。
postHandle方法:在业务处理器处理请求执行完成后,生成视图之前执行。后处理(调用了Service并返回ModelAndView,但未进行页面渲染),有机会修改ModelAndView ;
afterCompletion:在DispatcherServlet完全处理完请求后被调用,可用于清理资源等。返回处理(已经渲染了页面);
package com.xiaohaitang.somedemo.ierInterceptor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class lerInterceptor implements HandlerInterceptor {
private static final Logger logger = LoggerFactory.getLogger(lerInterceptor.class);
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
logger.info("Interceptor preHandle");
//如果返回false则 postHandle()和 afterCompletion()不会执行
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
logger.info("Interceptor postHandle");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
logger.info("Interceptor afterCompletion");
}
}
- 注册上面定义的拦截器并定义拦截范围
package com.xiaohaitang.somedemo.config;
import com.xiaohaitang.somedemo.ierInterceptor.lerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class MyWebAppConfigurer implements WebMvcConfigurer {
@Bean
public lerInterceptor myInterceptor() {
return new lerInterceptor();
}
@Override
//此方法用来专门注册一个拦截器
public void addInterceptors(InterceptorRegistry registry) {
//addPathPatterns("/**")对所有请求都拦截,但是排除了/apiList/v1/calculator和/js/**和/*/v1/returnJson请求的拦截。
registry.addInterceptor(myInterceptor())
.addPathPatterns("/**")
.excludePathPatterns("/apiList/v1/calculator", "/js/**", "/*/v1/returnJson");
}
}
验证
1.假设现在我们运行接口 /apiList/v1/calculator , 将不会打印任何信息,因为上面排除了 /apiList/v1/calculator ,所以 /apiList/v1/calculator不会被拦截。
2.假设现在我们运行接口 /apiList/v1/findAll ,这个接口里面的逻辑是打印
jsonObject:{note=你好啊!, month=12, yer=2020, day=24}
运行接口 /apiList/v1/findAll 后控制台打印了以下信息:
2021-02-05 14:38:36,738:INFO http-nio-8080-exec-1 (lerInterceptor.java:14) - Interceptor preHandle
2021-02-05 14:38:36,755:INFO http-nio-8080-exec-1 (UserConsumer.java:93) - jsonObject:{note=你好啊!, month=12, yer=2020, day=24}
2021-02-05 14:38:36,776:INFO http-nio-8080-exec-1 (lerInterceptor.java:21) - Interceptor postHandle
2021-02-05 14:38:36,776:INFO http-nio-8080-exec-1 (lerInterceptor.java:26) - Interceptor afterCompletion
可以看到请求在到达接口 /apiList/v1/findAll 前,先执行了拦截器里的preHandle方法,再执行了接口里的逻辑,最后再执行了postHandle和afterCompletion方法。