springboot实现拦截器

SpringMVC拦截器顺序执行及配置详解
文章介绍了在SpringMVC中继承HandlerInterceptorAdapter实现拦截器,详细阐述了preHandle、postHandle和afterCompletion的执行顺序。preHandle返回true时后续方法才会执行,postHandle在所有拦截器成功后调用,而afterCompletion仅在preHandle成功后调用。同时展示了如何通过WebMvcConfigurer接口添加和配置拦截路径。

内容:继承HandlerInterceptorAdapter并实现WebMvcConfigurer拦截器中的方法将preHandle->Controller->postHandle->affterCompletion的顺序执行。

注意:只有preHandle方法返回true时后面的方法才会执行。当拦截器链存在多个拦截器时,postHandle在所有拦截器内的所有拦截器返回成功时才会调用,而affterCompletion只有preHandle返回true才调用,但如果拦截器内的第一个拦截器的preHandle方法返回false,后面的方法都不会执行。

@Component
public class AppInterceptor extends HandlerInterceptorAdapter implements WebMvcConfigurer  {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle执行");
        return true;
    }
 
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle执行");
    }
 
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion执行");
    }

//设置拦截路径配置,addPathPatterns为拦截的路径,excludePathPatterns为排除的路径

 @Override
   public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new TestInterceptor())
                .addPathPatterns("/**")
                .excludePathPatterns("/hello1");
 
    }


}

Spring Boot应用中实现和配置拦截器,通常需要以下几个步骤:创建拦截器类、注册拦截器以及定义拦截规则。 ### 创建拦截器类 首先,需要实现一个拦截器类,该类通常实现`HandlerInterceptor`接口,并重写其中的方法。这些方法包括: - `preHandle`:在目标方法执行前调用,如果返回`false`,则中断请求。 - `postHandle`:在目标方法执行后,视图渲染前调用。 - `afterCompletion`:在整个请求完成后调用,无论是否发生异常。 下面是一个简单的拦截器示例,它在请求到达控制器之前打印请求的URL: ```java import org.springframework.web.servlet.HandlerInterceptor; import javax.servlet.http.HttpServletRequest; import HttpServletResponse; public class MyInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println("请求地址: " + request.getRequestURL()); return true; // 如果返回false,则中断请求 } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { // 在这里可以修改modelAndView } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { // 在这里可以进行资源清理工作 } } ``` ### 注册拦截器 创建了拦截器类之后,你需要创建一个配置类来注册这个拦截器。这个配置类需要实现`WebMvcConfigurer`接口,并重写`addInterceptors`方法。在这个方法中,你可以指定拦截器应该拦截哪些路径,以及哪些路径应该被排除。 下面是一个配置类的示例: ```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 MvcConfig implements WebMvcConfigurer { private final MyInterceptor myInterceptor; public MvcConfig(MyInterceptor myInterceptor) { this.myInterceptor = myInterceptor; } @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(myInterceptor) .addPathPatterns("/**") // 拦截所有请求 .excludePathPatterns("/public/**", "/error"); // 排除一些需要拦截的请求 } } ``` 在这个例子中,我们使用了构造器注入来注入`MyInterceptor`实例。然后,通过`addInterceptors`方法将拦截器添加到`InterceptorRegistry`中,并定义了拦截所有请求的模式,但排除了`/public/**`和`/error`路径。 ### 定义拦截规则 在上面的配置中,`.addPathPatterns("/**")`定义了拦截所有请求的规则,而`.excludePathPatterns("/public/**", "/error")`则定义了被拦截的特定路径。你可以根据实际需求调整这些规则。 ### 注意事项 - **职责单一**:每个拦截器应该只关注一个功能点。 - **性能考虑**:避免在拦截器执行耗时操作。 - **合理排序**:如果存在多个拦截器,应合理安排它们的顺序。 - **异常处理**:注意拦截器中的异常处理逻辑。 - **避免循环**:确保拦截器逻辑会导致循环重定向。 以上就是在Spring Boot实现和配置拦截器的基本步骤。当然,你可以根据具体的业务需求来扩展拦截器的功能,比如进行权限校验、日志记录或性能监控等[^3]。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值