轉(zhuǎn)載自www.youngboy.vip

demo 地址 https://gitee.com/youngboyvip/liquibase-demo

使用 LiquiBase 管理數(shù)據(jù)庫(kù)變更

首先來(lái)了解下liquibase是什么

Liquibase是一個(gè)用于跟蹤、管理和應(yīng)用數(shù)據(jù)庫(kù)變化的開(kāi)源的數(shù)據(jù)庫(kù)重構(gòu)工具。它將所有數(shù)據(jù)庫(kù)的變化（包括結(jié)構(gòu)和數(shù)據(jù)）都保存在XML文件中，便于版本控制

liquibase 可以干嘛剪勿？

• 不依賴于特定的數(shù)據(jù)庫(kù)，目前支持包括Oracle/Sql Server/DB2/MySql/Sybase/PostgreSQL/Caché等12種數(shù)據(jù)庫(kù)，這樣在數(shù)據(jù)庫(kù)的部署和升級(jí)環(huán)節(jié)可幫助應(yīng)用系統(tǒng)支持多數(shù)據(jù)庫(kù)。
• 提供數(shù)據(jù)庫(kù)比較功能具垫，比較結(jié)果保存在XML中，基于該XML你可用Liquibase輕松部署或升級(jí)數(shù)據(jù)庫(kù)试幽。
• 以XML存儲(chǔ)數(shù)據(jù)庫(kù)變化筝蚕，其中以作者和ID唯一標(biāo)識(shí)一個(gè)變化（ChangSet），支持?jǐn)?shù)據(jù)庫(kù)變化的合并铺坞，因此支持多開(kāi)發(fā)人員同時(shí)工作起宽。
• 在數(shù)據(jù)庫(kù)中保存數(shù)據(jù)庫(kù)修改歷史（DatabaseChangeHistory），在數(shù)據(jù)庫(kù)升級(jí)時(shí)自動(dòng)跳過(guò)已應(yīng)用的變化（ChangSet）济榨。
• 提供變化應(yīng)用的回滾功能坯沪，可按時(shí)間、數(shù)量或標(biāo)簽（tag）回滾已應(yīng)用的變化擒滑。通過(guò)這種方式腐晾，開(kāi)發(fā)人員可輕易的還原數(shù)據(jù)庫(kù)在任何時(shí)間點(diǎn)的狀態(tài)。
• 可生成數(shù)據(jù)庫(kù)修改文檔（HTML格式）
• 提供數(shù)據(jù)重構(gòu)的獨(dú)立的IDE和Eclipse插件橘忱。

傳統(tǒng)的開(kāi)發(fā)模式中的數(shù)據(jù)庫(kù)修改之為什么使用liquibase

在日常的項(xiàng)目開(kāi)發(fā)中赴魁，開(kāi)發(fā)團(tuán)隊(duì)經(jīng)常將數(shù)據(jù)庫(kù)和應(yīng)用程序視為單獨(dú)的實(shí)體卸奉，這樣就導(dǎo)致了數(shù)據(jù)庫(kù)團(tuán)隊(duì)與應(yīng)用開(kāi)發(fā)團(tuán)隊(duì)分離造成團(tuán)隊(duì)之間信息交流不暢钝诚，信息交流不及時(shí)，這種情況通常表現(xiàn)為下面幾種行為

• 手工變更數(shù)據(jù)庫(kù)
• 不能與團(tuán)隊(duì)的其他成員分享數(shù)據(jù)庫(kù)變更
• 使用不一致的方法變更數(shù)據(jù)庫(kù)或數(shù)據(jù)
• 使用低效的手工方法管理數(shù)據(jù)庫(kù)版本之間的變更

上面的幾種行為都是我們?cè)趯?shí)際開(kāi)發(fā)中遇到的問(wèn)題榄棵，不僅效率低而且出錯(cuò)的機(jī)率也高凝颇，就算是老司機(jī)也會(huì)翻車

解決上面問(wèn)題的思路是 減少人工手工變更數(shù)據(jù)庫(kù)的機(jī)會(huì)潘拱，用程序管理數(shù)據(jù)庫(kù)版本的更替

使用liquibase 管理數(shù)據(jù)庫(kù)的變更

使用步驟

• step1: 創(chuàng)建一個(gè)數(shù)據(jù)庫(kù) 變更日志（change log）文件。
• step2: 在變更日志文件內(nèi)部創(chuàng)建一個(gè) 變更集（change set）拧略。
• step3: 通過(guò)命令行或構(gòu)建腳本對(duì)數(shù)據(jù)庫(kù)運(yùn)行變更集芦岂。
• step4: 檢驗(yàn)數(shù)據(jù)庫(kù)中的變更。

step1:創(chuàng)建change log文件(changlog.xml)

change log 文件不一定要用xml寫 還可以使用json sql

<?xml version="1.0" encoding="UTF-8"?>

<databaseChangeLog
  xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
         http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.1.xsd">

</databaseChangeLog>

step2: 添加變更集

<?xml version="1.0" encoding="UTF-8"?>

<databaseChangeLog
  xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
         http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.1.xsd">

    <changeSet id="1" author="bob">
        <createTable tableName="department">
            <column name="id" type="int">
                <constraints primaryKey="true" nullable="false"/>
            </column>
            <column name="name" type="varchar(50)">
                <constraints nullable="false"/>
            </column>
            <column name="active" type="boolean" defaultValueBoolean="true"/>
        </createTable>
    </changeSet>

</databaseChangeLog>

每個(gè)更改集都用“id”屬性和“author”屬性唯一標(biāo)識(shí)垫蛆∏葑睿“作者”屬性可以最大限度地減少重復(fù)的可能性。
liquibase將每個(gè)更改集視為要應(yīng)用于數(shù)據(jù)庫(kù)的原子更改袱饭。通常最好只在更改集中包含一個(gè)更改

step3: 運(yùn)行ChangeSet
liquibase 可以使用命令行 Ant Maven Spring等工具運(yùn)行
命令演示

liquibase --driver=com.mysql.jdbc.Driver \
     --classpath=/path/to/classes \
     --changeLogFile=com/example/db.changelog.xml \
     --url="jdbc:mysql://localhost/example" \
     --username=user \
     --password=asdf \
     update

step4: 檢查你的數(shù)據(jù)庫(kù)
你可以看到數(shù)據(jù)庫(kù)現(xiàn)在包含一個(gè)名為“department”的表川无。還創(chuàng)建了另外兩個(gè)表：“databasechangelog”和“databasechangeloglock”。
databasechangelog表包含已針對(duì)數(shù)據(jù)庫(kù)運(yùn)行的所有語(yǔ)句的列表虑乖。
databasechangeloglock表用于確保兩臺(tái)計(jì)算機(jī)不會(huì)同時(shí)嘗試修改數(shù)據(jù)庫(kù)懦趋。

在項(xiàng)目中使用liquibase （spring集成的方式）

liquibase提供了對(duì)Spring的支持所以我們只需要引用對(duì)應(yīng)的jar包并進(jìn)行相關(guān)的配置就可以使用了

這里使用gradle作為示例
step1: 添加依賴

compile "org.liquibase:liquibase-core"
compile "com.github.sabomichal:liquibase-mssql"
compile "com.microsoft.sqlserver:mssql-jdbc"
testCompile "com.mattbertolini:liquibase-slf4j"

step2: 添加liquibase文件

在resource目錄下創(chuàng)建liquibase文件夾，并創(chuàng)建master.xml文件作為主文件
使用 <include file="config/liquibase/changelog/xxx.xml" relativeToChangelogFile="false"/> 目錄引入changelog文件

step3: 配置liquibase

@Bean
    public SpringLiquibase liquibase(DataSource dataSource, LiquibaseProperties liquibaseProperties) {

        SpringLiquibase liquibase = new SpringLiquibase(taskExecutor, env);
        liquibase.setDataSource(dataSource);
        //制定changelog的位置疹味，這里使用的一個(gè)master文件引用其他文件的方式
        liquibase.setChangeLog("classpath:config/liquibase/master.xml");
        liquibase.setContexts(liquibaseProperties.getContexts());
        liquibase.setDefaultSchema(liquibaseProperties.getDefaultSchema());
        liquibase.setDropFirst(liquibaseProperties.isDropFirst());
        return liquibase;
    }

liquibase會(huì)在啟動(dòng)的時(shí)候更新數(shù)據(jù)庫(kù)仅叫，可以配置為異步執(zhí)行

對(duì)現(xiàn)有數(shù)據(jù)庫(kù)應(yīng)用重構(gòu) & 常見(jiàn)的數(shù)據(jù)庫(kù)操作

隨著新特性添加到了應(yīng)用程序中，經(jīng)常需要變更數(shù)據(jù)庫(kù)的結(jié)構(gòu)或修改表約束糙捺。LiquiBase 提了超過(guò) 30 種數(shù)據(jù)庫(kù)重構(gòu)支持（參見(jiàn) 參考資料）诫咱。本節(jié)將介紹 4 種重構(gòu)：添加列（Add Column）、刪除列（Drop Column）继找、創(chuàng)建表（Create Table）和操作數(shù)據(jù)遂跟。

添加列

在項(xiàng)目的開(kāi)始，幾乎不可能考慮到數(shù)據(jù)庫(kù)中的所有列婴渡。而有時(shí)候幻锁，用戶要求新的特性 —例如為存儲(chǔ)在系統(tǒng)中的信息收集更多的數(shù)據(jù) —這就要求添加新的列。清單 4 使用 LiquiBase addColumn重構(gòu)边臼，向數(shù)據(jù)庫(kù)中的 distributor表添加了一個(gè)列：

清單 4. 使用 LiquiBase 變更集中的 Add Column 數(shù)據(jù)庫(kù)重構(gòu)

<changeSet id="4" author="joe"> 
 <addColumn tableName="distributor"> 
   <column name="phonenumber" type="varchar(255)"/> 
 </addColumn> 
</changeSet>

刪除列

假如在以后幾個(gè)版本中哄尔，您想要?jiǎng)h除在清單 4 添加的 phonenumber列。只需要調(diào)用 dropColumn重構(gòu)柠并，如清單 5 所示：

刪除一個(gè)數(shù)據(jù)庫(kù)列

<dropColumn tableName="distributor" columnName="phonenumber"/>

創(chuàng)建表

向數(shù)據(jù)庫(kù)添加一個(gè)新表也是常見(jiàn)的數(shù)據(jù)庫(kù)重構(gòu)岭接。清單 6 創(chuàng)建了一個(gè)新表 distributor，定義了列臼予、約束和默認(rèn)值：

清單 6. 在 LiquiBase 中創(chuàng)建一個(gè)新數(shù)據(jù)庫(kù)表

<changeSet id="3" author="betsey"> 
 <createTable tableName="distributor"> 
   <column name="id" type="int"> 
     <constraints primaryKey="true" nullable="false"/> 
   </column> 
   <column name="name" type="varchar(255)"> 
     <constraints nullable="false"/> 
   </column> 
   <column name="address" type="varchar(255)"> 
     <constraints nullable="true"/> 
   </column> 
   <column name="active" type="boolean" defaultValue="1"/> 
 </createTable> 
</changeSet>

操作數(shù)據(jù)

在應(yīng)用了結(jié)構(gòu)性數(shù)據(jù)重構(gòu)后（例如添加列和創(chuàng)建表）鸣戴，通常需要向受重構(gòu)影響的表中插入數(shù)據(jù)。此外粘拾，可能需要修改查找表（或其他類型的表）中的現(xiàn)有數(shù)據(jù)窄锅。清單 7 展示了如何使用一個(gè) LiquiBase 變更集插入數(shù)據(jù)：

清單 7. 使用一個(gè) LiquiBase 變更集插入數(shù)據(jù)

<changeSet id="3" author="betsey"> 
 <code type="section" width="100%"> 
 <insert tableName="distributor"> 
   <column name="id" valueNumeric="3"/> 
   <column name="name" value="Manassas Beer Company"/> 
 </insert> 
 <insert tableName="distributor"> 
   <column name="id" valueNumeric="4"/> 
   <column name="name" value="Harrisonburg Beer Distributors"/> 
 </insert> 
</changeSet>

您應(yīng)該編寫用于操作數(shù)據(jù)的 SQL 腳本，因?yàn)槭褂?LiquiBase XML 變更集限制很多缰雇。有時(shí)候使用 SQL 腳本向數(shù)據(jù)庫(kù)應(yīng)用大量的變更會(huì)簡(jiǎn)單一些入偷。LiquiBase 也可以支持這些情景追驴。清單 8 調(diào)用變更集中的 insert-distributor-data.sql來(lái)插入 distributor表數(shù)據(jù)：

清單 8. 從 LiquiBase 變更集運(yùn)行一個(gè)定制 SQL 文件

<changeSet id="6" author="joe"> 
 <sqlFile path="insert-distributor-data.sql"/> 
</changeSet>

LiquiBase 支持很多其他數(shù)據(jù)庫(kù)重構(gòu)，包括 Add Lookup Table 和 Merge Columns疏之〉钛可以使用如清單 4 到清單 8 所示的方式定義所有這些支持。

changeset xsd 參考

<!-- Children for changeSet -->
    <xsd:group name="changeSetChildren">
        <xsd:choice>
            <xsd:element ref="comment" maxOccurs="1" />
            <xsd:element ref="createTable" maxOccurs="unbounded" />
            <xsd:element ref="dropTable" maxOccurs="unbounded" />
            <xsd:element ref="createView" maxOccurs="unbounded" />
            <xsd:element ref="renameView" maxOccurs="unbounded" />
            <xsd:element ref="dropView" maxOccurs="unbounded" />
            <xsd:element ref="insert" maxOccurs="unbounded" />
            <xsd:element ref="addColumn" maxOccurs="unbounded" />
            <xsd:element ref="sql" maxOccurs="unbounded" />
            <xsd:element ref="createProcedure" maxOccurs="unbounded" />
            <xsd:element ref="dropProcedure" maxOccurs="unbounded" />
            <xsd:element ref="sqlFile" maxOccurs="unbounded" />
            <xsd:element ref="renameTable" maxOccurs="unbounded" />
            <xsd:element ref="renameColumn" maxOccurs="unbounded" />
            <xsd:element ref="dropColumn" maxOccurs="unbounded" />
            <xsd:element ref="mergeColumns" maxOccurs="unbounded" />
            <xsd:element ref="modifyDataType" maxOccurs="unbounded" />
            <xsd:element ref="createSequence" maxOccurs="unbounded" />
            <xsd:element ref="alterSequence" maxOccurs="unbounded" />
            <xsd:element ref="dropSequence" maxOccurs="unbounded" />
            <xsd:element ref="renameSequence" maxOccurs="unbounded" />
            <xsd:element ref="createIndex" maxOccurs="unbounded" />
            <xsd:element ref="dropIndex" maxOccurs="unbounded" />
            <xsd:element ref="addNotNullConstraint" maxOccurs="unbounded" />
            <xsd:element ref="dropNotNullConstraint" maxOccurs="unbounded" />
            <xsd:element ref="addForeignKeyConstraint" maxOccurs="unbounded" />
            <xsd:element ref="dropForeignKeyConstraint" maxOccurs="unbounded" />
            <xsd:element ref="dropAllForeignKeyConstraints"
                maxOccurs="unbounded" />
            <xsd:element ref="addPrimaryKey" maxOccurs="unbounded" />
            <xsd:element ref="dropPrimaryKey" maxOccurs="unbounded" />
            <xsd:element ref="addLookupTable" maxOccurs="unbounded" />
            <xsd:element ref="addAutoIncrement" maxOccurs="unbounded" />
            <xsd:element ref="addDefaultValue" maxOccurs="unbounded" />
            <xsd:element ref="dropDefaultValue" maxOccurs="unbounded" />
            <xsd:element ref="addUniqueConstraint" maxOccurs="unbounded" />
            <xsd:element ref="dropUniqueConstraint" maxOccurs="unbounded" />
            <xsd:element ref="setTableRemarks" maxOccurs="unbounded" />
            <xsd:element ref="setColumnRemarks" maxOccurs="unbounded" />
            <xsd:element ref="customChange" maxOccurs="unbounded" />
            <xsd:element ref="update" maxOccurs="unbounded" />
            <xsd:element ref="delete" maxOccurs="unbounded" />
            <xsd:element ref="loadData" maxOccurs="unbounded" />
            <xsd:element ref="loadUpdateData" maxOccurs="unbounded" />
            <xsd:element ref="executeCommand" maxOccurs="unbounded" />
            <xsd:element ref="stop" maxOccurs="unbounded" />
            <xsd:element ref="output" maxOccurs="unbounded" />
            <xsd:element ref="empty" maxOccurs="unbounded" />
            <xsd:element ref="rollback" maxOccurs="1" />
            <xsd:any namespace="##other" processContents="lax" minOccurs="0"
                maxOccurs="unbounded" />
        </xsd:choice>
    </xsd:group>

gradle liquibase 插件使用

安裝gradle插件

gradle 2.0 以上寫法

plugins {
  id 'org.liquibase.gradle' version '2.0.0'
}

gradle 2.0 以下寫法

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath "org.liquibase:liquibase-gradle-plugin:2.0.0"
    }
}
apply plugin: 'org.liquibase.gradle'

配置依賴

dependencies {
  ...
  // 選擇你需要的依賴
  liquibaseRuntime 'org.liquibase:liquibase-core:3.6.1'
  liquibaseRuntime 'org.liquibase:liquibase-groovy-dsl:2.0.0'
  liquibaseRuntime 'mysql:mysql-connector-java:5.1.34'
  ...
}

配置 liquibase activities（類似profile）

//生成對(duì)比記錄文件的位置
project.ext.diffChangelogFile = 'src/main/resources/config/liquibase/changelog/' + new Date().format('yyyyMMddHHmmss') + '_changelog.xml'
//生成sql文件的位置
project.ext.generateSql = 'src/main/resources/config/liquibase/sql/' + new Date().format('yyyyMMddHHmmss') + '_update.sql'

liquibase {
    activities {
        prod {
            driver 'com.microsoft.sqlserver.jdbc.SQLServerDriver'
            url 'jdbc:sqlserver://localhost:1433;database=damManager'
            username 'SA'
            password 'yourStrong(!)Password'
            changeLogFile 'config/liquibase/master.xml'
            defaultSchemaName ''
            logLevel 'debug'
            baseDir 'src/main/resources/'
            outputFile project.ext.generateSql
        }
        dev {
            driver 'com.microsoft.sqlserver.jdbc.SQLServerDriver'
            url 'jdbc:sqlserver://localhost:1433;database=damManager'
            username 'SA'
            password 'yourStrong(!)Password'
            password 'sql_2008dba'
            changeLogFile 'config/liquibase/master.xml'
            defaultSchemaName ''
            logLevel 'debug'
            baseDir 'src/main/resources/'
            outputFile project.ext.generateSql
        }
        diffLog {
            driver ''
            url 'jdbc:sqlserver://localhost:1433;database=damManager'
            username 'SA'
            password 'yourStrong(!)Password'
            changeLogFile project.ext.diffChangelogFile
            defaultSchemaName ''
            logLevel 'debug'
            classpath 'src/main/resources/'
        }
        runList = 'dev' // 這里代表選擇哪一個(gè)配置 可用參數(shù)代替
    }

}

入口類配置

可通過(guò)自定義入口類锋爪，拓展liquibase的功能
拓展示例項(xiàng)目地址 https://gitee.com/youngboyvip/liquibase-cmd

默認(rèn)入口類
liquibase.integration.commandline.Main

配置方法

liquibase {
  mainClassName = 'liquibase.ext.commandline.LiquibaseAlternativeMain'
}

配置完成后就可以在gradle中看到liquibase的task

注意：如果使用了include等標(biāo)簽需要注意 file="xxx/xxx/xxx.xml" 絕對(duì)路徑和相對(duì)路徑丙曙，如果設(shè)置relativeToChangelogFile="false" 這說(shuō)明你使用的是絕對(duì)路徑，true 選擇的是相對(duì)路徑其骄，可自定義資源加載器解決絕對(duì)路徑和相對(duì)路徑的問(wèn)題河泳，可以參考上方的示例項(xiàng)目

任務(wù)額外參數(shù)設(shè)置

liquibase.activities 中配置的是必須要配置的參數(shù)，一些命令可能需要額外的參數(shù)年栓，這個(gè)時(shí)候就需要使用命令行動(dòng)態(tài)創(chuàng)建參數(shù)

如果使用的是gradle wrapper 需要使用gradlew 執(zhí)行命令

示例

//多個(gè)參數(shù)用空格隔開(kāi)拆挥，命令參數(shù)可參考文章下方附錄
gradlew <任務(wù)名> -PliquibaseCommandValue="--xx=yy --aa=bb"

使用經(jīng)驗(yàn)

不要手動(dòng)修改數(shù)據(jù)庫(kù)
不要去修改原來(lái)的changeset 使用新的changeset去修改
定時(shí)打tag 方便回滾

正在開(kāi)發(fā)的項(xiàng)目中使用liquibase

使用思路： 把以前的數(shù)據(jù)庫(kù)變更(比如表結(jié)構(gòu)，存儲(chǔ)過(guò)程某抓，基礎(chǔ)數(shù)據(jù)）導(dǎo)出來(lái)纸兔，然后使用liquibase管理，以后開(kāi)發(fā)統(tǒng)一使用liquibase數(shù)據(jù)庫(kù)管理變更)

step1： 導(dǎo)出數(shù)據(jù)庫(kù)中的更改

可以使用數(shù)據(jù)庫(kù)工具導(dǎo)出為sql文件否副，或者使用liquibase命令行工具的generateChangelog命令 導(dǎo)出XML變更文件

step2： 使用liquibase管理數(shù)據(jù)庫(kù)變更

因?yàn)閿?shù)據(jù)庫(kù)中已經(jīng)存在對(duì)應(yīng)的變更汉矿，所以只需要把導(dǎo)出來(lái)的變更記錄標(biāo)記為已執(zhí)行即可

這步操作可以使用liquibase命令行根據(jù)的changelogSync或changelogSyncSQL 這個(gè)兩個(gè)命令的區(qū)別是一個(gè)會(huì)直接修改數(shù)據(jù)庫(kù)，一個(gè)是不直接修改數(shù)據(jù)庫(kù)备禀，一個(gè)是生成對(duì)應(yīng)的sql洲拇，需要手動(dòng)指向sql

liquibase 命令附錄

必傳參數(shù)

可選的參數(shù)

diff 命令必傳參數(shù)

diff 命令可選參數(shù)

官方參考文檔 http://www.liquibase.org/documentation/command_line.html

Gradle 命令參考