flyway快速入门 ---结合springboot

最新推荐文章于 2025-03-23 23:06:06 发布
原创 最新推荐文章于 2025-03-23 23:06:06 发布 · 770 阅读 · 0 ·
本内容遵循CC 4.0 BY-SA版权协议
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
标签
#flyway #mysql #springboot
本文介绍了Flyway作为数据库版本管理工具的原理及在SpringBoot项目中的使用方法，包括初始化项目、添加依赖、配置Flyway、创建数据库脚本以及启动时自动执行的流程。同时，文章提到了Flyway的一些注意事项，如执行前提、数据库清理和脚本修改的潜在问题。

一、Flyway简介

demo地址

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

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

Flyway支持的数据库很多，从官网摘抄如下：

Supported databases are Oracle, SQL Server (including Amazon RDS and Azure SQL Database), Azure Synapse (Formerly Data Warehouse), DB2, MySQL (including Amazon RDS, Azure Database & Google Cloud SQL), Aurora MySQL, MariaDB, Percona XtraDB Cluster, TestContainers, PostgreSQL (including Amazon RDS, Azure Database, Google Cloud SQL & Heroku), Aurora PostgreSQL, Redshift, CockroachDB, SAP HANA, Sybase ASE, Informix, H2, HSQLDB, Derby, Snowflake, SQLite and Firebird.

二、Flyway是如何工作的

Flyway工作流程如下：

1、项目启动，应用程序完成数据库连接池的建立后，Flyway自动运行。

2、初次使用时，Flyway会创建一个flyway_schema_history表，用于记录sql执行记录。

3、Flyway会扫描项目指定路径下(默认是classpath:db/migration)的所有sql脚本，与flyway_schema_history表脚本记录进行比对。如果数据库记录执行过的脚本记录，与项目中的sql脚本不一致，Flyway会报错并停止项目执行。

4、如果校验通过，则根据表中的sql记录最大版本号，忽略所有版本号不大于该版本的脚本。再按照版本号从小到大，逐个执行其余脚本。

三、在SpringBoot项目使用Flyway

1、初始化一个SpringBoot项目

引入MySQL数据库驱动依赖等，并且需要引入Flyway依赖：

   <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.flywaydb</groupId>
            <artifactId>flyway-core</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>2.3.7.RELEASE</version>
                <configuration>
                    <mainClass>com.example.flyway.FlywayApplication</mainClass>
                </configuration>
                <executions>
                    <execution>
                        <id>repackage</id>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

2、添加Flyway配置

server:
  port: 8080

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/flywaydemo?characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&serverTimezone=Asia/Shanghai&useInformationSchema=true
    username: root
    password: 123456
    driver-class-name: com.mysql.jdbc.Driver

  flyway:
    enabled: true # 开启flyway
    # flyway 的 clean 命令会删除指定 schema 下的所有 table, 生产务必禁掉。这个默认值是 false 理论上作为默认配置是不科学的。
    clean-disabled: true
    locations: classpath:db/migration  #flyway文件目录
    table: flyway_schema_history  #历史表名
    baseline-on-migrate: true
    validate-on-migrate: true  #连续性校验
    baseline-version: 1 #指定默认版本
    encoding: UTF-8 #编码
    out-of-order: false # 是否允许不按顺序迁移 开发建议 true  生产建议 false
    sql-migration-prefix: V #前缀默认v
    sql-migration-separator: __ #分割符，默认__
    sql-migration-suffixes: .sql  #迁移文件，默认.sql

springboot在创建项目时导入了flyway，可以不配置yml，采用默认构建

3、构建数据库

SQL语句命名需要遵从一定的规范，否则运行的时候flyway会报错。命名规则主要有两种：

  1. 仅需要被执行一次的SQL命名以大写的"V"开头，后面跟上"0~9"数字的组合,数字之间可以用“.”或者下划线"_"分割开，然后再以两个下划线分割，其后跟文件名称，最后以.sql结尾。比如，V2.1.5__create_user_ddl.sql、V4.1_2__add_user_dml.sql。
  2. 可重复运行的SQL，则以大写的“R”开头，后面再以两个下划线分割，其后跟文件名称，最后以.sql结尾。比如，R__truncate_user_dml.sql。

其中，V开头的SQL执行优先级要比R开头的SQL优先级高。

数据库名字为 flyway

首次执行需要在数据库实例flyway创建表flyway_schema_history``flyway_schema_history是flyway版本控制记录表，必须要创建。

CREATE TABLE `flyway_schema_history` (
  `installed_rank` int(11) NOT NULL,
  `version` varchar(50) DEFAULT NULL,
  `description` varchar(200) NOT NULL,
  `type` varchar(20) NOT NULL,
  `script` varchar(1000) NOT NULL,
  `checksum` int(11) DEFAULT NULL,
  `installed_by` varchar(100) NOT NULL,
  `installed_on` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `execution_time` int(11) NOT NULL,
  `success` tinyint(1) NOT NULL,
  PRIMARY KEY (`installed_rank`),
  KEY `flyway_schema_history_s_idx` (`success`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

接着如下，准备了三个脚本，分别为：

​ 1.V1__create_user.sql，其中代码如下，目的是建立一张user表，且只执行一次。

CREATE TABLE IF NOT EXISTS `USER`(
`USER_ID`          INT(11)           NOT NULL AUTO_INCREMENT,
`USER_NAME`        VARCHAR(100)      NOT NULL COMMENT '用户姓名',
`AGE`              INT(3)            NOT NULL COMMENT '年龄',
`CREATED_TIME`     datetime          NOT NULL DEFAULT CURRENT_TIMESTAMP,
`CREATED_BY`       varchar(100)      NOT NULL DEFAULT 'UNKNOWN',
`UPDATED_TIME`     datetime          NOT NULL DEFAULT CURRENT_TIMESTAMP,
`UPDATED_BY`       varchar(100)      NOT NULL DEFAULT 'UNKNOWN',
PRIMARY KEY (`USER_ID`)
)ENGINE=InnoDB DEFAULT CHARSET=utf8;

​ 2.V2__add_user.sql，其中代码如下，目的是往user表中插入一条数据，且只执行一次。

insert into `user`(user_name,age) values('lisi',33);

​ 3.R__add_unknown_user.sql，其中代码如下，目的是每次启动倘若有变化，则往user表中插入一条数据。

insert into `user`(user_name,age) values('unknown',33);

与之相对应的目录截图如下：

注意：这里的文件位置与yaml文件中的路径要对应，否则不能执行sql文件

下图中的文件位置与yaml中的一一对应
在这里插入图片描述
或者：
在这里插入图片描述

也可以执行指定文件夹中的sql

server:
  port: 8080

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/flywaydemo?characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&serverTimezone=Asia/Shanghai&useInformationSchema=true
    username: root
    password: 123456
    driver-class-name: com.mysql.jdbc.Driver

  flyway:
    enabled: true # 开启flyway
    # flyway 的 clean 命令会删除指定 schema 下的所有 table, 生产务必禁掉。这个默认值是 false 理论上作为默认配置是不科学的。
    clean-disabled: true
    locations: classpath:db/migration/create  #flyway文件目录
    table: flyway_schema_history  #历史表名
    baseline-on-migrate: true
    validate-on-migrate: true  #连续性校验
    baseline-version: 1 #指定默认版本
    encoding: UTF-8 #编码
    out-of-order: false # 是否允许不按顺序迁移 开发建议 true  生产建议 false
    sql-migration-prefix: V #前缀默认v
    sql-migration-separator: __ #分割符，默认__
    sql-migration-suffixes: .sql  #迁移文件，默认.sql

接下来，数据库中就会有user表了
在这里插入图片描述

但是另外两个sql文件并没有执行。

4、启动SpringBoot程序的主程序

到这一步，flyway的默认配置已经足够我们开始运行了。此时，我们启动SpringBoot的主程序，如果以上步骤没有配置错误的话，，启动时会自动执行数据库脚本文件。运行截图如下：

四、flyway注意点

​ 1.flyway执行migrate必须在空白的数据库上进行，否则报错；

​ 2.对于已经有数据的数据库，必须先baseline，然后才能migrate；

​ 3.clean操作是删除数据库的所有内容，包括baseline之前的内容；

​ 4.尽量不要修改已经执行过的SQL，即便是R开头的可反复执行的SQL，它们会不利于数据迁移；

五、flyway的配置清单

flyway.baseline-description对执行迁移时基准版本的描述.
flyway.baseline-on-migrate当迁移时发现目标schema非空，而且带有没有元数据的表时，是否自动执行基准迁移，默认false.
flyway.baseline-version开始执行基准迁移时对现有的schema的版本打标签，默认值为1.
flyway.check-location检查迁移脚本的位置是否存在，默认false.
flyway.clean-on-validation-error当发现校验错误时是否自动调用clean，默认false.
flyway.enabled是否开启flywary，默认true.
flyway.encoding设置迁移时的编码，默认UTF-8.
flyway.ignore-failed-future-migration当读取元数据表时是否忽略错误的迁移，默认false.
flyway.init-sqls当初始化好连接时要执行的SQL.
flyway.locations迁移脚本的位置，默认db/migration.
flyway.out-of-order是否允许无序的迁移，默认false.
flyway.password目标数据库的密码.
flyway.placeholder-prefix设置每个placeholder的前缀，默认${.
flyway.placeholder-replacementplaceholders是否要被替换，默认true.
flyway.placeholder-suffix设置每个placeholder的后缀，默认}.
flyway.placeholders.[placeholder name]设置placeholder的value
flyway.schemas设定需要flywary迁移的schema，大小写敏感，默认为连接默认的schema.
flyway.sql-migration-prefix迁移文件的前缀，默认为V.
flyway.sql-migration-separator迁移脚本的文件名分隔符，默认__
flyway.sql-migration-suffix迁移脚本的后缀，默认为.sql
flyway.tableflyway使用的元数据表名，默认为schema_version
flyway.target迁移时使用的目标版本，默认为latest version
flyway.url迁移时使用的JDBC URL，如果没有指定的话，将使用配置的主数据源
flyway.user迁移数据库的用户名
flyway.validate-on-migrate迁移时是否校验，默认为true
楠哥-------一心想为IT行业添砖加瓦，却总是面向cv编程的程序员。
  谢谢阅读，无误点赞，有误还望评论区指正。
楠哥学IT
关注
flyway的快速入门教程
web18484626332的博客
07-27 885
Flyway是一款开源的数据库版本管理工具。它可以很方便的在命令行中使用，或者在Java应用程序中引入，用于管理我们的数据库版本。在项目或产品中，很难一开始就把业务理清楚，把数据库表设计好，因此数据表也会在迭代周期不断迭代。在Java应用程序中使用Flyway，能快速有效地用于迭代数据库表结构，并保证部署到测试环境或生产环境时，数据表都是保持一致的。flyway官方文档[这里是图片001]https在控制台可以看到相关日志打印，并在数据库中查看到已经创建好的表和相关记录变更。...
springboot 3 + mysql8 + flyway 数据库版本管理
AimerDaniel的博客
01-21 2393
对于数据库每当发布时会出现手动执行sql脚本进行升级数据库，中间经常出现一些漏写、错写情况，对数据库的版本与代码的版本不匹配，R 代表可重复变迁(Repeatable Migrations)，一般为可重复执行的sql语句。1）flyway是个管理数据库版本的工具，可以对不同环境的sql进行迁移操作。== 其中，V开头的SQL执行优先级要比R开头的SQL优先级高==U 代表撤销变迁(Undo Migrations)，版本号: 唯一的版本号，比如V1.0.1。描述信息: 描述信息。
Flyway SpringBoot中使用
椰汁菠萝
05-17 1396
通过版本化数据库，提高数据库迁移的可靠性。即启动项目时就按版本执行sql脚本，实现数据库自动迁移。Flyway是一款开源的数据库版本管理工具，它能够实现数据库迁移和版本控制。Flyway通过SQL脚本或Java代码进行数据库变更，支持多种数据库，如MySQL、Oracle、SQL Server等。
Flyway详解（使用说明及避坑指南、一文搞懂flyway）
热门推荐
Jiao1225的博客
03-16 7万+
Flyway详解，包含工作原理、使用说明、避坑指南、以及团队使用时的注意事项
数据库版本管理工具Flyway使用介绍
scorpio的博客
02-20 4628
数据库版本管理工具Flyway使用介绍
flyway快速入门基础教程
大龄烤红薯的博客
12-15 1801
flyway快速入门基础教程
SpringBoot集成Flyway
最新发布
Jacks丶的博客
03-23 3379
Flyway 本质上是一个开源的数据库迁移工具，它能够以自动化、可重复且可靠的方式管理数据库的变更。无论是小型项目还是大型企业级应用，Flyway 都能助力开发者轻松应对数据库架构的演进。它支持多种数据库，如常见的 MySQL、Oracle、SQL Server、PostgreSQL 等，这使其在不同的技术栈中都能大显身手。如果数据库类型在有定义，Flyway默认支持根据不同的数据库读取不同的脚本文件，只需要配置即可实现自动切换读取脚本的路径。
【Flyway 介绍】
gaojingsong的专栏
07-21 1469
Flyway须要在DB中先建立一个metadata表(缺省表名为flyway_schema_history),在该表中保存着每次migration（迁移）的记录,记录包含migration脚本的版本号和SQL脚本的checksum值。Flyway可以独立于应用实现管理并跟踪数据库变更，支持数据库版本自动升级，并且有一套默认的规约，不需要复杂的配置，Migrations可以写成SQL脚本。它有一个命令行客户端。专为连续交付而设计，让Flyway在应用程序启动时迁移数据库。...
Flyway简介及使用
solo的博客
12-04 1万+
Flyway简介及使用 1、简介 1.1 Flyway是什么？ Flyway是一款开源的数据库版本管理工具，它更倾向于规约优于配置的方式。 Flyway可以独立于应用实现管理并跟踪数据库变更，支持数据库版本自动升级，并且有一套默认的规约，不需要复杂的配置。 Migrations可以写成SQL脚本，也可以写在Java代码中，不仅支持Command Line和Java API，还支持Build构建工具和Spring Boot等。 同时在分布式环境下能够安全可靠地升级数据库，同时也支持失败恢复等。 关于F
数据库版本控制利器：Flyway
LiuZihao97的博客
06-20 752
Flyway简介 数据库的版本控制。 在所有环境中进行稳健的架构演变。 轻松，愉快和简单的SQL。 官网：https://flywaydb.org/ Spring Boot整合Flyway 1、添加依赖 <dependency> <groupId>org.flywaydb</groupId> <artifactId>flyway-core</artifactId> <v
数据库版本控制和迁移的工具之Flyway
西京刀客
03-18 1101
Flyway 是一个用于数据库版本控制和迁移的工具，它使用纯 SQL 来管理数据库的变化。Flyway 帮助开发人员自动化数据库的部署过程，确保数据库在不同环境中的一致性。通过 Flyway，开发人员可以轻松地跟踪和管理数据库的变更历史，从而避免手动操作带来的错误和不一致性。
数据库版本管理框架-Flyway（从入门到精通）
可乐要加冰！！！
12-09 4696
数据库版本管理框架-Flyway（从入门到精通）
flyway数据库版本控制
dark159735的博客
01-27 6356
一.Flyway简介 Flyway是一款数据库迁移（migration）工具。简单点说，就是在你部署应用的时候，帮你执行数据库脚本的工具。Flyway支持SQL和Java两种类型的脚本，你可以将脚本打包到应用程序中，在应用程序启动时，由Flyway来管理这些脚本的执行，这些脚本被Flyway称之为migration。 二.使用 一.导入依赖 <!-- flyway--> <dependency> <groupId>org.flywaydb</groupId&g
Flyway 数据库版本控制
qq_37196321的博客
06-20 6941
在我们日常产品发布的过程中，代码的版本控制可以使用git、svn工具实现。对于数据库每当发布时会出现手动执行sql脚本进行升级数据库，中间经常出现一些漏写、错写情况，对数据库的版本与代码的版本不匹配，导致上线后出现数据库不同步的问题。flyway就是对数据库版本进行控制的工具.........
flyway 数据库版本控制
htfghgg的博客
07-22 2320
Flyway是一款由Boxfuse（现为Redgate）公司开发并维护的开源数据库版本管理工具。它通过版本化的方式管理数据库的变更和迁移，帮助开发者在不同环境间保持数据库的同步，减少手工操作，降低遗漏的风险。
flyway使用
xixingzhe2的博客
04-02 6261
一、Flyway是什么 官网解释地非常全面，可先大致阅读一下。 简单地说，flyway是一个能对数据库变更做版本控制的工具。 二、为什么要用Flyway 在多人开发的项目中，我们都习惯了使用SVN或者Git来对代码做版本控制，主要的目的就是为了解决多人开发代码冲突和版本回退的问题。 其实，数据库的变更也需要版本控制，在日常开发中，我们经常会遇到下面的问题： 自己写的SQL忘了在所有环境执行； 别人写的SQL我们不能确定是否都在所有环境执行过了； 有人修改了已经执行过的SQL，期望再次执行；
【SpringBoot系列】使用Flyway管理数据库版本
Hyatt的博客
01-09 3399
我们都知道，Git/SVN 是代码界的版本控制工具，那么，Flyway 就是数据库界的版本控制工具，它可以记录数据库的变化记录。
flyway：数据库版本管理
xyc1211的博客
05-18 2916
用通俗的话讲，Flyway可以像Git管理不同人的代码那样，管理不同 人的sql脚本，从而做到数据库同步。将“flyway-9.16.1”目录添加到“PATH”中，使“flyway”命令在系统的任何位置都可用。用来记录数据库已经执行过的migration，知道当前的基线在哪里，哪些不用执行，哪些要执行。相当于git的.git文件，把当前目录纳入管理，记录变化，知道哪些文件要提交，哪些不用提交。Flyway是独立于数据库的应用、管理并跟踪数据库变更的数据库版本管理工具。使你可以在执行过程中加入额外的操作.
数据库版本管理工具 Flyway 使用
清茶的博客
10-08 5874
Flyway是一款开源的数据库版本管理工具，使用简单，应用无侵入。面向 SQL，选择 Flyway不面向 SQL，选择 Liquibase。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值