mybatis中mapper-locations的作用

Posted on by

mapper-locations的作用說明

1、mapper-locations

mapper-locations是一個定義mapper接口位置的屬性，在xxx.yml或xxx.properties下配置，作用是實現mapper接口配置

2、使用場景

當mapper接口和mapper接口對應的配置文件在 命名上相同 、所在的路徑相同，則mapper-locations可以不用配置，配置也不會生效。

如果mapper接口和mapper接口對應的配置文件在命名上不同或所在的路徑不同，配置mapper-locations才能實現接口的綁定。實現mapper接口的綁定需要在配置文件中配置：

mybatis.mapper-locations=classpath:mapper/*Mapper.xml
  • mapper接口：com.liuzeyu.mapper.UserMapper.java
  • mapper接口對應的配置文件：mapper.UserMapper.xml

3、補充

實現接口綁定還可以在mapper接口上，直接使用註解實現，類似：

mybatis.mapper-locations作用和Invalid bound statement (not found)錯誤

mybatis.mapper-locations作用：加載我們的mapper xml文件,用於解決當我們的mapper映射文件所在位置不同於mapper接口所在位置,如果位置相同就可以忽略這條代碼

對應錯誤:mapper.xml沒被加載到

環境:SpringBoot+Mybatis+MySQL

環境準備:

  1. 創建springboot 的demo
  2. 引入依賴和插件
  3. 逆向工程生成相應的pojo,mapper接口,mapper映射xml文件
  4. 逆向工程生成相應的pojo,mapper接口,mapper映射xml文件
  5. 創建controller層

以上1-5層,目錄截圖,期中 resources下的mybatis文件夾隻是我用來存放逆向工程的配置文件(忽略) 

編寫application.properties

server.port=8080
server.servlet.context-path=/demo
spring.datasource.username=root
spring.datasource.password=
spring.datasource.url=jdbc:mysql://localhost:3307/studentdb?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.profiles.active=dev
spring.mvc.view.prefix=/WEB-INF/views/
spring.mvc.view.suffix=.jsp
#mybatis.mapper-locations=classpath:com/example/demo/mapper1/*.xml
mybatis.type-aliases-package=com.example.demo.pojo
logging.level.com.example.demo.mapper=debug
logging.level.web=debug

註意:此時沒有啟用#mybatis.mapper-locations

接下來修改DemoApplication.java

在@SpringBootApplication 後面加註解 

@MapperScan(“com.example.demo.mapper”)

掃描mybatis的相關文件,此時的作用是加載"com.example.demo.mapper"下的mapper接口,如果對應的mapper映射文件恰好所在的目錄是在resources下的"com.example.demo.mapper",那麼xml映射文件也會被

加載到配置中,此時mapper接口和xml文件恰好同放在"com.example.demo.mapper"中

在controller層編寫controller調用 mapper 訪問數據庫查詢信息

@Controller
@RequestMapping("student")
public class StudentController {
    @Autowired
    StudentMapper studentMapper;
    @RequestMapping("/listStudents")
    public String getStudentList(@RequestParam(defaultValue = "1",value = "page")int page, HttpServletRequest request){
        List<Student> list = studentMapper.selectByExample(new StudentExample());
        request.setAttribute("list",list);
        return "student/listStudents";
    }
}

運行,顯示成功

如果我們的mapper接口和mapper映射文件不在相同的目錄下 該案例同為"com.example.demo.mapper",則xml映射文件不能被加載到

我們把xml映射文件所在的文件夾改為mapper1

然後重啟項目,訪問地址,報錯

  • Failed to complete request: org.apache.ibatis.binding.BindingException: Invalid bound statement (not found)
  • org.apache.ibatis.binding.BindingException: Invalid bound statement (not found): com.example.demo.mapper.StudentMapper.selectByExample

由於xml所在路徑不同於mapper接口的所在路徑,所以xml映射文件沒被讀取到,調用的時候就自然報錯,解決路徑不同的讀取方法:

mybatis.mapper-locations

回到application.properties,我們加入一行:

mybatis.mapper-locations=classpath:com/example/demo/mapper1/*.xml

(我自己打開註釋) 

這一行代碼的作用是加載我們的mapper xml文件,用於解決當我們的mapper映射文件所在位置不同於mapper接口所在位置,如果位置相同就可以忽略這條代碼

指定瞭xml的新位置(com/example/demo/mapper1)後,重啟再次訪問就成功瞭, 

註意resources下的目錄路徑是以"/“為分隔,而不是.,java下的才是”."

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：