flyway常用配置_Spring Boot 2 实战:使用 Flyway 管理你数据库的版本变更
1. 前言
随着项目的不断迭代,数据库表结构、数据都在发生着变化。甚至有的业务在多环境版本并行运行。数据为王的时代,管理好数据库的版本也成为了迫切的需要。如何能做到像 Git 之类的版本控制工具来管理数据库?Java 项目中常用 Flyway 和 Liquibase 来管理数据库版本。其中 Flyway 相对来说比较受欢迎。
2. Flyway 的特点
Flyway 大受欢迎是因为它具有以下优点:
- 简单 非常容易安装和学习,同时迁移的方式也很容易被开发者接受。
- 专一 Flyway 专注于搞数据库迁移、版本控制而并没有其它副作用。
- 强大 专为连续交付而设计。让Flyway在应用程序启动时迁移数据库。
3. Flyway 的工作机制
Flyway 需要在 DB
中先创建一个 metadata
表 (缺省表名为 flyway_schema_history
), 在该表中保存着每次 migration
(迁移)的记录, 记录包含 migration
脚本的版本号和 SQL 脚本的 checksum
值。下图表示了多个数据库版本。
对应的 metadata
表记录:
Flyway 扫描文件系统或应用程序的类路径读取 DDL 和 DML 以进行迁移。根据metadata
表进行检查迁移。如果脚本声明的版本号小于或等于标记为当前版本的版本号之一,将忽略它们。其余迁移是待处理迁移:可用,但未应用。最后按版本号对它们进行排序并按顺序执行 并将执行结果写入 metadata 表。
对应的 metadata
表记录:
Flyway 支持命令行(需要下载命令行工具)和 Java Api ,也支持构建工具 Maven 和 Gradle 。这里我们将目光放在 Java Api 上。
3. Flyway 的规则
Flyway 是如何比较两个 SQL 文件的先后顺序呢?它采用 采用左对齐原则, 缺位用 0 代替 。举几个例子:
1.0.1.1 比 1.0.1 版本高。
1.0.10 比 1.0.9.4 版本高。
1.0.10 和 1.0.010 版本号一样高, 每个版本号部分的前导 0 会被忽略。
Flyway 将 SQL 文件分为 Versioned 、Repeatable 和 Undo 三种:
- Versioned 用于版本升级, 每个版本有唯一的版本号并只能执行一次.
- Repeatable 可重复执行, 当 Flyway检测到 Repeatable 类型的 SQL 脚本的
checksum
有变动, Flyway 就会重新应用该脚本. 它并不用于版本更新, 这类的migration
总是在 Versioned 执行之后才被执行。 - Undo 用于撤销具有相同版本的版本化迁移带来的影响。但是该回滚过于粗暴,过于机械化,一般不推荐使用。一般建议使用 Versioned 模式来解决。
这三种的命名规则如下图:
- Prefix 可配置,前缀标识,默认值
V
表示 Versioned,R
表示 Repeatable,U
表示 Undo - Version 标识版本号, 由一个或多个数字构成, 数字之间的分隔符可用点
.
或下划线_
- Separator 可配置, 用于分隔版本标识与描述信息, 默认为两个下划线
__
- Description 描述信息, 文字之间可以用下划线
_
或空格 分隔 - Suffix 可配置, 后续标识, 默认为
.sql
4. Spring Boot 集成 Flyway
Spring Boot 提供了对 Flyway 的自动配置 。使我们可以开箱即用 Flyway 进行数据库版本控制。
4.1 Flyway 依赖
你只需要引入依赖:
<!-- 无需版本号 --><dependency><groupId>org.flywaydb</groupId><artifactId>flyway-core</artifactId></dependency>
当然你要集成你的相关数据库环境。这里我们采用 H2 数据库来演示,其它数据库同理只不过方言不同。不熟悉 H2 数据库的可参阅我的专题文章 Spring Boot 2 实战:H2数据库集成以及使用 。
4.2 Flyway 配置
为了直观的讲解配置,首先在 Spring Boot 配置文件 application.yml
我们配置 H2 数据库为:
spring:datasource:# h2 驱动driver-class-name: org.h2.Driver# h2 数据库 持久化到磁盘D:/h2 库名: flyway mysql模式url: jdbc:h2:file:D:/h2/flyway;MODE=MySQL;DATABASE_TO_LOWER=TRUEh2:# 开启console 访问 默认falseconsole:enabled: truesettings:# 开启h2 console 跟踪 方便调试 默认 falsetrace: true# 允许console 远程访问 默认falseweb-allow-others: true# h2 访问路径上下文path: /h2-console
对应Flyway的配置为:
# flyway 配置
spring:flyway:# 启用或禁用 flywayenabled: true# flyway 的 clean 命令会删除指定 schema 下的所有 table, 生产务必禁掉。这个默认值是 false 理论上作为默认配置是不科学的。clean-disabled: true# SQL 脚本的目录,多个路径使用逗号分隔 默认值 classpath:db/migrationlocations: classpath:db/migration# metadata 版本控制信息表 默认 flyway_schema_historytable: flyway_schema_history# 如果没有 flyway_schema_history 这个 metadata 表, 在执行 flyway migrate 命令之前, 必须先执行 flyway baseline 命令# 设置为 true 后 flyway 将在需要 baseline 的时候, 自动执行一次 baseline。baseline-on-migrate: true# 指定 baseline 的版本号,默认值为 1, 低于该版本号的 SQL 文件, migrate 时会被忽略baseline-version: 1# 字符编码 默认 UTF-8encoding: UTF-8# 是否允许不按顺序迁移 开发建议 true 生产建议 falseout-of-order: false# 需要 flyway 管控的 schema list,这里我们配置为flyway 缺省的话, 使用spring.datasource.url 配置的那个 schema,# 可以指定多个schema, 但仅会在第一个schema下建立 metadata 表, 也仅在第一个schema应用migration sql 脚本.# 但flyway Clean 命令会依次在这些schema下都执行一遍. 所以 确保生产 spring.flyway.clean-disabled 为 trueschemas: flyway# 执行迁移时是否自动调用验证 当你的 版本不符合逻辑 比如 你先执行了 DML 而没有 对应的DDL 会抛出异常validate-on-migrate: true
请务必仔细阅读 Flyway 相关配置的说明。
4.3 编写 SQL 初始化脚本
我们先编写一个初始化 SQL 文件,向 H2 数据库已经自动初始化的 schema flyway
添加一张 sys_user
表。请注意命名规则。脚本名称为 V1.0.1__Add_table_user.sql
。SQL 脚本的位置在配置的 spring.flyway.locations
下。内容为:
use `flyway`;
CREATE TABLE `sys_user`
(`user_id` int(10) unsigned NOT NULL AUTO_INCREMENT,`username` varchar(1024) NOT NULL unique ,`encode_password` varchar(1024) NOT NULL,`age` int(3) NOT NULL,PRIMARY KEY (`user_id`)
) ENGINE = InnoDBDEFAULT CHARSET = utf8mb4;insert into flyway.sys_user values (1,'Felordcn','{noop}12345',18);
启动 Spring Boot 应用 。打开 H2 数据库控制台 http://localhost:8080/h2-console
,在 JDBC URL 一栏粘贴 jdbc:h2:file:D:/h2/flyway;MODE=MySQL;DATABASE_TO_LOWER=TRUE
并点击 Connect
按钮会进入以下界面:
这里 -1
是因为我们缺省了 Flyway 需要的 flyway_schema_history
表 。0
是因为 H2 数据库自动初始化了 Schema flyway
,其它数据库可能需要你手动来建立。
4.4 编写 SQL 变更脚本
我们编写一个 V1.0.0__Delete_sysuser_felordcn.sql
来删除 V1.0.1__Add_table_user.sql
中初始化的用户。你会发现启动报错了,因为我们开启了校验,所以对于逻辑错误的版本会抛出异常。我们将版本号更改为 V1.0.2__Delete_sysuser_felordcn.sql
再次启动。通过 H2 数据库控制台我们会发现多了一条变更记录:
同时 sys_user
表的数据也没有了,符合预期。
5. Flyway 最佳实践
通过上面的介绍相信你很快就会使用 Flyway 进行数据库版本控制了。这里总结了一些在实际开发中的使用经验:
- 生产务必禁
spring.flyway.cleanDisabled=false
。 - 尽量避免使用 Undo 模式。
- 开发版本号尽量根据团队来进行多层次的命名避免混乱。比如
V1.0.1__ProjectName_{Feature|fix}_Developer_Description.sql
,这种命名同时也可以获取更多脚本的开发者和相关功能的信息。 spring.flyway.outOfOrder
取值 生产上使用true
,开发中使用false
。- 多个系统公用一个 数据库
schema
时配置spring.flyway.table
为不同的系统设置不同的metadata
表名而不使用缺省值flyway_schema_history
。
6. 总结
今天我们对 Flyway 数据库版本迁移管理工具进行了介绍并将之与 Spring Boot 相结合。这将大大规范我们的数据库管理,提高生产效率。同时也分享了一些相当有用的生产实践经验。
flyway常用配置_Spring Boot 2 实战:使用 Flyway 管理你数据库的版本变更相关推荐
- flyway常用配置_Spring Boot 2.x基础教程:使用Flyway管理数据库版本
之前已经介绍了很多在Spring Boot中使用MySQL的案例,包含了Spring Boot最原始的JdbcTemplate.Spring Data JPA以及我们国内最常用的MyBatis.同时, ...
- springboot 事务统一配置_Spring Boot实现分布式微服务开发实战系列(五)
最近已经推出了好几篇SpringBoot+Dubbo+Redis+Kafka实现电商的文章,今天再次回到分布式微服务项目中来,在开始写今天的系列五文章之前,我先回顾下前面的内容. 系列(一):主要说了 ...
- flyway常用配置_flyway使用指南
说明 这一段时间项目变更比较大,经常修改表结构,然后各个环境数据库均为修改,一不小心就忘掉了,等出问题才发现表结构没有更新;遂寻找数据库版本控制工具;最终确定为flyway. flyway说明 按照官 ...
- springboot tomcat配置_Spring Boot项目如何同时支持HTTP和HTTPS协议
本文首发于个人网站:Spring Boot项目如何同时支持HTTP和HTTPS协议 如今,企业级应用程序的常见场景是同时支持HTTP和HTTPS两种协议,这篇文章考虑如何让Spring Boot应用程 ...
- dubbo yml配置_Spring boot 的profile功能如何实现多环境配置自动切换
通常服务端应用开发需要经过以下几个流程: 开发 -> 测试 -> RC验证 -> 上线 这就涉及到四个不同的环境,开发环境.测试环境.RC环境以及生产环境,为了避免不同环境之间相互干 ...
- jdbctemplate mysql 配置_Spring Boot 初级入门教程(十四) —— 配置 MySQL 数据库和使用 JdbcTemplate 测试...
经过前面几篇文章,包已经可以打了,不管是 jar 包还是 war 包都已测试通过,jsp 页面也可以访问了,但页面上的数据都是在配置文件中写死的,不爽 ~ 到目前为止,最重要的配置还没做,那就是连数据 ...
- flyway常用配置_flyway解决
flay基本参数配置说明 # 数据库配置 spring.datasource.platform=mysql spring.datasource.driver-class-name=com.mysql. ...
- flyway常用配置_flyway使用简介
官网 背景 Flyway是独立于数据库的应用.管理并跟踪数据库变更的数据库版本管理工具.用通俗的话讲,Flyway可以像Git管理不同人的代码那样,管理不同人的sql脚本,从而做到数据库同步. 流程 ...
- Vue + Spring Boot 项目实战(四):数据库的引入
这一篇的主要内容是引入数据库并实现通过数据库验证用户名与密码. 本篇目录 一.引入数据库 1.安装数据库 2.使用 Navicat 创建数据库与表 二.使用数据库验证登录 1.项目相关配置 2.登录控 ...
最新文章
- 学习笔记TF065:TensorFlowOnSpark
- Linux意外之rpm的删除与恢复
- 到底什么是几何深度学习?Twitter 首席科学家Bronstein深度解读
- 一个关于解决序列化问题的编程技巧
- sonar-scanner debug 模式设置(sonar-scanner调试)
- leetcode133. 克隆图(bfs)
- 工作288:跨组件传值
- oracle 10 expdp impdp 导入、导出
- 久等了,41连开班仪式!
- jQuery页面滚动图片等元素动态加载实现
- 2021计算机一级模拟29套,“智慧家”2021年第二十九期每周家庭套餐
- Oracle —— 如何执行SQL文件
- 11条要点速读:网络小额贷款业务管理暂行办法(征求意见稿)
- java多线程之计算数量
- 安装adt-bundle-windows-x86-20130917时遇到的问题及解决方法
- 取代SharedPreferences的多进程解决方案
- VS log4net引用错误的解决
- 毕业设计-医院药品出入库管理系统
- 字体大宝库:15款漂亮的艺术字体免费下载
- 2012年中国大学最新排名
热门文章
- python的快速入门-Python快速入门
- 自学python还是报班-零基础python自学还是报培训班?
- python如何读取excel数据-python怎么读取excel中的数值
- python编程入门书-关于 Python 的经典入门书籍有哪些?
- python安装第三方库-Python安装第三方库的3种方法
- python3最新稳定版本-Python 3.9.0 稳定版发布
- python语言能干什么-学Python语言可以做什么?
- python常用内置模块-python常见内置模块collections
- python读取txt文件并写入excel-Python实现读取txt文件并转换为excel的方法示例
- python获取excel某一列-Python 读取excel指定的列