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

时间  2021-01-14
标签 html java mysql git github web spring sql 数据库 数据结构 栏目 Spring 繁體版
原文   原文链接

以前已经介绍了不少在Spring Boot中使用MySQL的案例，包含了Spring Boot最原始的JdbcTemplate、Spring Data JPA以及咱们国内最经常使用的MyBatis。同时，对于一些复杂场景好比：更换Druid数据源，或是多数据源的状况也都作了介绍。html

不论咱们使用哪个具体实现框架，都离不开对数据库表结构的管理。而这一类管理一直都存在一个问题：因为数据库表元数据存储于数据库中，而咱们的访问逻辑都存在于Git或其余代码仓库中。Git已经帮助咱们完成了代码的多版本管理，那么数据库中的表该如何作好版本控制呢？java

今天咱们就来介绍在Spring Boot中使用Flyway来管理数据库版本的方法。mysql

Flyway简介

Flyway是一个简单开源数据库版本控制器（约定大于配置），主要提供migrate、clean、info、validate、baseline、repair等命令。它支持SQL（PL/SQL、T-SQL）方式和Java方式，支持命令行客户端等，还提供一系列的插件支持（Maven、Gradle、SBT、ANT等）。git

官方网站：https://flywaydb.org/github

本文对于Flyway的自身功能不作过多的介绍，读者能够经过阅读官方文档或利用搜索引擎得到更多资料。下面咱们具体说说在Spring Boot应用中的应用，如何使用Flyway来建立数据库以及结构不一致的检查。web

动手试试

下面咱们先预设一个开发目标：spring

  1. 假设咱们须要开发一个用户管理系统，那么咱们势必要设计一张用户表，并实现对用户表的增删改查操做。
  2. 在任务1的功能完成以后，咱们又有一个新需求，须要对用户表增长了一个字段，看看如何实现对数据库表结构的更改。

目标 1 的实现sql

第一步：建立一个基础的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学习之路！另每周赠书不停哦～
相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程