Spring Boot + Mybatisのmapper-locations

環境

Spring Boot：2.0.4.RELEASE
Mybatis：3.4.6
Mybatis-Spring：1.3.2

Spring Boot + Mybatisのmapper-locations

Spring Boot + MybatisでMapper XMLを利用してデータアクセスを行う場合、以下のようにapplication.yml(properties)にXMLファイルのロケーションの指定ができます。

application.yml

mybatis:
  mapper-locations: classpath*:/jp/co/arsware/example/mapper/*.xml

ただし、Spring Boot + Mybatisでは、Mapper XMLとMapperクラスのパスが同じ場合、上記の指定をしなくてもMybatisがMapper XMLを読み込んでくれます。「Mapper XMLとMapperクラスのパスが同じ」のイメージは以下のような形です。

・src/main/java/jp/co/arsware/example/mapper/CityMapper.java
・src/main/resources/jp/co/arsware/example/mapper/CityMapper.xml
※co以下が同じパスであれば読み込んでくれる

上記が同じでない場合でかつapplication.yml(properties)にmapper-locationsの指定がない場合、実行時に以下のようなエラーが発生することになります。

org.apache.ibatis.binding.BindingException: Invalid bound statement (not found)

そのため、例えばXMLの配置先は変更したい、等があれば明示的にapplication.yml(properties)にmapper-locationsの指定をする必要があります。

以上です。