Java SpringBoot

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来创建数据库以及结构不一致的检查。

Flyway的使用

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

  1. 假设需要开发一个用户管理系统，那么必然要设计一张用户表，并实现对用户表的增删改查操作。

  2. 在任务1的功能完成之后，又有一个新需求，需要对用户表增加了一个字段，看看如何实现对数据库表结构的更改。

    目标 1 的实现

    第一步：创建一个基础的Spring Boot项目

    在pom.xml中加入Flyway、MySQL连接和数据访问相关的必要依赖（这里选用spring-boot-starter-jdbc作为例子）

    1. <dependencies>
    2.  <dependency>
    3.      <groupId>org.springframework.boot</groupId>
    4.      <artifactId>spring-boot-starter-web</artifactId>
    5.  </dependency>
    7.  <dependency>
    8.      <groupId>org.springframework.boot</groupId>
    9.      <artifactId>spring-boot-starter-jdbc</artifactId>
    10.  </dependency>
    12.  <dependency>
    13.      <groupId>mysql</groupId>
    14.      <artifactId>mysql-connector-java</artifactId>
    15.  </dependency>
    17.  <dependency>
    18.      <groupId>org.flywaydb</groupId>
    19.      <artifactId>flyway-core</artifactId>
    20.  </dependency>
    22.  <dependency>
    23.      <groupId>org.projectlombok</groupId>
    24.      <artifactId>lombok</artifactId>
    25.      <scope>provided</scope>
    26.  </dependency>
    28.  <dependency>
    29.      <groupId>org.springframework.boot</groupId>
    30.      <artifactId>spring-boot-starter-test</artifactId>
    31.      <scope>test</scope>
    32.  </dependency>
    33. </dependencies>

    第二步：按Flyway的规范创建版本化的SQL脚本。

  • 在工程的src/main/resources目录下创建db目录，在db目录下再创建migration目录

  • 在migration目录下创建版本化的SQL脚本V1__Base_version.sql

    1. DROP TABLE IF EXISTS user ;
    2. CREATE TABLE `user` (
    3. `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键',
    4. `name` varchar(20) NOT NULL COMMENT '姓名',
    5. `age` int(5) DEFAULT NULL COMMENT '年龄',
    6. PRIMARY KEY (`id`)
    7. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

    :::tips 注意：如果不想将SQL脚本放到其他目录，可以用spring.flyway.locations参数来配置。这里不同于1.x版本的配置项flyway.locations :::

    第三步：根据User表的结构，编写对应的实体定义

    ```java @Data @NoArgsConstructor public class User {

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

}

  1. <a name="y4FN4"></a>
  2. #### 第四步：编写用户操作接口和实现
  3. ```java
  4. public interface UserService {
  6.     /**
  7.      * 新增一个用户
  8.      *
  9.      * @param name
  10.      * @param age
  11.      */
  12.     int create(String name, Integer age);
  14.     /**
  15.      * 根据name查询用户
  16.      *
  17.      * @param name
  18.      * @return
  19.      */
  20.     List<User> getByName(String name);
  22.     /**
  23.      * 根据name删除用户
  24.      *
  25.      * @param name
  26.      */
  27.     int deleteByName(String name);
  29.     /**
  30.      * 获取用户总量
  31.      */
  32.     int getAllUsers();
  34.     /**
  35.      * 删除所有用户
  36.      */
  37.     int deleteAllUsers();
  39. }
  1. @Service
  2. public class UserServiceImpl implements UserService {
  4.     private JdbcTemplate jdbcTemplate;
  6.     UserServiceImpl(JdbcTemplate jdbcTemplate) {
  7.         this.jdbcTemplate = jdbcTemplate;
  8.     }
  10.     @Override
  11.     public int create(String name, Integer age) {
  12.         return jdbcTemplate.update("insert into USER(NAME, AGE) values(?, ?)", name, age);
  13.     }
  15.     @Override
  16.     public List<User> getByName(String name) {
  17.         List<User> users = jdbcTemplate.query("select * from USER where NAME = ?", (resultSet, i) -> {
  18.             User user = new User();
  19.             user.setId(resultSet.getLong("ID"));
  20.             user.setName(resultSet.getString("NAME"));
  21.             user.setAge(resultSet.getInt("AGE"));
  22.             return user;
  23.         }, name);
  24.         return users;
  25.     }
  27.     @Override
  28.     public int deleteByName(String name) {
  29.         return jdbcTemplate.update("delete from USER where NAME = ?", name);
  30.     }
  32.     @Override
  33.     public int getAllUsers() {
  34.         return jdbcTemplate.queryForObject("select count(1) from USER", Integer.class);
  35.     }
  37.     @Override
  38.     public int deleteAllUsers() {
  39.         return jdbcTemplate.update("delete from USER");
  40.     }
  42. }

这里主要介绍Flyway的应用，所以采用这种比较简单的编写方式，实际项目应用中，还是推荐MyBatis的具体操作实现。

第五步：编写测试用例

  1. @Slf4j
  2. @SpringBootTest
  3. public class Chapter311ApplicationTests {
  5.     @Autowired
  6.     private UserService userSerivce;
  8.     @Test
  9.     public void test() throws Exception {
  10.         userSerivce.deleteAllUsers();
  12.         // 插入5个用户
  13.         userSerivce.create("Tom", 10);
  14.         userSerivce.create("Mike", 11);
  15.         userSerivce.create("Didispace", 30);
  16.         userSerivce.create("Oscar", 21);
  17.         userSerivce.create("Linda", 17);
  19.         // 查询名为Oscar的用户，判断年龄是否匹配
  20.         List<User> userList = userSerivce.getByName("Oscar");
  21.         Assertions.assertEquals(21, userList.get(0).getAge().intValue());
  23.         // 查数据库，应该有5个用户
  24.         Assertions.assertEquals(5, userSerivce.getAllUsers());
  26.         // 删除两个用户
  27.         userSerivce.deleteByName("Tom");
  28.         userSerivce.deleteByName("Mike");
  30.         // 查数据库，应该有5个用户
  31.         Assertions.assertEquals(3, userSerivce.getAllUsers());
  32.     }
  34. }

注意由于Spring Boot 2.4应用的junit版本与之前Spring Boot 1.x版本中的不同，因此单元测试的编写略有区别。
第六步：运行上面编写的单元测试，验证一下效果。
不出意外，单元测试运行ok的话
2021-05-24-17-35-53-222343.png
连上数据库看看。此时应该多出了这两张表：
2021-05-24-17-35-53-362929.png

  • 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列的语句

  1. ALTER TABLE `user` ADD COLUMN `address` VARCHAR(20) DEFAULT NULL;

对于脚本文件名的基本规则是：版本号__描述.sql。当然如果有更细致的要求，那么可以做更细致的文件名规划。

第二步：再次执行单元测试，在控制台中可以看到如下日志：

  1. 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)
  2. 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)
  3. 2021-01-11 16:58:12.075  INFO 37330 --- [           main] o.f.core.internal.command.DbMigrate      : Current version of schema `test`: 1
  4. 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"
  5. 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)

再查看一下数据中的内容：
2021-05-24-17-35-53-534764.png