乐趣区

关于spring:SpringBoot-Mybatis系列MapperMapper接口与Sql绑定几种姿势

jiezi

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

通常咱们在应用 Mybatis 进行开发时，会抉择 xml 文件来写对应的 sql，而后将 Mapper 接口与 sql 的 xml 文件建设绑定关系，而后在我的项目中调用 mapper 接口就能够执行对应的 sql

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

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

<!– more –>

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

退出移动版