Spring 中的Interceptor 拦截请求是通过HandlerInterceptor 来实现的。在Spring中定义一个Interceptor 非常简单,主要有两种方式,
【第一种方式】是要定义的Interceptor类要实现了Spring 的HandlerInterceptor 接口,或者是这个类继承实现了HandlerInterceptor 接口的类,比如Spring 已经提供的实现了HandlerInterceptor 接口的抽象类HandlerInterceptorAdapter ;
【第二种方式】是实现Spring的WebRequestInterceptor接口,或者是继承实现了WebRequestInterceptor的类。
其主要通过三个方法实现请求拦截业务
//该方法将在请求处理之前进行调用(返回true,请求通过;返回false,请求被拦截;注意,他是拦截器链中最前的一个)
public boolean preHandle (
HttpServletRequest request,
HttpServletResponse response,
Object handle)
//在当前请求进行处理之后调用(多用于:日志记录,权限检查,性能监控,通用行为等)
public void postHandle (
HttpServletRequest request,
HttpServletResponse response,
Object handle,
ModelAndView modelAndView)
//该方法也是需要当前对应的Interceptor 的preHandle 方法的返回值为true 时才会执行(这个方法的主要作用是用于进行资源清理工作的)
public void afterCompletion(
HttpServletRequest request,
HttpServletResponse response,
Object handler, Exception ex) throws Exception
拦截器三大方法的具体介绍:
【preHandle 方法】
preHandle (HttpServletRequest request, HttpServletResponse response, Object handle) 方法,顾名思义,该方法将在请求处理之前进行调用。SpringMVC 中的Interceptor 是链式的调用的,在一个应用中或者说是在一个请求中可以同时存在多个Interceptor 。每个Interceptor 的调用会依据它的声明顺序依次执行,而且最先执行的都是Interceptor 中的preHandle 方法,所以可以在这个方法中进行一些前置初始化操作或者是对当前请求的一个预处理,也可以在这个方法中进行一些判断来决定请求是否要继续进行下去。该方法的返回值是布尔值Boolean 类型的,当它返回为false 时,表示请求结束,后续的Interceptor 和Controller 都不会再执行;当返回值为true 时就会继续调用下一个Interceptor 的preHandle 方法,如果已经是最后一个Interceptor 的时候就会是调用当前请求的Controller 方法。
【postHandle 方法】
postHandle (HttpServletRequest request, HttpServletResponse response, Object handle, ModelAndView modelAndView) 方法,由preHandle 方法的解释我们知道这个方法包括后面要说到的afterCompletion 方法都只能是在当前所属的Interceptor 的preHandle 方法的返回值为true 时才能被调用。postHandle 方法,顾名思义就是在当前请求进行处理之后,也就是Controller 方法调用之后执行,但是它会在DispatcherServlet 进行视图返回渲染之前被调用,所以我们可以在这个方法中对Controller 处理之后的ModelAndView 对象进行操作。postHandle 方法被调用的方向跟preHandle 是相反的,也就是说先声明的Interceptor 的postHandle 方法反而会后执行,这和Struts2 里面的Interceptor 的执行过程有点类型。Struts2 里面的Interceptor 的执行过程也是链式的,只是在Struts2 里面需要手动调用ActionInvocation 的invoke 方法来触发对下一个Interceptor 或者是Action 的调用,然后每一个Interceptor 中在invoke 方法调用之前的内容都是按照声明顺序执行的,而invoke 方法之后的内容就是反向的。
【afterCompletion方法】
afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex) 方法,该方法也是需要当前对应的Interceptor 的preHandle 方法的返回值为true 时才会执行。顾名思义,该方法将在整个请求结束之后,也就是在DispatcherServlet 渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。
【下面是spring boot中对拦截器的运用】
【注册拦截器类】WebAppConfig
/**
* Created by mis on 2016/7/30.
* @author lvfang
*/
@EnableWebMvc
@Configuration
public class WebAppConfig extends WebMvcConfigurerAdapter {
//将拦截器注入容器
@Bean
HiseeInterceptor hiseeInterceptor(){
return new HiseeInterceptor();
}
/**
* 配置拦截器
*
* @param registry
* @author lvfang
*/
public void addInterceptors(InterceptorRegistry registry) {
//这里参数是一个实现了HandlerInterceptor接口的拦截器
registry.addInterceptor(hiseeInterceptor())
.addPathPatterns("/**")//需要拦截的请求
.excludePathPatterns("/user/login")
.excludePathPatterns("/user/exit");//不拦截的请求
}
}
【权限判断的一个封装类】BaseInterceptor
/**
* Created by mis on 2017/5/25.
* @author lvfang
*/
public class BaseInterceptor {
/**
* 权限列表查询
* @param permissionDomainRepository
* @param url
* @return
*/
public boolean isHavePermiss(PermissionDomainRepository permissionDomainRepository, UserInfo userInfo, String url){
boolean falg = false;
//获取用户权限
Set<PermissionInfo> permissionInfos = permissionDomainRepository.findPermissionByUid(userInfo.getId());
//对比查询权限
Iterator<PermissionInfo> iterator = permissionInfos.iterator();
while(iterator.hasNext()){
PermissionInfo permissionInfo = iterator.next();
if(permissionInfo.getpUrl().equals(url)){
falg = true;
}
}
return falg;
}
}
【具体的权限实现】拦截器实现:HiseeInterceptor
/**
* 拦截器
*/
@Component
public class HiseeInterceptor extends BaseInterceptor implements HandlerInterceptor {
@Autowired
private PermissionDomainRepository permissionDomainRepository;
@Autowired
private UserInfoMapper userInfoMapper;
@Override
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response, Object handler) throws Exception {
//获取session用户
UserSession userSession = SpringUtil.getBean(UserSession.class);
HiseeInterceptor userInterceptor = new HiseeInterceptor();
//登录状态
boolean isLogin = userSession.isLogin();
//请求资源
String url = request.getRequestURI(); // /user/deleteUser
UserInfo userInfo = userInfoMapper.findUserInfoById(userSession.getUserId());
//是否登录
if(!isLogin){
System.out.println("请登录 ... ...");
return false;
}
//是否拥有权限
boolean pstate = userInterceptor.isHavePermiss(permissionDomainRepository,userInfo,url);
if(!pstate){
System.out.println("无权限 ... ...");
return false;
}
System.out.println("权限通过 ... ...");
return true;
}
@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 {
}
}