【经验分享】mybatis那些约定的配置你分得清吗？

骑猪看日落 2022-10-07 07:56 161阅读 0赞

## 背景 ##

在springboot中有很多约定大于配置的规则，如果我们准守了约定，可以零配置。mybatsi中Mapper和xml文件之间有很多约定俗称的规则，比如名称匹配，包扫描，别名等，这些规则是什么。如果想更加灵活，该如何配置呢？今天就给大家讲一下如何配置mybatsi的xml文件等。

## 一、@Mapper注解和@MapperScan注解使用说明 ##

1.  可以不使用@MapperScan注解，默认扫描根路径下标注了@Mapper注解的接口
2.  可以使用@Mapper注解，使用@MapperScan(“com.kouryoushine.mybatis.demo.mapper”)，告诉spring该包下的接口都作为Mapepr对象扫描到容器中
3.  两个注解都不使用，报如下错误。在根路径下扫描不到任何Mapper  
    No MyBatis mapper was found in ‘\[com.kouryoushine.mybatis.demo\]’ package. Please check your configuration.

## 二、 mapper代理方法必须一致 ##

### mapper代理方法 ###

–程序员只需要mapper接口和mapper.xml映射文件，mybatis可以自动生成mapper接口实现类代理对象。  
–程序员编写mapper接口需要遵循一些开发规范。

### mapper代理开发规范 ###

*  在mapper.xml中namespace等于mapper接口地址
 *  mapper.java接口中的方法名和mapper.xml中statement的id一致
 *  mapper.java接口中的方法输入参数类型和mapper.xml中statement的parameterType指定的类型一致。
 *  mapper.java接口中的方法返回值类型和mapper.xml中statement的resultType指定的类型一致。
 *  mapper.xml文件名应该和接口名保持一致，否则也可能出现不匹配

## 二、xml文件的位置 ##

### 位置1：放在resource目录下相同目录结构 ###

这种方式无需额外的配置，但并不推荐。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tvdXJ5b3VzaGluZQ_size_16_color_FFFFFF_t_70]

### 位置2：放在resource下任意目录 ###

比如指定mapper-location的位置，否则扫描不到

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

### 位置3：和mapper接口放在同一目录下 ###

这种情况下比较特殊，其实是能扫描到这个xml文件的，只是打包时不会打进去。可以通过添加如下配置将xml打包进去。

<build>
        <resources>
            
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
            </resource>
            
            <resource>
                <directory>src/main/resources</directory>
            </resource>
        </resources>
    </build>

注：没有上述配置时target是没有mapper.xml文件的，大家可以自己尝试  
![在这里插入图片描述][20210617014849155.png]

## 总结 ##

虽然有多种方式都可以达成配置，但还是推荐加上注解同时指定好扫描路径。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tvdXJ5b3VzaGluZQ_size_16_color_FFFFFF_t_70]: /images/20221005/0e2f07bdb4b44ad78245c47a2f2b9ef9.png
[20210617014849155.png]: /images/20221005/d13bb0be65b64b0693f97c8396ae3431.png