欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

spring boot的拦截器简单使用示例代码

程序员文章站 2024-03-31 13:20:22
1.spring boot拦截器默认有: handlerinterceptoradapter abstracthandlermapping userroleautho...

1.spring boot拦截器默认有:

handlerinterceptoradapter
abstracthandlermapping
userroleauthorizationinterceptor
localechangeinterceptor
themechangeinterceptor 

其中 localechangeinterceptor 和 themechangeinterceptor 比较常用。

2.实现自定义拦截器只需要3步:

1)、创建我们自己的拦截器类并实现 handlerinterceptor 接口。

2)、创建一个java类继承webmvcconfigureradapter,并重写 addinterceptors 方法。

3)、实例化我们自定义的拦截器,然后将对像手动添加到拦截器链中(在addinterceptors方法中添加)。

3.代码示例

indexinterceptor.java类代码:

package com.example.interceptor;
import javax.servlet.http.httpservletrequest;
import javax.servlet.http.httpservletresponse;
import org.springframework.web.servlet.handlerinterceptor;
import org.springframework.web.servlet.modelandview;
public class indexinterceptor implements handlerinterceptor{
  @override
  public void aftercompletion(httpservletrequest arg0, httpservletresponse arg1, object arg2, exception arg3)
      throws exception {
    system.out.println(">>>indexinterceptor>>>>>>>在整个请求结束之后被调用,也就是在dispatcherservlet 渲染了对应的视图之后执行(主要是用于进行资源清理工作)");
  }
  @override
  public void posthandle(httpservletrequest arg0, httpservletresponse arg1, object arg2, modelandview arg3)
      throws exception {
    system.out.println(">>>indexinterceptor>>>>>>>请求处理之后进行调用,但是在视图被渲染之前(controller方法调用之后)");
  }
  @override
  public boolean prehandle(httpservletrequest arg0, httpservletresponse arg1, object arg2) throws exception {
     system.out.println(">>>indexinterceptor>>>>>>>在请求处理之前进行调用(controller方法调用之前)");
     // 只有返回true才会继续向下执行,返回false取消当前请求
     return true;
  }
}

indexinterceptor2.java类代码:

package com.example.interceptor;
import javax.servlet.http.httpservletrequest;
import javax.servlet.http.httpservletresponse;
import org.springframework.web.servlet.handlerinterceptor;
import org.springframework.web.servlet.modelandview;
public class indexinterceptor2 implements handlerinterceptor{
  @override
  public void aftercompletion(httpservletrequest arg0, httpservletresponse arg1, object arg2, exception arg3)
      throws exception {
    system.out.println(">>>indexinterceptor2>>>>>>>在整个请求结束之后被调用,也就是在dispatcherservlet 渲染了对应的视图之后执行(主要是用于进行资源清理工作)");
  }
  @override
  public void posthandle(httpservletrequest arg0, httpservletresponse arg1, object arg2, modelandview arg3)
      throws exception {
    system.out.println(">>>indexinterceptor2>>>>>>>请求处理之后进行调用,但是在视图被渲染之前(controller方法调用之后)");
  }
  @override
  public boolean prehandle(httpservletrequest arg0, httpservletresponse arg1, object arg2) throws exception {
     system.out.println(">>>indexinterceptor2>>>>>>>在请求处理之前进行调用(controller方法调用之前)");
     // 只有返回true才会继续向下执行,返回false取消当前请求
     return false;
  }
}

simplewebappconfigurer.java类代码:

package com.example.config;
import org.springframework.context.annotation.configuration;
import org.springframework.web.servlet.config.annotation.interceptorregistry;
import org.springframework.web.servlet.config.annotation.webmvcconfigureradapter;
import com.example.interceptor.indexinterceptor;
import com.example.interceptor.indexinterceptor2;
//只要能被springboot扫描到即可
@configuration
public class simplewebappconfigurer extends webmvcconfigureradapter{
  @override
  public void addinterceptors(interceptorregistry registry) {
    // 多个拦截器组成一个拦截器链
    // addpathpatterns 用于添加拦截规则
    // excludepathpatterns 用户排除拦截
    registry.addinterceptor(new indexinterceptor()).addpathpatterns("/**");
    registry.addinterceptor(new indexinterceptor2()).addpathpatterns("/**");
    super.addinterceptors(registry);
  }
}

4.拦截器解析说明

prehandle**:预处理回调方法,实现处理器的预处理(如登录检查),第三个参数为响应的处理器(如我们上一章的controller实现);

返回值:true表示继续流程(如调用下一个拦截器或处理器);

false表示流程中断(如登录检查失败),不会继续调用其他的拦截器或处理器,此时我们需要通过response来产生响应;

posthandle**:后处理回调方法,实现处理器的后处理(但在渲染视图之前),此时我们可以通过modelandview(模型和视图对象)对模型数据进行处理或对视图进行处理,modelandview也可能为null。

aftercompletion**:整个请求处理完毕回调方法,即在视图渲染完毕时回调,如性能监控中我们可以在此记录结束时间并输出消耗时间,还可以进行一些资源清理,类似于try-catch-finally中的finally,但仅调用处理器执行链中prehandle返回true的拦截器的aftercompletion**。

以上所述是小编给大家介绍的spring boot的拦截器简单使用浅析,希望对大家有所帮助