浅谈flywaydb

    一般来说，软件发布应该包含文档、代码和DB脚本等，在发布上线时，一般都需要先执行DB脚本，再启动软件，犹豫一些疏忽之类，经常容易出现数据库未升级导致软件发布失败的场景，因此一些组件提供了启动自动执行DB的操作，例如hibernate提供了auto_ddl的属性，能够根据实体类自动进行DDL操作，但是对于数据的升级，例如需要插入初始数据或者修改数据库数据时，一般只能靠发布者手动执行。 flywaydb就是一个解决数据库版本迁移的工具，不仅执行DDL类的数据迁移，同时支持数据类的迁移，为数据库的升级提供了一种很好的解决方案。

    flywaydb同时提供了Java API和命令行两种执行方式，其迁移脚本支持SQL或者Java，其对于Java做了很完美的支持，同时提供了与spring整合的功能，因此非常适合整合到Java WEB项目中。flyway默认读取$CLASS_PATH/db/migration目录及其子目录下的SQL或者Java脚本，同时也可以通过locations属性自定义多个目录。

flywaydb对于脚本名称有一定的约束，脚本名称必须以“版本号__描述”的格式组成，版本高可以是整数、浮点数、甚至是日期，例如下面这些都是符合flywaydb的命名方式。

1
001
5.2
5_2
1.2.3.4.5.6.7.8.9
205.68
20130115113556
2013.1.15.11.35.56
2013.01.15.11.35.56

因为 flywaydb会在需要升级的数据库中创建一张schema_version的数据meta表，里面保存了数据库升级的详细版本信息，每次项目启动时，会检查是否提供了新版本的数据库升级脚本，如果存在则先只需数据库升级，并将详细结果写到schema_version表中。flywaydb对于每个升级脚本都是以事务的方式进行提交，如果需要自定义是否已事务提交，只需实现MigrationResolver借口即可，例如

public class DemoResolver implements MigrationResolver {
    public Collection resolveMigrations() {
        return Arrays.asList((ResolvedMigration) new ResolvedMigration() {
	   //本次升级的版本号
            public MigrationVersion getVersion() {
                return MigrationVersion.fromVersion("3.0");
            }

            public String getDescription() {
                return "Custom Resolved";
            }
	    //执行的脚本名称
            public String getScript() {
                return "V3__Update_Table";
            }

            public Integer getChecksum() {
                return 1;
            }

            public MigrationType getType() {
                return MigrationType.CUSTOM;
            }

            //需要只需的脚本物理位置
            public String getPhysicalLocation() {
                return null;
            }
	    //迁移执行器包装了需要执行的迁移脚本以及是否已事务的方式进行执行
            public MigrationExecutor getExecutor() {
                return new MigrationExecutor() {
                    @Override
                    public void execute(Connection connection) throws SQLException {
                        Statement statement = null;
                        try {
                            statement = connection.createStatement();
                            statement.execute("INSERT INTO user_spring (name) VALUES ('Resolvix')");
                        } finally {
                            JdbcUtils.closeStatement(statement);
                        }
                    }

                    @Override
                    public boolean executeInTransaction() {
                        return true;
                    }
                };
            }
        });
    }
}

如果项目中集成了spring框架，则只需实现SpringJdbcMigration接口即可，本人已经写了一个简单的demo，包好了SQL、JDBC、spring、spring-boot。需要的可以在 Github上下载。

关于flywaydb原理，可以参考这篇文章，

使用flywaydb需要注意几点：

1、脚本名称必须以“版本号__描述”的格式，其中版本号和描述之间是两个"_"

2、如果将一个已经存在的数据库加入到flyway中进行版本管理，需要配置baseline为true

参考资料

https://github.com/michael8335/flywaydb-demo

https://flywaydb.org/getstarted/how