SpringMVC拦截器

最新推荐文章于 2024-06-27 15:25:28 发布
最新推荐文章于 2024-06-27 15:25:28 发布
阅读量88 收藏
点赞数
分类专栏： SpringMVC学习笔记 文章标签： java spring mvc
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_62912377/article/details/130916729
版权

一、拦截器概念

拦截器（Interceptor）是一种动态拦截方法调用的机制，在SpringMVC中动态拦截控制器方法的执行

其作用是在指定的方法调用前后执行预先设定的代码，阻止原始方法的执行，就是用来做增强的

那拦截器和过滤器有什么区别？

  • 归属不同：Filter属于Servlet技术，Interceptor属于SpringMVC技术
  • 拦截内容不同：Filter对所有访问进行增强，Interceptor仅针对SpringMVC的访问进行增强

二、拦截器入门

1、环境准备

创建一个Web的Maven项目，配置pom.xml文件

<?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>SpringMVC_09</groupId>
    <artifactId>SpringMVC_09</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <name>SpringMVC_09 Maven Webapp</name>
    <!-- FIXME change it to the project's website -->
    <url>http://www.example.com</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>16</maven.compiler.source>
        <maven.compiler.target>16</maven.compiler.target>
    </properties>

    <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.3.0</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>
                    <uriEncoding>UTF-8</uriEncoding>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

创建相关配置类

SpringMVCConfig

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

ServletConfig

public class ServletConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[0];
    }

    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMVCConfig.class};
    }

    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

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

创建模型类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='" + name + '\'' +
                ", price=" + price +
                '}';
    }
}

创建控制类BookController

@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'}";
    }
}

删除web.xml，配置tomcat服务器

最终项目结构如下

2、拦截器开发

创建拦截器类，让其实现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...");
    }
}

当设置preHandler中的返回值为false时，则不会执行原始Controller类中请求的方法和后续posrHandle、afterCompletion方法 

配置拦截器类

SpringMVCSupport

@Configuration
public class SpringMVCSupport extends WebMvcConfigurationSupport {
    @Autowired
    private ProjectInterceptor projectInterceptor;

    @Override
    //配置拦截器
    protected void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books", "/books/*");
    }
}

此处配置的/books和/books/*将以books开头的所有路径都进行了拦截

SpringMVC添加SpringMVCSupport包扫描

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

启动服务器，在apifox中进行测试

控制台输出

三、拦截器参数

1、前置处理方法

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle...");
        return true;
    }
  • request：请求对象
  • response：响应对象
  • handler：被调用的处理器对象，本质上是一个方法对象，对反射中的Method对象进行了再包装

使用request对象可以获取请求数据中的内容，如获取请求头的Content-Type

使用handler参数可以获取方法的相关信息

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String contenType = request.getHeader("Content-Type");//获取请求头
        System.out.println(contenType);
        
        HandlerMethod handlerMethod = (HandlerMethod) handler;
        String methodName = handlerMethod.getMethod().getName();//可以获取方法的名称
        System.out.println(methodName);
        
        System.out.println("preHandle...");
        
        return true;
    }

重启服务器，在apifox中测试

控制台输出

2、后置处理方法

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

modelAndView：如果处理器执行完成具有返回结果，可以读取到对应数据与页面信息，并进行调整（因为现在主流都是json数据，所以使用频率不高）

3、完成处理方法 

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

ex：如果处理器执行过程中出现异常对象，可以针对异常情况进行单独处理

四、拦截器链

当我们项目中有多个拦截器时，执行顺序该是怎么样的？

配置多个拦截器

@Component
//定义拦截器类，实现HandlerInterceptor接口
//注意当前类必须受Spring容器控制
public class ProjectInterceptor2 implements HandlerInterceptor {
    @Override
    //原始方法调用前执行的内容
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle...2");
        return true;
    }

    @Override
    //原始方法调用后执行的内容
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle...2");
    }

    @Override
    //原始方法调用完成后执行的内容
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion...2");
    }
}

配置拦截器类

@Configuration
public class SpringMVCSupport extends WebMvcConfigurationSupport {
    @Autowired
    private ProjectInterceptor projectInterceptor;

    @Autowired
    private ProjectInterceptor2 projectInterceptor2;


    @Override
    //配置拦截器
    protected void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books", "/books/*");

        registry.addInterceptor(projectInterceptor2).addPathPatterns("/books", "/books/*");
    }
}

重启服务器，运行apifox测试

控制台输出

可以看到，preHandle顺序执行，postHandle和afterCompletion倒序执行 

当设置ProjectInterceptor2中preHandle返回值为false时

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle...2");
        return false;
    }

重启服务器，运行apifox测试

控制台输出

即只执行了ProjectInterceptor的preHandle和afterCompletion方法和ProjectInterceptor2中的preHandle方法

王二hhh
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
实现springmvc中的拦截器Interceptor
weixin_46855885的博客
12-01 190
1.开发所需的工具是idea 2.首先我们导入所需要的jar包 <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>5.2.9.RELEASE</version> </dependency> <dependency> &lt
SpringMVC的拦截器（Interceptor）
coderge's CSDN Blog.
05-18 4313
在这个方法中可以通过返回值来决定是否要进行放行，我们可以把业务逻辑放在该方法中，如果满足业务则返回true放行，不满足则返回false拦截。方法，如果返回true,则代表放行，会执行原始Controller类中要请求的方法，如果返回false，则代表拦截，后面的就不会再执行了。(7)如果满足规则，则进行处理，找到其对应的controller类中的方法进行执行,完成后返回结果。拦截器执行的顺序是和配置顺序有关。(5)在找到具体的方法之前，我们可以去配置过滤器(可以配置多个)，按照顺序进行执行。
SpringMVC --- 拦截器
Oldfat的博客
04-13 3070
拦截器 1、拦截器的配置 SpringMVC中的拦截器用于拦截控制器方法的执行 SpringMVC中的拦截器需要实现 HandlerInterceptor SpringMVC的拦截器必须在SpringMVC的配置文件中进行配置： <!--配置拦截器--> <!--所有的请求都会被拦截--> <mvc:interceptors> <!--第一种方式--> <!-- <bean class="com
SpringMVC实现拦截器的两种方式（详细）
qq_45515182的博客
05-12 9551
本文介绍了SpringMVC中的两种过滤器的使用，分别是HandlerInterceptor和WebRequestInterceptor，详细的介绍了如何使用这两种过滤器。
Spring MVC 拦截器使用及实现
Luckydog1991的博客
07-03 5377
1、自定义拦截器        Spring MVC 也可以使用拦截器对请求进行拦截处理，用户 可以自定义拦截器来实现特定的功能，自定义的拦截器必须实现HandlerInterceptor接口。  1）、     HandlerInterceptor接口： public interface HandlerInterceptor { boolean preHandl
springmvc 拦截器
05-08
springmvc 拦截器
SpringMvc 拦截器
04-16
SpringMvc 拦截器 原理清楚，代码简单，值得学习！
SpringMVC拦截器配置及运行流程解析
08-19
SpringMVC拦截器配置及运行流程解析 SpringMVC拦截器是指在SpringMVC框架中，用于拦截和处理请求的组件。拦截器可以在请求处理之前、之后或抛出异常时执行某些操作，例如身份验证、日志记录、异常处理等。SpringMVC...
springMVC拦截器HandlerInterceptor用法代码示例
08-28
"springMVC拦截器HandlerInterceptor用法代码示例" springMVC拦截器HandlerInterceptor是一种非常重要的技术，它可以帮助我们拦截用户的请求，从而知道页面请求的是哪个class的哪个方法。本文将详细介绍springMVC...
SpringMVC 拦截器实现原理和登录实现
weixin_30730151的博客
12-01 2536
SpringMVC 拦截器的原理图 springMVC拦截器的实现一般有两种方式 第一种方式是要定义的Interceptor类要实现了Spring的HandlerInterceptor 接口 第二种方式是继承实现了HandlerInterceptor接口的类，比如Spring已经提供的实现了HandlerInterceptor接口的抽象类HandlerIntercep...
SpringMvc Interceptor拦截器的配置与使用
热门推荐
Top5软件工程硕士，先后在京东、字节从事多年Java后端开发、实时和离线大数据开发
02-28 6万+
package com.springmvc.controller; import com.springmvc.entity.User; import com.springmvc.service.UserService; import org.apache.commons.collections.map.HashedMap; import org.apache.log4j.Logger; impo...
SpringMVC 使用拦截器实现日志记录
Michean的博客
02-19 3111
SpringMVC 使用拦截器实现日志记录 java web日志实现方式有很多种，这次在这里介绍使用拦截器记录日志 拦截器代码 package com.my.interceptor; import java.util.List; import java.util.Map; import java.util.Map.Entry; import javax.annotation.Resour...
SpringMVC拦截器实现登录认证
Nicky's blog
05-15 586
博客以Demo的形式讲诉拦截器的使用 项目结构如图： 需要的jar：有springMVC配置需要的jar和jstl需要的jar SpringMVC包的作用说明： aopalliance.jar:这个包是AOP联盟的API包,里面包含了针对面向切面的接口。通常spring等其它具备动态织入功能的框架依赖这个jar spring-core.jar:这个jar ...
SpringMVC拦截器(登录实现)
qq_44892120的博客
05-18 848
SpringMVC拦截器 使用步骤 1.自定义拦截器 需要实现 HandlerInteceptor接口。 package com.edu.Intercepter; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.ModelAndView; import javax.servlet.http.HttpServletRequest; import javax.s
Springmvc实现用户登录拦截器
Mister_yang的博客
03-24 9638
SpringMvc实现简单的拦截器代码与讲解1.Springmvc需要的jar文件，其中部分为json操作jar（暂时未用）2.登录界面，简单的jsp代码，模拟登录所需数据&lt;%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%&gt; &lt;!DOCTYPE html...
日常工作记录目录
与海
06-21 555
EasyExcel实现二维码下载与展示
Lombok的hashCode方法
最新发布
LiZhen314的博客
06-27 226
在继承关系中，父类的hashCode针对父类的所有属性进行运算，而子类的hashCode却只是针对子类才有的属性进行运算，立此贴提醒自己。callSuper = false，根据子类自身的字段值 来生成hashcode， 当两个子类对象比较时，只有子类对象的本身的字段值相同，父类字段值可以不同，callSuper = true，根据子类自身的字段值和从父类继承的字段值 来生成hashcode，当两个子。比较时，只有子类对象的本身的字段值和继承父类的字段值都相同，equals方法的返回值是true。
Homebrew使用
gghh2015的博客
06-21 451
具体参考：https://blog.csdn.net/m0_67402970/article/details/126434901。简介：https://www.jianshu.com/p/f4c9cf0733ea。2、查看安装路径：brew list maven。官网：https://brew.sh/

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值