AI专业者开发社区 1 号成员
  •  0 回帖  •  3 浏览  •  4 个月前
 

Spring Boot教程（四十）使用Flyway来管理数据库版本

在上面的使用 JdbcTemplate一文中，主要通过 spring 提供的 JdbcTemplate 实现对用户表的增删改查操作。在实现这个例子的时候，我们事先在 MySQL 中创建了用户表。创建表的过程我们在实际开发系统的时候会经常使用，但是一直有一个问题存在，由于一个系统的程序版本通过 git 得到了很好的版本控制，而数据库结构并没有，即使我们通过 Git 进行了语句的版本化，那么在各个环境的数据库中如何做好版本管理呢？下面我们就通过本文来学习一下在 Spring Boot 中如何使用 Flyway 来管理数据库的版本。

Flyway 简介

Flyway 是一个简单开源数据库版本控制器（约定大于配置），主要提供 migrate、clean、info、validate、baseline、repair 等命令。它支持 SQL（PL/SQL、T-SQL）方式和 Java 方式，支持命令行客户端等，还提供一系列的插件支持（Maven、Gradle、SBT、ANT 等）。

官方网站：https://flywaydb.org/

本文对于 Flyway 的自身功能不做过多的介绍，读者可以通过阅读官方文档或利用搜索引擎获得更多资料。下面我们具体说说在 Spring Boot 应用中的应用，如何使用 Flyway 来创建数据库以及结构不一致的检查。

动手试一试

下面我们可以通过对使用 JdbcTemplate一文中的例子进行加工完成。读者也可以拿任何一个与数据访问相关的工程来做如下内容的实验：

  • 第一步，在pom.xml中增加 flyway 的依赖：
  • ?
    1
    2
    3
    4
    5
    <dependency>
        <groupId>org.flywaydb</groupId>
        <artifactId>flyway-core</artifactId>
        <version>5.0.3</version>
    </dependency>

    　　

    第二步，按 Flyway 的规范创建版本化的 SQL 脚本。

  • 在工程的src/main/resources目录下创建db目录
  • 在db目录下创建版本化的 SQL 脚本V1__Base_version.sql
  • 第三步，在application.properties文件中配置 Flyway 要加载的 SQL 脚本位置。按第二步创建的结果配置如下：
    ?
    1
    flyway.locations=classpath:/db
  • 第四步，执行单元测试ApplicationTests，此时我们在日志中可以看到如下信息：
    ?
    1
    2
    3
    4
    5
    6
    7
    8
    INFO 82441 --- [main] o.f.core.internal.util.VersionPrinter    : Flyway Community Edition 5.0.3 by Boxfuse
    INFO 82441 --- [main] o.f.c.internal.database.DatabaseFactory  : Database: jdbc:mysql://localhost:3306/test (MySQL 5.7)
    INFO 82441 --- [main] o.f.core.internal.command.DbValidate     : Successfully validated 1 migration (execution time 00:00.022s)
    INFO 82441 --- [main] o.f.c.i.s.JdbcTableSchemaHistory         : Creating Schema History table: `test`.`flyway_schema_history`
    INFO 82441 --- [main] o.f.core.internal.command.DbMigrate      : Current version of schema `test`: << Empty Schema >>
    INFO 82441 --- [main] o.f.core.internal.command.DbMigrate      : Migrating schema `test` to version 1 - Base version
    WARN 82441 --- [main] o.f.core.internal.sqlscript.SqlScript    : DB: Unknown table 'test.user' (SQL State: 42S02 - Error Code: 1051)
    INFO 82441 --- [main] o.f.core.internal.command.DbMigrate      : Successfully applied 1 migration to schema `test` (execution time 00:00.128s)

    　　

    Flyway 监测到需要运行版本脚本来初始化数据库，因此执行了V1__Base_version.sql脚本，从而创建了 user 表，这才得以让一系列单元测试（对 user 表的 CRUD 操作）通过。

  • 第五步，我们可以继续再执行一下单元测试，此时我们会发现日志输出与之前不同：
    ?
    1
    2
    3
    4
    5
    INFO 83150 --- [main] o.f.core.internal.util.VersionPrinter    : Flyway Community Edition 5.0.3 by Boxfuse
    INFO 83150 --- [main] o.f.c.internal.database.DatabaseFactory  : Database: jdbc:mysql://localhost:3306/test (MySQL 5.7)
    INFO 83150 --- [main] o.f.core.internal.command.DbValidate     : Successfully validated 1 migration (execution time 00:00.031s)
    INFO 83150 --- [main] o.f.core.internal.command.DbMigrate      : Current version of schema `test`: 1
    INFO 83150 --- [main] o.f.core.internal.command.DbMigrate      : Schema `test` is up to date. No migration necessary.

    　　

    由于在第四步的时候，初始化脚本已经执行过，所以这次执行就没有再去执行V1__Base_version.sql脚本来重建 user 表。

  • 第六步，我们可以尝试修改一下V1__Base_version.sql脚本中的 name 字段长度，然后在运行一下单元测试，此时我们可以得到如下错误：
    ?
    1
    2
    3
    4
    5
    ERROR 83791 --- [main] o.s.boot.SpringApplication               : Application startup failed
     
    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 1
    -> Applied to database : 466264992
    -> Resolved locally    : -270269434

    由于初始化脚本的改动，Flyway 校验失败，认为当前的V1__Base_version.sql脚本与上一次执行的内容不同，提示报错并终止程序，以免造成更严重的数据结构破坏。

  • 源码来源