51工具盒子前言 {#前言}
最近项目中引入了 Flyway 这个管理数据库版本框架，目的是为了解决我们一直存在的数据库脚本迭代混乱这个问题😂。说来惭愧，公司一直都是手动迭代数据库版本，配置 MybatisPlus 的init-sql组件使用的。
一直以来感觉没什么问题，但测试人员每次部署项目测试，都需要开发人员向测试发送数据库 sql 文件，这样就造成有时候脚本文件混乱，导致一些不必要的麻烦，所以就想要使用一款可以记录 SQL 文件版本迭代的工具，刚好 Flyway 可以解决这个问题。
今天我们就来介绍在 Spring Boot 中使用 Flyway 来管理数据库版本的方法。
Flyway 简介 {#Flyway 简介}
Flyway 是一个简单开源数据库版本控制器（约定大于配置），主要提供 migrate、clean、info、validate、baseline、repair 等命令。它支持 SQL（PL/SQL、T-SQL） 方式和 Java 方式，支持命令行客户端等，还提供一系列的插件支持（Maven、Gradle、SBT、ANT 等）。
实现 {#实现}
下面我们先预设一个开发目标：
- 假设我们需要开发一个用户管理系统，那么我们势必要设计一张用户表，并实现对用户表的增删改查操作。
- 在任务 1 的功能完成之后，我们又有一个新需求，需要对用户表增加了一个字段，看看如何实现对数据库表结构的更改。
目标 1 的实现 {#目标 -1- 的实现}
第一步： {#第一步：}
创建一个基础的
Spring Boot项目，并在pom.xml中加入Flyway、MySQL连接和数据访问相关的必要依赖（这里选用spring-boot-starter-jdbc作为例子）
<!-- Java 版本 -->
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>`
`<dependency>`
`<groupId>`org.springframework.boot`</groupId>`
`<artifactId>`spring-boot-starter-web`</artifactId>`
`</dependency>`
`<!-- flyway-core 依赖 V:7.7.3 -->`
`<dependency>`
`<groupId>`org.flywaydb`</groupId>`
`<artifactId>`flyway-core`</artifactId>`
`</dependency>`
`<dependency>`
`<groupId>`org.springframework.boot`</groupId>`
`<artifactId>`spring-boot-starter-jdbc`</artifactId>`
`</dependency>`
`<dependency>`
`<groupId>`mysql`</groupId>`
`<artifactId>`mysql-connector-java`</artifactId>`
`<scope>`runtime`</scope>`
`</dependency>`
`<dependency>`
`<groupId>`org.projectlombok`</groupId>`
`<artifactId>`lombok`</artifactId>`
`<optional>`true`</optional>`
`</dependency>`
`<dependency>`
`<groupId>`org.springframework.boot`</groupId>`
`<artifactId>`spring-boot-starter-test`</artifactId>`
`<scope>`test`</scope>`
`</dependency>`
`</dependencies>
yaml配置文件内容
spring:
# flyway 配置
flyway:
# 开启 flyway
enabled: true
# 是否禁用数据库清理
clean-disabled: true
# SQL 迁移的编码
encoding: UTF-8
# 迁移脚本的位置，默认 db/migration.
locations: classpath:db/migration
# SQL 迁移的文件名前缀。
sql-migration-prefix: V
# SQL 迁移的文件名分隔符。
sql-migration-separator: __
# SQL 迁移的文件名后缀。
sql-migration-suffixes: .sql
# 是否在执行迁移时自动调用验证。
validate-on-migrate: true
# 迁移时发现目标 schema 非空，而且带有没有元数据的表时，是否自动执行基准迁移，默认 false.
baseline-on-migrate: true
# JDBC 驱动程序的完全限定名称。 默认根据 URL 自动检测。
driver-class-name:
# 要迁移的数据库的 DBC url。 如果未设置，则使用主要配置的数据源。
url: jdbc:mysql://localhost:3306/flyway?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT
# 要迁移的数据库的登录密码。
password: root
# 要迁移的数据库的登录用户。
user: root
# MySQL 配置`
`datasource:`
`driver-class-name:` com.mysql.cj.jdbc.Driver
`url:` jdbc`:`mysql`:`//localhost`:`3306/flyway
`username:` root
`password:` root`
第二步： {#第二步：}
按
Flyway的规范创建版本化的SQL脚本。
- 在工程的
src/main/resources目录下创建db目录，在db目录下再创建migration目录 - 在
migration目录下创建版本化的 SQL 脚本V1__user_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;
第三步： {#第三步：}
根据
User表的结构，编写对应的实体定义
@Data
@NoArgsConstructor
public class User {
private Long id;
private String name;
private Integer age;
}
第四步： {#第四步：}
编写用户操作接口和实现
package com.mobaijun;
import java.sql.SQLException;
import java.util.List;
/**
`
`
*
Software：IntelliJ IDEA 2021.2 x64
*
Author: https://www.mobaijun.com
*
Date: 2021/11/15 13:43
*
InterfaceName:UserService
* `
`接口描述： 用户接口
*/
public interface UserService {
`
`
/**
`
`
* 新增一个用户
*/
int create(String name, Integer age);
`
`
/**
`
`
* 根据 name 查询用户
*/
List<User> getByName(String name);
`
`
/**
`
`
* 根据 name 删除用户
*/
int deleteByName(String name);
`
`
/**
`
`
* 获取用户总量
*/
Integer getAllUsers() throws SQLException;
`
`
/**
`
``
`
* `删除所有用户
*/``
`int` `deleteAllUsers();`
`}
第五步： {#第五步：}
实现类编写
package com.mobaijun;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Service;
import java.sql.SQLException;
import java.util.List;
/**
`
`
*
Software：IntelliJ IDEA 2021.2 x64
*
Author: https://www.mobaijun.com
*
Date: 2021/11/15 13:47
*
ClassName:UserServiceImpl
* `
`类描述： 用户实现类
*/
@Service
public class UserServiceImpl implements UserService {
`
`
@Autowired
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 Integer getAllUsers() throws SQLException {
return jdbcTemplate.queryForObject("select count(1) from user", Integer.class);
}
`
`
@Override`
`public` `int` `deleteAllUsers()` `{`
`return` jdbcTemplate`.update("delete from user");`
`}`
`}
第六步： {#第六步：}
编写测试用例
package com.mobaijun;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.List;
@SpringBootTest
class SpringBootFlywayApplicationTests {
<span class="token annotation punctuation">@Autowired</span>
<span class="token keyword">private</span> <span class="token class-name">UserService</span> userService<span class="token punctuation">;</span>
<span class="token annotation punctuation">@Test</span>
<span class="token keyword">void</span> <span class="token function">contextLoads</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
userService<span class="token punctuation">.</span><span class="token function">deleteAllUsers</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// 添加 5 个用户</span>
userService<span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span><span class="token string">"墨白"</span><span class="token punctuation">,</span> <span class="token number">18</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
userService<span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span><span class="token string">"李白"</span><span class="token punctuation">,</span> <span class="token number">100</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
userService<span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span><span class="token string">"张三"</span><span class="token punctuation">,</span> <span class="token number">100</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
userService<span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span><span class="token string">"王五"</span><span class="token punctuation">,</span> <span class="token number">100</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
userService<span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span><span class="token string">"李四"</span><span class="token punctuation">,</span> <span class="token number">100</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// 查询墨白年龄是否匹配</span>
<span class="token class-name">List</span><span class="token generics"><span class="token punctuation"><</span><span class="token class-name">User</span><span class="token punctuation">></span></span> userList <span class="token operator">=</span> userService<span class="token punctuation">.</span><span class="token function">getByName</span><span class="token punctuation">(</span><span class="token string">"墨白"</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token class-name">Assertions</span><span class="token punctuation">.</span><span class="token function">assertEquals</span><span class="token punctuation">(</span><span class="token number">18</span><span class="token punctuation">,</span> userList<span class="token punctuation">.</span><span class="token function">get</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">getAge</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">intValue</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// 查询所有用户</span>
<span class="token class-name">Assertions</span><span class="token punctuation">.</span><span class="token function">assertEquals</span><span class="token punctuation">(</span><span class="token number">5</span><span class="token punctuation">,</span> userService<span class="token punctuation">.</span><span class="token function">getAllUsers</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// 删除两个用户</span>
userService<span class="token punctuation">.</span><span class="token function">deleteByName</span><span class="token punctuation">(</span><span class="token string">"王五"</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
userService<span class="token punctuation">.</span><span class="token function">deleteByName</span><span class="token punctuation">(</span><span class="token string">"李四"</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>
}
第七步： {#第七步：}
运行上面编写的单元测试，验证一下效果。
不出意外，单元测试运行 ok 的话
连上数据库看看。此时应该多出了这两张表：
user表就是我们维护在SQL脚本中要创建的表flyway_schema_history表是flyway的管理表，用来记录在这个数据库上跑过的脚本，以及每个脚本的检查依据。这样每次应用启动的时候，就可以知道哪个脚本需要运行，或者哪个脚本发生了变动，运行基础可能不对，造成数据结构的混乱而阻止运行。
目标 2 的实现 {#目标 -2- 的实现}
有了上面的基础之后，我们来说说后续要做表结构的表变动该怎么操作。
首先，大家在开始使用 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-11-15 14:03:58.193 INFO 16840 --- [main] c.m.SpringBootFlywayApplicationTests : Starting SpringBootFlywayApplicationTests using Java 1.8.0_281 on mobai with PID 16840 (started by mobai in D:\IdeaProject\spring-boot-wikis\spring-boot-flyway)
2021-11-15 14:03:58.201 INFO 16840 --- [main] c.m.SpringBootFlywayApplicationTests : No active profile set, falling back to default profiles: default
2021-11-15 14:03:59.270 INFO 16840 --- [main] o.f.c.internal.license.VersionPrinter : Flyway Community Edition 7.7.3 by Redgate
2021-11-15 14:04:00.337 INFO 16840 --- [main] o.f.c.i.database.base.DatabaseType : Database: jdbc:mysql://localhost:3306/flyway (MySQL 8.0)
2021-11-15 14:04:00.382 INFO 16840 --- [main] o.f.core.internal.command.DbValidate : Successfully validated 2 migrations (execution time 00:00.021s)
2021-11-15 14:04:00.393 INFO 16840 --- [main] o.f.core.internal.command.DbMigrate : Current version of schema `flyway`: 1
2021-11-15 14:04:00.403 INFO 16840 --- [main] o.f.core.internal.command.DbMigrate : Migrating schema `flyway` to version "1.1 - alter table user"
2021-11-15 14:04:00.427 INFO 16840 --- [main] o.f.c.i.s.DefaultSqlScriptExecutor : 0 rows affected
2021-11-15 14:04:00.445 INFO 16840 --- [main] o.f.core.internal.command.DbMigrate : Successfully applied 1 migration to schema `flyway`, now at version v1.1 (execution time 00:00.058s)
2021-11-15 14:04:01.241 INFO 16840 --- [main] c.m.SpringBootFlywayApplicationTests : Started SpringBootFlywayApplicationTests in 3.435 seconds (JVM running for 4.441)
2021-11-15 14:04:01.409 INFO 16840 --- [main] com.zaxxer.hikari.HikariDataSource : HikariPool-1 - Starting...
2021-11-15 14:04:01.448 INFO 16840 --- [main] com.zaxxer.hikari.HikariDataSource : HikariPool-1 - Start completed.
- 再查看一下数据库中的内容：
user表中已经有了 Address 列
Flyway管理表中已经有新脚本的加载记录
源码地址：[传送门](https://github.com/mobaijun/spring-boot-wikis/tree/master/spring-boot-flyway)
欢迎留言分享下你们的数据库版本管理方式😁😁😁！
参考 {#参考}
Documentation - Flyway by Redgate • Database Migrations Made Easy.
![[JavaScript学习]正则表达式-什么是正则表达式？](http://static.51tbox.com/static/2024-11-23/col/b98601f7759cb44169e510dde9e185e4/25887db918c740629187c71f518ae413.png.jpg)
