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

相信使用Mybaits的小夥伴們必定會常常編寫相似以下的代碼：

 

能夠看到 userMapper 下有個紅色警告。雖然代碼自己並無問題，能正常運行，但有個警告總歸有點噁心。本文分析緣由，並列出解決該警告的幾種方案。

緣由

衆所周知，IDEA是很是智能的，它能夠理解Spring的上下文。然而 UserMapper 這個接口是Mybatis的，IDEA理解不了。

而 @Autowired 註解，默認狀況下要求依賴對象（也就是 userMapper ）必須存在。而IDEA認爲這個對象的實例/代理是個null，因此就友好地給個提示。

解決方案

方法1：爲 @Autowired 註解設置required = false

使用 @Autowired 註解時，若但願容許null值，可設置required = false，像這樣：

@Autowired(required = false)
private UserMapper userMapper;

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

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

方法2：用 @Resource 替換 @Autowired

像這樣：

@Resource
private UserMapper userMapper;

這樣也不會再有討厭的警告。若是你對緣由感興趣，不妨瞭解一下《@Autowired 與@Resource的區別》

總結：這種方式挺贊，但若是一個項目已經大量使用@Autowired，而後爲了個警告處處改爲@Resource，也有點蛋疼。

方法3：在Mapper接口上加上@Repository註解

像這樣：

@Repository
public interface UserMapper extends Mapper<User> {
}

這樣也能讓你的

@Autowired
private UserMapper userMapper;

再也不報錯。

固然，若是你用@Component替換@Repository也是能夠的。原理大體：IDEA不是認爲 userMapper 是個null嘛…加個@Repository註解騙一下IDEA就OK了……

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

方法4：用Lombok

像這樣：

@Service
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
public class TestService {
    private final UserMapper userMapper;
    ...
}

Lombok生成的代碼是這樣的：

@Service
public class TestService {
    private final UserMapper userMapper;
    @Autowired
    public TestService(final UserMapper userMapper) {
        this.userMapper = userMapper;
    }
    ...
}

但若是本身手寫成Lombok生成的代碼，IDEA依然會給你報警告 。我猜，應該是IDEA的Lombok插件把IDEA搞懵逼了…因此不提示了…

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

• Spring官方並不建議直接在類的field上使用@Autowired註解，緣由詳見：《Why field injection is evil》 ，用本方法可將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有什麼區別