【DB系列】SpringBoot系列Mybatis之Mapper接口与Sql绑定几种姿势

文章目录

1. I. 环境准备
   1. 1. 数据库准备
   2. 2. 项目环境
2. II. 实例演示
   1. 1. 实体类，Mapper接口
   2. 2. sql文件
   3. 3. Mapper与Sql绑定
      1. 3.1 默认方式
      2. 3.2 SpringBoot配置
      3. 3.3 Mapper标签
      4. 3.4 SqlSessionFactory
   4. 4. 小结
3. III. 不能错过的源码和相关知识点
   1. 0. 项目
   2. 1. 一灰灰Blog

通常我们在使用Mybatis进行开发时，会选择xml文件来写对应的sql，然后将Mapper接口与sql的xml文件建立绑定关系，然后在项目中调用mapper接口就可以执行对应的sql

那么如何将Mapper接口与sql进行绑定呢？本文将介绍四种常见的姿势

• 默认策略
• SpringBoot配置参数mybatis.mapper-locations
• <mapper>指定
• SqlSessionFactory指定

I. 环境准备

1. 数据库准备

使用mysql作为本文的实例数据库，新增一张表

CREATE TABLE `money` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(20) NOT NULL DEFAULT '' COMMENT '用户名',
  `money` int(26) NOT NULL DEFAULT '0' COMMENT '钱',
  `is_deleted` tinyint(1) NOT NULL DEFAULT '0',
  `create_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `update_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
  PRIMARY KEY (`id`),
  KEY `name` (`name`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4;

2. 项目环境

本文借助 SpringBoot 2.2.1.RELEASE + maven 3.5.3 + IDEA进行开发

pom依赖如下

<dependencies>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.2.0</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
</dependencies>

db配置信息 application.yml

spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/story?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai
    username: root
    password:

II. 实例演示

环境搭建完毕，准备对应的实体类，Mapper接口

1. 实体类，Mapper接口

数据库实体类: MoneyPo

@Data
@NoArgsConstructor
@AllArgsConstructor
public class MoneyPo {
    private Integer id;

    private String name;

    private Long money;

    private Integer isDeleted;

    private Timestamp createAt;

    private Timestamp updateAt;
}

一个基础的Mapper接口

@Mapper
public interface MoneyMapper {
	int savePo(@Param("po") MoneyPo po);
}

一个demo service

@Repository
public class MoneyRepository {
    private Random random = new Random();

    public void testMapper() {
        MoneyPo po = new MoneyPo();
        po.setName("mybatis user");
        po.setMoney((long) random.nextInt(12343));
        po.setIsDeleted(0);

        moneyMapper.savePo(po);
        System.out.println("add record: " + po);
}

2. sql文件

写sql的xml文件内容如下

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.git.hui.boot.mybatis.mapper.MoneyMapper">

    <insert id="savePo" parameterType="com.git.hui.boot.mybatis.entity.MoneyPo" useGeneratedKeys="true"
            keyProperty="po.id">
      INSERT INTO `money` (`name`, `money`, `is_deleted`)
      VALUES
	  (#{po.name}, #{po.money}, #{po.isDeleted});
    </insert>
</mapper>

3. Mapper与Sql绑定

以上为代码层面实现CURD的基础知识，基本上就是mybatis操作的那些套路，没有什么需要特殊注意的；接下来我们进入本文主题

如何告诉mybatis，将上面的MoenyMapper接口与xml文件关联起来

3.1 默认方式

采用默认的绑定方式，不需要我们做额外的操作，重点是需要遵循规则

• xml的目录结构，与Mapper接口的包路径完全一致
• xml文件名与Mapper接口名完全一致（注意大小写都要完全一致）

请注意上面的另个完全一致

使用默认的方式进行绑定时，一个示例如上图；特别需要注意的是文件名的大小写，xml文件的目录层级都需要完全一致

如果使用上面这种方式，在执行时，依然提示有问题，排查的思路就是查看 target目录下生成的class文件与xml文件是否在一起，如下图就是正常的case

再次说明

• 基于上面的case，我们可以直接将xml文件，与mapper接口写在一起，不放在资源路径resources下面

3.2 SpringBoot配置

SpringBoot提供了一个简单的配置，来指定Mapper接口与sql的绑定，一行配置即可

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

使用这种方式就比较简单了，不要求xml文件与Mapper接口文件名一致；也没有指定路径层级一致

3.3 Mapper标签

mapper标签，需要放在mybatis的配置文件中，因此我们首先通过SpringBoot的配置参数指定文件路径

mybatis:
  configuration:
    config-location: classpath:mybatis-config.xml

在资源文件下，新建文件 mybatis-config.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
        PUBLIC "-//ibatis.apache.org//DTD Config 3.1//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <mappers>
        <mapper resource="sqlmapper/money-mapper.xml"/>
    </mappers>
</configuration>

通过上面的mapper标签来指定注册关系，也是可行的，详情可参考官方文档 ！

https://mybatis.org/mybatis-3/configuration.html#mappers

3.4 SqlSessionFactory

在前面一篇介绍Mapper接口注册的博文中，就介绍了通过qlSessionFactory+ MapperScannerConfigurer来注册

这里也是可以通过SqlSessionFactory来指定xml文件的

 @Bean(name = "sqlSessionFactory")
public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
    SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
    bean.setDataSource(dataSource);
    bean.setMapperLocations(
            // 设置mybatis的xml所在位置，这里使用mybatis注解方式，没有配置xml文件
            new PathMatchingResourcePatternResolver().getResources("classpath*:mapping/*.xml"));
    // 注册typehandler，供全局使用
    bean.setTypeHandlers(new Timestamp2LongHandler());
    bean.setPlugins(new SqlStatInterceptor());
    return bean.getObject();
}

4. 小结

本文主要介绍了四种Mapper接口与sql文件关系绑定的姿势，了解几种不同的姿势的特点，在实际的项目开发中，选择一个即可

• 默认：在resource资源目录下，xml文件的目录层级与Mapper接口的包层级完全一致，且xml文件名与mapper接口文件名也完全一致
  • 如mapper接口： com.git.hui.boot.mybatis.mapper.MoneyMapper
  • 对应的xml文件: com/git/hui/boot/mybatis/mapper/MoneyMapper.xml
• springboot配置参数:
  • application.yml配置文件中，指定 mybatis.mapper-locations=classpath:sqlmapper/*.xml
• mybatis-config配置文件
  • 这种姿势常见于非SpringBoot项目集成mybatis，通常将mybatis的相关配置放在 mybatis-config.xml 文件中
  • 首先在配置文件中，指定加载参数 mybatis.config-location=classpath:mybatis-config.xml
  • 然后指定映射器 <mappers><mapper resource="sqlmapper/money-mapper.xml"/></mappers>
• SqlSessionFactory指定
  • 直接在SqlSessionFactory中指定即可Mapper文件

// 设置mybatis的xml所在位置，这里使用mybatis注解方式，没有配置xml文件
bean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath*:mapping/*.xml"));

除了上面几种方式之外，mybatis还支持无xml的方式，完全依靠注解来实现sql的拼装，因此也就不存在映射关系绑定了，关于注解的case，可以参考博文 【DB系列】Mybatis+注解整合篇

III. 不能错过的源码和相关知识点

0. 项目

• 工程：https://github.com/liuyueyi/spring-boot-demo
• 源码：https://github.com/liuyueyi/spring-boot-demo/tree/master/spring-boot/104-mybatis-ano
• 源码：https://github.com/liuyueyi/spring-boot-demo/tree/master/spring-boot/103-mybatis-xml

mybatis系列博文

• 【DB系列】SpringBoot系列Mybatis之Mapper注册的几种方式
• 【DB系列】Mybatis-Plus多数据源配置
• 【DB系列】Mybatis基于AbstractRoutingDataSource与AOP实现多数据源切换
• 【DB系列】Mybatis多数据源配置与使用
• 【DB系列】JdbcTemplate之多数据源配置与使用
• 【DB系列】Mybatis-Plus代码自动生成
• 【DB系列】MybatisPlus整合篇
• 【DB系列】Mybatis+注解整合篇
• 【DB系列】Mybatis+xml整合篇

1. 一灰灰Blog

尽信书则不如，以上内容，纯属一家之言，因个人能力有限，难免有疏漏和错误之处，如发现bug或者有更好的建议，欢迎批评指正，不吝感激

下面一灰灰的个人博客，记录所有学习和工作中的博文，欢迎大家前去逛逛

• 一灰灰Blog个人博客 https://blog.hhui.top
• 一灰灰Blog-Spring专题博客 http://spring.hhui.top

打赏 如果觉得我的文章对您有帮助，请随意打赏。

微信打赏

支付宝打赏