springboot拦截器的使用

该博客介绍了如何使用Spring MVC实现登录拦截器。通过编写HandlerInterceptor接口的实现类LoginInterceptor,进行登录检查,未登录的请求会被重定向到登录页。在WebMvcConfigurer接口的addInterceptors方法中注册拦截器,并设置拦截规则,排除静态资源。总结了拦截器的三个关键步骤:创建拦截器、注册到容器和指定拦截路径。

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

步骤

1、编写HandlerInterceptor 接口

/**
 * 登录检查
 * 1、配置好拦截器要拦截哪些请求
 * 2、把这些配置放在容器中
 */
@Slf4j
public class LoginInterceptor implements HandlerInterceptor {

    /**
     * 目标方法执行之前
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        String requestURI = request.getRequestURI();
        log.info("preHandle拦截的请求路径是{}",requestURI);

        //登录检查逻辑
        HttpSession session = request.getSession();

        Object loginUser = session.getAttribute("loginUser");

        if(loginUser != null){
            //放行
            return true;
        }

        //拦截住。未登录。跳转到登录页
        request.setAttribute("msg","请先登录");
//        re.sendRedirect("/");
        request.getRequestDispatcher("/").forward(request,response);
        return false;
    }

    /**
     * 目标方法执行完成以后
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("postHandle执行{}",modelAndView);
    }

    /**
     * 页面渲染以后
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("afterCompletion执行异常{}",ex);
    }
}

2、配置拦截器


@Configuration
public class AdminWebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                .addPathPatterns("/**")  //所有请求都被拦截包括静态资源
                .excludePathPatterns("/","/login","/css/**","/fonts/**","/images/**","/js/**"); //放行的请求
    }
}

3.简化方法

@GetMapping("/main.html")
    public  String mainPage(HttpSession session,Model model){
    return  "main";
}

总结

/**

  • 1、编写一个拦截器实现HandlerInterceptor接口
  • 2、拦截器注册到容器中(实现WebMvcConfigurer的addInterceptors)
  • 3、指定拦截规则【如果是拦截所有,静态资源也会被拦截】
    */
### 如何在 Spring Boot 中使用拦截器 #### 创建自定义拦截器 为了创建一个自定义拦截器,在应用程序中需要实现 `HandlerInterceptor` 接口。此接口提供了三个主要的方法:`preHandle()`、`postHandle()` 和 `afterCompletion()`, 这些方法允许开发者分别在控制器之前、视图渲染之后以及整个请求完成之后执行逻辑[^1]。 ```java import org.springframework.web.servlet.HandlerInterceptor; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; public class MyCustomInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println("Before handling the controller..."); return true; // 如果返回false,则不会继续调用后续的处理器 } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { System.out.println("After handling but before rendering view..."); } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { System.out.println("After completing all operations..."); } } ``` #### 注册拦截器到配置类 为了让上述自定义拦截器生效,还需要将其注册至 Web 配置文件中。这通常是在实现了 `WebMvcConfigurer` 的配置类里完成的: ```java 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 WebConfig implements WebMvcConfigurer { private final MyCustomInterceptor myCustomInterceptor; public WebConfig(MyCustomInterceptor myCustomInterceptor){ this.myCustomInterceptor = myCustomInterceptor; } @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(myCustomInterceptor).addPathPatterns("/api/**"); } } ``` 这里指定了 `/api/**` 路径模式下的所有请求都将被该拦截器所捕获并处理。 #### 关联注解 对于某些场景下可能希望仅当满足特定条件时才触发拦截操作,这时就可以利用一些内置或自定义的注解来达到目的。例如,可以通过编写带有参数验证功能的自定义注解,并结合 AOP 或者其他机制让其影响拦截行为;也可以直接在拦截器内部解析 HTTP 请求中的头信息或者其他元数据来进行判断[^2]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值