Intellij IDEA中Mybatis Mapper自動註入警告的6種解決方案

相信使用Mybaits的小夥伴們一定會經常編寫類似如下的程式碼：

可以看到 userMapper 下有個紅色警告。雖然程式碼本身並沒有問題，能正常執行，但有個警告總歸有點噁心。本文分析原因，併列出解決該警告的幾種方案。

原因

眾所周知，IDEA是非常智慧的，它可以理解Spring的背景關係。然而 UserMapper 這個介面是Mybatis的，IDEA理解不了。

而 @Autowired 註解，預設情況下要求依賴物件（也就是 userMapper ）必須存在。而IDEA認為這個物件的實體/代理是個null，所以就友好地給個提示。

解決方案

方法1：為 @Autowired 註解設定required = false

使用 @Autowired 註解時，若希望允許null值，可設定required = false，像這樣：

1. @Autowired(required = false)
2. private UserMapper userMapper;

這樣就不會有警告了。原因很好理解：IDEA認為userMapper是個null，給了警告；加上required = false後，使用 @Autowired 註解不再去校驗userMapper是否存在了。也就不會有警告了。

總結：這種方式有點蛋疼。一個龐大的既有專案，可能到處都在取用Mapper，總不能到處都補上 required = false 吧……而且對於新手/新員工，很難一眼看懂加required = false屬性只是為瞭解決IDEA的警告。

方法2：用 @Resource 替換 @Autowired

像這樣：

1. @Resource
2. private UserMapper userMapper;

這樣也不會再有討厭的警告。如果你對原因感興趣，不妨瞭解一下《@Autowired 與@Resource的區別》[1]

總結：這種方式挺贊，但如果一個專案已經大量使用@Autowired，然後為了個警告到處改成@Resource，也有點蛋疼。

方法3：在Mapper介面上加上@Repository註解

像這樣：

1. @Repository
2. public interface UserMapper extends Mapper<User> {

這樣也能讓你的

1. @Autowired
2. private UserMapper userMapper;

不再報錯。

當然，如果你用@Component替換@Repository也是可以的。原理大致：IDEA不是認為 userMapper 是個null嘛…加個@Repository註解騙一下IDEA就OK了……

總結：這種方式比較贊，改動小，也簡單，我比較喜歡。

方法4：用Lombok

像這樣：

1. @Service
2. @RequiredArgsConstructor(onConstructor = @__(@Autowired))
3. public class TestService {
4. private final UserMapper userMapper;
5. ...
6. }

Lombok生成的程式碼是這樣的：

1. @Service
2. public class TestService {
3. private final UserMapper userMapper;
4. @Autowired
5. public TestService(final UserMapper userMapper) {
6. this.userMapper = userMapper;
7. }
8. ...
9. }

但如果自己手寫成Lombok生成的程式碼，IDEA依然會給你報警告 。我猜，應該是IDEA的Lombok外掛把IDEA搞懵逼了…所以不提示了…

總結 ：這是我目前最喜歡的方式。原因有2：

•Spring官方並不建議直接在類的field上使用@Autowired註解，原因詳見：《Why field injection is evil》[2] ，用本方法可將field註入程式設計構造方法註入，Spring是比較推薦的。•體現了Lombok的優勢，簡化了你的程式碼。而且你也不用在每個field上都加上@Autowired註解了。

不過這種方式也有缺點：那就是如果你類之間的依賴關係比較複雜，特別是存在迴圈依賴(A取用B，B取用A，或者間接取用)時，取用將會啟動不起來……這其實是構造方法註入方式的缺點。

方法5：把IDEA的警告關閉掉

個人沒試過，也沒有動力去試。沒有提示的IDEA是沒有靈魂的，我從來不去修改IDEA的任何警告設定。

方法6：安裝mybatis plugin

據說安裝mybatis plugin可以解決該問題。不過這個外掛是收費的，我沒有錢去嘗試。有錢的讀者們可以告訴我一下是不是真的。

總結

以上是解決問題的6種方法。問題本身其實比較簡單，但其實隱藏的知識點其實挺多的，例如：

•@Autowired和@Resource有什麼區別•為什麼Spring不建議使用field方式註入•@Repository、@Componnt、@Controller、@Service有什麼區別

總之，硬貨有時候就隱藏在很low的問題之下，哈哈哈。