欢迎关注公众号 《小姐姐味道》 ,一起进步!

# 老板:把数据库变更,给整利索了

http://xjjdog.cn 对200+原创文章进行了细致的分类,阅读更流畅,欢迎收藏。

原创:不羡鸳鸯不羡仙,一行代码调半天。小姐姐味道(微信公众号ID:xjjdog),欢迎分享,转载请保留出处。

经过千难万险的开发,系统终于上线了,进入了更加惊险刺激的捉虫阶段。在修修补补之中,给后人留下一堆屎山之前,我们需要把数据库给整利索了。

想想吧,我们在开发环境,修改了多个字段的名称,经历了测试环境的洗礼,还搞了个预上线接受变更。结果,仅仅在线上忘了操作其中一条SQL,就前功尽弃。如果你做的是项目类型的工作,客户半年六个月才升级一次,这些脚本的管理就会乱上加乱。

我们需要把这些数据库变更,使用git这样的工具管理起来,在系统启动的时候,能够自动变更。通过口口相传,太不可信了。

谁也不想背这个锅。翻聊天记录?有用么?都是事后诸葛亮。

人和动物的区别,就是使用工具。经常被使用的两个,有Liquibase和Flyway。但是,Liquibase的迁移脚本写起来太复杂,需要花很多时间维护,远不如Flyway这样的开箱即用(牺牲跨平台)。如果你的项目不是非常复杂,对Liquibase也不熟悉,建议直接选用flyway。

一般,数据库变更,会有下面几种语句,我们都可以使用flyway来完成。

  • DDL 建表和索引的时候,用到的语句,比如CREATE、ALTER、DROP等
  • DML 就是一些常见的数据操作语句,比如update、delete、insert
  • DCL 用来设置和管理权限方面信息的语句,比如grant、deny、revoke等

下面,就以flyway为例,来看一下数据库的版本,是如何变更的。

# 1. flyway migrate

首先,使用mvn的命令,创建一个示范项目。

mvn archetype:generate -B \
-DarchetypeGroupId=org.apache.maven.archetypes \
    -DarchetypeArtifactId=maven-archetype-quickstart \
    -DarchetypeVersion=1.1 \
    -DgroupId=foo \
    -DartifactId=bar \
    -Dversion=1.0-SNAPSHOT \
    -Dpackage=foobar

在pom.xml文件中加入下面的内容:

<build>
    <plugins>
        <plugin>
            <groupId>org.flywaydb</groupId>
            <artifactId>flyway-maven-plugin</artifactId>
            <version>7.3.1</version>
            <configuration>
                <url>jdbc:h2:file:./target/foobar</url>
                <user>sa</user>
            </configuration>
            <dependencies>
                <dependency>
                    <groupId>com.h2database</groupId>
                    <artifactId>h2</artifactId>
                    <version>1.4.200</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

创建数据库变更目录。

mkdir -p src/main/resources/db/migration

创建新的数据库文件,我们把它叫做第一个版本: src/main/resources/db/migration/V1__Create_person_table.sql

create table PERSON (
    ID int not null,
    NAME varchar(100) not null
);

使用mvn命令,即可完成数据库更新。不要怕,这个命令是幂等的。

mvn flyway:migrate

终端将输出下面的内容:

[INFO] Database: jdbc:h2:file:./target/foobar (H2 1.4)
[INFO] Successfully validated 1 migration (execution time 00:00.009s)
[INFO] Creating Schema History table: "PUBLIC"."flyway_schema_history"
[INFO] Current version of schema "PUBLIC": << Empty Schema >>
[INFO] Migrating schema "PUBLIC" to version 1 - Create person table
[INFO] Successfully applied 1 migration to schema "PUBLIC" (execution time 00:00.038s)

下面,我们准备第二个变更,同样的,我们创建第二版本的文件: src/main/resources/db/migration/V2__Add_people.sql

下面是SQL文件的内容:

insert into PERSON (ID, NAME) values (1, 'Axel');
insert into PERSON (ID, NAME) values (2, 'Mr. Foo');
insert into PERSON (ID, NAME) values (3, 'Ms. Bar');

再次执行mvn flyway:migrate,可以发现第二版本的DML信息,已经被写入到数据库。

# 2. 如何工作?

那flyway是如何做到幂等的呢?我们使用DBeaver来打开这个h2文件。

在JDBC连接处,输入:jdbc:h2:/private/tmp/bar/target/foobar.mv.db;然后选择H2 Embedded模式。我们发现,数据库中除了用户创建的PERSON表,还多了一个叫做flyway_schema_history的表。

让我们see一see里面的内容。使用mvn flyway:info命令,能看到相同的内容。

可以看到,这个幂等操作,其实是由一张自动创建的状态表,来保证的。里面还躺着一个叫做checksum的字段,李曼存储的是一个CRC32值,用来判断你的SQL文件是否经过了非法篡改(篡改后将不予通过)。

捅破了这层窗户纸,一切神奇的事情忽然就变得豁然开朗。所以如果你想要用flyway,你的账户,应该起码给create table的权限,否则你就需要手动建这种表。

从上面的SQL文件定义,也可以看出来,这些文件,需要遵循一定的规律。大体如上图所示,包含:

  1. 前缀
  2. 版本号
  3. 分隔符
  4. 版本描述

flyway就是靠这种约定,来进行库表变更的。所以,要严格按照它的要求去命名Sql文件。

# 3. SpringBoot项目集成

在pom中加入flyway的坐标。可以看到我们是没有提供版本号的,说明它已经在bom文件中定义过了。而它的autoconfigure,在SpringBoot的autoconfigure包里面默认提供了。

<dependencies>
      <dependency>
         <groupId>org.flywaydb</groupId>
         <artifactId>flyway-core</artifactId>
      </dependency>
      ...
</dependencies>

我们当然要看一下FlywayProperties这个文件所定义的配置项。可以看到它的前缀,就是spring.flyway

默认的DB变更文件,放在classpath:db/migration,我们也可以通过locations配置自定义一个,比如classpath:cn/xjjdog/flyway。当然,也可以通过table属性,定义那张his表的名称。url、user、password这些,也可以提供,把his表存储在和业务表不一样的地方。如果不提供,将默认使用datasource所定义的库。

所以,最小配置,就是什么都不做,直接把变更文件,扔在变更目录下面就可以了。

spring:
   datasource: 
      # jdbc配置...
flyway:
    enable: true
    locations: classpath:cn/xjjdog/flyway

# End

一根头发一寸金,寸金难买寸光阴。

随着时间的迁移,代码和sql,都会变成屎一样的东西。如何在软件的生命中周期结束之前,让我们的工程师,活的幸福一点,才是我们该做的。

作者简介:小姐姐味道 (xjjdog),一个不允许程序员走弯路的公众号。聚焦基础架构和Linux。十年架构,日百亿流量,与你探讨高并发世界,给你不一样的味道。我的个人微信xjjdog0,欢迎添加好友,​进一步交流。​


关注回复 技术 关键字 ,即可 获取 海量资源

鲁ICP备2020043359号-1