前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >Spring Boot 2.5.0 重新设计的spring.sql.init 配置有啥用?

Spring Boot 2.5.0 重新设计的spring.sql.init 配置有啥用?

作者头像
程序猿DD
发布于 2021-06-08 14:16:33
发布于 2021-06-08 14:16:33
2K00
代码可运行
举报
文章被收录于专栏:程序猿DD程序猿DD
运行总次数:0
代码可运行

前几天Spring Boot 2.5.0发布了,其中提到了关于Datasource初始化机制的调整,有读者私信想了解这方面做了什么调整。那么今天就要详细说说这个重新设计的配置内容,并结合实际情况说说我的理解和实践建议。

弃用内容

先来纠正一个误区。主要之前在版本更新介绍的时候,存在一些表述上的问题。导致部分读者认为这次的更新是Datasource本身初始化的调整,但其实并不是。这次重新设计的只是对Datasource脚本初始化机制的重新设计。

先来看看这次被弃用部分的内容(位于org.springframework.boot.autoconfigure.jdbc.DataSourceProperties),如果你有用过这些配置内容,那么新配置就很容易理解了。

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
 /**
  * Mode to apply when determining if DataSource initialization should be performed
  * using the available DDL and DML scripts.
  */
 @Deprecated
 private DataSourceInitializationMode initializationMode = DataSourceInitializationMode.EMBEDDED;

 /**
  * Platform to use in the DDL or DML scripts (such as schema-${platform}.sql or
  * data-${platform}.sql).
  */
 @Deprecated
 private String platform = "all";

 /**
  * Schema (DDL) script resource references.
  */
 private List<String> schema;

 /**
  * Username of the database to execute DDL scripts (if different).
  */
 @Deprecated
 private String schemaUsername;

 /**
  * Password of the database to execute DDL scripts (if different).
  */
 @Deprecated
 private String schemaPassword;

 /**
  * Data (DML) script resource references.
  */
 @Deprecated
 private List<String> data;

 /**
  * Username of the database to execute DML scripts (if different).
  */
 @Deprecated
 private String dataUsername;

 /**
  * Password of the database to execute DML scripts (if different).
  */
 @Deprecated
 private String dataPassword;

 /**
  * Whether to stop if an error occurs while initializing the database.
  */
 @Deprecated
 private boolean continueOnError = false;

 /**
  * Statement separator in SQL initialization scripts.
  */
 @Deprecated
 private String separator = ";";

 /**
  * SQL scripts encoding.
  */
 @Deprecated
 private Charset sqlScriptEncoding;

对应到配置文件里的属性如下(这里仅列出部分,就不全部列出了,主要就是对应上面源码中的属性):

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
spring.datasource.schema=
spring.datasource.schema-username=
spring.datasource.schema-password=
...

这些配置主要用来指定数据源初始化之后要用什么用户、去执行哪些脚本、遇到错误是否继续等功能。

新的设计

Spring Boot 2.5.0开始,启用了全新的配置方式,我们可以从这个类org.springframework.boot.autoconfigure.sql.init.SqlInitializationProperties里看到详情。

下面我们通过一个简单的例子来体验这个功能的作用。

  • 创建一个Spring Boot的基础应用,并在pom.xml中引入和mysql的依赖:
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
  • 在配置文件中增加数据源和初始化数据源的配置,具体如下:
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

# Spring Boot 2.5.0 init schema & data
# 执行初始化脚本的用户名称
spring.sql.init.username=root
# 执行初始化脚本的用户密码
spring.sql.init.password=
# 初始化的schema脚本位置
spring.sql.init.schema-locations=classpath*:schema-all.sql
  • 根据上面配置的定义,接下来就在resource目录下,创建脚本文件schema-all.sql,并写入一些初始化表结构的脚本
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
create table test.user_info
(
    id          int unsigned auto_increment comment '用户id'
        primary key,
    open_id     varchar(255)     default '' null comment '微信小程序openid',
    nick_name   varchar(255)     default '' null comment '微信名',
    head_img    varchar(255)     default '' null comment '微信头像',
    sex         varchar(255)     default '' null comment '性别',
    phone       varchar(255)     default '' null comment '手机',
    province    varchar(255)     default '' null comment '注册地址:省',
    city        varchar(255)     default '' null comment '注册地址:城市',
    country     varchar(255)     default '' null comment '注册地址:县/区',
    status      tinyint unsigned default 0  not null comment '是否标记删除 0:否 1:是',
    create_time datetime                    not null comment '创建时间',
    update_time datetime                    not null comment '更新时间'
)
comment '用户表';
  • 完成上面步骤之后,启动应用。然后打开MySQL客户端,可以看到在test库下,多了一个user_info

通过上面的例子,不难想到这样的功能主要可以用来管理应用启动与数据库配置的自动执行,以减少应用部署过程中手工执行的内容,降低应用部署的执行步骤。

配置详解

除了上面用到的配置属性之外,还有一些其他的配置,下面详细讲解一下作用。

  • spring.sql.init.enabled:是否启动初始化的开关,默认是true。如果不想执行初始化脚本,设置为false即可。通过-D的命令行参数会更容易控制。
  • spring.sql.init.usernamespring.sql.init.password:配置执行初始化脚本的用户名与密码。这个非常有必要,因为安全管理要求,通常给业务应用分配的用户对一些建表删表等命令没有权限。这样就可以与datasource中的用户分开管理。
  • spring.sql.init.schema-locations:配置与schema变更相关的sql脚本,可配置多个(默认用;分割)
  • spring.sql.init.data-locations:用来配置与数据相关的sql脚本,可配置多个(默认用;分割)
  • spring.sql.init.encoding:配置脚本文件的编码
  • spring.sql.init.separator:配置多个sql文件的分隔符,默认是;
  • spring.sql.init.continue-on-error:如果执行脚本过程中碰到错误是否继续,默认是false`;所以,上面的例子第二次执行的时候会报错并启动失败,因为第一次执行的时候表已经存在。

应用建议

关于这些配置的应用,相信聪明的你一定会把它与数据库的版本管理联系起来(因为可以自动的执行脚本)。

那么依靠这些配置,是否可以胜任业务应用部署时候数据库初始化的自动化实现呢?

个人认为就上述所介绍的配置,虽然具备了一定的自动执行能力。但由于缺失对当前环境的判断能力,所以要应对实际的部署场景来说,还是远远不够的。

如果要自动化的管理数据库表结构、初始化数据的话,我的建议是:

  1. 默认提供的这个初始化功能可以且仅用于单元测试,自动创建数据库结构与初始化数据,使用完毕后销毁。可以方便的控制每次单元测试的执行环境一致。
  2. 应用在环境部署的时候,还是要使用之前介绍过的Flyway来实现,如何使用可见之前的分享:使用Flyway来管理数据库版本
  3. 联合Flyway一同使用,通过org.springframework.jdbc.datasource.init.DataSourceInitializer来定义更复杂的执行逻辑。

更多本系列免费教程连载:

https://blog.didispace.com/spring-boot-learning-2x/

代码示例

本文的相关例子可以查看下面仓库中的chapter3-13目录:

  • Github:https://github.com/dyc87112/SpringBoot-Learning/
  • Gitee:https://gitee.com/didispace/SpringBoot-Learning/
本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2021-05-24,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 程序猿DD 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
芋道 Spring Boot 数据库版本管理入门
在我们的认知中,我们会使用 SVN 或 Git 进行代码的版本管理。但是,我们是否好奇过,数据库也是需要进行版本管理的呢?
芋道源码
2020/05/19
8K0
芋道 Spring Boot 数据库版本管理入门
SpringBoot系列之数据库初始化-datasource配置方式
在我们的日常业务开发过程中,如果有db的相关操作,通常我们是直接建立好对应的库表结构,并初始化对应的数据,即更常见的情况下是我们在已有表结构基础之下,进行开发; 但是当我们是以项目形式工作时,更常见的做法是所有的库表结构变更、数据的初始、更新等都需要持有对应的sql变更,并保存在项目工程中,这也是使用liqubase的一个重要场景; 将上面的问题进行简单的翻译一下,就是如何实现在项目启动之后执行相应的sql,实现数据库表的初始化?
一灰灰blog
2022/12/29
2.4K0
SpringBoot系列之数据库初始化-datasource配置方式
SpringBoot高级篇DB之基本使用
现在的完整的后端项目,基本上离不开DB、缓存,接下来开始进入DB篇的系列教程,首先确定我们的目标,一个是知道怎么配置,怎么用;接着就是更高级一点的多个数据源的配置,使用不同的方式来实现CURD(如Mybatis, JPDA, MyCat, Hibernate, Jooq等),数据库不得不谈到的事物管理,锁机制,以及高级一点的分库分表等;然后再进一步则是优秀的框架的学习了,大名鼎鼎的MyBaits的设计思路,Jooq的使用姿势也特别有意思
一灰灰blog
2019/03/14
1.3K0
SpringBoot高级篇DB之基本使用
Spring Boot 集成 Flyway 实现数据库版本控制
在项目迭代开发中,难免会有更新数据库 Schema 的情况,比如添加新表、在表中增加字段或者删除字段等,那么当我对数据库进行一系列操作后,如何快速地在其他同事的电脑上同步?如何在测试/生产服务器上快速同步?
武培轩
2020/05/09
2.3K0
Spring Boot 集成 Flyway 实现数据库版本控制
Spring Boot配置属性
摘要:springboot数据库连接池使用策略以及对应的配置属性 正文: springboot数据库连接池使用策略 springboot官方文档介绍数据库连接池的使用策略如下: Production database connections can also be auto-configured using a pooling DataSource. Here’s the algorithm for choosing a specific implementation: W
itliusir
2018/05/21
2K0
Spring Boot 集成 Flyway,数据库也能做版本控制
Flyway是一款数据库迁移(migration)工具。简单点说,就是在你部署应用的时候,帮你执行数据库脚本的工具。
码猿技术专栏
2023/05/01
1K0
Spring Boot 集成 Flyway,数据库也能做版本控制
快速学会像Git一样管理数据库业务版本变更
随着项目的不断迭代,数据库表结构、数据都在发生着变化。甚至有的业务在多环境版本并行运行。数据为王的时代,管理好数据库的版本也成为了迫切的需要。如何能做到像 Git 之类的版本控制工具来管理数据库?Java 项目中常用 Flyway 和 Liquibase 来管理数据库版本。其中 Flyway 相对来说比较受欢迎。
码农小胖哥
2019/12/10
4.9K0
快速学会像Git一样管理数据库业务版本变更
【方向盘】Spring Boot 2.5.0正式发布,环境变量可指定前缀的功能很赞
你好,我是方向盘(YourBatman)。笔者的公号是保留地,只分享原创,不转载、不发商务广告!
YourBatman
2021/12/08
1.1K0
【方向盘】Spring Boot 2.5.0正式发布,环境变量可指定前缀的功能很赞
Spring Boot中使用Flyway来管理数据库版本
久违了的Spring Boot系列,今天抽空更新一篇。之前写过很多篇关于数据访问的文章了,比如下面这些: 使用JdbcTemplate 使用Spring-data-jpa简化数据访问层(推荐) 多数据源配置(一):JdbcTemplate 多数据源配置(二):Spring-data-jpa 使用NoSQL数据库(一):Redis 使用NoSQL数据库(二):MongoDB 整合MyBatis MyBatis注解配置详解 使用事务管理 在上面的使用JdbcTemplate一文中,主要通过spring提供的J
程序猿DD
2018/02/01
2.2K0
Spring Boot中使用Flyway来管理数据库版本
Spring Boot 2.5 终于对数据源动刀了!
最近有看过《Spring Boot 2.5 重磅发布》一文的朋友应该都知道,Spring Boot 2.5 有一个数据源的重大变动,那就是某些数据源初始化的方法被重新设计了,下面的数据源参数配置也被废除了:
Java技术栈
2021/06/16
1.1K0
初始化数据库和导入数据
在Spring Boot应用的测试一文中,我们在StarterRunner类的run(...)方法中给数据库中添加一些初始数据。尽管通过编程方式添加初始数据比较快捷方便,但长期来看这并不是一个好办法——特别是当需要添加的数据量很大时。我们开发最好把数据库准备、数据库修改和数据库的配置与将要运行的程序代码分离,尽管这仅仅是为测试用例做准备。Spring Boot已经提供了相应的支持来完成这个任务。
阿杜
2018/08/06
1.8K0
02. Springboot集成Flyway
在现代应用程序开发中,数据库的变化是一个不可避免的过程。为了管理数据库版本、维护迁移历史记录和确保开发团队之间的一致性,Flyway 是一个强大的数据库迁移工具,而与 Spring Boot 集成可以让我们更轻松地进行数据库版本管理。
有一只柴犬
2024/01/25
6400
02. Springboot集成Flyway
Spring Boot 默认数据源 HikariDataSource 与 JdbcTemplate 初遇
1、本文介绍 Spring Boot 内部集成的 JDBC 模板访问 Mysql 数据库,环境:Java JDK 8 + Spring boot 2.1.5 + HikariDataSource + Mysql/Oracle + JdbcTemplate
全栈程序员站长
2022/09/10
2K0
Spring Boot 默认数据源 HikariDataSource 与 JdbcTemplate 初遇
Springboot启动(DataSources创建时)执行初始化SQL脚本 – 源码剖析 – 超级干货
很多开源项目我们没有导入SQL进入数据库,但是项目一旦启动,就会替我们执行初始化数据了。我们今天来分析是如何实现的。
收心
2022/11/18
5.4K0
Spring Boot:整合JdbcTemplate
Spring对数据库的操作在jdbc上面做了更深层次的封装,而JdbcTemplate便是Spring提供的一个操作数据库的便捷工具。我们可以借助JdbcTemplate来执行所有数据库操作,例如插入,更新,删除和从数据库中检索数据,并且有效避免直接使用jdbc带来的繁琐编码。
朝雨忆轻尘
2019/06/19
2.5K0
Spring Boot:整合JdbcTemplate
【SpringBoot系列】SpringBoot微服务集成Flyway
我们在日常工作中通常遇到的大多数服务只是从用户那里获取一些输入并填充数据库,并从数据库中读取并在 UI 上显示。每个数据库都有一个Schema,我们会在需求发生变化时进行迭代过程,以修改我们的Schema。现在,所有这些迁移都可以单独驻留在应用程序中,并且可以由数据库团队处理,我们可以以版本控制的方式将此迁移脚本与应用程序一起保留,并在应用程序启动时应用它们,这就是flyway为我们所做的。
Freedom123
2024/04/23
5390
【DB系列】SpringBoot集成Flyway版本迭代框架
最近项目中引入了 Flyway 这个管理数据库版本框架,目的是为了解决我们一直存在的数据库脚本迭代混乱这个问题。说来惭愧,公司一直都是手动迭代数据库版本,配置MybatisPlus的init-sql组件使用的。
框架师
2021/11/22
2K0
【DB系列】SpringBoot集成Flyway版本迭代框架
springboot的配置文件
spring.dao.exceptiontranslation.enabled 是否开启PersistenceExceptionTranslationPostProcessor,默认为true
张哥编程
2024/12/19
1220
Dataway接口配置服务,去掉后台,从此告别Controller、Service、Mapping
博客(coder的自我修养)原文链接:http://www.imcoder.fun/archives/1591174066705
用户1682785
2020/06/29
1.9K0
Spring Boot(3)-使用mysql详解
Spring Boot构建的Web应用中,基于MYSQL数据库的几种数据库连接方式进行介绍,包括JDBC、JPA、MyBatis、多数据源和事务。
黄规速
2022/04/14
4.2K0
Spring Boot(3)-使用mysql详解
推荐阅读
相关推荐
芋道 Spring Boot 数据库版本管理入门
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档
本文部分代码块支持一键运行,欢迎体验
本文部分代码块支持一键运行,欢迎体验