SpringBoot使用flyway初始化数据库

 更新时间:2021年03月04日 09:18:29   作者:WilsonHe  
这篇文章主要介绍了SpringBoot如何使用flyway初始化数据库,帮助大家更好的理解和学习使用SpringBoot框架,感兴趣的朋友可以了解下

概述

Flyway这款数据库版本工具就算大家没有使用过但也略有耳闻了,SpringBoot对该款工具进行集成的框架可以让我们在启动SpringBoot应用时自动去找SQL版本文件进行比对执行,但在迁移或初始化时往往还是需要先手动进行下数据库的初始化配置,否则会把Unknown database的异常。 为了减少这一步所以个人就以SpringBoot的方式编码在项目的启动时自动进行数据库的初始化,然后再执行版本文件。

自动建库实现步骤

具体思路

  1. SpringBoot的配置项都会有相应的Properties属性类,数据库的属性类为DataSourceProperties,flyway的属性类为FlywayProperties,尽可能的使用其中的配置项而不额外添加自定义的配置
  2. 建库与相关设置的语句一般不会对已存在的设置进行更改(如建库建表时都是CREATE xxx IF NOT EXISTS),所以项目初始化时每次都执行也不会影响现有的数据库配置,编码时可以不用添加执行的前置判断

代码实现

配置文件

spring:
 profiles:
 include: database

application-database.yml

spring:
 datasource:
 url: jdbc:mysql://yourIp:3306/spring_boot_series?useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&allowMultiQueries=true&serverTimezone=GMT
 username: yourUsername
 password: yourPassword
 driver-class-name: com.mysql.cj.jdbc.Driver
 # 自动读取spring.datasource配置进行迁移操作
 flyway:
 # 版本迁移位置
 locations: classpath:db
 baseline-version: 1.0.2
 init-sqls:
 - SET @OLD_UNIQUE_CHECKS = @@UNIQUE_CHECKS, UNIQUE_CHECKS = 0;
 - SET @OLD_FOREIGN_KEY_CHECKS = @@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS = 0;
 - SET @OLD_SQL_MODE = @@SQL_MODE, SQL_MODE =
 'ONLY_FULL_GROUP_BY,STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION';
 - CREATE SCHEMA IF NOT EXISTS `spring_boot_series` DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;

为了让项目的配置结构更清晰,所以我把数据库的相关配置都独立到application-database.yml中。
flyway的init-sqls配置是当获取到SQL statement时会执行SQL语句列表,但需要注意的是如果spring.datasource.url连接不上,该块语句是依旧无法被执行的,因为SpringBoot集成的flyway配置是通过spring.datasource的配置去连接数据库的,如果url中的数据库不存在,flyway的版本迁移就无法执行了。
前文提到尽可能的使用SpringBoot原有的配置项,所以init-sqls其实是我配给自己用的。 个人通过init-sqls配置初始化语句与其它方式配置初始化想到的好处:

  • 无需将初始化语句硬编码再让Statement执行
  • 当数据库选型进行变更时只需再配置文件中进行修改相应的初始化语句
  • SpringBoot可以直接以字符串列表进行读取,开发过程中使用起来更加灵活,而不用去解析SQL文件

数据库初始化器DatabaseInitializer

package io.wilson.flyway;


import com.zaxxer.hikari.HikariDataSource;
import lombok.AllArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.autoconfigure.flyway.FlywayProperties;
import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import java.sql.Connection;
import java.sql.SQLException;
import java.sql.Statement;

/**
 * @author Wilson
 */
@Slf4j
@Component
@AllArgsConstructor
public class DatabaseInitializer {
 private final FlywayProperties flywayProperties;
 private final DataSourceProperties dataSourceProperties;

 @PostConstruct
 public void init() throws SQLException {
 log.info("DatabaseInitializer uses flyway init-sqls to initiate database");
 String url = dataSourceProperties.getUrl();
 // jdbc url最后一个 '/' 用于分割具体 schema?参数
 int lastSplitIndex = url.lastIndexOf('/');
 // 获取spring.datasource.url具体数据库schema前的jdbc url
 String addressUrl = url.substring(0, lastSplitIndex);
 // 直连数据库地址:jdbc:mysql://yourIp:port
 HikariDataSource dataSource = new HikariDataSource();
 dataSource.setJdbcUrl(addressUrl);
 dataSource.setUsername(dataSourceProperties.getUsername());
 dataSource.setPassword(dataSourceProperties.getPassword());
 Connection connection = dataSource.getConnection();
 Statement statement = connection.createStatement();
 for (String sql : flywayProperties.getInitSqls()) {
 // 通过flyway的init-sqls配置进行建库与数据库配置
 // executeUpdate:执行给定的SQL语句,该语句可以是INSERT,UPDATE或DELETE语句或不返回任何内容的SQL语句,例如SQL DDL语句。
 statement.executeUpdate(sql);
 }
 statement.close();
 connection.close();
 dataSource.close();
 log.info("DatabaseInitializer initialize completed");
 }
}

简单的主程序FlywayApplication

package io.wilson.flyway;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @author Wilson
 */
@SpringBootApplication
@MapperScan("io.wilson.flyway.mapper")
public class FlywayApplication {
 public static void main(String[] args) {
 SpringApplication.run(FlywayApplication.class, args);
 }
}

执行效果图

当项目启动时可以看到DatabaseInitializer会先通过init-sqls进行数据库的初始化,然后SpringBoot再初始化通用的数据源并执行SQL版本文件。图中的create_database.sql文件存放的是init-sqls配置的语句,该文件不会被执行,可以忽略。


以上就是SpringBoot使用flyway初始化数据库的详细内容,更多关于SpringBoot 初始化数据库的资料请关注脚本之家其它相关文章!

相关文章

  • Java跨域问题分析与解决方法详解

    Java跨域问题分析与解决方法详解

    这篇文章主要介绍了Java跨域问题分析与解决方法,跨域问题是在Web应用程序中,由于同源策略的限制,导致浏览器无法发送跨域请求,也无法获取跨域响应的问题,感兴趣想要详细了解可以参考下文
    2023-05-05
  • Springboot解决跨域问题方案总结(包括Nginx,Gateway网关等)

    Springboot解决跨域问题方案总结(包括Nginx,Gateway网关等)

    跨域问题是浏览器为了保护用户的信息安全,实施了同源策略(Same-Origin Policy),即只允许页面请求同源(相同协议、域名和端口)的资源,本文给大家总结了Springboot解决跨域问题方案包括Nginx,Gateway网关等),需要的朋友可以参考下
    2024-03-03
  • Java 垃圾回收机制详解及实例代码

    Java 垃圾回收机制详解及实例代码

    这篇文章主要介绍了 Java 垃圾回收机制详解及实例代码的相关资料,需要的朋友可以参考下
    2017-02-02
  • mybatis输出SQL格式化方式

    mybatis输出SQL格式化方式

    这篇文章主要介绍了mybatis输出SQL格式化方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • 解析Java的设计模式编程之解释器模式的运用

    解析Java的设计模式编程之解释器模式的运用

    这篇文章主要介绍了解析Java的设计模式编程之解释器模式的运用,文中对解释器模式的优缺点及适用场景作出了分析,需要的朋友可以参考下
    2016-02-02
  • JVM调优参数的设置

    JVM调优参数的设置

    Java虚拟机的调优是一个复杂而关键的任务,可以通过多种参数来实现,本文就来介绍一下JVM调优参数的设置,具有一定的参考价值,感兴趣的可以了解一下
    2024-03-03
  • Java动态替换properties文件中键值方式

    Java动态替换properties文件中键值方式

    这篇文章主要介绍了Java动态替换properties文件中键值方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-08-08
  • Java的Struts框架中登陆功能的实现和表单处理器的使用

    Java的Struts框架中登陆功能的实现和表单处理器的使用

    这篇文章主要介绍了Java的Struts框架中登陆功能的实现和表单处理器的使用,Struts框架是Java的SSH三大web开发框架之一,需要的朋友可以参考下
    2015-12-12
  • Java计算交集,差集,并集的方法示例

    Java计算交集,差集,并集的方法示例

    这篇文章主要介绍了Java计算交集,差集,并集的方法,结合实例形式简单分析了java集合运算的简单操作技巧,需要的朋友可以参考下
    2017-10-10
  • Java中枚举的使用详解

    Java中枚举的使用详解

    这篇文章主要介绍了Java中枚举的使用详解的相关资料,非常不错,具有参考借鉴价值,需要的朋友可以参考下
    2016-07-07

最新评论