Spring Boot 2.x基礎教程：使用Flyway管理資料庫版本

程式猿DD發表於2021-01-12
Spring Boot資料庫

之前已經介紹了很多在Spring Boot中使用MySQL的案例，包含了Spring Boot最原始的JdbcTemplate、Spring Data JPA以及我們國內最常用的MyBatis。同時，對於一些複雜場景比如：更換Druid資料來源，或是多資料來源的情況也都做了介紹。

不論我們使用哪一個具體實現框架，都離不開對資料庫表結構的管理。而這一類管理一直都存在一個問題：由於資料庫表後設資料儲存於資料庫中，而我們的訪問邏輯都存在於Git或其他程式碼倉庫中。Git已經幫助我們完成了程式碼的多版本管理，那麼資料庫中的表該如何做好版本控制呢？

今天我們就來介紹在Spring Boot中使用Flyway來管理資料庫版本的方法。

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. 假設我們需要開發一個使用者管理系統，那麼我們勢必要設計一張使用者表，並實現對使用者表的增刪改查操作。
  2. 在任務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之後，對於資料庫表介面的變更就要關閉這幾個途徑：

  1. 直接通過工具登入資料去修改表結構
  2. 已經發布的sql指令碼不允許修改

正確的表結構調整途徑：在flyway指令碼配置路徑下編寫新的指令碼，啟動程式來執行變更。這樣可以獲得幾個很大的好處：

  1. 指令碼受Git版本管理控制，可以方便的找到過去的歷史
  2. 指令碼在程式啟動的時候先載入，再提供介面服務，一起完成部署步驟
  3. 所有表結構的歷史變遷，在管理目錄中根據版本號就能很好的追溯

下面根據一個實際需求來具體操作下。假設我們現在想對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)

再檢視一下資料中國的內容：

User表中已經有了Address列

Flyway管理表中已經有新指令碼的載入記錄

如果你還沒有體會到引入Flyway對給我們的表結構帶來的好處的話，不妨也留言分享下你們的管理方式吧！

更多本系列免費教程連載「點選進入彙總目錄」

程式碼示例

本文的相關例子可以檢視下面倉庫中的chapter3-11目錄：

如果您覺得本文不錯，歡迎Star支援，您的關注是我堅持的動力！

參考資料

歡迎關注我的公眾號：程式猿DD，獲得獨家整理的免費學習資源助力你的Java學習之路！另每週贈書不停哦～

相關文章