SpringBoot之拦截器

我们为什么要使用拦截器？拦截用户的每一个请求，在真正开始处理业务之前做一些附属逻辑，比如日志记录、登录验证等。下面我们来看看SpringBoot中的拦截器是如何做的？

1.定义拦截器

继承HandlerInterceptorAdapter类，该接口有三个方法，分别如下：

a.preHandle：预处理回调方法，实现处理器的预处理（如请求执行前的日志记录、登录检查）

    返回值：

        true - 表示继续流程（如调用下一个拦截器或处理器)；

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

b.postHandle：后处理回调方法，实现处理器的后处理（但在渲染视图之前），此时我们可以通过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView也可能为null；

c.afterCompletion：整个请求处理完毕回调方法，即在视图渲染完毕时回调。

2.注册拦截器

添加拦截器配置类，继承WebMvcConfigurer类，使用@Configuration注解；注册一个或多个拦截器，多个拦截器便构成了拦截器链，执行顺序按注册的先后顺序执行。

3.实例

package com.tufire.seller.interceptors;

import com.tufire.common.util.NetworkUtil;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

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

/**
 * 对所有的控制器的请求处理方法执行日志记录，包括对请求参数的获取以及记录
 * 
 *
 */
@Slf4j
@Configuration
public class LogInterceptor extends HandlerInterceptorAdapter {
	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
			throws Exception {
		try {
			HandlerMethod handlerMethod = (HandlerMethod) handler;
			ApiOperation apiOperation = handlerMethod.getMethodAnnotation(ApiOperation.class);

			if (apiOperation != null) {
				log.info(apiOperation.value() + "开始...");
				log.info("请求参数:{}", NetworkUtil.getParameterStringByRequest(request));
			}
		}catch (Exception e) {
			log.info("日志拦截出现异常：{}", e.getMessage());
		}

		return true;
	}
}

package com.tufire.seller.config;

import com.tufire.seller.interceptors.LogInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 *拦截器配置类
 */
@Configuration
public class InterceptorConfig implements WebMvcConfigurer {

    @Autowired
    private LogInterceptor logInterceptor;

    /**
     * 注册自定义的拦截器类
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 加入自定义拦截器，这里可以根据实际需要对各个url添加不同的拦截器
        registry.addInterceptor(logInterceptor).addPathPatterns("/**/**").excludePathPatterns("/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui.html/**");
    }
}