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

之前已經介紹了很多在Spring Boot中使用MySQL的案例，包含了Spring Boot最原始的 JdbcTemplate 、 Spring Data JPA 以及我們國内最常用的 MyBatis

。同時，對于一些複雜場景比如：更換Druid資料源，或是多資料源的情況也都做了介紹。

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

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

https://blog.didispace.com/spring-boot-learning-24-3-11/#Flyway%E7%AE%80%E4%BB%8B 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來建立資料庫以及結構不一緻的檢查。

https://blog.didispace.com/spring-boot-learning-24-3-11/#%E5%8A%A8%E6%89%8B%E8%AF%95%E8%AF%95 動手試試

下面我們先預設一個開發目标：

假設我們需要開發一個使用者管理系統，那麼我們勢必要設計一張使用者表，并實作對使用者表的增删改查操作。
在任務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技術交流群

，參與交流與讨論，更好的學習與進步！

https://blog.didispace.com/spring-boot-learning-24-3-11/#%E4%BB%A3%E7%A0%81%E7%A4%BA%E4%BE%8B 代碼示例

本文的相關例子可以檢視下面倉庫中的

chapter3-11

Github： https://github.com/dyc87112/SpringBoot-Learning/
Gitee： https://gitee.com/didispace/SpringBoot-Learning/

如果您覺得本文不錯，歡迎

Star

支援，您的關注是我堅持的動力！

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

https://blog.didispace.com/spring-boot-learning-24-3-11/#Flyway%E7%AE%80%E4%BB%8B Flyway簡介

https://blog.didispace.com/spring-boot-learning-24-3-11/#%E5%8A%A8%E6%89%8B%E8%AF%95%E8%AF%95 動手試試

https://blog.didispace.com/spring-boot-learning-24-3-11/#%E4%BB%A3%E7%A0%81%E7%A4%BA%E4%BE%8B 代碼示例

https://blog.didispace.com/spring-boot-learning-24-3-11/#%E5%8F%82%E8%80%83%E8%B5%84%E6%96%99 參考資料

繼續閱讀

用mybatis的generator插件在項目中自動生成dao及entity

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

NOSQL安全攻擊

mybatis_入門程式Mybatis入門

vue-cli簡介（中文翻譯）

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

登入plsql 報錯 the account is locked --使用者被鎖

sqlServer根據經緯查距離

Effective Java 8:通用程式設計

SequoiaDB巨杉資料庫C++驅動概述

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

從mybatis到mybatis plus(mp)

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method