SpringMVC攔截器快速掌握上篇

更新時間：2022年08月19日 11:36:43 作者：十八歲討厭編程

攔截器（Interceptor）是一種動態(tài)攔截方法調(diào)用的機制，在SpringMVC中動態(tài)攔截控制器方法的執(zhí)行。本文將詳細講講SpringMVC中攔截器的概念及入門案例，感興趣的可以嘗試一下

什么是攔截器

講解攔截器的概念之前，我們先看一張圖:

(1)瀏覽器發(fā)送一個請求會先到Tomcat的web服務器

(2)Tomcat服務器接收到請求以后，會去判斷請求的是靜態(tài)資源還是動態(tài)資源

(3)如果是靜態(tài)資源，會直接到Tomcat的項目部署目錄下去直接訪問

(4)如果是動態(tài)資源，就需要交給項目的后臺代碼進行處理

(5)在找到具體的方法之前，我們可以去配置過濾器(可以配置多個)，按照順序進行執(zhí)行

(6)然后進入到到中央處理器(SpringMVC中的內(nèi)容)，SpringMVC會根據(jù)配置的規(guī)則進行攔截

(7)如果滿足規(guī)則，則進行處理，找到其對應的controller類中的方法進行執(zhí)行,完成后返回結果

(8)如果不滿足規(guī)則，則不進行處理

(9)這個時候，如果我們需要在每個Controller方法執(zhí)行的前后添加業(yè)務，具體該如何來實現(xiàn)?

這個就是攔截器要做的事。

攔截器（Interceptor）是一種動態(tài)攔截方法調(diào)用的機制，在SpringMVC中動態(tài)攔截控制器方法的執(zhí)行

作用:

在指定的方法調(diào)用前后執(zhí)行預先設定的代碼
阻止原始方法的執(zhí)行
總結：攔截器就是用來做增強

看完以后，大家會發(fā)現(xiàn)

攔截器和過濾器在作用和執(zhí)行順序上也很相似

所以這個時候，就有一個問題需要思考:攔截器和過濾器之間的區(qū)別是什么?

歸屬不同：Filter(過濾器)屬于Servlet技術，Interceptor(攔截器)屬于SpringMVC技術
攔截內(nèi)容不同：Filter對所有訪問進行增強，Interceptor僅針對SpringMVC的訪問進行增強

攔截器入門案例

環(huán)境準備

創(chuàng)建一個Web的Maven項目

pom.xml添加SSM整合所需jar包

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.nefu</groupId>
  <artifactId>springmvc_try</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>war</packaging>
  <dependencies>
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>3.1.0</version>
      <scope>provided</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>5.2.10.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-databind</artifactId>
      <version>2.9.0</version>
    </dependency>
  </dependencies>
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.tomcat.maven</groupId>
        <artifactId>tomcat7-maven-plugin</artifactId>
        <version>2.1</version>
        <configuration>
          <port>80</port>
          <path>/</path>
        </configuration>
      </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <source>8</source>
                <target>8</target>
            </configuration>
        </plugin>
    </plugins>
  </build>
</project>

創(chuàng)建對應的配置類

public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
    protected Class<?>[] getRootConfigClasses() {
        return new Class[0];
    }
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvcConfig.class};
    }
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
    //亂碼處理
    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter filter = new CharacterEncodingFilter();
        filter.setEncoding("UTF-8");
        return new Filter[]{filter};
    }
}
@Configuration
@ComponentScan({"com.nefu.controller"})
@EnableWebMvc
public class SpringMvcConfig{
}

創(chuàng)建模型類Book

public class Book {
    private String name;
    private double price;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public double getPrice() {
        return price;
    }
    public void setPrice(double price) {
        this.price = price;
    }
    @Override
    public String toString() {
        return "Book{" +
                "書名='" + name + '\'' +
                ", 價格=" + price +
                '}';
    }
}

編寫Controller

@RestController
@RequestMapping("/books")
public class BookController {
    @PostMapping
    public String save(@RequestBody Book book){
        System.out.println("book save..." + book);
        return "{'module':'book save'}";
    }
    @DeleteMapping("/{id}")
    public String delete(@PathVariable Integer id){
        System.out.println("book delete..." + id);
        return "{'module':'book delete'}";
    }
    @PutMapping
    public String update(@RequestBody Book book){
        System.out.println("book update..."+book);
        return "{'module':'book update'}";
    }
    @GetMapping("/{id}")
    public String getById(@PathVariable Integer id){
        System.out.println("book getById..."+id);
        return "{'module':'book getById'}";
    }
    @GetMapping
    public String getAll(){
        System.out.println("book getAll...");
        return "{'module':'book getAll'}";
    }
}

攔截器開發(fā)

步驟1:創(chuàng)建攔截器類

我們可以創(chuàng)建一個攔截器文件夾，命名為interceptor，這個文件夾我們可以把它放在controller文件夾中，因為攔截器本來就與表現(xiàn)層有關。然后我們再在攔截器文件夾中創(chuàng)建一個攔截器類ProjectInterceptor：

讓類實現(xiàn)HandlerInterceptor接口，重寫接口中的三個方法。

@Component
//定義攔截器類，實現(xiàn)HandlerInterceptor接口
//注意當前類必須受Spring容器控制
public class ProjectInterceptor implements HandlerInterceptor {
    @Override
    //原始方法調(diào)用前執(zhí)行的內(nèi)容
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle...");
        return true;
    }
    @Override
    //原始方法調(diào)用后執(zhí)行的內(nèi)容
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle...");
    }
    @Override
    //原始方法調(diào)用完成后執(zhí)行的內(nèi)容
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion...");
    }
}

注意：攔截器類要被SpringMVC容器掃描到。

攔截器中的preHandler方法，如果返回true,則代表放行，會執(zhí)行原始Controller類中要請求的方法，如果返回false，則代表攔截，后面的就不會再執(zhí)行了（你的原始方法也不會執(zhí)行）。

步驟2:配置攔截器類

也就是配置你執(zhí)行什么樣的請求的時候你的攔截器會生效

配置攔截器的地方與我們前面配置頁面靜態(tài)資源放行的地方是一樣的。

在配置的時候我們要把攔截器給添加進去，這里我們使用自動裝配進行注入。

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
    @Autowired
    private ProjectInterceptor projectInterceptor;
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
    }
    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        //配置攔截器
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books" );
    }
}

注意：

//配置攔截器
 registry.addInterceptor(projectInterceptor).addPathPatterns("/books" );

如果向上面這樣配置攔截器，那么你訪問：

localhost/books/100

這樣攔截器是不能生效的，你需要修改攔截器的配置：

//配置攔截器
 registry.addInterceptor(projectInterceptor).addPathPatterns("/books/*" );

也就是說他是從localhost后面那一級開始配置的

同時我們也可以配置多個：

//配置攔截器 registry.addInterceptor(projectInterceptor).addPathPatterns("/books/*" ,"/books" );//配置攔截器
 registry.addInterceptor(projectInterceptor).addPathPatterns("/books/*" ,"/books" );

步驟3:SpringMVC添加SpringMvcSupport包掃描

@Configuration
@ComponentScan({"com.nefu.controller","com.nefu.config"})
@EnableWebMvc
public class SpringMvcConfig{
}

步驟4:運行程序測試

使用PostMan發(fā)送http://localhost/books

如果發(fā)送http://localhost/books/100會發(fā)現(xiàn)攔截器沒有被執(zhí)行，原因是攔截器的addPathPatterns方法配置的攔截路徑是/books,我們現(xiàn)在發(fā)送的是/books/100，所以沒有匹配上，因此沒有攔截，攔截器就不會執(zhí)行。

步驟5:修改攔截器攔截規(guī)則

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
    @Autowired
    private ProjectInterceptor projectInterceptor;
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
    }
    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        //配置攔截器
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books","/books/*" );
    }
}

這個時候，如果再次訪問http://localhost/books/100，攔截器就會被執(zhí)行。

最后說一件事，就是攔截器中的preHandler方法，如果返回true,則代表放行，會執(zhí)行原始Controller類中要請求的方法，如果返回false，則代表攔截，后面的就不會再執(zhí)行了。

簡化SpringMvcSupport的編寫

@Configuration
@ComponentScan({"com.nefu.controller"})
@EnableWebMvc
//實現(xiàn)WebMvcConfigurer接口可以簡化開發(fā)，但具有一定的侵入性
public class SpringMvcConfig implements WebMvcConfigurer {
    @Autowired
    private ProjectInterceptor projectInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //配置多攔截器
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books","/books/*");
    }
}

此后咱們就不用再寫SpringMvcSupport類了。