SpringBoot中拦截器的基本使用

【拦截器的介绍】

拦截器是类似于Servlet的Filter，对一次请求进行拦截，然后可以处理一些校验之类的工作，作用还是挺大的。

【SpringBoot中拦截器的使用】

在SpringBoot中使用拦截器非常简单。总的来讲就只有以下两个步骤：
1.让一个Bean继承HandlerInterceptorAdapter类，里面有两个常用的方法preHandle, postHandle。一般将它们两个重写，然后我们就得到了一个拦截器Bean。
2.创建一个配置类，实现WebMvcConfigurer接口，重写其中的addInterceptors方法，这样就相当于告诉了spring框架这个Bean是我写好的一个拦截器。

在我上次的项目基础上继续实验：https://blog.csdn.net/weixin_40163242/article/details/99739155

一、实现一个拦截器的Bean

很简单，在主包下创建一个名为Interceptor的包，在里面创建一个名为DemoInterceptor的类，其继承HandlerInterceptorAdapter这个类。

然后重写方法，代码如下：

package com.example.demo.interceptor;

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

import org.springframework.lang.Nullable;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

//这个Bean继承HandlerInterceptorAdapter这个类，然后将其加入到Spring容器中即可，这就是我们的自定义拦截器
public class DemoInterceptor extends HandlerInterceptorAdapter{
	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
			throws Exception {
		System.out.println("preHandle拦截器方法进行处理...");
		return true;
	}
	@Override
	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
			@Nullable ModelAndView modelAndView) throws Exception {
		System.out.println("postHandle拦截器方法进行处理...");
	}
}

为了代码的简洁，我们就打印两条信息，模拟拦截器实现的功能即可。

二、创建配置类，在配置类中加入这个拦截器

在新建的configuration包下创建WebConfig配置类

package com.example.demo.configuration;

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.WebMvcConfigurer;

import com.example.demo.interceptor.DemoInterceptor;

//这里采用Java配置方式
@Configuration
public class WebConfig implements WebMvcConfigurer{
	
	@Bean
	public DemoInterceptor demoInterceptor() {
		return new DemoInterceptor();
	}
	
	@Override
	public void addInterceptors(InterceptorRegistry registry) {
		registry.addInterceptor(demoInterceptor()).addPathPatterns("/demo/index");
	}
}

稍微解释一下，@Configuration注解表明我的WebConfig类是一个配置类
@Bean注解表明该方法的返回值DemoInterceptor对象是一个交给Spring容器管理的Bean。
这种注入Bean的方式，是Java配置方式，也是spring4.x推荐的配置方式
Java配置方式的效果和普通注解（如：@Service, @Component注解）是一样的，习惯上，全局的配置我们以后就采用Java配置方式，业务Bean的配置使用注解配置。

addInterceptors方法中可能也要解释一下，最后调用addPathPatterns方法是控制拦截的请求，只有请求为/demo/index的时候才会启用拦截器，如果是别的请求，拦截器是无效的。

三、验证

现在拦截器的代码就写完了，我们验证一下。

先请求/demo/index：

看看控制台是否有拦截器的代码输出：

好的，确实进行了拦截处理。

那么我们再看看其他的请求会不会也触发拦截器呢?
我们重启一下，请求/demo/show：

那么此时的后台：

可以看到，没有任何的输出。说明我们的拦截器确实是按要求只拦截/demo/index请求的，其他的请求不会拦截

【补充：】

大家最后验证的时候，可能出现拦截器写好了，但最后就是执行不了拦截，关于这类问题推荐一个博客，里面有解决：
https://blog.csdn.net/u012862619/article/details/81557779