Spring Boot进阶(52):Spring Boot 如何集成Flyway并初始化执行 SQL 脚本?| 超级详细,建议收藏

news2024/11/26 1:35:11

1. 前言🔥

       在我们的认知中,我们会使用 SVN 或 Git 进行代码的版本管理。但是,我们是否好奇过,数据库也是需要进行版本管理的呢?

        在每次发版的时候,我们可能都会对数据库的表结构进行新增和变更,又或者需要插入一些初始化的数据。而我们的环境不仅仅只有一套,一般来说项目会有 dev、test、pred、prod四套环境,会对应 dev、test、prod 三个数据库。pred 环境,一般连接 prod 数据库,做准生产的验收。

        那么,就意味着我们需要对 dev、test、prodD 数据库都做一遍初始化操作。“人,是系统最大的 BUG”。很多时候,我们并不能保证像机器一样,每次都操作都正确,这就导致在不同的环境下,因为数据的每个版本的初始化,带来额外的验收成本。

        甚至说,因为我们常常是手动操作 dev 数据库,没有整理一个完整清单,保证我们在 test、prod 数据库中执行相同的操作。

        基于以上种种,如果我们能像管理代码版本一样,来管理我们的数据库版本,是不是这些问题可以得到很好的解决?答案是,绝大多数是的。

目前,技术社区已经提供了很多解决方案。比如:

  • Flyway

  • Liquibase

  • dbdeploy

  • SQL Source Control

  • dbv

  • MyBatis Migrations

        在 Spring Boot 项目中,提供了对 Flyway 和 Liquibase 的内置支持,所以在有数据库版本的需求时,肯定是推荐它两。

        本文,我会对 Flyway 进行深入入门学习。这样,我们在学习它的同时,可以有比较直观的使用感受,方便后续我们对它们进行选型。

        那么,具体如何集成Flyway 呢?这将又会是干货满满的一期,全程无尿点不废话只抓重点教,具有非常好的学习效果,拿好小板凳准备就坐!希望学习的过程中大家认真听好好学,学习的途中有任何不清楚或疑问的地方皆可评论区留言或私信,bug菌将第一时间给予解惑,那么废话不多说,直接开整!Fighting!! 

2. 环境说明🔥

本地的开发环境:

  • 开发工具:IDEA 2021.3
  • JDK版本: JDK 1.8
  • Spring Boot版本:2.3.1 RELEASE
  • Maven版本:3.8.2

3. Flyway🔥 

3.1 概念

        Flyway 是一款开源的数据库版本管理工具。它可以很方便的在命令行中使用,或者在Java应用程序中引入,用于管理我们的数据库版本。

  在项目或产品中,很难一开始就把业务理清楚,把数据库表设计好,因此数据表也会在迭代周期不断迭代。在Java应用程序中使用Flyway,能快速有效地用于迭代数据库表结构,并保证部署到测试环境或生产环境时,数据表都是保持一致的。

具体介绍请看Flyway官方文档

3.2 依赖包

        如果你是使用的maven构建工具,那你直接将如下依赖添加到你项目的pom.xml中即可

<!-- 使用 Flyway -->
<dependency>
    <groupId>org.flywaydb</groupId>
    <artifactId>flyway-core</artifactId>
</dependency>

3.3 使用flyway好处

        在多人开发的项目中,我们都习惯了使用SVN或者Git来对代码进行版本控制,主要的目的就是为了解决多人开发代码冲突和版本回退的问题。其实,数据库的变更也需要做版本控制,在日常开发中,我们经常会遇到下面的问题,比如:

  1. 自己写的SQL忘了在所有环境中执行初始化;别人写的SQL我们不能确定是否都在所有环境执行过了。
  2. 有人修改了已经执行过的SQL,期望再次执行。
  3. 需要新增环境做数据迁移。
  4. 每次发版需要手动控制先发DB版本,再发布应用版本。
  5. 其它场景。

        有了flyway,这些问题都能得到很好的解决。

4. 集成Flyway

        接下来,我就带着大家实战如何集成Flyway,具有很好的教学意义,同学们认真听好好学。

4.1 引入依赖包

首先需要在 pom.xml 文件中添加相应的依赖,示例代码如下:

<!-- 使用 Flyway -->
<dependency>
    <groupId>org.flywaydb</groupId>
    <artifactId>flyway-core</artifactId>
</dependency>

4.2 配置sql脚本

        然后在 application.yaml 或 application.properties 文件中配置数据库信息,并指定 SQL 脚本的位置,示例代码如下:

spring:
  flyway:
    enabled: true # 开启 Flyway 功能
    cleanDisabled: true # 禁用 Flyway 所有的 drop 相关的逻辑,避免出现跑路的情况。
    locations: # 迁移脚本目录
      classpath: db/migration # 配置 SQL-based 的 SQL 脚本在该目录下
    check-location: false # 是否校验迁移脚本目录下。如果配置为 true ,代表需要校验。此时,如果目录下没有迁移脚本,会抛出 IllegalStateException 异常
    url: jdbc:mysql://localhost:3306/springboot_db?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf-8 # 数据库地址
    user: root # 数据库账号
    password: 123456 # 数据库密码

注意:spring.flyway 配置项,设置 Flyway 的属性,而后可以被 FlywayAutoConfiguration 自动化配置。 每个配置项的作用,自己看下注释。 重点看下 locations 配置项,该配置设置了 SQL 迁移脚本所在目录。

4.3 定义SQL脚本

        在 resources/db/migration 目录下,创建 V1.0__INIT_DB.sql  SQL迁移脚本。具体项目位置截图如下演示:

 sql脚本代码如下:

DROP TABLE IF EXISTS `cat`;
CREATE TABLE `cat`  (
                         `id` bigint(20) NOT NULL AUTO_INCREMENT,
                         `color` varchar(64) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
                         `name` varchar(64) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
                         `age` int(11) NULL DEFAULT NULL,
                         PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 3 CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;

INSERT INTO `cat` VALUES (4, 'red', '波斯猫', 30);
INSERT INTO `cat` VALUES (5, 'blue', '蓝猫', 50);
INSERT INTO `cat` VALUES (6, 'green', '蓝白', 80);

4.4 sql 脚本命名规范

        对于 V1.0__INIT_DB.sql 的命名上。Flyway 是有明确规定的,约定如下:

Prefix 前缀:V 为版本迁移,U 为回滚迁移,R 为可重复迁移。

在我们的示例中,我们使用 V 前缀,表示版本迁移。绝大多数情况下,我们只会使用 V 前缀。

Version 版本号:每一个迁移脚本,都需要一个对应一个唯一的版本号。而脚本的执行顺序,按照版本号的顺序。一般情况下,我们使用数字自增即可。

在我们的示例中,我们使用 1.0 。

Separator 分隔符:两个 _ ,即 __ 。可配置,不过一般不配置。

Description 描述:描述脚本的用途。

在我们的示例中,我们使用 INIT_DB 。

Suffix 后缀:.sql 。可配置,不过一般不配置。

标准命令举例:V1.0__INIT_DB.sql、V3.0__INIT_DB.sql.等

4.5 启动项目测试

        基本配置已具备,接下来就是验证成功的关键了,我们重启项目查验FlyWay是否生效。

启动项目,执行日志如下所示:

        如果看到打印了以上日志,说明脚本执行成功了。查验下cat表也可以看到数据有被成功插入。

        从启动日志中可以看出,Flyway 监测到需要运行版本脚本来初始化数据库,因此执行了V1.0__INIT_DB.sql 脚本,从而创建了 cat 表,另外还自动创建了 

flyway_schema_history 表,用于记录所有版本演化和状态,其表结构如下(以 MySQL 为例):

        查询 flyway_schema_history 表,发现增加了一条版本号为 1.0 的,使用 V1.0__INIT_DB.sql 迁移脚本的记录。

        再次重启项目,可以看到,提示打印:Schema springboot_db is up to date. No migration necessary.意味着springboot_db是最新的,无需版本迁移。

        接下来,我们在 V1.0__INIT_DB.sql 迁移脚本中添加一条 INSERT 操作:INSERT INTO `cat` VALUES (7, 'pink', '粉色猫', 90);,再次启动项目,控制台会报如下错误:

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'flywayInitializer' defined in class path resource [org/springframework/boot/autoconfigure/flyway/FlywayAutoConfiguration$FlywayConfiguration.class]: Invocation of init method failed; nested exception is org.flywaydb.core.api.FlywayException: Validate failed: 
Migration checksum mismatch for migration version 2.0
-> Applied to database : -719082334
-> Resolved locally    : 1598008518

完整报错截图如下: 

        这个错误的原因就是 Flyway 会给脚本计算一个 checksum 保存在数据库中,用于在之后运行过程中对比 sql 文件是否有变化,如果发生了变化,则会报错,也就防止了误修改脚本导致发生问题。

        注意:只有在第一次启动时会执行脚本,之后相同的脚本不会再次执行,可以通过flyway的插件主动执行一次SQL脚本;也可以通过删除数据库中的flyway_schema_history表或者表中的相应脚本执行成功的记录让项目下次启动时会再次执行一次脚本。

4.6 演示修改脚本执行 

        接下来,我们来演示一下:删除掉V2.0__INIT_DB执行成功的记录,然后在迁移脚本中再添加一条 INSERT 操作,我们重启项目查验下结果:

结果如下:很明显脚本执行成功了。

对应flyway_schema_history表中也记录生成了一条记录。

4.7 总结

  • Flyway 可以有效改善数据库版本管理方式,并且是一款 Java 开源的数据库迁移管理工具,具有轻便小巧的特点,可以无门槛快速集成到项目中。
  • 对于我们的Flyway要根据我们的实际情况进行我们的库表删除,不要忙目删除我们的flyway_schema_history表。

        总之,Flyway 是一款 Java 开源的数据库迁移管理工具,轻便小巧,想了解更多的可以去官网查看文档学习,这里就不一一赘述啦。

5. 热文推荐🔥

滴~如下推荐【Spring Boot 进阶篇】的学习大纲,请小伙伴们注意查收。

Spring Boot进阶(01):Spring Boot 集成 Redis,实现缓存自由

Spring Boot进阶(02):使用Validation进行参数校验

Spring Boot进阶(03):如何使用MyBatis-Plus实现字段的自动填充

Spring Boot进阶(04):如何使用MyBatis-Plus快速实现自定义sql分页

Spring Boot进阶(05):Spring Boot 整合RabbitMq,实现消息队列服务

Spring Boot进阶(06):Windows10系统搭建 RabbitMq Server 服务端

Spring Boot进阶(07):集成EasyPoi,实现Excel/Word的导入导出

Spring Boot进阶(08):集成EasyPoi,实现Excel/Word携带图片导出

Spring Boot进阶(09):集成EasyPoi,实现Excel文件多sheet导入导出

Spring Boot进阶(10):集成EasyPoi,实现Excel模板导出成PDF文件

Spring Boot进阶(11):Spring Boot 如何实现纯文本转成.csv格式文件?

Spring Boot进阶(12):Spring Boot 如何获取Excel sheet页的数量?

Spring Boot进阶(13):Spring Boot 如何获取@ApiModelProperty(value = “序列号“, name = “uuid“)中的value值name值?

Spring Boot进阶(14):Spring Boot 如何手动连接库并获取指定表结构?一文教会你

Spring Boot进阶(15):根据数据库连接信息指定分页查询表结构信息

Spring Boot进阶(16):Spring Boot 如何通过Redis实现手机号验证码功能?

Spring Boot进阶(17):Spring Boot如何在swagger2中配置header请求头等参数信息

Spring Boot进阶(18):SpringBoot如何使用@Scheduled创建定时任务?

Spring Boot进阶(19):Spring Boot 整合ElasticSearch

Spring Boot进阶(20):配置Jetty容器

Spring Boot进阶(21):配置Undertow容器

Spring Boot进阶(22):Tomcat与Undertow容器性能对比分析

Spring Boot进阶(23):实现文件上传

Spring Boot进阶(24):如何快速实现多文件上传?

Spring Boot进阶(25):文件上传的单元测试怎么写?

Spring Boot进阶(26):Mybatis 中 resultType、resultMap详解及实战教学

Spring Boot进阶(27):Spring Boot 整合 kafka(环境搭建+演示)

Spring Boot进阶(28):Jar包Linux后台启动部署及滚动日志查看,日志输出至实体文件保存

Spring Boot进阶(29):如何正确使用@PathVariable,@RequestParam、@RequestBody等注解?不会我教你,结合Postman演示

Spring Boot进阶(30):@RestController和@Controller 注解使用区别,实战演示

...

6. 文末🔥

        如果想系统性的学习Spring Boot,小伙伴们直接订阅bug菌专门为大家创建的Spring Boot专栏《滚雪球学Spring Boot》从入门到精通,从无到有,从零到一!以知识点+实例+项目的学习模式由浅入深对Spring Boot框架进行学习&使用。

       我是bug菌,一名想走👣出大山改变命运的程序猿。接下来的路还很长,都等待着我们去突破、去挑战。来吧,小伙伴们,我们一起加油!未来皆可期,fighting!

关注公众号,获取最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板等硬核资源

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

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

相关文章

微机保护的数据采集系统(1)

一、模拟五输入电路概述 模拟量输入电路是微机保护装置中很重要的电路。保护装置的动作速度和测量精确度等性能都与该电路密切相关。模拟量输入电路的主要作用是隔离、规范输入电压及完成模数变换&#xff0c;以便与CPU接口&#xff0c;完成数据采集任务。因此这部分电路又称数…

iOS —— xcode14兼容 iOS9~iOS10系统

xcode14兼容 iOS9&#xff5e;iOS10系统 在Xcode升级到Xcode14以后&#xff0c;系统的支持版本升级到了iOS11.0。但是我们项目需要支持iOS9&#xff0c;脚本打包错误提示&#xff1a; The iOS deployment target IPHONEOS_DEPLOYMENT_TARGET is set to 9.0, but the range of …

鼠标的移入、移出事件

目录 一、mouseover和mouseenter 二、mouseout和mouseleave 三、重点总结 在原生JS中鼠标移入移出事件有四个&#xff0c;分别为mouseover ,mouseout ,mouseenter,mouseleave&#xff0c;其中mouseover和mouseenter为移入事件&#xff0c;mouseout和mouseleave为移出事件&…

IDEA提交过滤target、idea、iml、vscode、build、iws、imlz、ipr、xls、rebel.xml

一、问题截图&#xff08;IDEA提交过滤target、idea、iml、vscode、build、iws、imlz、ipr、xls、rebel.xml&#xff09; 二、解决 添加.gitignore提交到仓库&#xff0c;就可以了 HELP.md target/ !.mvn/wrapper/maven-wrapper.jar !**/src/main/** #!**/src/test/**### STS …

交换机中光口是如何配置的

在往期的文章中我们有介绍到电口和光口的概念&#xff0c;以及两者之间的区别。本期文章我们来了解一下交换机光口的是如何配置的。 一、交换机光口是如何配置的 1、确认光口类型&#xff1a;首先&#xff0c;确定光口插槽使用的光模块类型&#xff08;如SFP、SFP、QSFP等&am…

掌握5个关键点,搞定语音识别测试!

现在市面上的智能电子产品千千万&#xff0c;为了达到人们使用更加方便的目的&#xff0c;很多智能产品都开发了语音识别功能&#xff0c;用来语音唤醒进行交互&#xff1b; 另外&#xff0c;各大公司也开发出来了各种智能语音机器人&#xff0c;比如小米公司的“小爱”&#…

Redis实战案例2-基于Redis实现共享session短信登录

1. 实现Redis替代session的业务流程 保存用户登录信息采用Hash结构&#xff1b; key要保证唯一&#xff0c;用随机生成的token&#xff08;随机字符串&#xff09;作为key&#xff1b; 并且要保证客户端可以携带key去redis取出value&#xff0c;之前采用session方式是Tomcat自动…

实在智能RPA亮相2023全球人工智能技术博览会,“能对话的数字员工”引领智能自动化新篇章

随着ChatGPT火爆全网&#xff0c;人工智能再次成为学术界和科技领域“新宠”&#xff0c;一场“智能革命”的序幕悄然掀开。 6月13日&#xff0c;“智能驱动 砥砺前行”为主题的2023全球人工智能技术博览会在杭州未来科技城学术交流中心圆满落下帷幕。此次博览会以展示智能科技…

Java开发 - 带你了解集群间的相互调用,你还在等什么?

目录 前言 导读 项目准备 集群准备 父工程引入子项目 服务调用方HelloService准备 pom文件 yml文件 Controller文件 服务提供方HelloWorld准备 pom文件 yml文件 Controller文件 运行此两个工程 hello_world组集群 集群调用测试 RestTemplate换成Dubbo行不行…

web基础与HTTP

文章目录 一.web基础1.域名概述2.DNS解析3.阿里云域名申请流程 二.网页1.网页&#xff08;HTTP/HTTPS)1.1 网页1.2 网站1.3 域名1.4 HTTP/HTTPS1.5 URL1.&#xff16;HTML1.7超链接1.&#xff18;发布 &#xff12;. HTML&#xff12;.&#xff11;HTML超文本标记语言&#xff…

人机交互学习-3 交互设计目标与原则

交互设计目标与原则 交互设计目标可用性目标易用性&#xff08;learnability&#xff09;高效率&#xff08;efficiency&#xff09;易记性&#xff08;memorability&#xff09;少出错&#xff08;errors&#xff09;主观满意度&#xff08;satisfaction&#xff09; 用户体验…

C++ 11(2)右值引用 | 移动构造、移动赋值

前文中我们讲解了C11中的部分知识点&#xff0c;下面我们来介绍一下C11中的一个比较重要的知识点右值引用。 右值引用和移动语义 左值引用和右值引用 左值引用 左值就是一个数据的表达式&#xff08;如变量名和解引用指针&#xff09;&#xff0c;我们可以获取它的地址可以…

JD 某工业平台详情API接口PHP接口数据API接口

随着电商市场的蓬勃发展&#xff0c;越来越多的企业正在寻找一种高效、便捷的方式来推销和销售自己的产品。在这个过程中&#xff0c;API接口的使用变得越来越普遍。而京东工业平台商品详情API接口正是一种在推销和销售方面迅速占据市场的技术。 京东工业平台商品详情API接口是…

百度富文本框对接

第一步:引入富文本插件 第二步:修改配置文件 1:ueditor.config.js中,var URL = window.UEDITOR_HOME_URL || getUEBasePath();改为window.UEDITOR_HOME_URL = "http://ip+端口/项目名"; var URL = "http://ip+端口/项目名/.../ueditor/1.4.3/"; …

CORS跨域资源共享漏洞复现——详细利用方法,漏洞危害最大化

文章目录 前言一、漏洞原理以及成因二、CORS漏洞利用总结 前言 在很久很久以前&#xff0c;2021年&#xff0c;我写过一篇关于CORS的漏洞文章&#xff0c;CORS跨域资源共享漏洞靶场演示。当时技术水平欠佳&#xff0c;而且文章内容也仅仅是简单过了一遍漏洞的原理和检测方法&a…

芯片设计全流程概述

芯片设计分为前端设计和后端设计&#xff0c;前端设计&#xff08;也称逻辑设计&#xff09;和后端设计&#xff08;也称物理设计&#xff09;并没有统一严格的界限&#xff0c;涉及到与工艺有关的设计就是后端设计。 1、规格制定 芯片规格&#xff0c;也就像功能列表一样&…

详解c++---AVL树的原理和实现

目录标题 搜索二叉树的缺点什么是AVL树平衡因子的变化规律AVL树的旋转准备工作insert函数模拟实现左旋转右旋转右左双旋左右双旋 AVL树的打印AVL的查找AVL树的检查 搜索二叉树的缺点 在上一篇文章的学习种我们知道了什么搜索二叉树&#xff0c;它让比根小的节点都在根的左边&a…

数字孪生水网可视化平台提高企业应急联动指挥水平

随着城市化进程的不断加快&#xff0c;给水管网的建设和维护变得越来越重要。传统的给水管网监测和管理方式通常只能通过文字和图片来进行描述和展示&#xff0c;难以直观地了解管网的结构和运行情况。而3D可视化大屏展示技术的出现&#xff0c;为给水管网的监测管控提供了以下…

可完成城市内涝一维二维耦合模拟的慧天[HTWATER]软件讲解

第一部分&#xff1a;CAD、GIS在水力建模过程中的应用 1.1复杂城市排水管网系统快速建模&#xff1a;通过标准化的步骤&#xff0c;利用CAD数据、GIS数据建立SWMM模型。在建模的不同阶段发挥不同软件的优势&#xff0c;实现高效的数据处理、准确的参数赋值、模型的快速建立。在…

【NPS 】1. 服务器端搭建

一、环境&#xff1a; 二、安装docker docker-compose 三、安装 nps 服务端 1. 在 /mnt/docker/nps 下创建 docker-compose.yaml 文件 2. 安装 nps 四、登录 1. ip:8800登录&#xff0c;默认 账号密码 admin / 123 2. 修改密码 一、环境&#xff1a; 系统 &#xff1a;C…