SpringMVC攔截器快速掌握上篇

2022-08-19 14:00:40

什麼是攔截器

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

(1)瀏覽器傳送一個請求會先到Tomcat的web伺服器

(2)Tomcat伺服器接收到請求以後，會去判斷請求的是靜態資源還是動態資源

(3)如果是靜態資源，會直接到Tomcat的專案部署目錄下去直接存取

(4)如果是動態資源，就需要交給專案的後臺程式碼進行處理

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

(6)然後進入到到中央處理器(SpringMVC中的內容)，SpringMVC會根據設定的規則進行攔截

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

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

(9)這個時候，如果我們需要在每個Controller方法執行的前後新增業務，具體該如何來實現?

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

攔截器（Interceptor）是一種動態攔截方法呼叫的機制，在SpringMVC中動態攔截控制器方法的執行

作用:

在指定的方法呼叫前後執行預先設定的程式碼
阻止原始方法的執行
總結：攔截器就是用來做增強

看完以後，大家會發現

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

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

歸屬不同：Filter(過濾器)屬於Servlet技術，Interceptor(攔截器)屬於SpringMVC技術
攔截內容不同：Filter對所有存取進行增強，Interceptor僅針對SpringMVC的存取進行增強

攔截器入門案例

環境準備

建立一個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>

建立對應的設定類

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{
}

建立模型類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'}";
    }
}

攔截器開發

步驟1:建立攔截器類

我們可以建立一個攔截器資料夾，命名為interceptor，這個資料夾我們可以把它放在controller資料夾中，因為攔截器本來就與表現層有關。然後我們再在攔截器資料夾中建立一個攔截器類ProjectInterceptor：

讓類實現HandlerInterceptor介面，重寫介面中的三個方法。

@Component
//定義攔截器類，實現HandlerInterceptor介面
//注意當前類必須受Spring容器控制
public class ProjectInterceptor implements HandlerInterceptor {
    @Override
    //原始方法呼叫前執行的內容
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle...");
        return true;
    }
    @Override
    //原始方法呼叫後執行的內容
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle...");
    }
    @Override
    //原始方法呼叫完成後執行的內容
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion...");
    }
}

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

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

步驟2:設定攔截器類

也就是設定你執行什麼樣的請求的時候你的攔截器會生效

設定攔截器的地方與我們前面設定頁面靜態資源放行的地方是一樣的。

在設定的時候我們要把攔截器給新增進去，這裡我們使用自動裝配進行注入。

@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傳送http://localhost/books

如果傳送http://localhost/books/100會發現攔截器沒有被執行，原因是攔截器的addPathPatterns方法設定的攔截路徑是/books,我們現在傳送的是/books/100，所以沒有匹配上，因此沒有攔截，攔截器就不會執行。

步驟5:修改攔截器攔截規則

@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，攔截器就會被執行。

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

簡化SpringMvcSupport的編寫

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

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