SpringBoot 拦截器

SpringBoot 拦截器

在Spring Boot中,拦截器(Interceptor)是一个强大的工具,它允许你在请求处理之前、之后以及渲染视图之后执行代码。拦截器可以用于执行各种任务,如日志记录、身份验证、授权、数据转换等。

Spring Boot中的拦截器通常实现HandlerInterceptor接口,该接口定义了三个方法:

  1. preHandle

    在请求处理之前调用。你可以在这里执行诸如验证、日志记录等操作。如果此方法返回false,则请求将不会继续处理。

  2. postHandle

    在请求处理之后但在视图渲染之前调用。你可以在这里对模型数据进行后处理。

  3. afterCompletion

    在整个请求处理完成后调用,即视图渲染之后。你可以在这里执行清理操作。

拦截器流程图:


要在Spring Boot中使用拦截器,你需要执行以下步骤:

创建拦截器类:

这里以实现登录拦截器为例:

java 复制代码
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;
import javax.servlet.http.HttpSession;

@Component
public class LoginInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 在请求处理之前执行的代码(Controller方法调用之前)
        System.out.println("Pre-handle method is called");
        HttpSession session = request.getSession();
        Object loginUser = session.getAttribute("loginUser");
        if(loginUser == null){
            response.sendRedirect("/user/login");
            return false;
        }
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 在请求处理之后执行的代码(Controller方法调用之后)
        System.out.println("Post-handle method is called");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 在请求处理完成后执行的代码(即视图渲染之后)
        System.out.println("After-completion method is called");
    }
}

注册拦截器:

java 复制代码
import cn.qvtu.web.interceptor.LoginInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class LoginConfig implements WebMvcConfigurer {

    @Autowired
    private LoginInterceptor loginInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        InterceptorRegistration registration = registry.addInterceptor(loginInterceptor);
        registration.addPathPatterns("/user/**"); // 拦截/user下的所有路径
        registration.excludePathPatterns(  // 排除特定路径
                "/user/login",
                "/user/register"
        );
    }
}

在上面的配置中,addPathPatterns方法定义了哪些URL路径应该被拦截,而excludePathPatterns方法则定义了哪些路径应该被排除。

拦截器是Spring MVC框架中一个非常强大的特性,通过它你可以对请求处理流程进行细粒度的控制

相关推荐
卷毛的技术笔记5 分钟前
从“拆东墙补西墙”到“最终一致”:分布式事务在Spring Boot/Cloud中的破局之道
java·spring boot·分布式·后端·spring cloud·面试·rocketmq
BduL OWED1 小时前
将 vue3 项目打包后部署在 springboot 项目运行
java·spring boot·后端
imuliuliang1 小时前
Spring Boot 多数据源解决方案:dynamic-datasource-spring-boot-starter 的奥秘(上)
java·spring boot·后端
csdn2015_2 小时前
spring boot 启动的时候将数据库里的分类信息写入redis
数据库·spring boot·redis
霸道流氓气质2 小时前
SpringBoot+LangChain4j+Ollama实现Function Calling工具调用-仿智能客服示例
java·spring boot·后端
彭于晏Yan3 小时前
Spring Boot整合WebSocket入门(一)
spring boot·后端·websocket
disgare5 小时前
SpringBoot 请求调用时关于高可用机制选型和落地
java·spring boot·后端
CodeMartain5 小时前
@SpringBootApplication 到底是什么呢?
java·spring boot·intellij-idea
许彰午6 小时前
Spring Boot + Vue 实现 XML 动态表单:固定字段 + 自由扩展方案
xml·vue.js·spring boot
indexsunny6 小时前
互联网大厂Java面试实战:Spring Boot微服务与Kafka消息队列深度解析
java·spring boot·微服务·面试·kafka·消息队列·电商