為什麼你寫的攔截器注入不了 Java bean？
阿新 • • 發佈：2020-11-23
## 一、如何實現攔截器
在Spring Boot專案中，**攔截器**經常被用來做登陸驗證，日誌記錄等操作。攔截器是Spring提供的，所以可以將攔截器注成bean，由IOC容器來管理。實現攔截器的方式很簡單，主要由以下兩個步驟：
1. 自定義攔截器類實現`HandlerInterceptor`介面
2. 自定義WebMvc配置類實現`WebMvcConfigurer`介面，新增自定義攔截器類
簡要實現程式碼如下：
自定義攔截器 `LoginInterceptor`：
```java
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;
}
}
```
配置自定義攔截器：
```java
@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介面類：
```java
@Component
public class TokenUtil {
/**
* 驗證token 是否有效
*/
public boolean checkToken(String token){
...
}
}
```
改造完的攔截器程式碼如下：
```java
@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`註解將攔截器注入。
攔截器程式碼：
```java
@Component
public class LoginInterceptor implements HandlerInterceptor {
}
```
配置類程式碼：
```java
@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。
攔截器程式碼：
```java
public class LoginInterceptor implements HandlerInterceptor {
}
```
配置類程式碼：
```java
@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物件了。
攔截器程式碼：
```java
public class LoginInterceptor implements HandlerInterceptor {
private TokenUtil tokenUtil;
public LoginInterceptor(TokenUtil tokenUtil) {
this.tokenUtil = tokenUtil;
}
}
```
配置類程式碼：
```java
@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配置類中。
## 四、點關注、不迷路
如果覺得文章不錯，歡迎**關注**、**點贊**、**收藏**，你們的支援是我創作的動力，感謝大家。
如果文章寫的有問題，請不要吝惜文筆，歡迎留言指出，我會及時核查修改。
如果你還想看到更多別的東西，可以微信搜尋「**Java旅途**」進行關注。「**Java旅途**」目前已經整理各種中介軟體的使用教程及各類Java相關的面試題。掃描下方**二維碼**進行關注就可以得到這些資料。
![](https://img2020.cnblogs.com/blog/1719198/202011/1719198-20201123085057788-13320971