springboot3增加拦截器

最新推荐文章于 2025-03-06 18:29:52 发布

影孓

最新推荐文章于 2025-03-06 18:29:52 发布

阅读量1k

点赞数 6

CC 4.0 BY-SA版权

分类专栏： Java 文章标签： java spring boot

本文链接：https://blog.youkuaiyun.com/senge_com/article/details/135838504

Java 专栏收录该内容

7 篇文章

订阅专栏

本文介绍了如何在SpringBoot3.x项目中创建和配置一个用户登录拦截器，包括创建拦截器类、启用拦截器、设置拦截和排除路径，以及如何在配置类中注册拦截器。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

springboot3增加拦截器

在Spring Boot中添加拦截器可以通过以下步骤完成：
1.创建自定义的拦截器类。该类需要实现HandlerInterceptor接口并重写其中的preHandle、postHandle和afterCompletion等方法来处理相应的业务逻辑。


import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

/**
 * 用户登录拦截器
 */
public class LoginInterceptor implements HandlerInterceptor {

    /**
     * 在请求被处理之前进行操作
     *
     * @param request
     * @param response
     * @param handler
     * @return 返回true表示继续执行后续的拦截器或Controller；返回false则不再执行后续的拦截器或Controller
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 判断当前请求是否需要被拦截
        if (request.getSession().getAttribute("user") == null) {
            // 未登录则重定向到登录页面
            response.sendRedirect("/login");
            return false;
        } else {
            return true;
        }

    }

    /**
     * 在请求被处理之后但视图还未渲染时进行操作
     *
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    /**
     * 在整个请求结束之后（包括视图已经渲染）进行操作
     *
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }
}

2.配置拦截器。在Spring Boot项目的配置文件（如application.properties或application.yml）中添加以下内容：

# application.yml
spring:
  mvc:
    interceptor:
      enabled: true # 开启拦截器功能
      path-patterns: /** # 设置拦截路径模式，这里使用/**表示所有URL都会被拦截
      exclude-path-patterns: /login # 设置排除的路径模式，这里使用/login表示登录页面不会被拦截

3.注册拦截器。创建一个配置类，将自定义的拦截器注入到Spring容器中：


import com.itasen.asenmanageweb.handlerInterceptor.LoginInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * 拦截器注册
 */
@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
    //登录拦截器
    private final LoginInterceptor loginInterceptor = new LoginInterceptor();

    @Bean
    public LoginInterceptor getLoginInterceptor() {
        return this.loginInterceptor;
    }

    /**
     * 排除拦截页面
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(getLoginInterceptor()).excludePathPatterns(
                new String[]{
                        "/login"
                        ,"/"
                }
        ); // 注册拦截器并指定排除的路径模式
    }

}