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來創建數據庫以及結構不一致的檢查。
#動手試試
下面我們先預設一個開發目標：
- 假設我們需要開發一個用戶管理系統，那么我們勢必要設計一張用戶表，并實現對用戶表的增刪改查操作。
- 在任務1的功能完成之后，我們又有一個新需求，需要對用戶表增加了一個字段，看看如何實現對數據庫表結構的更改。
目標 1 的實現
第一步：創建一個基礎的Spring Boot項目，并在pom.xml中加入Flyway、MySQL連接和數據訪問相關的必要依賴（這里選用spring-boot-starter-jdbc作為例子）
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>org.flywaydb</groupId>
<artifactId>flyway-core</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
第二步：按Flyway的規范創建版本化的SQL腳本。
- 在工程的
src/main/resources目錄下創建db目錄，在db目錄下再創建migration目錄 - 在
migration目錄下創建版本化的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;
注意：如果你不想將SQL腳本放到其他目錄，可以用spring.flyway.locations參數來配置。這里不同于1.x版本的配置項flyway.locations
第三步：根據User表的結構，編寫對應的實體定義
@Data
@NoArgsConstructor
public class User {
private Long id;
private String name;
private Integer age;
}
第四步：編寫用戶操作接口和實現
public interface UserService {
/**
* 新增一個用戶
*
* @param name
* @param age
*/
int create(String name, Integer age);
/**
* 根據name查詢用戶
*
* @param name
* @return
*/
List<User> getByName(String name);
/**
* 根據name刪除用戶
*
* @param name
*/
int deleteByName(String name);
/**
* 獲取用戶總量
*/
int getAllUsers();
/**
* 刪除所有用戶
*/
int deleteAllUsers();
}
@Service
public class UserServiceImpl implements UserService {
private JdbcTemplate jdbcTemplate;
UserServiceImpl(JdbcTemplate jdbcTemplate) {
this.jdbcTemplate = jdbcTemplate;
}
@Override
public int create(String name, Integer age) {
return jdbcTemplate.update("insert into USER(NAME, AGE) values(?, ?)", name, age);
}
@Override
public List<User> getByName(String name) {
List<User> users = jdbcTemplate.query("select * from USER where NAME = ?", (resultSet, i) -> {
User user = new User();
user.setId(resultSet.getLong("ID"));
user.setName(resultSet.getString("NAME"));
user.setAge(resultSet.getInt("AGE"));
return user;
}, name);
return users;
}
@Override
public int deleteByName(String name) {
return jdbcTemplate.update("delete from USER where NAME = ?", name);
}
@Override
public int getAllUsers() {
return jdbcTemplate.queryForObject("select count(1) from USER", Integer.class);
}
@Override
public int deleteAllUsers() {
return jdbcTemplate.update("delete from USER");
}
}
這里主要介紹Flyway的應用，所以采用這種比較簡單的編寫方式，實際項目應用中，還是推薦MyBatis的具體操作實現。
第五步：編寫測試用例
@Slf4j
@SpringBootTest
public class Chapter311ApplicationTests {
@Autowired
private UserService userSerivce;
@Test
public void test() throws Exception {
userSerivce.deleteAllUsers();
// 插入5個用戶
userSerivce.create("Tom", 10);
userSerivce.create("Mike", 11);
userSerivce.create("Didispace", 30);
userSerivce.create("Oscar", 21);
userSerivce.create("Linda", 17);
// 查詢名為Oscar的用戶，判斷年齡是否匹配
List<User> userList = userSerivce.getByName("Oscar");
Assertions.assertEquals(21, userList.get(0).getAge().intValue());
// 查數據庫，應該有5個用戶
Assertions.assertEquals(5, userSerivce.getAllUsers());
// 刪除兩個用戶
userSerivce.deleteByName("Tom");
userSerivce.deleteByName("Mike");
// 查數據庫，應該有5個用戶
Assertions.assertEquals(3, userSerivce.getAllUsers());
}
}
注意由于Spring Boot 2.4應用的junit版本與之前Spring Boot 1.x版本中的不同，因此單元測試的編寫略有區別，有興趣的讀者可以分別查看之前介紹文章和這篇文章中的單元測試的區別，這里就不細說了。
第六步：運行上面編寫的單元測試，驗證一下效果。
不出意外，單元測試運行ok的話
連上數據庫看看。此時應該多出了這兩張表：
user表就是我們維護在SQL腳本中要創建的表flyway_schema_history表是flyway的管理表，用來記錄在這個數據庫上跑過的腳本，以及每個腳本的檢查依據。這樣每次應用啟動的時候，就可以知道哪個腳本需要運行，或者哪個腳本發生了變動，運行基礎可能不對，造成數據結構的混亂而阻止運行。
目標 2 的實現
有了上面的基礎之后，我們來說說后續要做表結構的表變動該怎么操作，這也是之前讀者出現問題最多的情況，所以在2.x版本教程中特地講一講。
首先，大家在開始使用Flyway之后，對于數據庫表接口的變更就要關閉這幾個途徑：
- 直接通過工具登錄數據去修改表結構
- 已經發布的sql腳本不允許修改
正確的表結構調整途徑：在flyway腳本配置路徑下編寫新的腳本，啟動程序來執行變更。這樣可以獲得幾個很大的好處：
- 腳本受Git版本管理控制，可以方便的找到過去的歷史
- 腳本在程序啟動的時候先加載，再提供接口服務，一起完成部署步驟
- 所有表結構的歷史變遷，在管理目錄中根據版本號就能很好的追溯
下面根據一個實際需求來具體操作下。假設我們現在想對User表增加一個字段：address，用來存儲用戶的通訊地址，那么我們就需要這樣操作實現。
第一步：創建腳本文件V1_1__alter_table_user.sql，并寫入增加address列的語句
ALTER TABLE `user` ADD COLUMN `address` VARCHAR(20) DEFAULT NULL;對于腳本文件名的基本規則是：版本號__描述.sql。當然如果你有更細致的要求，那么可以做更細致的文件名規劃，具體細節讀者可以查閱文末參考資料中的官方文檔獲取。
第二步：再次執行單元測試，在控制臺中可以看到如下日志：
2021-01-11 16:58:12.025 INFO 37330 --- [ main] o.f.c.i.database.base.DatabaseType : Database: jdbc:mysql://localhost:3306/test (MySQL 8.0)
2021-01-11 16:58:12.063 INFO 37330 --- [ main] o.f.core.internal.command.DbValidate : Successfully validated 2 migrations (execution time 00:00.020s)
2021-01-11 16:58:12.075 INFO 37330 --- [ main] o.f.core.internal.command.DbMigrate : Current version of schema `test`: 1
2021-01-11 16:58:12.082 INFO 37330 --- [ main] o.f.core.internal.command.DbMigrate : Migrating schema `test` to version "1.1 - alter table user"
2021-01-11 16:58:12.113 INFO 37330 --- [ main] o.f.core.internal.command.DbMigrate : Successfully applied 1 migration to schema `test` (execution time 00:00.045s)
再查看一下數據中國的內容：
如果你還沒有體會到引入Flyway對給我們的表結構帶來的好處的話，不妨也留言分享下你們的管理方式吧！
本系列教程《Spring Boot 2.x基礎教程》點擊直達！。學習過程中如遇困難，建議加入Spring技術交流群open in new window，參與交流與討論，更好的學習與進步！
#代碼示例
本文的相關例子可以查看下面倉庫中的chapter3-11目錄：
- Github：https://github.com/dyc87112/SpringBoot-Learning/open in new window
- Gitee：https://gitee.com/didispace/SpringBoot-Learning/
