SpringBoot+Mybatis实现Mapper接口与Sql绑定几种姿势

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

通常我们在使用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 {
trueint 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
true  (#{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. 不能错过的源码和相关知识点

项目

工程: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

到此这篇关于SpringBoot+Mybatis实现Mapper接口与Sql绑定几种姿势的文章就介绍到这了,更多相关SpringBoot Mybatis Mapper接口与Sql绑定内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • 详解mybatis通过mapper接口加载映射文件

    通过 mapper 接口加载映射文件,这对于后面 ssm三大框架 的整合是非常重要的.那么什么是通过 mapper 接口加载映射文件呢? 我们首先看以前的做法,在全局配置文件 mybatis-configuration.xml 通过 <mappers> 标签来加载映射文件,那么如果我们项目足够大,有很多映射文件呢,难道我们每一个映射文件都这样加载吗,这样肯定是不行的,那么我们就需要使用 mapper 接口来加载映射文件 以前的做法: 改进做法:使用 mapper 接口来加载映射文件 1.定义

  • Springboot 扫描mapper接口的2种操作

    方式一: 在所有mapper接口使用@Mapper注解 @Mapper (将包中的所有接口都标注为DAO层接口) public interface UserMapper { UserInfo getUserInfo(@Param("userId") String userId); } 方式二: 在springboot的启动类使用@MapperScan注解 (作用:将指定包中的所有接口都标注为DAO层接口,相当于在每一个接口上写@Mapper) @SpringBootApplicatio

  • SpringBoot+Mybatis使用Mapper接口注册的几种方式

    目录 I. 环境准备 1. 数据库准备 2. 项目环境 II. 实例演示 1. 实体类,Mapper类 2. 注册方式 2.1 @MapperScan注册方式 2.2 @Mapper 注册方式 2.3 MapperScannerConfigurer注册方式 3. 小结 III. 不能错过的源码和相关知识点 SpringBoot项目中借助Mybatis来操作数据库,对大部分java技术栈的小伙伴来说,并不会陌生:我们知道,使用mybatis,一般会有下面几个 Entity: 数据库实体类 Mapp

  • 使用Spring扫描Mybatis的mapper接口的三种配置

    Spring扫描Mybatis的mapper接口的配置 1.前言 mybatis支持与spring结合使用,使得mybatis中的mapper接口可以作为spring容器中的bean被应用代码中相关类,如Service类,通过@Autowired自动注入进来. 在使用方面需要在项目中引入以下包: <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis-spring</artifac

  • Mybatis Mapper接口工作原理实例解析

    KeyWords: Mybatis 原理,源码,Mybatis Mapper 接口实现类,代理模式,动态代理,Java动态代理, Proxy.newProxyInstance,Mapper 映射,Mapper 实现 MyBatis 是一款优秀的持久层框架,它支持定制化 SQL.存储过程以及高级映射.MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集.我们在使用 Mybaits 进行 ,通常只需要定义几个 Mapper 接口,然后在编写一个 xml 文件,我们在配置文件中

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

    今天遇到一个问题是mybatis中接口和对应的mapper文件位置不同,而引起的操作也会不同,在网上找了好久最终找到了方法,这里就简单的解析一下: 我们知道在典型的maven工程中,目录结构有:src/main/java和src/main/resources,前者是用来存放java源代码的,后者则是存放一些资源文件,比如配置文件等. Mybatis中接口和对应的mapper文件不一定要放在同一个包下,如果放在一起的目的是为了Mybatis进行自动扫描,并且要注意此时Java接口的名称和mappe

  • SpringBoot+Mybatis实现Mapper接口与Sql绑定几种姿势

    目录 I. 环境准备 1. 数据库准备 2. 项目环境 II. 实例演示 1. 实体类,Mapper接口 2. sql文件 3. Mapper与Sql绑定 3.1 默认方式 3.2 SpringBoot配置 3.3 Mapper标签 3.4 SqlSessionFactory 4. 小结 III. 不能错过的源码和相关知识点 通常我们在使用Mybatis进行开发时,会选择xml文件来写对应的sql,然后将Mapper接口与sql的xml文件建立绑定关系,然后在项目中调用mapper接口就可以执行

  • 关于Mybatis的mapper接口函数重载问题

    目录 Mybatis的接口函数能不能进行重载? 语法层面 Mybatis框架方面 测试 MyBatis实现方法重载的小技巧 QuestionMapper.java QuestionMapper.xml Mybatis的接口函数能不能进行重载? mybatis版本:3.4x java版本:java 8 语法层面 1.接口的方法可以进行重载,因为 java 语法可以让接口函数进行重载. Mybatis框架方面 1.结论:可以有条件的进行重载. 2.为什么会有这个问题?:mybatis里面将接口里面的

  • Mybatis如何通过接口实现sql执行原理解析

    目录 1.环境搭建 2.动态代理类的生成 3.MapperProxy 增强 mapper 接口 3.1.cachedInvoker(method) 3.2.MapperMethod 3.2.1.参数转换 method.convertArgsToSqlCommandParam(args) 3.2.2.调用 sqlSession 的方法获取结果 4.小结 总结 使用过 mybatis 框架的小伙伴们都知道,mybatis 是个半 orm 框架,通过写 mapper 接口就能自动实现数据库的增删改查,

  • 浅谈Mybatis之参数传递的几种姿势

    目录 I. 环境配置 1. 项目配置 2. 数据库表 II. 参数传递 1. @Param注解 2. 单参数 3. 多参数 3. Map传参 4. POJO对象 5. 简单参数 + Map参数 6.小结 III. 不能错过的源码和相关知识点 在mybatis的日常开发中,mapper接口中定义的参数如何与xml中的参数进行映射呢?除了我们常用的@Param注解之外,其他的方式是怎样的呢? I. 环境配置 我们使用SpringBoot + Mybatis + MySql来搭建实例demo spri

  • 浅谈MyBatis执行SQL的两种方式

    目录 前言 准备接口和Mapper配置文件: 使用SqlSession 发送 SQL 使用 Mapper 接口发送 SQL 比较两种发送 SQL 方式 前言 本文介绍MyBatis执行SQL语句的2种方式:SqlSession和Mapper接口以及它们的区别. 准备接口和Mapper配置文件: 定义UserMapper接口: package cn.cvs.dao; import cn.cvs.pojo.User; import java.util.List; public interface U

  • 详解MyEclipse中搭建spring-boot+mybatis+freemarker框架

    1.在MyEclipse里创建一个maven项目.File>New>Maven Project: 勾选图中红色部分,然后点击Next. 2.填写下图中红色部分然后点击Finish. 3.此时一个maven项目已经生成,目录结构如下: 4.打开pom.xml在里面编辑如下内容: <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSche

  • SpringBoot整合mybatis通用Mapper+自定义通用Mapper方法解析

    目录 首先引入pom 通用Mapper是tk.mybais中的 也可以用代码进行配置 数据库创建一张表member以及相关字段 新建一个通用Mapper继承Mapper.MySqlMapper 比较详细的一个入门示例 举例我要写一个通用的单表分页 在自己的BaseMapper写一个方法,改造后的BaseMapper 新建的BaseMapperProvider 对上诉实现代码的描述 返回后通用Mapper是怎么处理的 最近公司在用的通用mapper,自己感兴趣,然后就来搭建了一个springboo

随机推荐