mapper-locations的作用說(shuō)明

1、mapper-locations

mapper-locations是一個(gè)定義mapper接口位置的屬性，在xxx.yml或xxx.properties下配置，作用是實(shí)現(xiàn)mapper接口配置

2、使用場(chǎng)景

當(dāng)mapper接口和mapper接口對(duì)應(yīng)的配置文件在 命名上相同 、所在的路徑相同，則mapper-locations可以不用配置，配置也不會(huì)生效。

如果mapper接口和mapper接口對(duì)應(yīng)的配置文件在命名上不同或所在的路徑不同，配置mapper-locations才能實(shí)現(xiàn)接口的綁定。實(shí)現(xiàn)mapper接口的綁定需要在配置文件中配置：

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

• mapper接口：com.liuzeyu.mapper.UserMapper.java
• mapper接口對(duì)應(yīng)的配置文件：mapper.UserMapper.xml

3、補(bǔ)充

實(shí)現(xiàn)接口綁定還可以在mapper接口上，直接使用注解實(shí)現(xiàn)，類(lèi)似：

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

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

對(duì)應(yīng)錯(cuò)誤:mapper.xml沒(méi)被加載到

環(huán)境:SpringBoot+Mybatis+MySQL

環(huán)境準(zhǔn)備:

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

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

編寫(xiě)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

注意:此時(shí)沒(méi)有啟用#mybatis.mapper-locations

接下來(lái)修改DemoApplication.java

在@SpringBootApplication 后面加注解 

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

掃描mybatis的相關(guān)文件,此時(shí)的作用是加載"com.example.demo.mapper"下的mapper接口,如果對(duì)應(yīng)的mapper映射文件恰好所在的目錄是在resources下的"com.example.demo.mapper",那么xml映射文件也會(huì)被

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

在controller層編寫(xiě)controller調(diào)用 mapper 訪問(wèn)數(shù)據(jù)庫(kù)查詢(xún)信息

@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";
    }
}

運(yùn)行,顯示成功

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

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

然后重啟項(xiàng)目,訪問(wèn)地址,報(bào)錯(cuò)

• 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映射文件沒(méi)被讀取到,調(diào)用的時(shí)候就自然報(bào)錯(cuò),解決路徑不同的讀取方法:

mybatis.mapper-locations

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

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

(我自己打開(kāi)注釋) 

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

指定了xml的新位置(com/example/demo/mapper1)后,重啟再次訪問(wèn)就成功了, 

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

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