一涡驮、概要

Spring Web MVC的攔截器暗甥，類似于Servlet開發(fā)中的過濾器Filter，用于對處理器進(jìn)行預(yù)處理和后處理捉捅。

二撤防、核心接口

攔截器

preHandle方法

進(jìn)入Handler方法之前執(zhí)行“艨冢可以用于身份認(rèn)證寄月、身份授權(quán)。比如如果認(rèn)證沒有通過表示用戶沒有登陸无牵，需要此方法攔截不再往下執(zhí)行（return false）漾肮，否則就放行（return true）。

postHandle方法

進(jìn)入Handler方法之后茎毁，返回ModelAndView之前執(zhí)行克懊。可以看到該方法中有個(gè)modelAndView的形參。應(yīng)用場景：從modelAndView出發(fā)：將公用的模型數(shù)據(jù)（比如菜單導(dǎo)航之類的）在這里傳到視圖，也可以在這里同一指定視圖艰猬。

afterCompletion方法

執(zhí)行Handler完成之后執(zhí)行珍语。應(yīng)用場景：統(tǒng)一異常處理，統(tǒng)一日志處理等。

攔截器適配器

spring提供了一個(gè)HandlerInterceptorAdapter適配器（一種適配器設(shè)計(jì)模式的實(shí)現(xiàn)），允許我們只實(shí)現(xiàn)需要的回調(diào)方法

三、使用步驟

第一步 創(chuàng)建一個(gè)類實(shí)現(xiàn) HandlerInterceptor

/**
 * 現(xiàn)在需要實(shí)現(xiàn)用戶登錄檢查——如果發(fā)現(xiàn)用戶沒有登錄扔亥，跳轉(zhuǎn)到登錄頁面场躯，登
 * 錄成功后跳轉(zhuǎn)回之前訪問的頁面。
 *
 * @author zhangwei
 */
@Component
@Slf4j
public class LoginInterceptor implements HandlerInterceptor {
    public static final String USER_SESSION_NAME = "username";
    /**
     * 作用
     * 預(yù)處理回調(diào)方法
     * 1> 如果方法返回true 表示繼續(xù)執(zhí)行下一個(gè)攔截器
     * 2> 如果方法返回false 請求處理流程中斷
     * 不會(huì)繼續(xù)調(diào)用其他的攔截器或處理器方法旅挤，此時(shí)需要通過response產(chǎn)生響應(yīng)
     *
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        Object attribute = request.getSession().getAttribute(USER_SESSION_NAME);
        log.debug("VerifyInterceptor====> preHandle方法執(zhí)行" );
        if (attribute != null) {
            return true;
        }
        response.sendRedirect("/account/login?next=" + request.getRequestURI());
        return false;
    }
    /**
     * 后處理回調(diào)方法踢关，
     * 實(shí)現(xiàn)處理器的后處理（但在渲染視圖之前），
     * 此時(shí)可以通過modelAndView對模型數(shù)據(jù)進(jìn)行處理或?qū)σ晥D進(jìn)行處理
     *
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.debug("VerifyInterceptor====> preHandle2方法執(zhí)行" );
    }
    /**
     * 整個(gè)請求處理完畢回調(diào)方法粘茄，即在視圖渲染完畢時(shí)調(diào)用
     *
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.debug("VerifyInterceptor====> afterCompletion 方法執(zhí)行" );
    }
}

第二步 控制器

@Controller
@RequestMapping("/account")
public class AccountController {
    @RequestMapping("/login")
    public String login(HttpServletRequest request) {
        request.getSession().setAttribute("username", "admin");
        return   "redirect:/";
    }
}

四签舞、注冊方式

一種通過java類注冊,另外一種通過xml注冊

java類注冊(spring-boot)

@Configuration
public class WebMvcConfigInterceptor implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 添加攔截器
        registry.addInterceptor(new VerifyInterceptor())
                    // 添加攔截的url地址
                .addPathPatterns("/**")
                    // 排除不攔截的url地址
                .excludePathPatterns("/login");
    }
}

xml注冊

攔截所有的url

<mvc:interceptors>
    <bean class="com.vip.mvc.interceptor.LoginInterceptor"/>
</mvc:interceptors>

攔截匹配的URL

<mvc:interceptors >
  <mvc:interceptor>
            <interceptor下面定義的mapping和exclude-mapping都是可以有多個(gè)的>
             <!-- /user/*  -->
        <mvc:mapping path="/admin/**" />
　　　　 <mvc:exclude-mapping path="/account/login" /><!-- 不攔截 -->
        <bean class="com.vip.mvc.interceptor.LoginInterceptor"></bean>
    </mvc:interceptor>
</mvc:interceptors>

注 攔截器語法

栗子

五、栗子

需求

1. 用戶請求url
2. 攔截器進(jìn)行攔截校驗(yàn)
   如果請求的url是公開地址（無需登陸即可訪問的url）柒瓣。
3. 如果用戶session不存在儒搭，則跳轉(zhuǎn)到登陸頁面。
4. 如果用戶session存在芙贫，跳轉(zhuǎn)相應(yīng)的界面搂鲫。

創(chuàng)建登錄攔截器

/**
 * 現(xiàn)在需要實(shí)現(xiàn)用戶登錄檢查——如果發(fā)現(xiàn)用戶沒有登錄，跳轉(zhuǎn)到登錄頁面磺平，登
 * 錄成功后跳轉(zhuǎn)回之前訪問的頁面魂仍。
 *
 * @author zhangwei
 */
@Component
@Slf4j
public class LoginInterceptor implements HandlerInterceptor {
    public static final String USER_SESSION_NAME = "username";
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        Object attribute = request.getSession().getAttribute(USER_SESSION_NAME);
        log.debug("VerifyInterceptor====> preHandle方法執(zhí)行" );
        if (attribute != null) {
            return true;
        }
        response.sendRedirect("/account/login?next=" + request.getRequestURI());
        return false;
    }
}

創(chuàng)建登錄控制器

@Controller
@RequestMapping("/account")
public class AccountController {
    @RequestMapping("/login")
    public String login(HttpServletRequest request) {
        request.getSession().setAttribute("name", "admin");
        // 重定向
        return "redirect:/";
    }
}

注冊攔截器

<mvc:interceptors>
  <mvc:interceptor>
    <mvc:mapping path="/"/>
    <mvc:exclude-mapping path="/account/login"/>
    <bean class="com.vip.mvc.interceptor.LoginInterceptor"/>
  </mvc:interceptor>
</mvc:interceptors>

性能檢測案例

@Component
@Slf4j
public class PerformanceInterceptor extends HandlerInterceptorAdapter {
    ThreadLocal<Long> threadLocal = new ThreadLocal<>();
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //1、開始時(shí)間
        long beginTime = System.currentTimeMillis();
        threadLocal.set(beginTime);
        return true;
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        //2拣挪、結(jié)束時(shí)間
        long endTime = System.currentTimeMillis();
        //3擦酌、消耗的時(shí)間
        long consumeTime = endTime - threadLocal.get();
        // 此處認(rèn)為處理時(shí)間超過300毫秒的請求為慢請求
        if (consumeTime > 300) {
            log.error("請求url:{} 執(zhí)行時(shí)間:{}" , request.getRequestURI(),consumeTime);
        }
    }
}

<mvc:interceptors>
  <mvc:interceptor>
    <mvc:mapping path="/**"/>
    <bean class="com.vip.mvc.interceptor.PerformanceInterceptor"/>
  </mvc:interceptor>
</mvc:interceptors>

六、區(qū)別

1媒吗、過濾器：

• 依賴于servlet容器仑氛；
• 在實(shí)現(xiàn)上基于函數(shù)回調(diào)，可以對幾乎所有請求進(jìn)行過濾闸英；
• 缺點(diǎn)是一個(gè)過濾器實(shí)例只能在容器初始化時(shí)調(diào)用一次；
• 使用過濾器的目的是用來做一些過濾操作介袜，獲取我們想要獲取的數(shù)據(jù)甫何，比如：在過濾器中修改字符編碼；在過濾器中修改HttpServletRequest的一些參數(shù)遇伞，包括：過濾低俗文字辙喂、危險(xiǎn)字符等。

2鸠珠、攔截器：

• 依賴于web框架巍耗，在SpringMVC中就是依賴于SpringMVC框架；
• 在實(shí)現(xiàn)上基于Java的反射機(jī)制渐排，屬于面向切面編程（AOP）的一種運(yùn)用炬太；
• 缺點(diǎn)是只能對controller請求進(jìn)行攔截，對其他的一些比如直接訪問靜態(tài)資源的請求則沒辦法進(jìn)行攔截處理驯耻；
• 由于攔截器是基于web框架的調(diào)用亲族，因此可以使用Spring的依賴注入（DI）進(jìn)行一些業(yè)務(wù)操作炒考，同時(shí)一個(gè)攔截器實(shí)例在一個(gè)controller生命周期之內(nèi)可以多次調(diào)用。