1. 配置拦截器
@Configuration // 标注配置类
@EnableWebMvc // 开启Spring MVC的注解驱动
@ComponentScan(basePackages = "org.example") // 需要扫描的Controller包
public class WebConfig implements WebMvcConfigurer {
/**
* 添加拦截器
* @param registry
*/
@Override
public void addInterceptors(InterceptorRegistry registry) {
//将一个新的 MyInterceptor 实例添加到拦截器注册表中, 并指定拦截器的拦截路径为 "/**"
//"/**" 表示拦截所有路径。** 是一个通配符,表示任意数量的字符和子路径。
registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
}
}
2. 自定义拦截器功能
拦截器通常通过实现 HandlerInterceptor 接口来定义,该接口包含三个方法:
① preHandle:在处理器执行之前执行。如果返回 false,将跳过处理器和后续的拦截器。
② postHandle:在处理器执行之后,视图渲染之前执行。
③ afterCompletion:在视图渲染之后执行,不管处理器是否抛出异常。
@Component //spring托管拦截器 拦截器可能会调用控制层
public class MyInterceptor implements HandlerInterceptor {
/**
* 在处理器执行之前执行。如果返回 false,将跳过处理器和后续的拦截器。
* 可用于记录请求日志
* @param request
* @param response
* @param handler
* @return
* @throws Exception
*/
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("接受到请求");
return true;
}
/**
* 在处理器执行之后,视图渲染之前执行。
* @param request
* @param response
* @param handler
* @param modelAndView
* @throws Exception
*/
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("处理器执行完成");
}
/**
* 在视图渲染之后执行,不管处理器是否抛出异常。
* 可用于监控请求的处理时间
* @param request
* @param response
* @param handler
* @param ex
* @throws Exception
*/
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("请求完成");
}
}
3. 简单实例-实现请求日志
0. 导入日志依赖
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>1.2.3</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.3</version>
</dependency>
1. 创建/webapp/demo.html文件
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<h1>Hello world</h1>
</body>
</html>
2. 控制类
@Controller
public class WebController {
@RequestMapping("/demo")
public String test1() {
return "demo.html";
}
}
3. 配置类
@Configuration
@EnableWebMvc // 开启Spring MVC的注解驱动
@ComponentScan(basePackages = "com.huan.web") // 扫描Controller包
public class WebConfig implements WebMvcConfigurer {
/**
* 访问 webapp下的静态资源
* 配置默认的servlet处理器
* @param configurer
*/
@Override
public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
configurer.enable();
}
/**
* 添加拦截器
* @param registry
*/
@Override
public void addInterceptors(InterceptorRegistry registry) {
//将一个新的 MyInterceptor 实例添加到拦截器注册表中, 并指定拦截器的拦截路径为 "/**"
//"/**" 表示拦截所有路径。** 是一个通配符,表示任意数量的字符和子路径。
registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
}
}
4. 拦截器加入日志功能
//以下两个是日志需要导入的包
//import org.slf4j.Logger;
//import org.slf4j.LoggerFactory;
public class MyInterceptor implements HandlerInterceptor {
private static final Logger logger = LoggerFactory.getLogger(MyInterceptor.class);
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("接收到请求");
// logger.info("接收到一个请求:" + request.getRequestURI() + ", 请求方式为:"+request.getMethod() + ", 请求参数为:" + request.getQueryString());
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("处理器执行完成");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("请求完成");
}
}
5. 运行tomcat
访问demo:
控制台输出: