MyBatis XML 文件无法调用的解决方案_技术教程

本文旨在解决Spring Boot项目中MyBatis XML映射文件无法被正确调用的问题。我们将通过分析常见配置错误、文件路径问题以及Mapper接口定义等方面，提供详细的排查和解决方案，确保XML中定义的SQL语句能够被成功执行。

问题分析与解决

当在Spring Boot项目中使用MyBatis时，如果XML映射文件中的SQL语句无法被正确调用，通常是由以下几个原因造成的：

XML文件路径配置错误： MyBatis无法找到XML文件。
Mapper接口定义问题： Mapper接口的方法签名与XML文件中SQL语句的id不匹配。
MyBatis配置问题： 缺少必要的MyBatis配置或配置不正确。

下面我们将针对这些问题逐一进行排查和解决。

1. 检查XML文件路径配置

首先，确保application.properties或application.yml文件中mybatis.mapper-locations属性配置正确。这个属性告诉MyBatis去哪里寻找XML映射文件。

mybatis.mapper-locations=classpath:/com/example/userapi/repository/*.xml

classpath: 表示从类路径（resources目录）开始查找。
/com/example/userapi/repository/*.xml：指定了XML文件所在的包路径和文件名模式。

注意事项：

确保XML文件实际存在于指定的路径下。
如果使用不同的构建工具（如Maven或Gradle），类路径的结构可能会有所不同，需要根据实际情况调整路径。
如果XML文件位于多个不同的包中，可以使用逗号分隔多个路径。例如：mybatis.mapper-locations=classpath:/com/example/userapi/repository/*.xml,classpath:/com/example/userapi/dao/*.xml

示例：

如果你的XML文件位于src/main/resources/com/example/userapi/repository/PurchasingInformationMapper.xml，那么mybatis.mapper-locations应该配置为：

mybatis.mapper-locations=classpath:/com/example/userapi/repository/PurchasingInformationMapper.xml

或者，如果想扫描整个repository包下的所有XML文件，可以配置为：

mybatis.mapper-locations=classpath:/com/example/userapi/repository/*.xml

2. 检查Mapper接口定义

确保Mapper接口的方法签名与XML文件中SQL语句的id和parameterType匹配。

示例：

PurchasingInformationMapper.java：

package com.example.userapi.repository;

import java.util.List;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;
import org.springframework.stereotype.Component;

import com.example.userapi.entity.PurchasingInformation;

@Mapper
@Component
public interface PurchasingInformationMapper {
    int bulkInsert(@Param("entities")List entities);
}

PurchasingInformationMapper.xml：




    
        INSERT INTO purchasing_information
        (
            sales_date,
            buyer_id,
            product_name,
            comment
        )
        VALUES
        
        (
            #{entity.sales_date},
            #{entity.buyer_id},
            #{entity.product_name},
            #{entity.comment}
        )

namespace： XML文件的namespace必须与Mapper接口的完整类名一致。
id： XML文件中标签的id必须与Mapper接口中的方法名一致。
parameterType： XML文件中标签的parameterType应该与Mapper接口中对应方法的参数类型一致。如果使用@Param注解，则XML文件中使用#{paramName.propertyName}访问参数。

注意事项：

大小写敏感：方法名和SQL id的大小写必须完全一致。
参数类型：确保参数类型匹配，例如java.util.List。
@Param注解：如果Mapper接口的方法使用了@Param注解，那么在XML文件中必须使用#{paramName.propertyName}来引用参数。

3. 检查MyBatis配置

确保项目中已经正确配置了MyBatis。这通常涉及到以下几个步骤：

添加MyBatis依赖： 确保build.gradle或pom.xml文件中包含了MyBatis的依赖。

build.gradle：
```
dependencies {
    implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:2.2.2'
}
```
配置数据源： 确保application.properties或application.yml文件中配置了数据源信息，包括数据库URL、用户名和密码等。

application.properties：
```
spring.datasource.url=jdbc:sqlite:db/database.sqlite3
spring.datasource.driver-class-name=org.sqlite.JDBC
```
配置MyBatis： 可以在application.properties或application.yml文件中配置MyBatis的一些全局设置，例如驼峰命名转换。

application.properties：
```
mybatis.configuration.map-underscore-to-camel-case=true
```

Mapper扫描配置： 确保配置了Mapper扫描器，以便MyBatis能够找到Mapper接口。可以使用@MapperScan注解或MapperScannerConfigurer类来实现。

使用@MapperScan注解：

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.example.userapi.repository") // 指定Mapper接口所在的包
public class UserApiApplication {

    public static void main(String[] args) {
        SpringApplication.run(UserApiApplication.class, args);
    }
}

使用MapperScannerConfigurer类：

package com.example.userapi.config;

import org.mybatis.spring.mapper.MapperScannerConfigurer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MyBatisMapperScannerConfig {
    @Bean
    public MapperScannerConfigurer mapperScannerConfigurer() {
        MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
        mapperScannerConfigurer.setSqlSessionFactoryBeanName("sqlSessionFactory");
        mapperScannerConfigurer.setBasePackage("com.example.userapi.repository"); // 指定Mapper接口所在的包
        return mapperScannerConfigurer;
    }
}

注意事项：