MyBatis - Spring Boot 集成 MyBatis

news2024/10/6 18:36:53

文章目录

    • 1.版本要求
    • 2.导入依赖
    • 3.自动配置
    • 2.可配置项

MyBatis-Spring-Boot-Starter 可以帮助你更快地在 Spring Boot 之上构建 MyBatis 应用。通过使用该模块我们能够快速实现以下目的：

  • 构建单体应用程序
  • 将几乎不需要样板配置
  • 使用更少的 XML 配置

1.版本要求

MyBatis-Spring-Boot-Starter 要求以下版本：

MyBatis-Spring-Boot-StarterMyBatis-SpringSpring BootJava
3.03.03.0 - 3.117 或更高
2.32.12.5 - 2.78 或更高

从上面的版本要求，我们们也不难发现，在 Spring Boot 3.x 发布后，MyBatis Starter 也进行了兼容性适配，在 Spring Boot 3.x 项目中我们可以使用 mybatis-spring-boot-starter 3.x 的版本。

2.导入依赖

Spring Boot 官方没有提供 MyBatis Starter，但是 MyBatis 官方提供了 mybatis-spring-boot-starter 一站式启动器。如果你使用 Maven，要使用 MyBatis-Spring-Boot-Starter 模块，你只需要在你的 pom.xml 添加以下依赖：

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>${mybatis-starter.version}</version>
</dependency>

具体使用哪个版本的 MyBatis 依赖需要根据实际情况进行选择，然后对应替换上例中的 ${mybatis-starter.version} 部分。对应的你可以到 Maven 中央仓库进行查阅：Maven Repository:mybatis-spring-boot-starter。

3.自动配置

当我们导入 mybatis-spring-boot-starter，它就同时导入了使用 MyBatis 所需的所有依赖：

在 org.mybatis.spring.boot.autoconfigure 的自动配置文件中也包含了 Spring Boot 使用 MyBatis 时所需的自动配置，对应的自动配置类为 MyBatisAutoConfiguration，它代替了传统 Spring 项目集成 MyBatis 所需的 XML 配置文件。

自动配置类 MyBatisAutoConfiguration 主要负责 SqlSessionFactory 和 SqlSessionTemplate 两个实例的创建和注册。

  • SqlSessionFactory: 这是 MyBatis 的核心类，用于创建 SqlSession 对象。它存储了执行 SQL 命令所需的所有配置信息。Spring Boot 通过 SqlSessionFactoryBean 创建 SqlSessionFactory，并自动将数据源、事务管理器、配置属性等所需的依赖注入其中。
  • SqlSessionTemplate: 这是 SqlSession 的线程安全的实现，代表了与数据库的一次会话。在 Spring 管理的事务中，SqlSessionTemplate 可以确保使用的是同一个 SqlSession。SqlSessionTemplate 实例由 Spring Boot 在创建 SqlSessionFactory 后自动创建并注册，将 SqlSessionFactory 作为参数传递给其构造函数。

对应的源码如下：

// MyBatis自动配置类
@Configuration
@ConditionalOnClass({SqlSessionFactory.class, SqlSessionFactoryBean.class})
@ConditionalOnSingleCandidate(DataSource.class) // 单一数据源
@EnableConfigurationProperties({MybatisProperties.class}) // 参数绑定配置类
@AutoConfigureAfter({DataSourceAutoConfiguration.class, MybatisLanguageDriverAutoConfiguration.class})
public class MybatisAutoConfiguration implements InitializingBean {
    
    // 配置SqlSessionFactory
	@Bean
    @ConditionalOnMissingBean
    public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
        // ......
    }
    
    // 配置SqlSessionTemplate
    @Bean
    @ConditionalOnMissingBean
    public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory) {
        ExecutorType executorType = this.properties.getExecutorType();
        return executorType != null ? new SqlSessionTemplate(sqlSessionFactory, executorType) : new SqlSessionTemplate(sqlSessionFactory);
    }
    
    // ......
}

注意：从上述源码中不难看出，SqlSessionFactory 需要一个 DataSource（数据源）。这可以是任意的 DataSource，只需要和配置其它 Spring 数据库连接一样配置它就可以了。

对应的参数绑定配置类为 MyBatisProperties，通过一系列 mybatis.* 参数就可以自定义 MyBatis 配置。

2.可配置项

MybatisProperties 参数绑定配置类源码如下：

@ConfigurationProperties(prefix = "mybatis") // 指定前缀为 mybatis
public class MybatisProperties {
    public static final String MYBATIS_PREFIX = "mybatis";
    private static final ResourcePatternResolver resourceResolver = new PathMatchingResourcePatternResolver();
    private String configLocation;
    private String[] mapperLocations;
    private String typeAliasesPackage;
    private Class<?> typeAliasesSuperType;
    private String typeHandlersPackage;
    private boolean checkConfigLocation = false;
    private ExecutorType executorType;
    private Class<? extends LanguageDriver> defaultScriptingLanguageDriver;
    private Properties configurationProperties;
    @NestedConfigurationProperty
    
    // 核心配置
    private Configuration configuration;
    
    
    
    // ......
}

下表是基于上述源码整理的常用 mybatis.* 配置参数：

配置项说明
mybatis.config-locationMyBatis 的配置文件位置（默认扫描 CLASSPATH 路径）
mybatis.mapper-locationsMyBatis 映射文件的位置，支持通配符
mybatis.type-aliases-packageMyBatis 实体类别名的包路径
mybatis.type-handlers-package类型映射所需的 TypeHandler 放置的包路径

从源码中还可以看到，其中提供了一个 CoreConfiguration 类型的配置属性，这是一个内部类，其中定义了对应于 MyBatis 的核心配置文件的内容，源码如下：

public static class CoreConfiguration {
        private Boolean safeRowBoundsEnabled;
        private Boolean safeResultHandlerEnabled;
        private Boolean mapUnderscoreToCamelCase;
        private Boolean aggressiveLazyLoading;
        private Boolean multipleResultSetsEnabled;
        private Boolean useGeneratedKeys;
        private Boolean useColumnLabel;
        private Boolean cacheEnabled;
        private Boolean callSettersOnNulls;
        private Boolean useActualParamName;
        private Boolean returnInstanceForEmptyRow;
        private Boolean shrinkWhitespacesInSql;
        private Boolean nullableOnForEach;
        private Boolean argNameBasedConstructorAutoMapping;
        private Boolean lazyLoadingEnabled;
        private Integer defaultStatementTimeout;
        private Integer defaultFetchSize;
        private LocalCacheScope localCacheScope;
        private JdbcType jdbcTypeForNull;
        private ResultSetType defaultResultSetType;
        private ExecutorType defaultExecutorType;
        private AutoMappingBehavior autoMappingBehavior;
        private AutoMappingUnknownColumnBehavior autoMappingUnknownColumnBehavior;
        private String logPrefix;
        private Set<String> lazyLoadTriggerMethods;
        private Class<? extends Log> logImpl;
        private Class<? extends VFS> vfsImpl;
        private Class<?> defaultSqlProviderType;
        Class<? extends TypeHandler> defaultEnumTypeHandler;
        private Class<?> configurationFactory;
        private Properties variables;

		// ......
}

其实这就对应了 MyBatis 官方文档中的 XML 配置部分，需要时直接进行查阅即可：mybatis – MyBatis 3 | 配置

下表是基于上述源码整理的常用 mybatis.configuration.* 配置参数：

配置项说明
mybatis.configuration.default-statement-timeout设置默认语句超时时间，它决定数据库驱动等待数据库响应的秒数。
mybatis.configuration.map-underscore-to-camel-case是否开启驼峰命名自动映射，即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。

注意：以上两个配置项不能和 mybatis.config-location 一起使用。

例如，在我们项目的 application 配置文件里就可以像下面这样做配置：

mybatis:
  type-handlers-package: cn.javgo.demo.support.handler
  type-aliases-package: cn.javgo.demo.model
  configuration:
    map-underscore-to-camel-case: true

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/598413.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

Apache Kafka - 构建数据管道 Kafka Connect

Apache Kafka - 构建数据管道 Kafka Connect

文章目录 概述主要概念ConnectorTasksWorkesConvertersTransformsDead Letter Queue 主要使用场景主要价值Kafka Connect API vs Producer 和 Consumer API构建数据管道时需要考虑的主要问题ETL VS ELT数据整合方式的不同ETL 和 ELT 各有优缺点: 概述 Kafka Connect 是一个工具…
阅读更多...
Linux二——Web基础与HTTP协议

Linux二——Web基础与HTTP协议

Web基础与HTTP协议 一、Web基础1. 域名的概念2.域名空间结构3.域名注册4.网页的概念5. HTML概念6.网页基本标签1 二、HTTP协议1.HTTP概念2.HTML的基本标签3.头标签中常用标签4.内容标签中常用的标签 三、动态网页与静态网页1.静态网页2.动态网页3.动态网页和静态网页的区别4.动…
阅读更多...
软件测试目的是什么?软件测试公司可提供哪些测试服务类型?

软件测试目的是什么?软件测试公司可提供哪些测试服务类型?

随着科技的不断发展&#xff0c;软件行业的发展也越来越迅速。然而&#xff0c;随着软件的增多和复杂性的提高&#xff0c;开发者们需要更多的手段来确保软件质量。软件测试就是通过一系列的测试来发现软件的问题&#xff0c;从而提高软件的质量。 一、软件测试目的是什么? …
阅读更多...
Unity中的UniTask如何取消指定的任务或所有的任务

Unity中的UniTask如何取消指定的任务或所有的任务

今天儿童节&#xff0c;犬子已经9个多月了&#xff0c;今天是他的第一个儿童节。中年得子&#xff0c;其乐无穷无尽啊… 〇、 示例效果 一连创建5个异步任务[id 从0~4]&#xff0c;先停止其中的第id 4的任务&#xff0c;再停止所有的任务 一、CancellationTokenSource有什…
阅读更多...
利用矩阵分解实现图像压缩（实验）

利用矩阵分解实现图像压缩（实验）

机器学习的课程&#xff0c;老师布置了一个实验报告&#xff0c;当我看到实验内容&#xff0c;傻眼了&#xff0c;手写计算矩阵特征值和特征向量的函数&#xff0c;这给我整无语了&#xff0c;直接调用已有的不好吗&#xff0c; 我直接摆烂。 实验报告放这了&#…
阅读更多...
【C#图解教程】 第六章 方法（上）

【C#图解教程】 第六章 方法（上）

方法的结构 方法是一块具有名称的代码&#xff0c;在类和结构中都经常用到 局部变量 局部变量位于方法内部&#xff0c;在方法中声明时产生&#xff0c;在方法执行结束时结束 类型推断与var关键字 某些情况下&#xff0c;在声明的开始部分包含类型名是多余的&#xff0c;因为…
阅读更多...
Python-python判断语句：布尔类型和比较运算符、if语句的基本格式、if else语句、if el if else语句、判断语句的嵌套、实战案例

Python-python判断语句：布尔类型和比较运算符、if语句的基本格式、if else语句、if el if else语句、判断语句的嵌套、实战案例

版本说明 当前版本号[20230601]。 版本修改说明20230601初版 知识总览图 目录 文章目录 版本说明知识总览图目录Python判断语句布尔类型和比较运算符布尔类型布尔类型的定义 比较运算符 if语句的基本格式if判断语句if语句的注意点 if else 语句语句注意点 if elif else语句注…
阅读更多...
7min 到 40s：SpringBoot 优化居然可以玩出这么多花样！

7min 到 40s：SpringBoot 优化居然可以玩出这么多花样！

0 背景 公司 SpringBoot 项目在日常开发过程中发现服务启动过程异常缓慢&#xff0c;常常需要6-7分钟才能暴露端口&#xff0c;严重降低开发效率。通过 SpringBoot 的 SpringApplicationRunListener 、BeanPostProcessor 原理和源码调试等手段排查发现&#xff0c;在 Bean 扫描…
阅读更多...
“灵巧小工具”一个将图片处理成打印纸尺寸的丰富功能完全免费无水印的图片处理工具

“灵巧小工具”一个将图片处理成打印纸尺寸的丰富功能完全免费无水印的图片处理工具

今天推荐一款微信小程序“灵巧小工具”&#xff0c;经常有打印图片需求的用户赶紧收藏了。 可以先扫码体验一番&#xff1a; 下面介绍一下它的主要功能&#xff1a; 1.照片&#xff08;1寸、2寸、5寸、6寸&#xff09; 支持1寸&#xff0c;2寸照片自动排版&#xff0c;生成相纸…
阅读更多...
JavaSE】Java基础语法(四十)：UDP通信程序

JavaSE】Java基础语法(四十)：UDP通信程序

文章目录 1. UDP发送数据2. UDP接收数据【应用】3. UDP通信程序练习【应用】4. UDP三种通讯方式 1. UDP发送数据 Java中的UDP通信 UDP协议是一种不可靠的网络协议&#xff0c;它在通信的两端各建立一个Socket对象&#xff0c;但是这两个 Socket只是发送&#xff0c;接收数据的对…
阅读更多...
IPv6 6to4隧道配置和验证实验

IPv6 6to4隧道配置和验证实验

IPv6 6to4隧道配置和验证实验 【实验目的】 熟悉IPv6 6to4隧道的概念。 掌握IPv6和IPv4共存的实现方法。 掌握IPv6 6to4地址编址规则。 掌握IPv6 6to4隧道的配置。 验证配置。 【实验拓扑】 设备参数如下表所示。 设备 接口 IP地址 子网掩码 默认网关 R1 S0/0 19…
阅读更多...
cuda编程学习——CUDA共享内存性能优化（九）

cuda编程学习——CUDA共享内存性能优化（九）

前言 参考资料&#xff1a; 高升博客 《CUDA C编程权威指南》 以及 CUDA官方文档 CUDA编程&#xff1a;基础与实践 樊哲勇 文章所有代码可在我的GitHub获得&#xff0c;后续会慢慢更新 文章、讲解视频同步更新公众《AI知识物语》&#xff0c;B站&#xff1a;出门吃三碗饭 …
阅读更多...
绝不可错过！R语言与ggplot2实现SCI论文数据分析神器

绝不可错过！R语言与ggplot2实现SCI论文数据分析神器

一、介绍 1.1 R语言和ggplot2 语言是一种强大的数据分析和统计建模工具&#xff0c;具有广泛的应用领域。 ggplot2是基于R语言的数据可视化工具&#xff0c;具有强大的绘图功能和灵活性。 1.2 数据分析中的重要性 R语言和ggplot2在数据分析中具有广泛的应用&#xff0c;能够帮助…
阅读更多...
有些香港云主机为啥更容易遭遇停机风险？

有些香港云主机为啥更容易遭遇停机风险？

​对于搭建过外贸网站的站长们来说&#xff0c;在面对香港云主机的选择时&#xff0c;往往遇到且出现较为频繁的两个词便是&#xff1a;免费香港云主机和付费香港云主机。其中&#xff0c;一些所谓的免费香港云主机&#xff0c;尤其是长久免费使用&#xff0c;恐怕用户们就要承…
阅读更多...
ES6中函数新增了哪些扩展?

ES6中函数新增了哪些扩展?

参数 &#x1f355;&#x1f355;&#x1f355;ES6允许为函数的参数设置默认值 函数的形参是默认声明的&#xff0c;不能使用let或const再次声明 function foo(x5){let x 1;//errconst x 2;//err }参数默认值可以与解构赋值的默认值结合起来使用 function foo({x,y 5}){co…
阅读更多...
华为OD机试真题B卷 Java 实现【分奖金】，附详细解题思路

华为OD机试真题B卷 Java 实现【分奖金】，附详细解题思路

一、题目描述 公司老板做了一笔大生意&#xff0c;想要给每位员工分配一些奖金&#xff0c;想通过游戏的方式来决定每个人分多少钱。按照员工的工号顺序&#xff0c;每个人随机抽取一个数字。按照工号的顺序往后排列&#xff0c;遇到第一个数字比自己数字大的&#xff0c;那么…
阅读更多...
OpenGL超级宝典第八章学习笔记：基元处理之曲面细分

OpenGL超级宝典第八章学习笔记：基元处理之曲面细分

前言 本篇在讲什么 OpenGL蓝宝书第八章学习笔记之曲面细分 本篇适合什么 适合初学OpenGL的小白 本篇需要什么 对C语法有简单认知 对OpenGL有简单认知 最好是有OpenGL超级宝典蓝宝书 依赖Visual Studio编辑器 本篇的特色 具有全流程的图文教学 重实践&#xff0c;轻…
阅读更多...
CI/CD：如何使用 GitLab 执行 SpringBoot 前后端分离项目的持续集成与持续交付（持续部署）？

CI/CD：如何使用 GitLab 执行 SpringBoot 前后端分离项目的持续集成与持续交付（持续部署）？

一、GitLab Runner 安装 官网各系统 & 各方式安装说明&#xff1a;https://docs.gitlab.com/runner/install/ 本文基于阿里云 CentOS 安装 GitLab Runner &#xff08;Linux Shell 方式&#xff0c;非 Docker 方式&#xff09; 1.1 GitLab Runner 介绍 GitLab Runner 是…
阅读更多...
GPT面试知识点

GPT面试知识点

0.GPT的模型结构 GPT是一个基于Transformer的生成式预训练模型。使用Transformer中的解码器部分 它由一系列的模块化的Transformer Blocks组成。每一个Block包含一个多头自注意力机制(Multi-Head Self-Attention mechanism)以及一个位置前馈网络(position-wise feedforward n…
阅读更多...
Redis - 原理篇

Redis - 原理篇

✨作者&#xff1a;猫十二懿 ❤️‍&#x1f525;账号&#xff1a;CSDN 、掘金 、个人博客 、Github、语雀 &#x1f389;公众号&#xff1a;猫十二懿 Redis(原理篇) 一、数据结构 1.1 动态字符串SDS 我们都知道Redis中保存的Key是字符串&#xff0c;value往往是字符串或者字…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023