springmvc - 拦截器

最新推荐文章于 2024-09-13 19:38:35 发布
最新推荐文章于 2024-09-13 19:38:35 发布
阅读量405 收藏 3
点赞数 1
分类专栏： 笔记 文章标签： java spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lwj_07/article/details/126049977
版权
本文介绍了Spring MVC中的拦截器概念及其与过滤器的区别。通过一个简单的例子展示了在没有使用拦截器时的增删改查操作。接着详细阐述了如何创建并配置拦截器，包括编写拦截器类、配置拦截器执行的请求路径。同时，文章还探讨了拦截器参数的含义以及拦截器链的实现，展示了多个拦截器按顺序执行的情况。
摘要由CSDN通过智能技术生成

  

 一、拦截器概念 & 拦截器与过滤器Filter的区别

 

 

 

二、拦截器入门

2.1、我们在没有使用拦截器的时候，我们的增删改查项目代码写法如下所示：

config包：

ServletContainersInitConfig类：

package com.itheima.config;

import org.springframework.web.filter.CharacterEncodingFilter;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

import javax.servlet.Filter;

/**
 *  让tomcat服务器获取到的客户端请求全交给springmvc管理
 */
public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
    protected Class<?>[] getRootConfigClasses() {
        return new Class[0];
    }
    
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvcConfig.class};
    }
    // 交给springmvc管理
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

    //乱码处理
    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter filter = new CharacterEncodingFilter();
        filter.setEncoding("UTF-8");
        return new Filter[]{filter};
    }
}

SpringMvcConfig类：

package com.itheima.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration  // 定义SpringMvc容器注解
@ComponentScan({"com.itheima.controller"})  // 扫描bean注解
@EnableWebMvc   // JSON数据和JAVA数据相互转换注解
public class SpringMvcConfig {

}

POJO封装实体对象类：

package com.itheima.domain;

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 +
                '}';
    }
}

表现层：

package com.itheima.controller;

import com.itheima.domain.Book;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

@RestController // 响应前端数据注解 & 表现层bean注解
@RequestMapping("/books")
public class BookController {

    /**
     *  增
     */
    @PostMapping    // REST风格访问路径
    public String save(@RequestBody Book book){ // @RequestBody :JSON数据格式
        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'}";
    }
}

测试程序是否正常执行：前端用户通过访问表现层的资源路径：

 

2.2、使用拦截器的步骤：

第一步：写拦截器类：

注：因为加载器是把关着表现层是否让客户端访问的，因此一般把加载器类放在controller表现层包下

 

package com.itheima.controller.interceptor;

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 *  拦截器类
 *
 * 注1：该拦截器类需要实现HandlerInterceptor类，并且重写HandlerInterceptor中的方法
 * 注2：preHandle方法必须返回true，如果为false就说明拦截器直接把客户端的请求拦截下来了
 * 注3：因为拦截器是为springmvc服务的（因为拦截器把关着表现层是否让客户端访问，而springmvc就是扫描处理表现层业务的
 *      因此拦截器是为springmvc服务的），所以拦截器也需要被springmvc加载到，因此需要配上@Compoent bean注解，被springmvc扫描
 */

@Component  // springmvc扫描该拦截器
public class ProjectInterceptor implements HandlerInterceptor {
    
    // 决定是否让客户端访问想要的资源的方法 true：让客户端访问增删改查功能，false：不让拿
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle....");
        return true;    // true：代表放行客户端的访问请求，让客户端拿想要的访问数据
    }

    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle....");
    }

    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion....");
    }
}

第二步：配置客户端执行什么样的请求（如执行增删改查的哪个请求时），该拦截器会执行：

做法：将SpringMvcConfig容器类实现WebMvcConfigurer，重写WebMvcConfigurer类中的

addInterceptors方法，并且把刚才第一步写的拦截器类配置成依赖关系

注意：特别注意这里面的设定的访问路径（这里面我们设定是"/books"和"/books/*"的访问路径），只有设定了访问的路径时候，客户端访问的路径如果是我们设定的这种路径的话，那么拦截器类才能生效，才能决定放不放行，如果没设定用户如"/users"格式的访问路径，那么拦截器对这种用户的资源访问路径是不生效的 

package com.itheima.config;

import com.itheima.controller.interceptor.ProjectInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration  // 定义SpringMvc容器注解
@ComponentScan({"com.itheima.controller"})  // 扫描bean注解
@EnableWebMvc   // JSON数据和JAVA数据相互转换注解
public class SpringMvcConfig implements WebMvcConfigurer{

    /**
     *  拦截器类的依赖关系
     */
    @Autowired  // 自动装配注解（处理依赖关系的注解）
    // private ProjectInterceptor projectInterceptor = new ProjectInterceptor();
    // 该自动装配的注解作用就如上，新建对象，所以projectInterceptor对象就可以供下面的方法用了
    private ProjectInterceptor projectInterceptor;


    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books","/books/*");
        // 这句话的意思就是说：当客户端的访问表现层的资源路径是 "/books"格式或者"/books/*"格式的话，
        //  那么就触发拦截器类projectInterceptor（也就是说保安出动~）然后让拦截器类中的方法判定放不放行
    }
}

当客户端进行访问"/books"格式的资源路径的时候，结果如下所示：

因为拦截器类中的preHandle方法（专门决定让不让用户访问的资源调用的方法）

返回的是true，

        因此就允许客户端访问调用想要的资源数据了，

但是如果该方法返回的为false时，

        那么就不允许用户访问调用想要的路径资源（前提要保证在SpringMvcConfig容器中设定好了访问哪些路径时才让拦截器进行判断）

preHandle方法返回值为true时：（放行，允许用户调用/books路径下的资源） 

 preHandle方法返回值为false时：（不放行，不允许用户调用/books路径下的资源）

 

 

 三、拦截器参数

我们从上面的演示输出的结果可以看出，当客户端访问的路径是我们设定的需要通过拦截器判断是否放行的路径的时候，是先走我们拦截器类的preHandle（）方法的，而该方法中也是有参数的，那么这些参数都有哪些作用呢：

 

 

 其他的几个参数，用到了再说~

四、拦截器链

也就是说：可以配置多个拦截器，因此被称为拦截器链

代码演示如下所示：

拦截器1的代码：

package com.itheima.controller.interceptor;

import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 *  拦截器类
 *
 * 注1：该拦截器类需要实现HandlerInterceptor类，并且重写HandlerInterceptor中的方法
 * 注2：preHandle方法必须返回true,如果为false就说明拦截器直接把客户端的请求拦截下来了
 * 注3：因为拦截器是为springmvc服务的（因为拦截器把关着表现层是否让客户端访问，而springmvc就是扫描处理表现层业务的
 *      因此拦截器是为springmvc服务的），所以拦截器也需要被springmvc加载到，因此需要配上@Compoent bean注解，被springmvc扫描
 */

@Component  // springmvc扫描该拦截器
public class ProjectInterceptor implements HandlerInterceptor {
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        System.out.println("preHandle....");
        return true;
    }

    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle....");
    }

    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion....");
    }
}

拦截器2的代码：

package com.itheima.controller.interceptor;

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 *  拦截器类
 *
 * 注1：该拦截器类需要实现HandlerInterceptor类，并且重写HandlerInterceptor中的方法
 * 注2：preHandle方法必须返回true,如果为false就说明拦截器直接把客户端的请求拦截下来了
 * 注3：因为拦截器是为springmvc服务的（因为拦截器把关着表现层是否让客户端访问，而springmvc就是扫描处理表现层业务的
 *      因此拦截器是为springmvc服务的），所以拦截器也需要被springmvc加载到，因此需要配上@Compoent bean注解，被springmvc扫描
 */

@Component  // springmvc扫描该拦截器
public class ProjectInterceptor2 implements HandlerInterceptor {
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        System.out.println("preHandle....2222");
        return true;
    }

    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle....2222");
    }

    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion....2222");
    }
}

配置该两个拦截器拦截路径的请求：

package com.itheima.config;

import com.itheima.controller.interceptor.ProjectInterceptor;
import com.itheima.controller.interceptor.ProjectInterceptor2;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration  // 定义SpringMvc容器注解
@ComponentScan({"com.itheima.controller"})  // 扫描bean注解
@EnableWebMvc   // JSON数据和JAVA数据相互转换注解
public class SpringMvcConfig implements WebMvcConfigurer{

    /**
     *  拦截器类的依赖关系
     */
    @Autowired  // 自动装配注解（处理依赖关系的注解）

    private ProjectInterceptor projectInterceptor;  // 第一个拦截器类依赖

    @Autowired
    private ProjectInterceptor2 projectInterceptor2;    // 第二个拦截器类依赖


    public void addInterceptors(InterceptorRegistry registry) {

        registry.addInterceptor(projectInterceptor).addPathPatterns("/books","/books/*");
        registry.addInterceptor(projectInterceptor2).addPathPatterns("/books","/books/*");
        // 这句话的意思就是说：当客户端的访问表现层的资源路径是 "/books"格式或者"/books/*"格式的话，
        //  那么就触发拦截器类projectInterceptor（也就是说保安出动~）然后让拦截器类中的方法判定放不放行
    }
}

客户端访问能被拦截器获取的/books路径资源时，结果如下所示：

 注意：无论几个拦截器，都是先执行这几个拦截器的判断是否放行用户访问资源路径的preHandle（）方法的，【上面结果的模拟压栈，可以先看成只有preHandle（）方法，然后调用完数据后再有的其他方法】

并且当有很多个拦截器的时候，先进入哪个拦截器的preHandle（）方法，是由下面的先后顺序决定的：

 并且当第一个拦截器如果preHandle（）方法返回的是false，就是代表不让客户端调用访问路径资源，那么当执行到第一个拦截器preHandle（）方法后，就会结束了，后面的其他拦截器及其他代码就不会再执行了，（就比如压栈的时候，第一个进去的卡在里面了，后面的也就都进不去了）

lwj_07
关注
专栏目录
spring系列 SpringMVC-拦截器
weixin_53069745的博客
01-30 121
拦截器（Interceptor）是在SpringMVC中动态拦截方法的执行。
SpringMVC--拦截器使用原理
liulianglin的专栏
03-17 878
基于HandlerInterceptor接口实现拦截器
springmvc 拦截器
05-08
springmvc 拦截器
SpringMVC拦截器
m0_63300795的博客
08-19 238
SpringMVC的处理器拦截器,类似于Servlet开发中的过滤器Filter，用于对处理器进行预处理和后处理。依赖于web框架，在实现上基于Java的反射机制，属于面向切面编程（AOP）的一种运用。由于拦截器是基于web框架的调用，因此可以使用Spring的依赖注入（DI）进行一些业务操作，同时一个拦截器实例在一个 controller生命周期之内可以多次调用。
Spring MVC 拦截器
最新发布
m0_73837751的博客
09-13 1036
简单介绍了spring MVC中拦截器的使用
【SpringMVC】框架中的拦截器
恩会的博客
01-22 564
1. 拦截器的概述 1. SpringMVC框架中的拦截器用于对处理器进行预处理和后处理的技术。 2. 可以定义拦截器链，连接器链就是将拦截器按着一定的顺序结成一条链，在访问被拦截的方法时，拦截器链 中的拦截器会按着定义的顺序执行。 3. 拦截器和过滤器的功能比较类似，有区别 1. 过滤器是Servlet规范的一部分，任何框架都可以使用过滤器技术。 2. 拦截器是SpringMVC框架...
SpringMVC中的拦截器
weixin_43891398的博客
07-04 228
SpringMVC中的拦截器
SpringMVC - 拦截器
05-23
下面将详细介绍 SpringMVC 拦截器的工作原理、创建与配置方法，以及如何应用到实际项目中。 1. **工作原理** - 在 SpringMVC 中，拦截器是基于 HandlerMapping 和 HandlerAdapter 的概念实现的。当一个请求到达时...
SpringMVC-6-拦截器
baidu_38126306的博客
10-09 413
SpringMVC的处理器拦截器HandlerInterceptor
企业级开发-SpringMVC使用拦截器实现用户登录权限验证实验报告.docx
08-21
本实验报告将探讨如何利用 SpringMVC 的拦截器（Interceptor）来实现用户登录权限验证，确保只有已登录的用户才能访问特定的受保护资源。 首先，我们来看一下实验的基本步骤： 1. 创建 `User` 类：这是表示用户...
springmvc 配置拦截器
09-01
在 Spring MVC 中配置拦截器可以通过实现 `HandlerInterceptor` 接口来创建自定义的拦截器。下面是配置拦截器的步骤： 1. 创建一个实现了 `HandlerInterceptor` 接口的拦截器类，例如： ```java public class ...
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值