SpringBoot(4)配置拦截器

上一篇我们对过滤器进行了介绍，此篇将会介绍spring独有的拦截器，它相对于过滤器来说更加的精细，能够在响应请求之前，请求响应之后，视图渲染之前，以及请求全部结束之后。我们不能通过拦截器去修改请求的内容，但是我们可以通过抛出异常或者返回FALSE来暂停请求的执行。

实现 UserRoleAuthorizationInterceptor 的拦截器有： 
ConversionServiceExposingInterceptor 
CorsInterceptor 
LocaleChangeInterceptor 
PathExposingHandlerInterceptor 
ResourceUrlProviderExposingInterceptor 
ThemeChangeInterceptor 
UriTemplateVariablesHandlerInterceptor 
UserRoleAuthorizationInterceptor

其中 LocaleChangeInterceptor 和 ThemeChangeInterceptor 比较常用。

配置拦截器也很简单，Spring 为什么提供了基础类WebMvcConfigurerAdapter ，我们只需要重写 addInterceptors 方法添加注册拦截器。

实现自定义拦截器只需要3步： 
1、创建我们自己的拦截器类并实现 HandlerInterceptor 接口。 
2、创建一个Java类继承WebMvcConfigurerAdapter，并重写 addInterceptors 方法。 
2、实例化我们自定义的拦截器，然后将对像手动添加到拦截器链中（在addInterceptors方法中添加）。

代码如下：

MyInterceptor1.java

package com.springboot.study.interceptors;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

public class MyInterceptor1 implements HandlerInterceptor{

	@Override
	public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)
			throws Exception {
		System.out.println("=====>(1)在整个请求之后调用，即在dispatcherServlet渲染了对应的视图之后（主要是进行资源清理工作）");
	}

	@Override
	public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)
			throws Exception {
		System.out.println("=====>(1)在请求处理之后调用，即在controller方法执行之后调用");
	}

	@Override
	public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2) throws Exception {
		System.out.println("=====>（1）在请求处理之前调用，即在Controller方法调用之前！");
		return true;//只有返回true才会往下执行，返回FALSE的话就会取消当前请求
	}

}

MyInterceptor2.java

package com.springboot.study.interceptors;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

public class MyInterceptor2 implements HandlerInterceptor{

	@Override
	public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)
			throws Exception {
		System.out.println("=====>(2)在整个请求之后调用，即在dispatcherServlet渲染了对应的视图之后（主要是进行资源清理工作）");
	}

	@Override
	public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)
			throws Exception {
		System.out.println("=====>(2)在请求处理之后调用，即在controller方法执行之后调用");
	}

	@Override
	public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2) throws Exception {
		System.out.println("=====>（2）在请求处理之前调用，即在Controller方法调用之前！");
		return true;//只有返回true才会往下执行，返回FALSE的话就会取消当前请求
	}

}

MyController.java

package com.springboot.study.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {
	
	@RequestMapping("/index")
	public String index(){
		return "hello!";
	}
	
}

MyWebAppConfigurer.java

package com.springboot.study.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

import com.springboot.study.interceptors.MyInterceptor1;
import com.springboot.study.interceptors.MyInterceptor2;

@Configuration
public class MyWebAppConfigurer extends WebMvcConfigurerAdapter{
	
	@Override
	public void addInterceptors(InterceptorRegistry registry) {
		registry.addInterceptor(new MyInterceptor1()).addPathPatterns("/**");
        registry.addInterceptor(new MyInterceptor2()).addPathPatterns("/**");
		super.addInterceptors(registry);
	}
}

拦截器链的执行顺序是先进后出，执行结果为：

=====>（1）在请求处理之前调用，即在Controller方法调用之前！
=====>（2）在请求处理之前调用，即在Controller方法调用之前！
=====>(2)在请求处理之后调用，即在controller方法执行之后调用
=====>(1)在请求处理之后调用，即在controller方法执行之后调用
=====>(2)在整个请求之后调用，即在dispatcherServlet渲染了对应的视图之后（主要是进行资源清理工作）
=====>(1)在整个请求之后调用，即在dispatcherServlet渲染了对应的视图之后（主要是进行资源清理工作）

但是拦截器只能后作用于dispatcherSevlet处理的请求，我们自定义的Servlet是不会拦截的， 并且不管是属于哪个Servlet 只要复合过滤器的过滤规则，过滤器都会拦截。而且WebMvcConfigurerAdapter 不只是能够添加拦截器，还有很多很多的功能，可以去详细的看一看他的方法列表去研究研究。