为热门项目 若依(ruoyi) 添加flyway,自动管理数据库版本

flyway大家应该都听说过甚至用过,是一种数据库管理工具。多个人协作开发,或者是项目部署的时候,非常方便,不需要再mysql里面去初始化表结构和数据,项目启动时,根据flyway_schema_history表中的历史数据,动态的更新数据库。

若依则是一个非常优秀的开源系统,支持代码自动生成,同时发布了三个版本可供选择。部分框架其实有待更新,后续空闲了会继续将其依赖升级的更新的版本,有兴趣的朋友可以关注。今天主要是为前后端分离项目继承flyway,实现数据库自动管理,项目迁移部署啥的也更加方便。

  1. 添加依赖
    在ruoyi-admin这个module里面添加flyway依赖
  <dependency>
      <groupId>org.flywaydb</groupId>
      <artifactId>flyway-core</artifactId>
  </dependency>
  1. 配置flyway
    在ruoyi-admin这个module的application-druid.properites文件中添加如下配置
spring:
    # 配置flyway数据版本管理
    flyway:
        enabled: true
        baseline-on-migrate: true
        clean-on-validation-error: false
        sql-migration-prefix: V
        sql-migration-suffixes: .sql
        locations: classpath:db/migration
  1. 配置sql脚本
    在原项目中的sql目录下有两个初始化sql脚本,读者通过自己创建数据库,运行脚本,初始化表和数据,再启动前后端项目是完全没有问题的。
    在这里插入图片描述
    在ruoyi-admin的resource目录下创建db/migration目录,使用idea的朋友这里要特别特别注意,一不小心就报错了,先看下图。
    在这里插入图片描述
    看着是不是像有两个同名的文件夹,但这肯定是不被允许的,我们打开windows的资源管理器,找到对应的目录查看一下。
    在这里插入图片描述事情果然没有那么简单,在创建目录的时候,我们大多数人肯定是习惯用.号隔离多个目录,因为我们创建java文件就是这么做的,如果只是创建一个目录,携程db.migration,idea默认创建的是一个名为db.migration的目录,所以最后分两次创建。
    在/db/migration/目录下,我们把原项目提供的两个sql脚本复制粘贴过来,并重命名为如下格式。
    在这里插入图片描述
    大V开头,后面跟版本号,用两根下划线隔开,后面接版本描述,.sql结尾。
    在这里插入图片描述
    一般项目进行到这里,flyway配置就完成了,不过ruoyi-vue到这里启动的话,还是会报错,主要是有三个地方用到了@PostConstruct注解,系统需要从数据库中加载配置信息,并且是构造bean后就执行,此时flaway的数据库配置加载还没执行,如果是第一次执行项目的话,数据库都还没有表结构信息,所以会报错。
    此时可以考虑重写flyway自动配置,通过@Bean的方式添加,不采用默认的自动化配置,控制表信息的加载时机。更方便的,直接改这三个地方的加载时机就行了。
    首先,注销掉三个地方的配置加载。
    ruoyi-system中com.ruoyi.system.service.impl.SysConfigServiceImpl的redis参数缓存配置
    在这里插入图片描述ruoyi-system中com.ruoyi.system.service.impl.SysDictTypeServiceImpl的字典信息缓存配置
    在这里插入图片描述ruoyi-quartz中com.ruoyi.quartz.service.impl.SysJobServiceImpl的定时任务配置
    在这里插入图片描述
    在ruoyi-system中新增一个配置类com.ruoyi.system.config.RuntimeConfig,内容如下,在项目加载完成后再执行这些参数的缓存配置。
@Component
public class RuntimeConfig implements ApplicationListener<ContextRefreshedEvent> {
    
    

    private final static Logger LOGGER = LoggerFactory.getLogger(RuntimeConfig.class);

    @Autowired
    private SysConfigMapper configMapper;

    @Autowired
    private RedisCache redisCache;

    @Autowired
    private SysDictTypeMapper dictTypeMapper;

    @Autowired
    private SysDictDataMapper dictDataMapper;

    @Autowired
    private Scheduler scheduler;

    @Autowired
    private SysJobMapper jobMapper;

    /**
     * 项目启动时,初始化参数
     */
    @Override
    public void onApplicationEvent(ContextRefreshedEvent contextRefreshedEvent) {
    
    
        LOGGER.info("init redis ...");
        this.initRedis();
        LOGGER.info("init dict ...");
        this.initDict();
        try {
    
    
            LOGGER.info("init job ...");
            this.initJob();
        } catch (SchedulerException e) {
    
    
            e.printStackTrace();
        } catch (TaskException e) {
    
    
            e.printStackTrace();
        }
    }

    /**
     * 初始化定时任务信息到缓存
     *
     * @throws SchedulerException
     * @throws TaskException
     */
    public void initJob() throws SchedulerException, TaskException {
    
    
        scheduler.clear();
        List<SysJob> jobList = jobMapper.selectJobAll();
        for (SysJob job : jobList) {
    
    
            ScheduleUtils.createScheduleJob(scheduler, job);
        }
    }

    /**
     * 初始化参数到缓存
     */
    public void initRedis() {
    
    
        List<SysConfig> configsList = configMapper.selectConfigList(new SysConfig());
        for (SysConfig config : configsList) {
    
    
            redisCache.setCacheObject(getCacheKey(config.getConfigKey()), config.getConfigValue());
        }
    }

    /**
     * 初始化字典到缓存
     */
    public void initDict() {
    
    
        List<SysDictType> dictTypeList = dictTypeMapper.selectDictTypeAll();
        for (SysDictType dictType : dictTypeList) {
    
    
            List<SysDictData> dictDatas = dictDataMapper.selectDictDataByType(dictType.getDictType());
            DictUtils.setDictCache(dictType.getDictType(), dictDatas);
        }
    }

    /**
     * 设置cache key
     *
     * @param configKey 参数键
     * @return 缓存键key
     */
    private String getCacheKey(String configKey) {
    
    
        return Constants.SYS_CONFIG_KEY + configKey;
    }
}

到此,再启动项目,表结构和数据都会按照我们的脚本,自动初始化,并且,新增一张flyway_schema_history的表,记录数据库的版本信息。
在这里插入图片描述

猜你喜欢

转载自blog.csdn.net/qq_41885819/article/details/114970148