Spring MVC的拦截器

前言

       当请求到达DispatcherServlet时，它会根据HandlerMapping的机制找到处理器，这样就会返回一个HandlerExecutionChain对象，这个对象包含处理器和拦截器。这里的拦截器会对处理器进行拦截，这样通过拦截器就可以增强处理器的功能。

一、HandlerInterceptor源码分析

在Spring MVC中，所有的拦截器都是通过实现HandlerInterceptor接口来实现的，下面让我们来看下它的源码。

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package org.springframework.web.servlet;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.lang.Nullable;

public interface HandlerInterceptor {
    default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return true;
    }

    default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
    }

    default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
    }
}

 

•  preHandle方法：顾名思义，该方法在Controller处理之前进行调用。SpringMVC中的Interceptor拦截器是链式的，可以同时存在多个Interceptor。SpringMVC会根据声明的前后顺序一个接一个的执行（preHandle方法是先注册先执行），而且所有的Interceptor中的preHandle方法都会在Controller方法调用之前调用。SpringMVC的这种Interceptor链式结构也是可以进行中断的，这种中断方式是令preHandle的返回值为false，当preHandle的返回值为false的时候整个请求就结束了。
• postHandle方法：只会在当前这个Interceptor的preHandle方法返回值为true的时候才会执行。postHandle是进行处理器拦截用的，它的执行时间是在处理器进行处理之后，也就是在Controller的方法调用之后执行，但是它会在DispatcherServlet进行视图的渲染之前执行，也就是说在这个方法中你可以对ModelAndView进行操作。这个方法的链式结构跟正常访问的方向是相反的，也就是说先声明的Interceptor拦截器该方法反而会后调用（postHandle方法是先注册后执行）。
• afterCompletion方法：需要当前对应的Interceptor的preHandle方法的返回值为true时才会执行。该方法将在整个请求完成之后，也就是DispatcherServlet渲染了视图之后执行，这个方法的主要作用是用于清理资源的。  

上面详细解释了拦截器各个方法的作用与执行的顺序，即下图所示：

 拦截器执行过程如下：

• 执行preHandle方法，该方法会返回一个布尔值。如果为false，则结束所有流程；如果为true，则执行下一步。
• 执行处理器逻辑，它包含控制器的功能。
• 执行postHandler方法。
• 执行视图解析和视图渲染。
• 执行afterCompletion方法。

二、自定义拦截器

1、实现HandlerInterceptor接口

package com.scb.springbootdemo.interceptor;


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

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

public class MyInterceptor implements HandlerInterceptor {

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion");
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle");
    }

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle");
        return true;
    }
}

2、注册拦截器

package com.scb.springbootdemo.config;

import com.scb.springbootdemo.interceptor.MyInterceptor;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.config.annotation.InterceptorRegistration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Component
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        InterceptorRegistration ir=registry.addInterceptor(new MyInterceptor());
        ir.addPathPatterns("/interceptor/*");
    }
}

3、拦截控制器

package com.scb.springbootdemo.controller;

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

@RestController
@RequestMapping("/interceptor")
public class InterceptorController {
    @GetMapping("/test")
    public String test(){
        System.out.println("controller");
        return "interceptor";
    }
}

4、interceptor.jsp视图

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %>
<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html;  charset=UTF-8">
    <title>title</title>
</head>
<body>
<h1>
    <%
        System.out.println("view");
        out.print("view");
    %>
</h1>
</body>
</html>

5、运行结果

从运行结果也可以看出拦截器的执行流程。（这里应该输出view的，但是不知道为啥没有输出）