|- flyway -| 项目中接入 flyway 的几种方式

最新推荐文章于 2024-09-22 12:52:15 发布
最新推荐文章于 2024-09-22 12:52:15 发布
阅读量1.5k 收藏 6
点赞数 3
分类专栏： 数据层 文章标签： flyway flyway 配置 flyway 脚本 引入flyway 项目中引入flyway的几种方式
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/QAC_Boy/article/details/102692055
版权

项目中接入 flyway 的几种方式

自己整理了几种实现方式~
欢迎吐槽和交流~
本篇实战篇，话不多说，直接开刚~
注：最终的源码也会给出，放在文章最下方了

方式一：使用配置类读取数据库配置

pom 文件中引入 flyway 依赖

<dependency>
   <groupId>org.flywaydb</groupId>
   <artifactId>flyway-core</artifactId>
   <version>6.0.7</version>
   <!--<version>5.0.3</version>-->
</dependency>

yml 文件中的配置如下（可以将配置信息放在 配置中心里）：

spring:
  application:
    name: flyway-db
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/db_user?useUnicode=true&useSSL=false&characterEncoding=utf-8
    username: tester
    password: balabala

新增配置类：

FlywayConfiguration.java

package com.example.flywaydb.config;

import org.flywaydb.core.Flyway;
import org.flywaydb.core.api.configuration.ClassicConfiguration;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 描述: <br>
 * < TODO >
 *
 * @author qacboy
 * @create 2019-10-23
 * @since TODO
 */
@Configuration
public class FlywayConfiguration {

    @Value("${spring.datasource.url}")
    private String datasourceUrl;
    @Value("${spring.datasource.username}")
    private String databaseUsername;
    @Value("${spring.datasource.password}")
    private String databasePassword;

    // 脚本存放路径
    // @Value("${flyway.locations}")
    // private String locations;


    /**
     * version: 6.0.7 写法
     */
    @Bean
    Flyway flyway() {
        ClassicConfiguration classicConfiguration = new ClassicConfiguration();
        classicConfiguration.setDataSource(datasourceUrl, databaseUsername, databasePassword);
        classicConfiguration.setBaselineOnMigrate(true);
        // classicConfiguration.setLocations(locations);
        Flyway flyway = new Flyway(classicConfiguration);
        System.out.println(" ****** repair ****** ");
        flyway.repair();
        System.out.println(" ****** migrate ****** ");
        flyway.migrate();
        return flyway;
    }

    /**
     * repair
     * migrate
     * version: 5.0.3 写法
     * @return
     */
/*
    @Bean(initMethod = "migrate")
    @Bean
    Flyway flyway() {
        Flyway flyway = new Flyway();
        flyway.setBaselineOnMigrate(true);
        flyway.setDataSource(datasourceUrl, databaseUsername, databasePassword);
        // flyway.setLocations(locations);
        System.out.println(" ****** repair");
        flyway.repair();
        System.out.println(" ****** migrate");
        flyway.migrate();
        return flyway;
    }*/

}

注：添加数据库脚本，脚本存放位置（默认）：src/resources/db/migration（目录是可以自定义的，参数由 FlywayConfiguration.java 中的 locations 控制）
SQL 脚本的命名规则（ 这里我的写法只是提供一个参考 ）：
不可重复执行脚本：
V${version}__${name}.sql，其中前缀V、后缀.sql、分隔符__；
可重复执行脚本：
R__${name}.sql，其中前缀V、后缀.sql、分隔符__；
当然，你也可以在配置类中自行修改匹配规则
在这里插入图片描述
SQL 脚本一并给出：

CREATE TABLE user_test (
  id bigint(20) NOT NULL AUTO_INCREMENT,
  username varchar(100) NOT NULL,
  first_name varchar(50) NOT NULL,
  last_name varchar(50) DEFAULT NULL,
  PRIMARY KEY (id),
  UNIQUE KEY UK_username (username)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci;

启动项目，坐等执行成功~

如果你只想执行单个命令

emmm… 写个测试类吧（突然变 low 有没有，哈哈哈）

顺便把测试类给了

package com.example.flywaydb;

import com.alibaba.fastjson.JSONObject;
import org.flywaydb.core.Flyway;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;


/**
 * 描述: <br>
 * < TODO >
 *
 * @author qacboy
 * @create 2019-10-23
 * @since TODO
 */
@RunWith(SpringRunner.class)
@SpringBootTest
public class FlywayTest {
    @Autowired
    private Flyway flyway;

    @Test
    public void dbMigrate() {
        System.out.println(flyway.migrate());
    }

    @Test
    public void dbValidate() {
        flyway.validate();
    }

    @Test
    public void dbClean() {
        flyway.clean();
    }

    @Test
    public void dbInfo() {
        System.out.println(JSONObject.toJSONString(flyway.info()));
    }

    @Test
    public void dbBaseline() {
        flyway.baseline();
    }

    @Test
    public void dbRepair() {
        flyway.repair();
    }
}

好了，至此方式一介绍已经结束，项目也成功引入 flyway 了，so easy !

方式二：使用脚本

下载脚本

根据需要选择合适的系统，下载 flyway 官方提供的脚本 。
然后，
官网教程已经写得很清清楚楚明明白白了~~
跟着来就行了

修改配置文件

简单起见~
我这里也就只修改的 flyway.conf 文件了，当然你也可以自定义配置文件的位置和名称，这里为了方便就直接使用默认的配置文件了
然后配置好数据库的连接信息即可

这种方式的使用也简单~
可以将脚本放在你的服务器上，需要对数据库进行更新的时候，把你的脚本拷贝至你的指定目录，然后再去执行一下 flyway 的脚本命令就行了
在这里插入图片描述

执行 flyway 命令

直接执行 flyway 命令（注意：需要进到脚本的目录下）

sh flyway migrate
在这里插入图片描述
感觉最常用的命令也就是 repair 和 migrate 这两个了
一般也是配合着使用，先 repair 再 migrate

好了，完美搞定~

方式三：通过 flyway 官网提供的插件

这个方法就更更更简单了~
不过~
不推荐使用，
不推荐使用，
不推荐使用！

因为需要将数据库的配置信息定义在 pom 文件中，这样很不安全

反正都说是介绍了，那就一起说一下~

引入插件

在 pom 文件中引入 flyway 插件，同时配置数据库信息

			<!--直接使用 plugin 的配置-->
			<plugin>
				<groupId>org.flywaydb</groupId>
				<artifactId>flyway-maven-plugin</artifactId>
				<configuration>
					<url>jdbc:mysql://localhost:3306/db_user?useUnicode=true&amp;useSSL=false&amp;characterEncoding=utf-8</url>
					<user>tester</user>
					<password>balabala</password>
				</configuration>
			</plugin>

点击运行插件

在 plugin 中点击 flyway -> migrate ，ok 坐等插件执行成功~
在这里插入图片描述
注：脚本存放位置（同方式一）：src/resources/db/migration
在这里插入图片描述
大功告成！

方式四

还有一种刺激的写法（炒鸡不推荐）：

封装成请求：暴露出去

前期所有步骤同方式一

新增 service 和 controller 即可

这里一并给出了~

IFlywayDBService.java

package com.example.flywaydb.service;

import org.flywaydb.core.api.MigrationInfoService;

/**
 * 描述: <br>
 * < TODO >
 *
 * @author qacboy
 * @create 2019-10-23
 * @since TODO
 */
public interface IFlywayDBService {

    /**
     * 数据迁移，新增数据脚本时，执行 migrate 进行更新
     */
    int dbMigrate();

    /**
     * 校验数据中是否有执行失败的脚本，当有执行失败的时候，执行 repair 进行修复
     */
    void dbValidate();

    /**
     * 警告： 删除 数据库 中所有的表
     * 谨慎操作!!!
     * 传说中的删库跑路
     */
    void dbClean();

    MigrationInfoService dbInfo();

    void dbBaseline();

    /**
     * 清除数据中执行失败的脚本记录
     */
    void dbRepair();

}

FlywayDBServiceImpl.java

package com.example.flywaydb.service.impl;

import com.example.flywaydb.service.IFlywayDBService;
import org.flywaydb.core.Flyway;
import org.flywaydb.core.api.MigrationInfoService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

/**
 * 描述: <br>
 * < TODO >
 *
 * @author qacboy
 * @create 2019-10-23
 * @since TODO
 */
@Service
public class FlywayDBServiceImpl implements IFlywayDBService {

    @Autowired
    private Flyway flyway;


    @Override
    public int dbMigrate() {
        System.out.println("dbMigrate");
        return flyway.migrate();
    }

    @Override
    public void dbValidate() {
        System.out.println("dbValidate");
        flyway.validate();
    }

    @Override
    public void dbClean() {
        System.out.println("dbClean");
        flyway.clean();
    }

    @Override
    public MigrationInfoService dbInfo() {
        System.out.println("dbInfo");
        return flyway.info();
    }

    @Override
    public void dbBaseline() {
        System.out.println("dbBaseline");
        flyway.baseline();
    }

    @Override
    public void dbRepair() {
        System.out.println("dbRepair");
        flyway.repair();
    }

}

FlywayDBController.java

package com.example.flywaydb.controller;


import com.example.flywaydb.service.IFlywayDBService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 描述: <br>
 * < TODO >
 *
 * @author qacboy
 * @create 2019-10-23
 * @since TODO
 */
@RestController
public class FlywayDBController {

    @Autowired
    private IFlywayDBService flyway;

    @GetMapping(value = "/migrate")
    public void dbMigrate() {
        System.out.println("migrate");
        flyway.dbMigrate();
    }

    @GetMapping(value = "/validate")
    public void dbValidate() {
        System.out.println("validate");
        flyway.dbValidate();
    }

    @GetMapping(value = "/clean")
    public void dbClean() {
        System.out.println("clean");
        flyway.dbClean();
    }

    @GetMapping(value = "/info")
    public void dbInfo() {
        System.out.println("info");
        flyway.dbInfo();
    }

    @GetMapping(value = "/baseline")
    public void dbBaseline() {
        System.out.println("baseline");
        flyway.dbBaseline();
    }

    @GetMapping(value = "/repair")
    public void dbRepair() {
        System.out.println("repair");
        flyway.dbRepair();
    }

}

目录结构如下：
在这里插入图片描述

方式五

感觉最满意的写法：

自己写个插件去封装，flyway 的操作。

emmm… 抱歉，能力有限 。 idea 的插件编写还不会整，有时间研究下再去搞一个玩玩

写的不好的地方还请大伙多多包涵哈~
要是能帮忙指出更是十分感谢了！
要是有写得不清不楚的地方，也欢迎小伙伴们来交流呀~
在这里插入图片描述
项目地址： https://github.com/QACBoy/flywaydb

参考文章：

https://flywaydb.org/documentation/command/migrate

linkr_
关注
专栏目录
基于Flyway的数据库版本控制实战
孤独烟
04-19 488
背景大家平时在开发过程中，会用代码管理工具来进行我们的代码管理。如Git这些，使用这些版本控制系统能轻松地帮我们解决不同开发人员之间的代码冲突处理版本回退实现软件代码的CI/CD等那大家考虑过么，针对数据库脚本怎么办的呢？有如下几个问题？我们如何比对多环境的数据库版本是否一致？几个人同时修改一个表，如何进行协同合作？我们如何确定该脚本是否在生产环境运行过？针对上述这些问题...
Flyway让数据库版本管理更简单
weixin_44433834的博客
12-15 518
作者：烧鸡太子爷 来源：恒生LIGHT云社区 Flyway是什么 随着项目CICD接入,一键启动,敏捷开发已经成为降本提效的不二法宝,其中涉及SQL的变更还不够智能和自动化,因此亟需一款工具能够帮助开发及运维人员高效简便地完成SQL变更,Flyway正是可以满足我们需求的一款工具。 当我们打开Flyway的官网，在首页可以看到关于Flyway的一段英文介绍： Flyway是数据库的版本控制，跨所有环境的稳健架构演变。轻松、愉快和简单的SQL。 总的来说，Flyway是一款专为CI/CD打造的，能对数.
Spring Boot 项目中引入 flyway
h_My_first_CSDN的博客
04-23 279
Spring Boot 项目中引入 flyway pom.xml 文件中加入依赖 <!--flyway--> <dependency> <groupId>org.flywaydb</groupId> <artifactId>flyway-core</artifactId...
spring项目接入flyway（一） 背景、快速入门
一直走，不要回头
06-19 2425
官方文档：https://flywaydb.org/documentation/
Flyway 命令
最新发布
Flying_Fish_roe的博客
09-22 712
执行后，Flyway 会检查所有迁移文件的校验和（Checksum），如果某个已经执行过的文件被修改，Flyway 会报错并提示有潜在的数据库不一致问题。它会显示所有的迁移文件，包括哪些文件已经执行，哪些文件尚未执行，以及每个迁移文件的执行时间、状态等。命令是 Flyway 最重要的命令，用于执行所有未执行的迁移文件，更新数据库的结构。命令用于验证迁移文件的完整性，确保已经执行过的迁移文件没有被修改，且所有待执行的迁移文件都是有效的。它会重新计算已经执行的迁移文件的校验和，并删除任何失败的迁移记录。
简化项目部署 ，SpringBoot引入 Flyway 管理数据库脚本文件
Soup's Blog
06-16 917
前言： 由于项目设计初期的设计缺陷，数据库字段设计的不够完整，我们在开发的过程中可能会不断的往数据库中增加表，增加字段，删除字段等操作，如果项目还没上线的话，就非常简单。如果项目上线的话我们就需要执行脚本。 这样就会造成一个问题，如何保证测试环境数据库和生产环境的字段一致呢，某个开发人员修改了测试库的一个字段，如何能够有效的同步到测试库，测试通过以后如何有效的同步到多个生产库。 在没有任何工具之前，我们需要各自手动执行脚本。然而我遇到了下面这个问题。 生产环境的数据库一般独立放，我们开发人员需要通过
flyway简单使用
雨易辰木的博客
07-22 480
flyway简单使用 官网看这里https://flywaydb.org/ 背景 Flyway是独立于数据库的应用、管理并跟踪数据库变更的数据库版本管理工具。用通俗的话讲，Flyway可以像Git管理不同人的代码那样，管理不同人的sql脚本，从而做到数据库同步。 流程 1、 首先配置好flyway的基本信息后，运行项目，会在数据库表中默认新建一个数据表用于存储flyway的运行信息，默认的数据库名：flyway_schema_history 2、 紧接着Flyway将开始扫描文件系统或应用程序的类路径进行迁
Spring学习笔记（三十七）——Flyway 数据库版本控制
不愿意做鱼的小鲸鱼の博客
08-15 2965
Flyway，是一个数据库版本管理工具。每次上线新功能的时候，都需要先更新数据库，然后再部署代码。当数据库的更新部分很多时，难免会忘掉，造成升级失败。 另外一个问题的是，当你的服务是允许客户自己私有部署的时候，每个客户可能都在不同的数据库版本上，这时候对于不同的客户给与不同的升级机制就相当重要了。 ...
flywaydb.zip
10-24
# 项目中接入 flyway 的几种方式 ## 第一种方式 使用 FlywayConfiguration + FlywayTest 数据库配置信息写在 yml 文件中 在 FlywayConfiguration 中调用修复和迁移方法，启动默认执行 调用 FlywayTest 中的方法进行...
数据库迁移神器——Flyway
Java极客技术
08-13 747
每天早上七点三十，准时推送干货Hello 大家好，我是阿粉，不知道你有没有遇到过这种场景，一套代码部署在不同的环境中，随着时间的过去，各个环境代码有版本差异，代码层面可以通过不同的版本来...
【愚公系列】《AIGC辅助软件开发》011-AI辅助编写技术文档：技术文档
时光隧道
07-24 1万+
在当今快速发展的技术环境中，技术文档的编写变得愈加重要。无论是软件开发、产品设计，还是系统架构，清晰、准确的技术文档不仅能帮助团队成员快速理解项目，还能为用户提供必要的使用指导。然而，编写高质量的技术文档常常是一项繁琐且耗时的任务。随着人工智能技术的不断进步，AI工具的辅助作用逐渐显现，特别是在技术文档的编写过程中。借助AI，开发者和技术作家可以更高效地生成、编辑和维护文档，从而专注于更高层次的创作和思考。
gradle 项目添加flyway的能力
keyboard专栏
07-19 587
请将上述代码中的jdbc:your-database-url替换为您的数据库连接URL，your-username和your-password替换为数据库的用户名和密码。在Gradle项目中添加Flyway的能力是非常简单的。接下来，您需要在build.gradle文件中配置Flyway以连接到您的数据库。首先，您需要在项目的build.gradle文件中添加Flyway的依赖。这将会把最新版本的Flyway添加到您的Gradle项目中。这将会启动数据库迁移，将未执行的迁移脚本应用到您的数据库中。
SpringCloud基础架构构建过程（二）__配置数据库、flyway、MybatisPlus插件
qq_31235799的博客
08-14 456
前述 本次微服务架构的构建过程以Mysql来作为关系型数据库，flyway进行数据库版本控制。 引入基础依赖 此微服务架构在设计上使用分服务分库的的模式，即每个服务都有一个单独的数据库模块，为减少代码冗余，将相关依赖引入到common中。 <!-- 集成mysql --> <dependency> <groupId>mysql</groupId> ...
flyway（数据库迁移工具）
后羿一号的博客
06-08 9069
系列文章目录 主要是用来记录每次迭代的版本sql的表结构的变动.在部署某个版本时,能够快找到这个版本对应的sql,避免出现表结构的错误 Flyway是独立于数据库的应用、管理并跟踪数据库变更的数据库版本管理工具。用通俗的话讲，Flyway可以像Git管理不同人的代码那样，管理不同人的sql脚本，从而做到数据库同步。 文章目录系列文章目录一、flyway是什么？相关链接二、使用步骤1.准备2.模块介绍3.使用实例流程1流程2三、问题总结 一、flyway是什么？ flyway是一个数据库迁移工具.使用v
Flyway详解（使用说明及避坑指南、一文搞懂flyway）
热门推荐
Jiao1225的博客
03-16 4万+
Flyway详解，包含工作原理、使用说明、避坑指南、以及团队使用时的注意事项
flyway配置详解
CAT
09-18 3887
flyway.baseline-description对执行迁移时基准版本的描述. flyway.baseline-on-migrate当迁移时发现目标schema非空，而且带有没有元数据的表时，是否自动执行基准迁移，默认false. flyway.baseline-version开始执行基准迁移时对现有的schema的版本打标签，默认值为1. flyway.check-location检查迁移脚本的位置是否存在，默认false. flyway.clean-on-validation-error当发现校验错
springboot集成flyway使用多数据源的一种实现方式
weixin_42935566的博客
02-02 1855
springboot集成flyway使用多数据源的一种实现方式
flyway的快速入门教程
web18484626332的博客
07-27 409
Flyway是一款开源的数据库版本管理工具。它可以很方便的在命令行中使用，或者在Java应用程序中引入，用于管理我们的数据库版本。在项目或产品中，很难一开始就把业务理清楚，把数据库表设计好，因此数据表也会在迭代周期不断迭代。在Java应用程序中使用Flyway，能快速有效地用于迭代数据库表结构，并保证部署到测试环境或生产环境时，数据表都是保持一致的。flyway官方文档[这里是图片001]https在控制台可以看到相关日志打印，并在数据库中查看到已经创建好的表和相关记录变更。...
flywaydb在项目中的使用
yulang1992514的博客
11-22 2135
flyway在项目中的简单使用
Play-Flyway: Play框架的数据库版本控制插件
资源摘要信息:"play-flyway:...综上所述，play-flyway插件为Play框架的数据库迁移工作提供了一种专业和高效的解决方案，使得数据库的变更管理更加简便和安全，同时通过与Scala语言的结合，发挥了Play框架的高性能特点。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值