【DB 系列】SpringBoot 系列 Mybatis 之 Mapper 接口与 Sql 绑定几种姿势
通常我们在使用 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 标签来指定注册关系,也是可行的,详情可参考官方文档 !
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,