Spring拦截服务【二】(SpringBoot使用自定义拦截器Interceptor)

最新推荐文章于 2025-01-01 16:12:42 发布

神马_逗_浮云

最新推荐文章于 2025-01-01 16:12:42 发布

阅读量731

点赞数

分类专栏： springboot 文章标签： springboot

springboot 专栏收录该内容

7 篇文章

订阅专栏

本文介绍如何在SpringBoot中实现自定义拦截器，并详细解释了其工作原理及配置过程。

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

SpringBoot使用自定义拦截器，方法都有注释：

package com.yhn.web.interceptor;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Date;
/**
 * 自定义拦截器
 * Created by yhn on 2017/9/21.
 */
@Component
public class TimeInterceptor implements HandlerInterceptor{
    @Override
    //在访问Controller某个方法之前这个方法会被调用。
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handle) throws Exception {
        System.out.println("preHandle");
        System.out.println(((HandlerMethod)handle).getBean().getClass().getName());
        System.out.println(((HandlerMethod)handle).getMethod().getName());
        request.setAttribute("startTime",new Date().getTime());
        return true;   //false则表示不执行postHandle方法
    }
    @Override
    //preHandle方法处理之后这个方法会被调用，如果控制器Controller出现了异常，则不会执行此方法
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle");
        Long start = (long)httpServletRequest.getAttribute("startTime");
        System.out.println("time interceptor 耗时(postHandle)："+(new Date().getTime()-start));
    }
    @Override
    //不管有没有异常，这个afterCompletion都会被调用。
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
        System.out.println("afterCompletion");
        Long start = (long)httpServletRequest.getAttribute("startTime");
        System.out.println("time interceptor 耗时(afterCompletion)："+(new Date().getTime()-start));
        System.out.println("异常?:"+e);   //没有异常则为空，声明一下，如果有用@ControllerAdvice捕获异常，将拿不到异常信息
    }
}

写好自定义拦截器后，需要配置进Spring

首先要写一个配置类，继承WebMvcConfigurerAdapter。
我们的自定义拦截器类已经@Component，就是当作Spring的一个组件了，我们可以直接将其通过@Autowired注入进来。
覆写addInterceptors方法，将拦截器注册进去。

package com.yhn.web.config;

import com.yhn.web.filter.TimeFilter;
import com.yhn.web.interceptor.TimeInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import java.util.ArrayList;
import java.util.List;
/**
 * Created by yhn on 2017/12/3.
 */
@Configuration
public class WebConfig extends WebMvcConfigurerAdapter{
    @Autowired
    private TimeInterceptor timeInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(timeInterceptor);
    }
}