实现SpringBoot自定义拦截器

品茗IT

发布于 2023-10-22 15:12:50

2040

发布于 2023-10-22 15:12:50

文章被收录于专栏：品茗IT品茗IT

实现SpringBoot自定义拦截器

一、概述

SpringMVC 中的Interceptor 拦截器的主要作用就是拦截用户的 url 请求,并在执行 handler 方法的前中后加入某些特殊请求,类似于 servlet 里面的过滤器.

那么，为什么选择使用拦截器，而不用过滤器呢？

过滤器（Filter）是Java EE体系中的组件，无论是否使用其它框架都可以使用过滤器来实现拦截的效果。
拦截器（Interceptor）是Spring MVC框架中的组件，只有项目中使用了Spring MVC框架才可以使用拦截器。
过滤器是运行在所有Servlet之前的，拦截器是运行在DispatcherServlet之后的。

通常在使用Spring MVC框架后，推荐使用拦截器来实现登录的处理（其实就是中文意义上的拦截和过滤来区分）。

二、定义拦截器

实现一个拦截器，需要继承HandlerInterceptorAdapter，或者实现HandlerInterceptor。 AuthenticationInterceptor：

import java.lang.reflect.Method;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;


@Component
public class AuthenticationInterceptor extends HandlerInterceptorAdapter {
    private final static Logger logger = LoggerFactory.getLogger(AuthenticationInterceptor.class);

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if(!(handler instanceof HandlerMethod)){
            response.setStatus(404);
            // 拦截之后应该返回公共结果, 这里没做处理
            return false;
        }
        // 将handler强转为HandlerMethod, 前面已经证实这个handler就是HandlerMethod
        HandlerMethod handlerMethod = (HandlerMethod) handler;
        // 从方法处理器中获取出要调用的方法
        Method method = handlerMethod.getMethod();
        logger.info("拦截到url:{}", method.getName());
        System.out.println("拦截到了。。。。。");
        // 获取出方法上的Access注解
        return true;
    }
}

三、拦截器配置

注册拦截器，并配置拦截的url。

InterceptorConfig：

import javax.annotation.Resource;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import com.cff.springbootwork.mybatis.interceptor.AuthenticationInterceptor;

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {

    @Resource
    private AuthenticationInterceptor authenticationInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(authenticationInterceptor).addPathPatterns("/**");
    }
}

SpringBoot上配置拦截器就是这么简单。

本文参与腾讯云自媒体分享计划，分享自作者个人站点/博客。

原始发表：2021-07-03 ，如有侵权请联系 cloudcommunity@tencent.com 删除

import