SpringMVC攔截器建立設定及執行順序

2022-05-28 18:01:51

SpringMVC攔截器介紹

springMVC 中的攔截器用於攔截控制器方法的執行。

先建立出前置需要的一些條件：

<a th:href="@{/testInterceptor}" rel="external nofollow" >測試攔截器</a>

後端：

@Controller
public class TestController {
    @RequestMapping("/testInterceptor")
    public String testInterceptor() {
        return "success";
    }
}

一、建立攔截器

新建一個包 interceptors，在下面建立一個攔截器 FirstInterceptor ，並且要實現 HandlerInterceptor 介面。

快捷鍵Ctrl + O，快速重寫方法，圖示裡的 3 個。

public class FirstInterceptor implements HandlerInterceptor {
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("FirstInterceptor --> preHandle");
        return false;
    }
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("FirstInterceptor --> postHandle");
    }
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("FirstInterceptor --> afterCompletion");
    }
}

preHandle: 在當前控制器方法執行之前執行。

postHandle: 在當前控制器方法執行之後執行。

afterCompletion：處理完檢視和模型資料，渲染檢視完畢之後執行。

二、設定攔截器

在 springMVC 組態檔裡設定攔截器，物件就是FirstInterceptor 類:

<!-- 設定攔截器 -->
  <mvc:interceptors>
      <bean class="com.pingguo.mvc.interceptors.FirstInterceptor"></bean>
  </mvc:interceptors>

重新部署，存取http://localhost:8080/springmvc/，發現頁面空白，檢視控制器紀錄檔看到有列印：

說明攔截成功。

看下上面重新的三個方法中，只有preHandle有返回值，是個布林型別：false 表示攔截，true 表示放行。

修改上面preHandle的返回為 true，重新部署後再次存取首頁，可以存取成功。

檢視控制檯列印輸出，看到在渲染之前，前面2個方法執行了：preHandle、postHandle 。

在非常多的 Thymeleaf 渲染之後，最後一個 afterCompletion 也執行了。

現在繼續點選首頁裡的新加的超連結，發現也會被攔截放行。

說明這種設定方式，會攔截所有的請求。

設定不需要攔截的請求

可以通過 ref 或 bean 標籤設定攔截器:

通過mvc:mapping設定需要攔截的請求通過
mvc:exclude-mapping設定需要排除的請求

<bean name="firstInterceptor" class="com.pingguo.mvc.interceptors.FirstInterceptor"></bean>
    <!-- 設定攔截器 -->
    <mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <mvc:exclude-mapping path="/"></mvc:exclude-mapping>
            <ref bean="firstInterceptor"></ref>
        </mvc:interceptor>
    </mvc:interceptors>

注意這裡我在外部註冊了一個 bean 叫 firstInterceptor，以便 ref 參照。

<mvc:mapping path="/**"/>，表示攔截所有請求。
<mvc:exclude-mapping path="/">，表示除了首頁不攔截。

也就是說，現在我存取http://localhost:8080/springmvc/的時候，應該不攔截。

存取http://localhost:8080/springmvc/testInterceptor就會攔截了。

試一下，先存取 http://localhost:8080/springmvc/：

可以正常開啟首頁，並且控制檯也沒有輸出攔截器裡的內容：

現在繼續存取 http://localhost:8080/springmvc/testInterceptor，

攔截了。

三、多個攔截器的執行順序

繼續新建一個攔截器SecondInterceptor，注意這次我加了 @Component，方便在組態檔中直接ref參照使用。

@Component
public class SecondInterceptor implements HandlerInterceptor {
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("SecondInterceptor --> preHandle");
        return true;
    }
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("SecondInterceptor --> postHandle");
    }
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("SecondInterceptor --> afterCompletion");
    }
}

修改攔截器設定：

<!-- 設定攔截器 -->
    <mvc:interceptors>
        <ref bean="firstInterceptor"></ref>
        <ref bean="secondInterceptor"></ref>
    </mvc:interceptors>

重新部署，存取下首頁http://localhost:8080/springmvc/，檢視控制檯列印輸出。