金风玉露一相逢,便胜却人间无数。
何为拦截器
拦截器(Interceptor):它依赖于web框架,在SpringMVC中就是依赖于SpringMVC框架。在实现上,基于Java的反射机制,属于面向切面编程(AOP)的一种运用,就是在service或者一个方法前,调用一个方法,或者在方法后,调用一个方法,比如动态代理就是拦截器的简单实现,在调用方法前打印出字符串(或者做其它业务逻辑的操作),也可以在调用方法后打印出字符串,甚至在抛出异常的时候做业务逻辑的操作。由于拦截器是基于web框架的调用,因此可以使用Spring的依赖注入(DI)进行一些业务操作,同时一个拦截器实例在一个controller生命周期之内可以多次调用。但是缺点是只能对controller请求进行拦截,对其他的一些比如直接访问静态资源的请求则没办法进行拦截处理。
实现方式
定义一个Interceptor 的方式有多种,这里简单列举两种:
- 定义一个类实现Spring的HandlerInterceptor接口。
- 定义一个类继承并实现HandlerInterceptor接口的类。
代码实现
以定义一个类实现Spring的HandlerInterceptor接口为例。
DemoInterceptor
package demointerceptor.interceptor;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* 拦截器中方法的执行流程是 preHandle -> Controlelr -> postHandle -> afterCompletion。
*/
public class DemoInterceptor implements HandlerInterceptor {
/**
* 在业务处理器处理请求之前被调用。预处理,可以进行编码、安全控制、权限校验等处理.
* 如果设置为false时,被请求时,拦截器执行到此处将不会继续操作。
* 如果设置为true时,请求将会继续执行后面的操作。
* @param request
* @param response
* @param handler
* @return
* @throws Exception
*/
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
//do somthing.
System.out.println("请求已到达拦截器。");
return false;
}
/**
* 在业务处理器处理请求执行完成后,生成视图之前执行。
* 后处理(调用了Service并返回ModelAndView,但未进行页面渲染),有机会修改ModelAndView。
* @param request
* @param response
* @param handler
* @param modelAndView
* @throws Exception
*/
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
}
/**
* 在DispatcherServlet完全处理完请求后被调用,
* 可用于清理资源等。返回处理(已经渲染了页面)。
* @param request
* @param response
* @param handler
* @param ex
* @throws Exception
*/
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
}
}
StartUp(启动类)
package demointerceptor;
import demointerceptor.interceptor.DemoInterceptor;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@SpringBootApplication
public class StartUp {
public static void main(String[] args) {
SpringApplication.run(StartUp.class,args);
}
//配置拦截器。
@Configuration
static class DemoInterceptorConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new DemoInterceptor()).addPathPatterns("/**");
}
}
}
DemoInterceptorController
package demointerceptor.controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class DemoInterceptorController {
@PostMapping(value = "demointerceptor")
public void demoRequest(){
System.out.println("方法未被拦截。");
}
}
DemoInterceptor.html
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/html">
<head>
<meta charset="UTF-8">
<title>请求示例</title>
</head>
<body>
<form action="http://localhost:8080/demointerceptor" method="post">
<input type="submit" value="发送请求"/>
</form>
</body>
</html>