SpringMVC攔截器快速掌握上篇
什么是攔截器
講解攔截器的概念之前，我們先看一張圖:
(1)瀏覽器發(fā)送一個(gè)請(qǐng)求會(huì)先到Tomcat的web服務(wù)器
(2)Tomcat服務(wù)器接收到請(qǐng)求以后，會(huì)去判斷請(qǐng)求的是靜態(tài)資源還是動(dòng)態(tài)資源
(3)如果是靜態(tài)資源，會(huì)直接到Tomcat的項(xiàng)目部署目錄下去直接訪問
(4)如果是動(dòng)態(tài)資源，就需要交給項(xiàng)目的后臺(tái)代碼進(jìn)行處理
(5)在找到具體的方法之前，我們可以去配置過濾器(可以配置多個(gè))，按照順序進(jìn)行執(zhí)行
(6)然后進(jìn)入到到中央處理器(SpringMVC中的內(nèi)容)，SpringMVC會(huì)根據(jù)配置的規(guī)則進(jìn)行攔截
(7)如果滿足規(guī)則，則進(jìn)行處理，找到其對(duì)應(yīng)的controller類中的方法進(jìn)行執(zhí)行,完成后返回結(jié)果
(8)如果不滿足規(guī)則，則不進(jìn)行處理
(9)這個(gè)時(shí)候，如果我們需要在每個(gè)Controller方法執(zhí)行的前后添加業(yè)務(wù)，具體該如何來(lái)實(shí)現(xiàn)?
這個(gè)就是攔截器要做的事。
攔截器（Interceptor）是一種動(dòng)態(tài)攔截方法調(diào)用的機(jī)制，在SpringMVC中動(dòng)態(tài)攔截控制器方法的執(zhí)行
作用:
- 在指定的方法調(diào)用前后執(zhí)行預(yù)先設(shè)定的代碼
- 阻止原始方法的執(zhí)行
- 總結(jié)：攔截器就是用來(lái)做增強(qiáng)
看完以后，大家會(huì)發(fā)現(xiàn)
- 攔截器和過濾器在作用和執(zhí)行順序上也很相似
所以這個(gè)時(shí)候，就有一個(gè)問題需要思考:攔截器和過濾器之間的區(qū)別是什么?
- 歸屬不同：Filter(過濾器)屬于Servlet技術(shù)，Interceptor(攔截器)屬于SpringMVC技術(shù)
- 攔截內(nèi)容不同：Filter對(duì)所有訪問進(jìn)行增強(qiáng)，Interceptor僅針對(duì)SpringMVC的訪問進(jìn)行增強(qiáng)
攔截器入門案例
環(huán)境準(zhǔn)備
創(chuàng)建一個(gè)Web的Maven項(xiàng)目
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)建對(duì)應(yī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 + '\'' +
", 價(jià)格=" + 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)建一個(gè)攔截器文件夾，命名為interceptor，這個(gè)文件夾我們可以把它放在controller文件夾中，因?yàn)閿r截器本來(lái)就與表現(xiàn)層有關(guān)。然后我們?cè)僭跀r截器文件夾中創(chuàng)建一個(gè)攔截器類ProjectInterceptor：
讓類實(shí)現(xiàn)HandlerInterceptor接口，重寫接口中的三個(gè)方法。
@Component
//定義攔截器類，實(shí)現(xiàn)HandlerInterceptor接口
//注意當(dāng)前類必須受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,則代表放行，會(huì)執(zhí)行原始Controller類中要請(qǐng)求的方法，如果返回false，則代表攔截，后面的就不會(huì)再執(zhí)行了（你的原始方法也不會(huì)執(zhí)行）。
步驟2:配置攔截器類
也就是配置你執(zhí)行什么樣的請(qǐng)求的時(shí)候你的攔截器會(huì)生效
配置攔截器的地方與我們前面配置頁(yè)面靜態(tài)資源放行的地方是一樣的。
在配置的時(shí)候我們要把攔截器給添加進(jìn)去，這里我們使用自動(dòng)裝配進(jìn)行注入。
@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后面那一級(jí)開始配置的
同時(shí)我們也可以配置多個(gè)：
//配置攔截器 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:運(yùn)行程序測(cè)試
使用PostMan發(fā)送http://localhost/books
如果發(fā)送http://localhost/books/100會(huì)發(fā)現(xiàn)攔截器沒有被執(zhí)行，原因是攔截器的addPathPatterns方法配置的攔截路徑是/books,我們現(xiàn)在發(fā)送的是/books/100，所以沒有匹配上，因此沒有攔截，攔截器就不會(huì)執(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/*" );
}
}這個(gè)時(shí)候，如果再次訪問http://localhost/books/100，攔截器就會(huì)被執(zhí)行。
最后說一件事，就是攔截器中的preHandler方法，如果返回true,則代表放行，會(huì)執(zhí)行原始Controller類中要請(qǐng)求的方法，如果返回false，則代表攔截，后面的就不會(huì)再執(zhí)行了。
簡(jiǎn)化SpringMvcSupport的編寫
@Configuration
@ComponentScan({"com.nefu.controller"})
@EnableWebMvc
//實(shí)現(xiàn)WebMvcConfigurer接口可以簡(jiǎn)化開發(fā)，但具有一定的侵入性
public class SpringMvcConfig implements WebMvcConfigurer {
@Autowired
private ProjectInterceptor projectInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
//配置多攔截器
registry.addInterceptor(projectInterceptor).addPathPatterns("/books","/books/*");
}
}此后咱們就不用再寫SpringMvcSupport類了。
總結(jié)
最后我們來(lái)看下攔截器的執(zhí)行流程:
當(dāng)有攔截器后，請(qǐng)求會(huì)先進(jìn)入preHandle方法，
? 如果方法返回true，則放行繼續(xù)執(zhí)行后面的handle[controller的方法]和后面的方法
? 如果返回false，則直接跳過后面方法的執(zhí)行。
到此這篇關(guān)于SpringMVC攔截器快速掌握上篇的文章就介紹到這了,更多相關(guān)SpringMVC攔截器內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
如何基于Java實(shí)現(xiàn)對(duì)象List排序
Spring boot使用spring retry重試機(jī)制的方法示例
LeetCode程序員面試題之無(wú)重復(fù)字符的最長(zhǎng)子串
java實(shí)現(xiàn)表格數(shù)據(jù)的存儲(chǔ)