解决Mapper接口和mapper.xml的文件位置问题

今天遇到一个问题是mybatis中接口和对应的mapper文件位置不同,而引起的操作也会不同,在网上找了好久最终找到了方法,这里就简单的解析一下:

我们知道在典型的maven工程中,目录结构有:src/main/java和src/main/resources,前者是用来存放java源代码的,后者则是存放一些资源文件,比如配置文件等.

Mybatis中接口和对应的mapper文件不一定要放在同一个包下,如果放在一起的目的是为了Mybatis进行自动扫描,并且要注意此时Java接口的名称和mapper文件的名称要相同,否则会报异常,由于此时Mybatis会自动解析对应的接口和相应的配置文件,所以就不需要配置mapper文件的位置了。

1:接口和文件放在同一个包中如下:

在默认的情况下maven打包的时候,对于src/main/java目录只打包源代码,而不会打包其他文件。所以此时如果把对应的mapper文件放到src/main/java目录下时,不会打包到最终的jar文件夹中,也不会输出到target文件夹中,由于在进行单元测试的时候执行的是/target目录下/test-classes下的代码,所以在测试的时候也不会成功。

解决Mapper接口和mapper.xml的文件位置问题_第1张图片

为了实现在maven默认环境下打包时,Mybatis的接口和mapper文件在同一包中,可以通过将接口文件放在src/main/java某个包中,而在src/main/resources目录中建立同样的包,这是一种约定优于配置的方式,这样在maven打包的时候就会将src/main/java和src/main/resources相同包下的文件合并到同一包中。

在默认maven打包的环境下,不要将接口文件和mapper文件全部放到src/main/java,这样也不会把mapper文件打包进去

在src/main/java和src/main/resources中相同的包名,相同的文件名,默认打包后的结构如下:

解决Mapper接口和mapper.xml的文件位置问题_第2张图片

发现打包之后已经到同一个包下了。

而当你把接口和mapper文件全部放到src/main/java中同一包时,如下:

解决Mapper接口和mapper.xml的文件位置问题_第3张图片

打包之后的文件如下:

解决Mapper接口和mapper.xml的文件位置问题_第4张图片

发现编译打包之后并没有mapper文件,所以此时不管是测试还是正式执行都会出错!!

更改maven构建配置

如果不想将接口和mapper文件分别放到src/main/java和src/main/resources中,而是全部放到src/main/java,那么在构建的时候需要指定maven打包需要包括xml文件,具体配置如下:


  
    
      src/main/java
      
        **/*.xml
      
      false
    
  

这样在打包的时候也会将mapper文件打包到/target文件夹中。

2:接口和文件不在同一个包下

如果接口和mapper文件不在同一个包下,就不能进行自动扫描解析了,需要对接口和文件分别进行配置。

2.1 XML配置方式

2.1.1 不使用Spring

使用Mybatis的配置文件如下:




 
  
  
  
  
 

2.1.2 使用Spring
使用spring的配置文件如下:

 
 
 
  
  
  // ...
 

补充知识:mybatis配置文件中config与mapper的约束

Config的约束:


Mapper的约束:


PS:

1:一般这个config的配置文件的约束的名字叫做:SQLMapConfig.xml(在resources中)

2:Mapper的配置文件约束是在resources中与其main中java下接口的相应文件相对应,但是简单来书,main中文件夹是包属性例如:comgaoxin.dao,属于三级结构,但是在resources中目录属于一级结构,需注意。

举例(防止日后看不懂)

SQLMapConfig.xml:





  
  
    
    
      
      
      
      
        
        
        
        
        
      
    
  
  
  
    
    
  

Mapper.xml(也就是java中dao包中接口文件相映射的文件名.xml)




  
  
  

以上这篇解决Mapper接口和mapper.xml的文件位置问题就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持脚本之家。

你可能感兴趣的:(解决Mapper接口和mapper.xml的文件位置问题)