簡單總結(jié)SpringMVC攔截器的使用方法

更新時(shí)間：2021年06月28日 11:54:32 作者：紅旗下的小兵

今天給大家?guī)淼氖顷P(guān)于SpringMVC攔截器的相關(guān)知識(shí),文章圍繞著SpringMVC攔截器的使用方法展開,文中有非常詳細(xì)的介紹及代碼示例,需要的朋友可以參考下

SpringMVC攔截器

攔截器類似于Filter過濾器，它是springMVC特有的，它可以預(yù)處理和后處理，我們可以定義一些攔截器來實(shí)現(xiàn)特定的業(yè)務(wù)。

過濾器與攔截器本質(zhì)區(qū)別：

（1）攔截器時(shí)AOP思想的具體應(yīng)用（一個(gè)橫切面，直接切進(jìn)請(qǐng)求響應(yīng)中去）。

（2）攔截器時(shí)spring MVC特有的。

（3）攔截器只會(huì)攔截訪問控制器的方法，如果訪問靜態(tài)資源如：.jsp/html/css/image/js 時(shí)，它不會(huì)去攔截，而Filter過濾器無論什么都會(huì)去攔截。

自定義攔截器需要兩步：

第一步：編寫自定義類實(shí)現(xiàn) HandlerInterceptor 接口，且必須重寫方法；

第二步：在配置類中，注冊(cè)攔截器，實(shí)現(xiàn) WebMvcConfigurer接口，重寫對(duì)應(yīng)的方法；關(guān)于配置類我在這邊文章有記錄：http://www.dbjr.com.cn/article/204128.htm

（1）public boolean preHandle() {}

請(qǐng)求前處理的邏輯 - 前置。
方法返回值：返回布爾值，返回true表示可以執(zhí)行后續(xù)代碼，返回false程序會(huì)終止。

（2）public void postHandle(）{}

請(qǐng)響應(yīng)前處理的邏輯 - 后置。
方法返回值：無返回值。

package com.lxc.springboot.interceptor;
 
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
 
@Component
public class MyInterceptor implements HandlerInterceptor {
    private static final Logger LOG = LoggerFactory.getLogger(LogInterceptor.class);
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        s
        // 攔截前的操作
        System.out.println("-----------前置攔截-----------");
        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 {
        // 可以做一些清理工作
    }
}

注冊(cè)攔截器：

package com.lxc.springboot.config;
 
 
import com.lxc.springboot.intercetor.MyInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
import javax.annotation.Resource;
 
/**
 * @擴(kuò)展springMVC
 * 第一步：
 * @Configuration 注解的作用：讓這個(gè)類變?yōu)榕渲妙?
 * 第二步：
 * 必須實(shí)現(xiàn) WebMvcConfigurer 接口
 */
@Configuration
public class SpringMvcConfig implements WebMvcConfigurer {
    @Resource
    private MyInterceptor myInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // addInterceptor()：注冊(cè)攔截器，參數(shù)是一個(gè)攔截器
        // addPathPatterns(): 路徑映射，哪些路徑需要被攔截，/** 全部攔截
        // excludePathPatterns(): 排除哪些路徑，不會(huì)被攔截
        registry.addInterceptor(myInterceptor)
                .addPathPatterns("/**")
                .excludePathPatterns("/login");
    }
}

小例子

跟Filter一樣，記錄接口的請(qǐng)求響應(yīng)耗時(shí)：

package com.lxc.springboot.interceptor;
 
 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
 
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
/**
 * 這個(gè)是攔截器，與過濾器區(qū)別：
 *
 * 【【【【特別注意：增加攔截器，還需要在config中增加一個(gè)配置類！配置】】】】
 *
 * （1）攔截器是spring特有的，經(jīng)常用于登錄校驗(yàn)、權(quán)限驗(yàn)證、請(qǐng)求打印日志等等。
 * （2）攔截器不需要你手動(dòng)調(diào)用后續(xù)代碼執(zhí)行，它是有兩個(gè)方法的，且分開的，一個(gè)前，一個(gè)后
 * （3）而過濾器，我們會(huì)在打印日志的中間，使用filterChain.doFilter()方法去調(diào)用后續(xù)代碼執(zhí)行的！
 * （4）攔截器的 preHandle 前置處理方法，必須返回true，否則后續(xù)邏輯不會(huì)執(zhí)行，整個(gè)業(yè)務(wù)也會(huì)結(jié)束！
 */
@Component // 增加這個(gè)注解，讓spring能掃描到這個(gè)類
public class LogInterceptor implements HandlerInterceptor {
    private static final Logger LOG = LoggerFactory.getLogger(LogInterceptor.class);
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        LOG.info("【全局?jǐn)r截器】");
        LOG.info("*********** InterceptorLog日志開始 *********** ");
        LOG.info("* 請(qǐng)求地址: {}, 方法: {}", request.getRequestURL().toString(), request.getMethod());
        LOG.info("* 遠(yuǎn)程地址: {}, 域名: {}, 端口: {}", request.getRemoteAddr(), request.getRemoteHost(), request.getRemotePort());
        long startTime = System.currentTimeMillis();
        request.setAttribute("boot-responseTime", startTime);
        return true;
    }
 
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // request.getAttribute("boot-responseTime") 返回的是Object
        long startTimed = (long) request.getAttribute("boot-responseTime");
        LOG.info(" *********** InterceptorLog 結(jié)束，耗時(shí): {} ms *********** ", System.currentTimeMillis() - startTimed);
    }
}

在配置類中注冊(cè)攔截器：

package com.lxc.springboot.config;
 
import com.lxc.springboot.intercetor.LogInterceptor;
import com.lxc.springboot.intercetor.MyInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
import javax.annotation.Resource;
 
@Configuration
public class SpringMvcConfig implements WebMvcConfigurer {
    @Resource
    private MyInterceptor myInterceptor;
    @Resource
    private LogInterceptor logInterceptor;
    
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(logInterceptor)
                .addPathPatterns("/**")
                .excludePathPatterns("/login");
    }
    
}

測試：