Spring Boot构建interceptor简明教程

1 定义interceptor

直接上代码:

@Slf4j
@Component
public class MyInterceptor extends HandlerInterceptorAdapter {
    @Override
     public boolean preHandle(HttpServletRequest request, 
            HttpServletResponse response, Object object) throws Exception {
            //do something
            // return true, 正常流程执行
            // return false, 则中断执行
    }
  @Override
     public void postHandle(HttpServletRequest request, HttpServletResponse response, 
            Object object, ModelAndView model){
            //do something.
    }
     @Override
     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, 
            Object object, Exception arg3){
            //do something
        }   
}

“`

“`
这个三个方法的处理时机有所不同:
- preHandle: 发生在真正的处理逻辑之前
- postHandle: 发生在处理逻辑之后
- afterComplete: 整个请求处理完毕回调方法

2. 注册

@Configuration
public class AppConfig extends WebMvcConfigurerAdapter {
    @Autowired
    private MyInterceptor myInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(myInterceptor);
        registry.addInterceptor(localeChangeInterceptor());
    }


    @Bean
    public LocaleChangeInterceptor localeChangeInterceptor() {
        LocaleChangeInterceptor lci = new LocaleChangeInterceptor();
        lci.setParamName("lang");
        return lci;
    }
}

这里使用了两种声明和定义的方法,一种在直接基于@Autowired来实现注入,第二种是基于@Bean的方式,进行对象声明。

3. 应用场景

由于Interceptor的特殊性,则其具备以下使用场景:

  • 日志记录
    记录请求信息的日志,以便进行信息监控、信息统计、计算PV(Page View)等。

  • 权限检查
    如登录检测,进入处理器检测检测是否登录,如果没有直接返回到登录页面;

  • 性能监控
    可以通过拦截器在进入处理器之前记录开始时间,在处理完后记录结束时间,从而得到该请求的处理时间
  • 通用行为
    读取cookie得到用户信息并将用户对象放入请求,提取Locale、Theme信息等
Spring Boot provides a way to intercept method calls using Method Interceptor. Method Interceptor allows you to intercept a method call before and after the method is called. This is useful when you want to add some additional behavior to a method, such as logging or security checks. To create a method interceptor in Spring Boot, you need to create a class that implements the `MethodInterceptor` interface from the `org.aopalliance.intercept` package. This interface has two methods: 1. `Object invoke(MethodInvocation invocation) throws Throwable`: This method is called before and after the method is executed. The `MethodInvocation` object contains information about the method call and allows you to manipulate the method parameters and return value. 2. `MethodInterceptor getInterceptor()`: This method returns the actual interceptor that will be used to intercept the method call. Here's an example of how to create a method interceptor in Spring Boot: ```java import org.aopalliance.intercept.MethodInterceptor; import org.aopalliance.intercept.MethodInvocation; public class LoggingInterceptor implements MethodInterceptor { @Override public Object invoke(MethodInvocation invocation) throws Throwable { System.out.println("Before method call: " + invocation.getMethod().getName()); Object result = invocation.proceed(); System.out.println("After method call: " + invocation.getMethod().getName()); return result; } } ``` In this example, the `LoggingInterceptor` class implements the `MethodInterceptor` interface and overrides the `invoke` method to log the method name before and after the actual method call. To use this interceptor, you need to configure it in your Spring Boot application context: ```java import org.springframework.aop.framework.ProxyFactoryBean; @Configuration public class AppConfig { @Bean public LoggingInterceptor loggingInterceptor() { return new LoggingInterceptor(); } @Bean public MyService myService() { ProxyFactoryBean proxyFactoryBean = new ProxyFactoryBean(); proxyFactoryBean.setTarget(new MyServiceImpl()); proxyFactoryBean.setInterceptorNames("loggingInterceptor"); return (MyService) proxyFactoryBean.getObject(); } } ``` In this example, the `loggingInterceptor` bean is created and configured to intercept method calls. The `MyService` bean is also created and configured to use the `loggingInterceptor` for method interception. When a method is called on the `MyService` bean, the `LoggingInterceptor` will intercept the method call and log the method name before and after the actual method call.
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值