SpringBoot之HandlerInterceptor拦截器

时间:2021-7-3 作者:qvyue

简介

拦截器,最常用的登录拦截、权限校验、防重复提交、打印日志、出入参参数处理,可以说拦截器+解析器最佳拍档。

实现方式

  1. 自定义类要实现Spring 的HandlerInterceptor 接口
  2. 继承抽象类HandlerInterceptorAdapter

拦截器实现

package com.sharding.test.aop;

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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

/**
 * @author leijie.gao
 * @version 1.0.0
 * @ClassName TestHandler.java
 * @Description TODO
 * @createTime 2021年06月03日 17:31:00
 */
@Slf4j
@Component
public class TestHandler implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        log.info("开始预处理【在业务处理器处理请求之前被调用】");
        String token = request.getHeader("Authorization");
        log.info("获取token:{}",token);
        if(StringUtils.isBlank(token)){
            log.error("获取token失败");
        }
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("在业务处理器处理请求执行完成后,生成视图之前执行,使用频率少");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("后处理【,生成视图之前执行,使用频率少");
    }
}

配置拦截器(一)

package com.sharding.test.config;

import com.sharding.test.aop.TestHandler;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * @author leijie.gao
 * @version 1.0.0
 * @ClassName WebAppConfiger.java
 * @Description TODO
 * @createTime 2021年06月03日 19:29:00
 */
@Configuration
public class WebAppConfiger implements WebMvcConfigurer {
    @Autowired
    private TestHandler testHandler;

//  addPathPatterns("/**")一定要两个*,实测一个/*不生效,其中/**表示当前目录以及所有子目录(递归),/*表示当前目录,不包括子目录
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(testHandler).addPathPatterns("/**");
    }
}

配置拦截器(二)

package com.sharding.test.config;

import com.sharding.test.aop.TestHandler;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ViewResolverRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;

/**
 * @author leijie.gao
 * @version 1.0.0
 * @ClassName WebMvcConfig.java
 * @Description TODO
 * @createTime 2021年06月03日 20:10:00
 */
@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
    /** 添加拦截器 **/
    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new TestHandler()).addPathPatterns("/*");
    }
}

以前是继承WebMvcConfigurerAdapter类 不过springBoot2.0以上 WebMvcConfigurerAdapter 方法过时,有两种替代方案:
1、继承WebMvcConfigurationSupport
2、实现WebMvcConfigurer
但是继承WebMvcConfigurationSupport会让Spring-boot对mvc的自动配置失效。根据项目情况选择。现在大多数项目是前后端分离,并没有对静态资源有自动配置的需求所以继承WebMvcConfigurationSupport也可以。

/** 解决跨域问题 **/
public void addCorsMappings(CorsRegistry registry) ;
/** 添加拦截器 **/
void addInterceptors(InterceptorRegistry registry);

/** 这里配置视图解析器 **/
void configureViewResolvers(ViewResolverRegistry registry);

/** 配置内容裁决的一些选项 **/
void configureContentNegotiation(ContentNegotiationConfigurer configurer);

/** 视图跳转控制器 **/
void addViewControllers(ViewControllerRegistry registry);

/** 静态资源处理 **/
void addResourceHandlers(ResourceHandlerRegistry registry);

/** 默认静态资源处理器 **/
void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer);

结束语

到此拦截器就差不多了,最基础拦截是可以了。

声明:本文内容由互联网用户自发贡献自行上传,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任。如果您发现有涉嫌版权的内容,欢迎发送邮件至:qvyue@qq.com 进行举报,并提供相关证据,工作人员会在5个工作日内联系你,一经查实,本站将立刻删除涉嫌侵权内容。