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框架中一个非常强大的特性,通过它你可以对请求处理流程进行细粒度的控制

相关推荐
Rain的Java大神之路1 小时前
如何快速上传10G文件
java·spring boot·redis·后端·mysql·spring cloud·面试
+VX:Fegn08954 小时前
计算机毕业设计|基于springboot + vue旅游管理系统(源码+数据库+文档)
java·开发语言·vue.js·spring boot·课程设计
需要8265 小时前
MySQL 索引 B+ 树与“查询为什么变慢了
java·spring boot·spring·spring cloud·tomcat
一 乐5 小时前
二手交易平台|基于springboot + vue二手交易平台(源码+数据库+文档)
java·数据库·vue.js·spring boot·小程序
vx-程序开发6 小时前
【计算机毕设】django校园跑腿服务系统83141
java·数据库·vue.js·spring boot·spring·elasticsearch·django
一 乐6 小时前
养老院管理系统|基于springboot + vue养老院管理系统(源码+数据库+文档)
java·数据库·vue.js·spring boot·毕业设计
今年下半年9 小时前
SpringBoot整合金蝶中间件
spring boot·中间件·maven
字节探索9 小时前
别再只会写 Controller 了!一文吃透 Spring Boot 高级特性与项目实战
spring boot·spring
MetaLite10 小时前
全网最好的SpringBoot接口请求对象设计
java·spring boot·后端
摇滚侠11 小时前
《Spring Boot 3:高级与架构设计》第 2 章 IOC容器的高级机制 BeanFactoryPostProcessor 个人理解 6
java·spring boot·笔记·后端