久違了的Spring Boot系列殉疼，今天抽空更新一篇。去年寫過很多篇關(guān)于數(shù)據(jù)訪問的文章了涧郊，比如下面這些：
如果沒有讀過上面內(nèi)容的讀者蟀悦，有興趣的可以一閱荤牍。在上面的使用JdbcTemplate一文中，主要通過spring提供的JdbcTemplate實(shí)現(xiàn)對用戶表的增刪改查操作啰脚。在實(shí)現(xiàn)這個(gè)例子的時(shí)候殷蛇，我們事先在MySQL中創(chuàng)建了用戶表。創(chuàng)建表的過程我們在實(shí)際開發(fā)系統(tǒng)的時(shí)候會(huì)經(jīng)常使用橄浓，但是一直有一個(gè)問題存在粒梦，由于一個(gè)系統(tǒng)的程序版本通過git得到了很好的版本控制，而數(shù)據(jù)庫結(jié)構(gòu)并沒有荸实，即使我們通過Git進(jìn)行了語句的版本化匀们，那么在各個(gè)環(huán)境的數(shù)據(jù)庫中如何做好版本管理呢？下面我們就通過本文來學(xué)習(xí)一下在Spring Boot中如何使用Flyway來管理數(shù)據(jù)庫的版本准给。
Flyway簡介
Flyway是一個(gè)簡單開源數(shù)據(jù)庫版本控制器（約定大于配置）泄朴，主要提供migrate、clean露氮、info祖灰、validate、baseline畔规、repair等命令局扶。它支持SQL（PL/SQL、T-SQL）方式和Java方式，支持命令行客戶端等三妈，還提供一系列的插件支持（Maven畜埋、Gradle、SBT畴蒲、ANT等）悠鞍。
官方網(wǎng)站：https://flywaydb.org/
本文對于Flyway的自身功能不做過多的介紹，讀者可以通過閱讀官方文檔或利用搜索引擎獲得更多資料饿凛。下面我們具體說說在Spring Boot應(yīng)用中的應(yīng)用狞玛，如何使用Flyway來創(chuàng)建數(shù)據(jù)庫以及結(jié)構(gòu)不一致的檢查。
動(dòng)手試一試
下面我們可以通過對使用JdbcTemplate一文中的例子進(jìn)行加工完成涧窒。讀者也可以拿任何一個(gè)與數(shù)據(jù)訪問相關(guān)的工程來做如下內(nèi)容的實(shí)驗(yàn)：
- 第一步心肪，在
pom.xml中增加flyway的依賴：
<dependency>
<groupId>org.flywaydb</groupId>
<artifactId>flyway-core</artifactId>
<version>5.0.3</version>
</dependency>
- 第二步，按Flyway的規(guī)范創(chuàng)建版本化的SQL腳本纠吴。
- 在工程的
src/main/resources目錄下創(chuàng)建db目錄 - 在
db目錄下創(chuàng)建版本化的SQL腳本V1__Base_version.sql
- 在工程的
DROP TABLE IF EXISTS user ;
CREATE TABLE `user` (
`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主鍵',
`name` varchar(20) NOT NULL COMMENT '姓名',
`age` int(5) DEFAULT NULL COMMENT '年齡',
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
- 第三步硬鞍，在
application.properties文件中配置Flyway要加載的SQL腳本位置。按第二步創(chuàng)建的結(jié)果配置如下：
flyway.locations=classpath:/db
- 第四步戴已，執(zhí)行單元測試
ApplicationTests固该，此時(shí)我們在日志中可以看到如下信息：
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監(jiān)測到需要運(yùn)行版本腳本來初始化數(shù)據(jù)庫，因此執(zhí)行了V1__Base_version.sql腳本糖儡，從而創(chuàng)建了user表伐坏，這才得以讓一系列單元測試（對user表的CRUD操作）通過。
- 第五步握联，我們可以繼續(xù)再執(zhí)行一下單元測試桦沉，此時(shí)我們會(huì)發(fā)現(xiàn)日志輸出與之前不同：
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.
由于在第四步的時(shí)候，初始化腳本已經(jīng)執(zhí)行過金闽，所以這次執(zhí)行就沒有再去執(zhí)行V1__Base_version.sql腳本來重建user表纯露。
- 第六步，我們可以嘗試修改一下
V1__Base_version.sql腳本中的name字段長度代芜，然后在運(yùn)行一下單元測試埠褪，此時(shí)我們可以得到如下錯(cuò)誤：
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
由于初始化腳本的改動(dòng)，F(xiàn)lyway校驗(yàn)失敗挤庇，認(rèn)為當(dāng)前的V1__Base_version.sql腳本與上一次執(zhí)行的內(nèi)容不同钞速，提示報(bào)錯(cuò)并終止程序，以免造成更嚴(yán)重的數(shù)據(jù)結(jié)構(gòu)破壞罚随。
總結(jié)
到這里為止玉工，本文的內(nèi)容告一段落。由于博文篇幅問題淘菩，對于Flyway更細(xì)節(jié)的使用沒有說的太多遵班，本文主要作為敲門磚屠升，幫助和引導(dǎo)正在使用Spring Boot做系統(tǒng)開發(fā)的個(gè)人或團(tuán)隊(duì)在數(shù)據(jù)庫的版本控制上做的更好提供一些思路。至于更深入的應(yīng)用還請讀者自行翻閱官方文檔參考和學(xué)習(xí)狭郑。
本文代碼
可以通過下面兩個(gè)倉庫中查閱Chapter3-2-9目錄：
- Github：https://github.com/dyc87112/SpringBoot-Learning/
- Gitee：https://gitee.com/didispace/SpringBoot-Learning
