Spring Boot 2.x基础教程：使用Flyway管理数据库版本

之前已经介绍了很多在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的功能完成之后，我们又有一个新需求，需要对用户表增加了一个字段，看看如何实现对数据库表结构的更改。

目标 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对给我们的表结构带来的好处的话，不妨也留言分享下你们的管理方式吧！

更多本系列免费教程连载「点击进入汇总目录」

代码示例

本文的相关例子可以查看下面仓库中的chapter3-11目录：

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

如果您觉得本文不错，欢迎Star支持，您的关注是我坚持的动力！

参考资料

欢迎关注我的公众号：程序猿DD，获得独家整理的免费学习资源助力你的Java学习之路！另每周赠书不停哦～

Spring Boot 2.x基础教程：使用Flyway管理数据库版本的更多相关文章

Spring Boot 2.x基础教程：事务管理入门
什么是事务? 我们在开发企业应用时,通常业务人员的一个操作实际上是对数据库读写的多步操作的结合.由于数据操作在顺序执行的过程中,任何一步操作都有可能发生异常,异常会导致后续操作无法完成,此时由于业务逻 ...
Spring Boot 2.x基础教程：使用Swagger2构建强大的API文档
随着前后端分离架构和微服务架构的流行,我们使用Spring Boot来构建RESTful API项目的场景越来越多.通常我们的一个RESTful API就有可能要服务于多个不同的开发人员或开发团队:I ...
Spring Boot 2.x基础教程：JSR-303实现请求参数校验
请求参数的校验是很多新手开发非常容易犯错,或存在较多改进点的常见场景.比较常见的问题主要表现在以下几个方面: 仅依靠前端框架解决参数校验,缺失服务端的校验.这种情况常见于需要同时开发前后端的时候,虽然 ...
Spring Boot 2.x基础教程：Swagger接口分类与各元素排序问题详解
之前通过Spring Boot 2.x基础教程:使用Swagger2构建强大的API文档一文,我们学习了如何使用Swagger为Spring Boot项目自动生成API文档,有不少用户留言问了关于文档 ...
Spring Boot 2.x基础教程：Swagger静态文档的生成
前言通过之前的两篇关于Swagger入门以及具体使用细节的介绍之后,我们已经能够轻松地为Spring MVC的Web项目自动构建出API文档了.如果您还不熟悉这块,可以先阅读: Spring Boo ...
Spring Boot 2.x基础教程：使用国产数据库连接池Druid
上一节,我们介绍了Spring Boot在JDBC模块中自动化配置使用的默认数据源HikariCP.接下来这一节,我们将介绍另外一个被广泛应用的开源数据源:Druid. Druid是由阿里巴巴数据库事 ...
Spring Boot 2.x基础教程：找回启动日志中的请求路径列表
如果您看过之前的Spring Boot 1.x教程,或者自己原本就对Spring Boot有一些经验,或者对Spring MVC很熟悉.那么对于Spring构建的Web应用在启动的时候,都会输出当前应 ...
Spring Boot 2.x基础教程：使用MyBatis的XML配置方式
上一篇我们介绍了如何在Spring Boot中整合我们国人最常用的MyBatis来实现对关系型数据库的访问.但是上一篇中使用了注解方式来实现,而对于很多MyBatis老用户还是习惯于XML的开发方式, ...
Spring Boot 2.x基础教程：Spring Data JPA的多数据源配置
上一篇我们介绍了在使用JdbcTemplate来做数据访问时候的多数据源配置实现.接下来我们继续学习如何在使用Spring Data JPA的时候,完成多数据源的配置和使用. 添加多数据源的配置先在 ...
Spring Boot 2.x基础教程：进程内缓存的使用与Cache注解详解
随着时间的积累,应用的使用用户不断增加,数据规模也越来越大,往往数据库查询操作会成为影响用户使用体验的瓶颈,此时使用缓存往往是解决这一问题非常好的手段之一.Spring 3开始提供了强大的基于注解的缓 ...

随机推荐

对iOS后台模式最多10分钟运行时间的进一步理解
在app进入后台时,系统初始默认是只有10s的处理时间,但如果10s不够,我们可以主动申请,网上流传最多的一个说法是10分钟. 但这种说法有个前提: 那就是iOS7之前,是这样但从iOS7开始,我们 ...
Javascript小笔记
1.315360000000 毫秒 = 10年 2.Javascript 取时间截: JavaScript 获取当前时间戳: 第一种方法: var timestamp = Date.parse(new ...
bigdata_一篇文看懂Hadoop
本文转载:暂未找到原出处,如需署名请联系我们很荣幸能够见证Hadoop十年从无到有,再到称王.感动于技术的日新月异时,希望通过这篇内容深入解读Hadoop的昨天.今天和明天,憧憬下一个十年. 本文 ...
JS表格分页(封装版)
HTML代码: <html> <head> <meta charset='utf-8'> <script type="text/javascript ...
TTS 语音修复 ,缺少文件的，没注册类的
完美运行 http://bbs.nga.cn/read.php?tid=13292628&rand=492 Win7系统TTS修复-采用原生Win7提取绿色修复一键自动修复,控制面板里有语音 ...
Codeforces Round #516 (Div. 2, by Moscow Team Olympiad) D. Labyrinth
http://codeforces.com/contest/1064/problem/D 向上/向下加0,向左/右加1, step = 0,1,…… 求的是最少的步数,所以使用bfs. step=k ...
svn上传和下载项目
上传:到项目文件的svn文件夹下——>右键——>SVN Commit...——>输入提交代码备注信息,以便同事查看时,是属于什么内容.这里可以选择哪些文件是要提交到代码仓库上, 下载 ...
【转】让你彻底搞懂websocket
一.websocket与http WebSocket是HTML5出的东西(协议),也就是说HTTP协议没有变化,或者说没关系,但HTTP是不支持持久连接的(长连接,循环连接的不算) 首先HTTP有 1 ...
ssh: connect to host 192.168.11.180 port 22: Connection refused
错误原因: 1.sshd 未安装:sudo apt-get install openssh-server 2.sshd 未启动:sudo net start sshd 3.防火墙:sudo ufw d ...
MyBatis:2
转载:http://www.cnblogs.com/xrq730/p/5256221.html 前言前一篇文章,讲了MyBatis入门,讲到了MyBatis有两个基本的配置文件,一个用来配置环境信息 ...