一、如何實現攔截器
在Spring Boot項目中，攔截器經常被用來做登陸驗證，日志記錄等操作。攔截器是Spring提供的，所以可以將攔截器注成bean，由IOC容器來管理。實現攔截器的方式很簡單，主要由以下兩個步驟：
- 自定義攔截器類實現
HandlerInterceptor接口 - 自定義WebMvc配置類實現
WebMvcConfigurer接口，添加自定義攔截器類
簡要實現代碼如下：
自定義攔截器 LoginInterceptor：
public class LoginInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
String token = request.getHeader("token");
if(StringUtils.isEmpty(token)){
...
return false;
}
return true;
}
}
配置自定義攔截器：
@Configuration
public class WebConfiguration implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LoginInterceptor())
// 攔截的請求
.addPathPatterns("/**")
// 不用攔截的請求
.excludePathPatterns("/login");
}
}
這個攔截器的主要作用就是攔截所有訪問請求，驗證所帶token是否有效，當token驗證成功后，才能訪問我們的業務接口。這時候就需要提供一個驗證token有效性的接口，在攔截器中驗證token，由于攔截器是Spring提供的，因此很容易想到使用@Component注解將攔截器注成一個 bean。然后使用@Autowired注解將驗證token的類注入到攔截器進行驗證。
改造完的代碼如下：
驗證token接口類：
@Component
public class TokenUtil {
/**
* 驗證token 是否有效
*/
public boolean checkToken(String token){
...
}
}
改造完的攔截器代碼如下：
@Component
public class LoginInterceptor implements HandlerInterceptor {
@Autowired
private TokenUtil tokenUtil;
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
if(!tokenUtil.checkToken(token)){
...
return false;
}
return true;
}
}
調用接口時發現，TokenUtil并沒有被注入進來！明明代碼寫的沒問題，為什么不能正常注入TokenUtil呢？
仔細觀察我們自定義的配置類WebConfiguration，在添加攔截器的時候用的是new LoginInterceptor()，如果想要攔截器生效，必須將攔截器配置到WebMvc的配置類中，就是我們自定義的WebConfiguration類。現在添加攔截器的時候是 new 了一個攔截器，也就是說并沒有將攔截器托管給IOC容器，所以就無法引入Spring的bean對象。
二、如何將攔截器托管給IOC容器
解決問題的思路也很簡單，就是將攔截器也托管給IOC容器，這樣容器內的對象就可以相互注入了。總共有以下三種方式進行處理上述問題。
2.1 在WebConfiguration注入攔截器
攔截器代碼不變，在攔截器上使用@Component，同時在WebConfiguration中使用@Autowired注解將攔截器注入。
攔截器代碼：
@Component
public class LoginInterceptor implements HandlerInterceptor {
}
配置類代碼：
@Configuration
public class WebConfiguration implements WebMvcConfigurer {
@Autowired
private LoginInterceptor loginInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(loginInterceptor);
}
}
2.2 在WebConfiguration將攔截器注成bean
攔截器無需增加@Component注解，在WebConfiguration類中使用@Bean注解將攔截器注成bean。
攔截器代碼：
public class LoginInterceptor implements HandlerInterceptor {
}
配置類代碼：
@Configuration
public class WebConfiguration implements WebMvcConfigurer {
@Bean
public LoginInterceptor loginInterceptor(){
return new LoginInterceptor();
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor( loginInterceptor());
}
}
2.3 通過構造器處理
思路是在WebConfiguration類中注入需要的驗證token的業務類，然后在初始化攔截器的時候將業務類通過構造器帶入攔截器中，這樣就不用把攔截器注成Spring Bean對象了。
攔截器代碼：
public class LoginInterceptor implements HandlerInterceptor {
private TokenUtil tokenUtil;
public LoginInterceptor(TokenUtil tokenUtil) {
this.tokenUtil = tokenUtil;
}
}
配置類代碼：
@Configuration
public class WebConfiguration implements WebMvcConfigurer {
@Autowired
private TokenUtil tokenUtil;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LoginInterceptor(tokenUtil));
}
}
三、總結
網上關于攔截器的代碼基本都是通過new一個攔截器進行配置的，這時候就會出現無法注入其他bean的情況。很多人想當然地直接在攔截器加@Component注解使其成為一個bean對象。這是一種錯誤的做法。我們需要保證的是在WebMvc配置類中添加的攔截器是Spring 的一個bean對象，也就是說我們需要將攔截器注成一個bean，同時將這個bean添加的WebMvc配置類中。
