背景

之前幫同事解決mybatis Invalid bound statement (not found):這個問題，最近看到很多人也遇到這樣的問題，所以就記錄一下出現(xiàn)這種情況的幾種情況。

問題分析

出現(xiàn) Invalid bound statement (not found) 這個錯誤的原因：

是根據(jù) mapper接口的全路徑 以"."(點號)與方法名拼接成字符串，作為唯一key（下面將以key代替 ） 到 Map<String, MappedStatement> mappedStatements （后續(xù)已map 代替該對象）中去獲取對應(yīng)的MappedStatement, 如果獲取不到就報這個錯誤。

根據(jù)上面的流程，也就解釋了為什么mapper 中的方法不能重載的原因。因為獲取MappedStatement 是根類和方法名有關(guān)，與參數(shù)無關(guān)。所以不能重載。

繼續(xù)分析Invalid bound statement 這個錯誤，出現(xiàn)這個錯誤是因為獲取不到MappedStatement，也就是說在map 容器中根據(jù)key 去獲取值，沒有獲取到。

解決

那么問題來了，什么情況下在map中根據(jù)key 獲取不到值呢？

其實獲取不到就兩種情況。

• 第一種情況： 就是map 是一個空集合。
• 第二種情況：map中沒有這個key （也就是說key值不對）

什么情況下mappedStatements 這個map 為空呢？

回答這個問題要明白mybatis 的原理。

在項目啟動的過程中，會掃描并解析掃描到的mapper.xml 文件，將xml文件的namespace 與select 、update 、insert、delete 標簽的id 以 namespace.id 的形式組成一個唯一的key ,將sql語句封裝成一個MappedStatement 對象作為value存儲在mappedStatements 這個map 集合中。

所以當map集合為空，說明mapper.xml 沒有被容器掃描到。

那什么情況下項目中有mapper.xml 文件卻沒有被掃描到呢？

回答這個問題，要清楚mybatis mapper.xml 文件的加載目錄。

當我們沒有在配置文件中配置指定目錄或者配置配置錯誤的文件地址。

 mybatis:
  mapper-locations: classpath:mybatis/mapper/*.xml

在容器啟動的時候會到配置文件指定的目錄和mapper 接口所在的包中查找，如果查找不到map集合就是空的。

這時候有的人該問

配置文件配置的mapper.xml 文件地址沒有錯誤，為什么map 還是空的？

如果出現(xiàn)這個問題，我們需要排查一下target 目錄中是否有mapper.xml 文件 因為maven 編譯打包 會將代碼編譯打包成target文件中，程序運行也是讀取加載該目錄下的文件，而不是我們項目目錄。

這時需要在pom 文件build中添加如下配置

<resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.xml</include>
                    <include>**/*.yml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
        </resources>`

map為空總結(jié)

1、 檢查mapper的xml文件 是否在mapper 接口包中。如果不在，說明指定了目錄（目前一般都是在resource 資源目錄下新建文件夾） 如果指定了目錄 需要在配置文件中配置指定的目錄。

注意：在resource 目錄下創(chuàng)建多級目錄時，要一層一層創(chuàng)建，不要像創(chuàng)建Java目錄一下以"."隔開，這樣是不對的。

2、項目配置沒有問題，還出現(xiàn)這個問題，排查一下target 目錄中是否有mapper.xml 。沒有則說明maven 打包的時候沒有將xml 文件打包進jar中，需要在pom中添加resource配置信息。

下面來說說第二種情況：key 值不正確

1、這種情況 需要排查mapper 接口全路徑 與 mapper xml 文件中的namespace 配置是否一致。

這里有個驗證技巧：

按住Ctrl 鍵 鼠標點擊接口名 看看是否能正常跳轉(zhuǎn)到接口中，如果能正常跳轉(zhuǎn)，則說明映射成功，如果不能跳轉(zhuǎn)，則說明namespace 配置的不正確，需要修改。

2、隱射成功，下一步拷貝接口中的方法名 到xml 文件中查找是否有對應(yīng)的sql，排查xml sql 的id值是否與方法名一致。（注意空格）

這里也有一個排錯技巧：

在idea 上安裝 Free Mybatis plugin插件，這樣 按住Ctrl 鍵 點擊id 看是否能跳轉(zhuǎn)到接口中對應(yīng)的方法上。如果不能則說明id 的值不對，修改成方法名即可。

看到這里估計有人又該問了

我怎么知道m(xù)ap中是否為空呢？怎么知道key是不正確呢？

如果有看源碼能力的，可以debug項目 追源碼。

如果不想看源碼的，我這里給一個很直接的方式。debug模式啟動項目后，記住是在項目啟動后，在mybatis 源碼中打斷點，然后請求 debug查看。

千萬別在啟動項目前打斷點，因為項目啟動加載也會走這里，這樣會看迷糊的。記住是啟動項目后，訪問前 打斷點

總結(jié)

這是我目前能找到錯誤的原因和解決的方式方法。

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

最新評論