Springboot拦截器

本文介绍了在Spring MVC项目中如何自定义拦截器实现登录检查。拦截器`LoginInterceptor`继承`HandlerInterceptor`接口,通过检查session中的user属性判断用户是否已登录。未登录时,将用户重定向到登录页面。配置类`MyConfig`中注册拦截器,并设置拦截及排除路径,确保特定页面不受拦截。

     在web项目中,拦截器是不可或缺的,下面就拦截器来讲解一下代码

     首先,要自定义一个拦截器并继承  HandlerInterceptor 接口

package com.xyh.Config;

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;

public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        HttpSession session = request.getSession();
        String  flag = (String) session.getAttribute("user");
        if(null == flag){
            request.setAttribute("msg","您还未登录,请先登录");
            request.getRequestDispatcher("test").forward(request,response);
        }
        return true;
    }
}

 通过session获取是否已经登录,若已登录,则放行,return true,若session 为空,则表示并未登录,则返回一条msg,转发到你自己的登录界面,让用户先登录,再进行下面的操作。

  配置完自定义拦截器,还要在配置类里装配

package com.xyh;

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 MyConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                .addPathPatterns("/*")
                .excludePathPatterns("/test")
                .excludePathPatterns("/register")
                .excludePathPatterns("/log")
                .excludePathPatterns("/UserLogin")
                .excludePathPatterns("/file")
                .excludePathPatterns("/fileUpload")
                .excludePathPatterns("/toregister");
    }

}

 @configuration表明是一个配置类,然后继承了WebMvcConfigurer接口,重写它的addInterceptor方法,也就是它里面的关于拦截器的方法,把自己的类名称通过new的方式注入进来,然后.addPathPatterns("/*")表示拦截所有请求,..excludePathPatterns("")表示不拦截一些请求,引号里写自己不想被拦截的地址

在 Spring Boot 中创建和配置拦截器是一个相对简单的过程,可以通过以下步骤实现: ### 创建自定义拦截器 1. **创建拦截器类** 自定义拦截器可以通过实现 `HandlerInterceptor` 接口或继承 `HandlerInterceptorAdapter` 类来完成。拦截器的主要方法包括: - `preHandle()`:在 Controller 方法执行之前调用,返回值为 `true` 表示继续执行后续流程,`false` 表示中断请求。 - `postHandle()`:在 Controller 方法执行之后、视图渲染之前调用。 - `afterCompletion()`:在整个请求完成之后(视图渲染结束)调用,可用于资源清理等操作。 示例代码如下: ```java import org.springframework.web.servlet.HandlerInterceptor; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; public class MyInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { // 在 Controller 方法执行前执行 System.out.println("preHandle 方法执行"); return true; // 返回 true 表示继续后续流程 } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { // 在 Controller 方法执行后、视图渲染前执行 System.out.println("postHandle 方法执行"); } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { // 在整个请求完成之后执行 System.out.println("afterCompletion 方法执行"); } } ``` 2. **配置拦截器** 需要创建一个 Java 配置类,实现 `WebMvcConfigurer` 接口,并重写 `addInterceptors` 方法,将自定义拦截器注册到 Spring Boot 的拦截器链中。 示例代码如下: ```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 { @Override public void addInterceptors(InterceptorRegistry registry) { // 添加自定义拦截器,并指定拦截路径 registry.addInterceptor(new MyInterceptor()) .addPathPatterns("/**") // 拦截所有请求 .excludePathPatterns("/", "/login", "/index.html", "/user/login", "/css/**", "/images/**", "/js/**", "/fonts/**"); // 排除特定路径 } } ``` 3. **拦截器的作用范围** - `addPathPatterns("/**")` 表示拦截所有请求路径。 - `excludePathPatterns(...)` 可以指定一些不需要拦截的路径,例如登录页面、静态资源等。 - 通过这种方式,可以灵活地控制拦截器的作用范围,避免对某些特定请求造成干扰。 4. **注意事项** - 在较新的 Spring Boot 版本中,建议直接实现 `WebMvcConfigurer` 接口,而不是继承 `WebMvcConfigurerAdapter` 类,因为后者在 Spring Boot 5 中已被标记为过时。 - 拦截器类可以放在 `config` 包下,或者与主应用类在同一目录下,以确保 Spring Boot 能够正确扫描到该类。 ### 拦截器的工作流程 拦截器的执行顺序如下: 1. `preHandle()`:在 Controller 方法执行之前执行。 2. Controller 方法执行。 3. `postHandle()`:在 Controller 方法执行之后、视图渲染之前执行。 4. `afterCompletion()`:在整个请求完成之后执行,通常用于清理资源。 通过拦截器,可以实现对请求的统一处理,例如权限校验、日志记录、请求时间统计等功能。 --- ###
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值