preHandle

调用时间:Controller方法处理之前

执行顺序:链式Intercepter情况下,Intercepter按照声明的顺序一个接一个执行

若返回false,则中断执行,注意:不会进入afterCompletion

顾名思义,该方法将在请求处理之前进行调用。SpringMVC中的Interceptor是链式的调用的,在一个应用中或者是在一个请求中可以同时存在多个Interceptor。每个Interceptor的调用会依据它的声明顺序依次执行,而且最先执行的都是Interceptor中的preHandle 方法,所以可以在这个方法中进行一些前置初始化操作或者是对当前请求的一个预处理,也可以在这个方法中进行一些判断来决定请求是否要继续进行下去。该方法的返回值是Boolean类型的,当它返回为false时,表示请求结束,后续的Interceptor和Controller都不会再执行;当返回值为true 时就会继续调用下一个Interceptor的preHandle方法,如果已经是最后一个Interceptor的时候就会是调用当前请求的Controller 方法。

postHandle

调用前提:preHandle返回true

调用时间:Controller方法处理完之后,DispatcherServlet进行视图的渲染之前,也就是说在这个方法中你可以对ModelAndView进行操作

执行顺序:链式Intercepter情况下,Intercepter按照声明的顺序倒着执行。

备注:postHandle虽然post打头,但post、get方法都能处理

由preHandle方法的解释我们知道这个方法包括后面要说到的afterCompletion和postHandle方法都只能是在当前所属的Interceptor的preHandle方法的返回值为true时才能被调用。postHandle方法,顾名思义就是在当前请求进行处理之后,也就是Controller方法调用之后执行,但是它会在DispatcherServlet进行视图返回渲染之前被调用,所以我们可以在这个方法中对Controller处理之后的ModelAndView对象进行操作。postHandle方法被调用的方向跟preHandle是相反的,也就是说先声明的Interceptor的postHandle方法反而会后执行。

afterCompletion

调用前提:preHandle返回true

调用时间:DispatcherServlet进行视图的渲染之后

多用于清理资源

该方法也是需要当前对应的Interceptor的preHandle方法的返回值为true时才会执行。顾名思义,该方法将在整个请求结束之后,也就是在DispatcherServlet 渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。

项目测试代码

TokenInterceptor.class

package com.orm.mybatis.token.interceptor;

import com.alibaba.fastjson.JSON;
import com.orm.mybatis.token.annotation.PassToken;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Method;
import java.util.HashMap;

/**
 * 添加拦截器
 */
@Component
public class TokenInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) 
    throws Exception {
        System.out.println("preHandle");
        //如果不是映射到方法直接放行
        if(!(handler instanceof HandlerMethod)){
            return true;
        }
        HandlerMethod handlerMethod = (HandlerMethod)handler;
        Method method = handlerMethod.getMethod();
        if (method.isAnnotationPresent(PassToken.class)) { //方法上面是否有注解?
            PassToken passToken = method.getAnnotation(PassToken.class);
            if (passToken.value()){
                return true;
            }else {
                HashMap<String,String> hashMap = new HashMap<String,String>();
                hashMap.put("passTokenFalse","passTokenFalse");
                String resultJson = JSON.toJSONString(hashMap);
                response.setContentType("application/json;charset=utf-8");
                response.getWriter().print(resultJson);
                return false;
            }
        }
        HashMap<String,String> hashMap = new HashMap<String,String>();
        hashMap.put("noPass","noPass");
        String resultJson = JSON.toJSONString(hashMap);
        response.setContentType("application/json;charset=utf-8");
        response.getWriter().print(resultJson);
        return false;
    }

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

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

PassToken.class

package com.orm.mybatis.token.annotation;

import java.lang.annotation.*;

@Documented
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface PassToken {
    boolean value() default true;
}

TestLoginController.class

package com.orm.mybatis.token.controller;

import com.orm.mybatis.token.annotation.PassToken;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;

@RestController
public class TestLoginController {

    @GetMapping("/test/one")
    public HashMap<String,String> login(){
      HashMap<String,String> hashMap = new HashMap<>();
      hashMap.put("one","one");
      return hashMap;
    }

    @PassToken
    @GetMapping("/test/two")
    public HashMap<String,String> login1(){
        HashMap<String,String> hashMap = new HashMap<>();
        hashMap.put("two","two");
        return hashMap;
    }

    @PassToken(value = false)
    @GetMapping("/test/three")
    public HashMap<String,String> login2(){
        HashMap<String,String> hashMap = new HashMap<>();
        hashMap.put("three","three");
        return hashMap;
    }
}

项目测试

http://127.0.0.1:8080/test/one
在这里插入图片描述
后台反馈
在这里插入图片描述
结果:由preHandle方法的解释我们知道这个方法包括后面要说到的afterCompletion和postHandle方法都只能是在当前所属的Interceptor的preHandle方法的返回值为true时才能被调用。所以没有调用。


http://127.0.0.1:8080/test/two
在这里插入图片描述
后台反馈
在这里插入图片描述
结果:由preHandle方法的解释我们知道这个方法包括后面要说到的afterCompletion和postHandle方法都只能是在当前所属的Interceptor的preHandle方法的返回值为true时才能被调用。所以调用了。


http://127.0.0.1:8080/test/three

在这里插入图片描述
在这里插入图片描述
结果:由preHandle方法的解释我们知道这个方法包括后面要说到的afterCompletion和postHandle方法都只能是在当前所属的Interceptor的preHandle方法的返回值为true时才能被调用。没有调用。因为@PassToken(value = false),后台判断了value为false的话return false

Logo

旨在为数千万中国开发者提供一个无缝且高效的云端环境,以支持学习、使用和贡献开源项目。

更多推荐