SpringMVC | 拦截器

简介: SpringMVC | 拦截器

37a95c61322b4079a6d11d3e45da04a1.png

一、拦截器简介


1.1 概念


在学习SpringMVC之前,我们学习过一个和拦截器很像的技术——过滤器Filter,过滤器属于Servlet技术,Filter对所有内容进行过滤。而拦截器Interceptor属于SpringMVC技术,仅针对SpringMVC的访问进行拦截。


9f576e56cf5247f8b72b31b13f007c3e.png

1.2 作用


(1)在指定的方法调用前执行预先设定的代码(类似于AOP的事前通知@Before)

(2)阻止原控制方法的执行


二、拦截器入门案例


2.1 入门案例制作


(1)在controller下新建拦截器包和拦截器类,实现HandlerInterceptor接口并覆盖3个方法。


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 ...");
    }
}


暂时先分别打印一句话,主要目的是查看拦截器的执行流程。

(2)使用@Component注解将这个类交给SpringMVC管理


140f7548b149457ca49481baf34e79b3.png


(3)编写SpringMvcSupport类,并重写拦截器方法


/**
 * 资源拦截器
 */
@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
    @Autowired
    private ProjectInterceptor interceptor;
    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(interceptor).addPathPatterns("/books"); // 3.注入拦截器对象并设置当URL含有/books时执行拦截
    }
}


(4)在SpringMVC配置类中扫描controller包


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

(5)重启服务器,使用Postman测试并查看BookController执行结果。


@RestController
@RequestMapping("/books")
public class BookController {
    /**
     * 通过书名模糊查询书籍
     *
     * @param bookName
     * @return
     */
    @GetMapping("/{bookName}")
    public List<Book> selectByBookName(@PathVariable String bookName) {
        System.out.println("bookName is " + bookName);
        List<Book> books = new ArrayList<>();
        return books;
    }
    /**
     * 查询所有书籍
     * @return
     */
    @GetMapping
    public List<Book> selectAll() {
        System.out.println("book select all...");
        Book book = new Book(1,"计算机","SpringMVC入门教程","小试牛刀");
        Book book1 = new Book(2,"计算机","SpringMVC实战教程","一代宗师");
        List<Book> books = new ArrayList<>();
        books.add(book);
        books.add(book1);
        return books;
    }
    /**
     * 添加书籍
     *
     * @param book
     * @return
     */
    @PostMapping()
    public int addBook(@RequestBody Book book) {
        System.out.println("book add ... " + book);
        return 1;
    }
    /**
     * 修改书籍信息
     *
     * @param book
     * @return
     */
    @PutMapping()
    public int updateBook(@RequestBody Book book) {
        System.out.println("book update ..." + book);
        return 1;
    }
    /**
     * 通过id删除书籍
     * @param id
     * @return
     */
    @DeleteMapping("/{id}")
    public int deleteBookById(@PathVariable Integer id) {
        System.out.println("book delete by id..." + id);
        return 1;
    }
}

b5bf3a0335cc440f9c540a92428f10b8.png

402176a907e142fbb852c8246e21d68b.png

737845f1d0e340bb8ded87edf7282f0f.png

d5df6c86f63748798cee3e769ac00c55.png6dc072718cfd4df6a3d1c247964928f0.png634645fdd762419fabce2c554235a4a6.png447ae9c3d5d14dbbb44c9d91e3793673.png

abb97187882f4cbdade8fd13002b76e5.png


(6)由此得出结论,Post请求和Put请求执行了拦截器,而Get请求和Delete请求没有。

原因:

一开始拦截的是以/books结尾的请求,现在要加上拦截。


6a55ee12c1f94216b7dd3577b153d44e.png


5ccba192b94b4d19adc303069c7d0fe8.png最后再看一下拦截器类


/**
 * 1.在controller下新建拦截器包和拦截器类,实现HandlerInterceptor接口并覆盖3个方法
 */
@Component
/**
 * 2.使用@Component注解将这个类交给SpringMVC管理
 */
public class ProjectInterceptor implements HandlerInterceptor {
    /**
     * controller方法前执行的方法
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle ...");
        return true; // 如果改为false,原始控制器方法将不执行
    }
    /**
    *控制方法后执行的方法
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle ...");
    }
    /**
    *PostHandle()方法后执行的方法
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion ...");
    }
}

2.2 实现WebMvcConfigurer接口简化开发


在SpringMVC配置类中实现WebMvcConfigurer接口,重写解决Post请求乱码的方法和添加拦截器对象和拦截控制器的方法,从而SpringMVC配置类不用再扫描config包,但是这种方法侵入性较强。


@Configuration
@ComponentScan({"controller"})
@EnableWebMvc
public class SpringMvcConfig implements WebMvcConfigurer {
    @Autowired
    private ProjectInterceptor interceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 3.注入拦截器对象并设置当URL以/books结尾时执行拦截,再设置以/books/结尾的也拦截
        registry.addInterceptor(interceptor).addPathPatterns("/books","/books/*");
    }
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
        registry.addResourceHandler("/static/**").addResourceLocations("/static/"); // 放行static和pages目录下的资源
    }
}


2.3 拦截器执行流程图

f2f375053ee44bdd96899a4096289c8d.png


三、参数和拦截器链


3.1 拦截器参数

ab52d3174cb944339f619bc24f691a17.png


4e0c87f15edd47dab3a1e7eda4f0fb94.png

ea04800f987649dcb3789aab89d20168.png

3.2 拦截器链


(1)配置多个拦截器interceptor

fd13881b0acc4ef69465a3caca9165d8.png

使用Postman测试查看结果:

0257ad8beae34e23a359a13826a9c0d4.png

01a1b49e38bb47b08586fd8c94b89859.png

3b4a524ab50e481197a45901131a786e.png


(2)拦截器执行顺序


拦截器链中,当拦截器中断,后面的拦截器和原始方法、postHandle方法全部不执行, 下一个执行点是是上一个拦截器的afterHandle方法,因为它不执行自己的postHandle方法和afterHandle方法


b5e266bd283f457eb4ac4b290c18538f.png

8ace727157a24496986d7d58115ed0ed.png

0d99b3fa9d804a1f9efd74f4b5a8a5b1.png

c9d181913008478f919e520fa49d7be9.png

86617f6671b343f093c113dcc0327e5e.pngc7c70d00f7684c768f457c474a70140b.png


ebeba2fdc025445a8efe746371b02c57.png

9caf5d35402241f6a7b5b29fedc1b15f.png


相关文章
|
前端开发 Java Spring
56SpringMVC - 拦截器
56SpringMVC - 拦截器
37 0
|
5月前
|
XML Java 数据格式
|
5月前
|
JSON 算法 Java
SpringMVC(五)【拦截器】
SpringMVC(五)【拦截器】
|
6月前
|
数据采集 监控 前端开发
SpringMVC 拦截器
SpringMVC 拦截器
55 0
|
6月前
|
数据安全/隐私保护
SpringMVC拦截器
SpringMVC拦截器
61 0
|
6月前
springMVC之拦截器
springMVC之拦截器
|
Java
SpringMVC-拦截器
SpringMVC-拦截器
58 0
SpringMVC-拦截器
|
前端开发 JavaScript Java
SpringMVC 中的拦截器
SpringMVC 中的拦截器
|
XML 数据格式 容器
springmvc之拦截器
springmvc之拦截器
114 2