spring项目接入flyway（一） 背景、快速入门

目录

一、背景

1.1 为什么使用数据库版本控制工具？

1.2 liquibase和flyway

二、快速开始

2.1 flyway基础

2.2 通过maven使用flyway

2.3 项目结构

2.4 maven集成flyway

2.5 使用Spring和flyway自动初始化数据库

2.6 配置相关的application.yml参数

2.6.1 flyway参数说明

---

​​​​​​​​​​​​​​

官方文档：https://flywaydb.org/documentation/​​​​​​​

本文项目代码仓库：https://github.com/Rudy0530/readinglist

 

 

一、背景

1.1 为什么使用数据库版本控制工具？

 

作为开发人员，代码版本控制已经属于标配了，但是很多团队还不会把数据库schema纳入版本控制。在开发期间，schema随着需求变化，而这些变化难以追踪记录，从而导致开发人员之间，以及各个环境下的数据库schema的一致性问题。

引入数据库schema版本管理，是期望模仿代码版本控制，把schema的所有版本记录下来，并且可以自动地把数据库升级到最新版本。

 

 

 

1.2 liquibase和flyway

liquibase和flyway都是数据库schema版本管理工具。liquibase提供了更强大的功能，比如多数据库支持，rollback等。而flyway没有引入过多的概念，使用更为简单。在够用的情况下，使用flyway学习成本更低。

 

 

 

二、快速开始

 

2.1 flyway基础

flyway要求为每一次数据库schema变更创建一个sql语句，以VN（双下划线）作为前缀（比如V1__create_table_A.sql, V2__create_index_on_field_1。）

 

 

2.2 通过maven使用flyway

flyway支持命令行，java api，maven，gradle等各种方式调用。我接触的项目使用maven进行管理，所以选择了通过maven使用flyway的方式。

 

 

2.3 项目结构

下面是在标准的maven文件夹结构中，增加了/src/resources/db/migration，用于存放数据库脚本。

 

 

2.4 maven集成flyway

把以下节点放入pom.xml。flyway需要配置数据库驱动依赖和数据库连接，例子如下：

    4.0.0
    
        org.springframework.boot
        spring-boot-starter-parent
        2.5.1
         
    
    com.manning
    readinglist
    0.0.1-SNAPSHOT
    readinglist
    reading list demo
    
        11
    
    
        
            org.springframework.boot
            spring-boot-starter-data-jpa
        
        
            org.springframework.boot
            spring-boot-starter-thymeleaf
        
        
            org.springframework.boot
            spring-boot-starter-web
        

        
            org.postgresql
            postgresql
            runtime
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
        
        
            org.projectlombok
            lombok
        
        
        
            org.flywaydb
            flyway-core
        
    

    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
            
            
                org.flywaydb
                flyway-maven-plugin
                7.10.0
                
                    
                    
                        org.flywaydb
                        flyway-maven-plugin
                        7.10.0
                    
                
                
                    
                    UTF-8
                
            
        
    

 

 

 

 

2.5 使用Spring和flyway自动初始化数据库

可以设置在Spring启动的时候，自动检测数据库版本，如果不是最新的，则自动更新。但一般生产环境应该不会使用这种，这种能力，一般应该是在自动化测试里面使用，每次自动化测试前，使用flyway创建一个新的数据库。

首先需要在pom添加flyway-core依赖。

    org.flywaydb
    flyway-core

 

 

2.6 配置相关的application.yml参数

spring:
  datasource:
    driver-class-name: org.postgresql.Driver
    username: postgres
    url: jdbc:postgresql://127.0.0.1:5432/rudy
    password: 111
  flyway:
    url: jdbc:postgresql://127.0.0.1:5432/rudy
    user: postgres
    password: 111
    enabled: true
    locations: classpath:db/migration
    baseline-on-migrate: true

 

2.6.1 flyway参数说明

 https://flywaydb.org/documentation/configfiles

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.


 
spring.flyway.cleanDisabled = true 
  # flyway 的 clean 命令会删除指定 schema 下的所有 table, 杀伤力太大了, 应该禁掉. 
spring.flyway.enabled = true
  # 启用或禁用 flyway 
spring.flyway.locations =classpath:db/migration
  # 设定 SQL 脚本的目录,多个路径使用逗号分隔, 比如取值为 classpath:db/migration,filesystem:/sql-migrations
spring.flyway.baselineOnMigrate=true
  # 如果指定 schema 包含了其他表,但没有 flyway schema history 表的话, 在执行 flyway migrate 命令之前, 必须先执行 flyway baseline 命令.
  # 设置 spring.flyway.baseline-on-migrate 为 true 后, flyway 将在需要 baseline 的时候, 自动执行一次 baseline. 
spring.flyway.baselineVersion=1 
  # 指定 baseline 的版本号,缺省值为 1, 低于该版本号的 SQL 文件, migrate 的时候被忽略. 
#spring.flyway.encoding=
  # Encoding of SQL migrations (default: UTF-8)
spring.flyway.table=flyway_schema_history_myapp
  # 设定 flyway 的 metadata 表名, 缺省为 flyway_schema_history
spring.flyway.outOfOrder=true
  # 开发环境最好开启 outOfOrder, 生产环境关闭 outOfOrder . 
#spring.flyway.schemas=
  # 需要 flyway 管控的 schema list, 缺省的话, 使用的时 dbsource.connection直连上的那个 schema, 可以指定多个schema, 但仅会在第一个schema下建立 metadata 表, 也仅在第一个schema应用migration sql 脚本. 但flyway Clean 命令会依次在这些schema下都执行一遍.