Spring Boot 2.x基礎(chǔ)教程：使用Flyway管理數(shù)據(jù)庫

之前已經(jīng)介紹了很多在Spring Boot中使用MySQL的案例，包含了Spring Boot最原始的JdbcTemplate、Spring Data JPA以及我們國內(nèi)最常用的MyBatis。同時，對于一些復(fù)雜場景比如：更換Druid數(shù)據(jù)源，或是多數(shù)據(jù)源的情況也都做了介紹。

不論我們使用哪一個具體實現(xiàn)框架，都離不開對數(shù)據(jù)庫表結(jié)構(gòu)的管理。而這一類管理一直都存在一個問題：由于數(shù)據(jù)庫表元數(shù)據(jù)存儲于數(shù)據(jù)庫中，而我們的訪問邏輯都存在于Git或其他代碼倉庫中。Git已經(jīng)幫助我們完成了代碼的多版本管理，那么數(shù)據(jù)庫中的表該如何做好版本控制呢？

今天我們就來介紹在Spring Boot中使用Flyway來管理數(shù)據(jù)庫版本的方法。
Flyway簡介

Flyway是一個簡單開源數(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)不一致的檢查。
動手試試

下面我們先預(yù)設(shè)一個開發(fā)目標(biāo)：

    假設(shè)我們需要開發(fā)一個用戶管理系統(tǒng)，那么我們勢必要設(shè)計一張用戶表，并實現(xiàn)對用戶表的增刪改查操作。
    在任務(wù)1的功能完成之后，我們又有一個新需求，需要對用戶表增加了一個字段，看看如何實現(xiàn)對數(shù)據(jù)庫表結(jié)構(gòu)的更改。

目標(biāo) 1 的實現(xiàn)

第一步：創(chuàng)建一個基礎(chǔ)的Spring Boot項目，并在pom.xml中加入Flyway、MySQL連接和數(shù)據(jù)訪問相關(guān)的必要依賴（這里選用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>

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32

第二步：按Flyway的規(guī)范創(chuàng)建版本化的SQL腳本。

    在工程的src/main/resources目錄下創(chuàng)建db目錄，在db目錄下再創(chuàng)建migration目錄
    在migration目錄下創(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;

    1
    2
    3
    4
    5
    6
    7

    注意：如果你不想將SQL腳本放到其他目錄，可以用spring.flyway.locations參數(shù)來配置。這里不同于1.x版本的配置項flyway.locations

第三步：根據(jù)User表的結(jié)構(gòu)，編寫對應(yīng)的實體定義

@Data
@NoArgsConstructor
public class User {

    private Long id;
    private String name;
    private Integer age;

}

    1
    2
    3
    4
    5
    6
    7
    8

第四步：編寫用戶操作接口和實現(xiàn)

public interface UserService {

    /**
     * 新增一個用戶
     *
     * @param name
     * @param age
     */
    int create(String name, Integer age);

    /**
     * 根據(jù)name查詢用戶
     *
     * @param name
     * @return
     */
    List<User> getByName(String name);

    /**
     * 根據(jù)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");
    }

}

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78

    這里主要介紹Flyway的應(yīng)用，所以采用這種比較簡單的編寫方式，實際項目應(yīng)用中，還是推薦MyBatis的具體操作實現(xiàn)。

第五步：編寫測試用例

@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());

        // 查數(shù)據(jù)庫，應(yīng)該有5個用戶
        Assertions.assertEquals(5, userSerivce.getAllUsers());

        // 刪除兩個用戶
        userSerivce.deleteByName("Tom");
        userSerivce.deleteByName("Mike");

        // 查數(shù)據(jù)庫，應(yīng)該有5個用戶
        Assertions.assertEquals(3, userSerivce.getAllUsers());
    }

}

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33

    注意由于Spring Boot 2.4應(yīng)用的junit版本與之前Spring Boot 1.x版本中的不同，因此單元測試的編寫略有區(qū)別，有興趣的讀者可以分別查看之前介紹文章和這篇文章中的單元測試的區(qū)別，這里就不細說了。

第六步：運行上面編寫的單元測試，驗證一下效果。

不出意外，單元測試運行ok的話

連上數(shù)據(jù)庫看看。此時應(yīng)該多出了這兩張表：

    user表就是我們維護在SQL腳本中要創(chuàng)建的表
    flyway_schema_history表是flyway的管理表，用來記錄在這個數(shù)據(jù)庫上跑過的腳本，以及每個腳本的檢查依據(jù)。這樣每次應(yīng)用啟動的時候，就可以知道哪個腳本需要運行，或者哪個腳本發(fā)生了變動，運行基礎(chǔ)可能不對，造成數(shù)據(jù)結(jié)構(gòu)的混亂而阻止運行。

目標(biāo) 2 的實現(xiàn)

有了上面的基礎(chǔ)之后，我們來說說后續(xù)要做表結(jié)構(gòu)的表變動該怎么操作，這也是之前讀者出現(xiàn)問題最多的情況，所以在2.x版本教程中特地講一講。

首先，大家在開始使用Flyway之后，對于數(shù)據(jù)庫表接口的變更就要關(guān)閉這幾個途徑：

    直接通過工具登錄數(shù)據(jù)去修改表結(jié)構(gòu)
    已經(jīng)發(fā)布的sql腳本不允許修改

正確的表結(jié)構(gòu)調(diào)整途徑：在flyway腳本配置路徑下編寫新的腳本，啟動程序來執(zhí)行變更。這樣可以獲得幾個很大的好處：

    腳本受Git版本管理控制，可以方便的找到過去的歷史
    腳本在程序啟動的時候先加載，再提供接口服務(wù)，一起完成部署步驟
    所有表結(jié)構(gòu)的歷史變遷，在管理目錄中根據(jù)版本號就能很好的追溯

下面根據(jù)一個實際需求來具體操作下。假設(shè)我們現(xiàn)在想對User表增加一個字段：address，用來存儲用戶的通訊地址，那么我們就需要這樣操作實現(xiàn)。
————————————————
版權(quán)聲明：本文為CSDN博主「程序猿DD」的原創(chuàng)文章，遵循CC 4.0 BY-SA版權(quán)協(xié)議，轉(zhuǎn)載請附上原文出處鏈接及本聲明。
原文鏈接：https://blog.csdn.net/dyc87112/article/details/112506676