SpringBoot结合Flyway实现数据库版本管理及配置文件说明

╰半夏微凉° 2022-05-14 15:16 506阅读 0赞

# SpringBoot结合Flyway实现数据库版本管理及配置文件说明 #

### 文章目录 ###

*  前言
 *  实例
 *  其它配置
 *  拓展

# 前言 #

Flyway是个很好的数据库版本管理工具，根据版本号顺序执行sql文件，维护一个统一的数据库，适用于多人协作开发。  
可以参考下面文章，说明很详细  
[快速掌握和使用Flyway][Flyway]  
[Flyway官网][Flyway 1]  
我关注的是实战，以及`Springboot`如何配置Flyway，同时`Springboot`都支持Flyway哪些默认配置。

# 实例 #

`maven引入Flyway-core.jar`

<dependency>
        <groupId>org.flywaydb</groupId>
        <artifactId>flyway-core</artifactId>
        <version>5.2.1</version>
    </dependency>

`Gradle引入Flyway-core.jar`

compile "org.flywaydb:flyway-core:5.2.1"

上面代码可以从[官网API(Java/Android)页签上找到][API_Java_Android]。

`flyway`迁移默认路径是`resources/db/migration`  
默认记录更新版本的表名是`flyway_schema_history`

在`springboot`的配置文件里配置`application.yml`即可:

#数据库版本管理和迁移
      flyway:
        baseline-on-migrate: true
        table: schame_version

如果我们没有配置`url/user/password`那么`springboot`会使用主要的`datasource`配置，换句话说，如果我们配置了`mysql`数据库，而`flyway`也是管理这个数据库，那么url等参数可以不配置。

至此Flyway配置完成，剩余就是写sql语句，我相信不用我再继续说了。

# 其它配置 #

从官网上我们可以得到`Flyway`的配置文件[Config Files][]。  
同时Flyway是支持Springboot的，所以SpringBoot同样对Flyway有默认配置，可以看[SpringBoot对Flyway的自动化配置][SpringBoot_Flyway]，默认配置如下：

@ConfigurationProperties(prefix = "flyway", ignoreUnknownFields = true)
    public class FlywayProperties {
    
    	/**
    	 * Locations of migrations scripts. Can contain the special "{vendor}" placeholder to
    	 * use vendor-specific locations.
    	 */
    	private List<String> locations = new ArrayList<String>(
    			Collections.singletonList("db/migration"));
    
    	/**
    	 * Check that migration scripts location exists.
    	 */
    	private boolean checkLocation = false;
    
    	/**
    	 * Enable flyway.
    	 */
    	private boolean enabled = true;
    
    	/**
    	 * Login user of the database to migrate.
    	 */
    	private String user;
    
    	/**
    	 * Login password of the database to migrate.
    	 */
    	private String password;
    
    	/**
    	 * JDBC url of the database to migrate. If not set, the primary configured data source
    	 * is used.
    	 */
    	private String url;
    
    	/**
    	 * SQL statements to execute to initialize a connection immediately after obtaining
    	 * it.
    	 */
    	private List<String> initSqls = new ArrayList<String>();
    
    	...getter/setter
    }

上面是springboot自动化配置Flyway的属性。我想说明3点

1.  springboot支持flyway的自动配置，我们可以从上面网址上找到flyway配置。这样不至于我们不知道怎么配置flyway
2.  上面没出现的flyway属性我们一样可以写。`FlywayProperties.java`文件的意思是springboot提供的配置优先于flyway本身的配置，当然，我们可以埴写flyway其它的配置文件，比如`FlywayProperties.java`里没有`sqlMigrationPrefix`属性，但它在Flyway配置里有，那我们依然可以`spring.flyway.sqlMigrationPrefix: "V"`这样配置。
3.  springboot配置名怎么写？`spring.flyway.sqlMigrationPrefix: "V"`和`spring.flyway.sql-migration-prefix: "V"`是等价的。

授人以鱼不如授人以渔，我写的是从哪里可以找到配置，而不是配置本身。  
[官方Config Files][Config Files]  
[SpringBoot对Flyway的自动化配置][SpringBoot_Flyway]

# 拓展 #

访问[springboot其它项目的配置][springboot]，看到很多项目的配置，当然它不是很全，比较redis就没在里面。访问`web/ServerProperties.java`

@ConfigurationProperties(prefix = "server", ignoreUnknownFields = true)
    public class ServerProperties
    		implements EmbeddedServletContainerCustomizer, EnvironmentAware, Ordered {
    
    	/**
    	 * Server HTTP port.
    	 */
    	private Integer port;
    
    	/**
    	 * Network address to which the server should bind to.
    	 */
    	private InetAddress address;
    
    	....
    
    
    }

是不是很熟悉，它就是我们常要使用的application.yml如下配置

server:
      port:
      address: localhost

如果找不到springboot如何配置基本个项目，2种解决办法

*  试着从这里找试试，[springboot其它项目的配置][springboot]
 *  从官方的配置文件上下手，找到配置文件，在`application.yml`配置属性，按住ctrl，鼠标移到配置上，看是不是出现手型。

[Flyway]: https://blog.csdn.net/u014091123/article/details/78133522
[Flyway 1]: https://flywaydb.org/documentation/configfiles#structure
[API_Java_Android]: https://flywaydb.org/documentation/api/
[Config Files]: https://flywaydb.org/documentation/configfiles
[SpringBoot_Flyway]: https://github.com/spring-projects/spring-boot/blob/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayProperties.java
[springboot]: https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure