本文用简洁的代码构建springboot拦截器。 拦截器的使用很简单。 定义自己的拦截器，添加到配置中即可使用。 为了方便，之后导入了评论。
目录和摘要
概要
前提条件：访问项目的控制器必须进行“token身份验证”，但登录等方法除外。
项目结构：
TokenInterceptor.java自定义拦截器
添加InterceptorConfig.java拦截器进入项目
NoNeedToken.java自定义注释
test控制器. Java测试接口
目录
1、定制窃听器
在TokenInterceptor.java中输入以下代码： 以下代码生成一个阻止程序，用于在请求到达控制器之前阻止它
import com.Alibaba.fast JSON.JSON object；
importorg.spring framework.lang.nullable；
importorg.spring framework.stereotype.com ponent；
importorg.spring framework.web.servlet.handler interceptor；
importorg.spring framework.web.servlet.modelandview；
import javax.servlet.http.http servlet请求；
import javax.servlet.http.http无servlet保罗；
import java.io.PrintWriter；
import java.util.Arrays；
import java.util.List；
@Component
publicclasstokeninterceptorimplementshandlerinterceptor {
//假设现在的token中有以下数据
listtokenlist=arrays.as list (' 111 '、' 222 '、' 333 ' )；
//因为该方法是在访问接口之前执行的，所以您只需要在此编写用于验证登录状态的业务逻辑，就可以在用户调用指定接口之前验证登录状态
@Override
publicbooleanprehandle (httpservletrequestrequest，HttpServletResponse response，对象处理程序) throws Exception {
//设定返回json格式，使用UTF-8
response.setcharacterencoding (utf-8 )；
response.set content type (应用程序/JSON； charset=utf-8 '；
string token=request.get header (' token )；
打印机输出；
//然后写下你的判断逻辑。 返回真可以通过阻止程序继续访问控制器。 返回假不通过
if(token==null|！ Tokenlist.contains(Token ) ) }
//失败后返回{state:'false '，msg:'token is null or wrong'}
JSONObject res=new JSONObject (；
RES.put(state，) false )；
RES.put('msg )、' token is null or wrong )；
out=response.getWriter (；
out.append(RES.tostring ) )；
返回假；
}
//否则返回true进入控制器
返回真；
}
publicvoidposthandle (httpservletrequestrequest，http servlet响应响应，对象处理程序，@ nullablemodelandviewmodelandler
}
publicvoidaftercompletion (httpservletrequestrequest，http servlet响应响应，对象处理程序，@Nullable Exception ex )
ows Exception {}
}
2、载入拦截器
将以下代码写在InterceptorConfig.java中 ，使用addInterceptors方法将我们定义的拦截器添加进入项目中
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import javax.annotation.Resource;
@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
@Resource
TokenInterceptor tokenInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
// 设置所有的路径都要进行拦截，除了/test/login
registry.addInterceptor(tokenInterceptor).addPathPatterns("/**")
.excludePathPatterns("/test/login");
}
}
3、测试成功
将如下代码到TestController中，用于测试拦截器效果
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.HashMap;
import java.util.Map;
@RestController
// canload用于检测拦截器是否正常工作
@RequestMapping("/test")
public class TestController {
@RequestMapping(value = "/canload")
public Map canLoad(){
Map res = new HashMap<>();
res.put("state", "ok");
res.put("msg", "you can load");
return res;
}
// login模拟登录时token返回
@RequestMapping(value = "/login")
public String login(){
return "111";
}
}
可以看到如下结果
①直接登录成功
②直接访问canload失败
③使用postman，带上token进行访问成功
4、使用注解(Annotation)进行选择
你也可以使用注解来代替第三步配置中的excludePathPatterns(), 来实现对于指定方法和controller的免token访问，新建一个NoNeedToken.java注解，在拦截器里判断注解存在时，直接return true放行
NoNeedToken.java
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.METHOD, ElementType.TYPE}) //注解的范围是类、接口、枚举的方法上
@Retention(RetentionPolicy.RUNTIME)//被虚拟机保存，可用反射机制读取
public @interface NoNeedToken {
}
响应的更改自定义拦截器的 preHandle方法，和拦截器配置
① 自定义拦截器
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
response.setCharacterEncoding("UTF-8");
response.setContentType("application/json; charset=utf-8");
String token = request.getHeader("token");
PrintWriter out;
// 对于注解的判断---------------------------------------------------
HandlerMethod handlerMethod = (HandlerMethod) handler;
if(handlerMethod.getMethodAnnotation(NoNeedToken.class)!=null || handlerMethod.getBeanType().isAnnotationPresent(NoNeedToken.class)){
// 如果自己拥有NoNeedToken标注或者所属的class拥有NoNeedToken 就直接放行
return true;
}
//------------------------------------------------------------------
if (token == null || !tokenList.contains(token)) {
JSONObject res = new JSONObject();
res.put("state","false");
res.put("msg","token is null or wrong");
out = response.getWriter();
out.append(res.toString());
return false;
}
return true;
}
② 去除拦截器配置中的去除项
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(tokenInterceptor).addPathPatterns("/**");
// .excludePathPatterns("/test/login");
}
③ 在测试的login方法上添加注释
@RequestMapping(value = "/login")
@NoNeedToken
public String login(){
return "111";
}
修改完成之后效果和上面相同
5、常见问题
1.这个自定义注解的那些@Target，@Retention，@Documented是什么意思
https://blog.csdn.net/zt15732625878/article/details/100061528，这篇文章写的很详细了
2.为什么我的注解加了，还是被拦截了
一般出现这种情况是类与方法的获取注解方式不同，在本文中作者使用了下面的一句话来表述
handlerMethod.getMethodAnnotation(NoNeedToken.class)!=null || handlerMethod.getBeanType().isAnnotationPresent(NoNeedToken.class)
其中handlerMethod.getMethodAnnotation(NoNeedToken.class)!=null是对于方法的
而handlerMethod.getBeanType().isAnnotationPresent(NoNeedToken.class)是对于类的
结语：希望对大家有帮助