Spring Boot 2.5.0版本發(fā)布后，其中提到了關(guān)于Datasource初始化機(jī)制的調(diào)整，那這方面到底做了什么調(diào)整？那么今天就詳細(xì)說(shuō)說(shuō)這個(gè)重新設(shè)計(jì)的配置內(nèi)容，并結(jié)合實(shí)際情況聊一聊相關(guān)理解和實(shí)踐建議。
棄用內(nèi)容
先來(lái)糾正一個(gè)誤區(qū)。主要之前在版本更新介紹的時(shí)候，存在一些表述上的問(wèn)題。有些朋友認(rèn)為這次的更新是Datasource本身初始化的調(diào)整，但其實(shí)并不是。這次重新設(shè)計(jì)的只是對(duì)Datasource腳本初始化機(jī)制的重新設(shè)計(jì)。
先來(lái)看看這次被棄用部分的內(nèi)容（位于org.springframework.boot.autoconfigure.jdbc.DataSourceProperties），如果你有用過(guò)這些配置內(nèi)容，那么新配置就很容易理解了。
/**
* Mode to apply when determining if DataSource initialization should be performed
* using the available DDL and DML scripts.
*/
@Deprecated
private DataSourceInitializationMode initializationMode = DataSourceInitializationMode.EMBEDDED;
/**
* Platform to use in the DDL or DML scripts (such as schema-${platform}.sql or
* data-${platform}.sql).
*/
@Deprecated
private String platform = "all";
/**
* Schema (DDL) script resource references.
*/
private List<String> schema;
/**
* Username of the database to execute DDL scripts (if different).
*/
@Deprecated
private String schemaUsername;
/**
* Password of the database to execute DDL scripts (if different).
*/
@Deprecated
private String schemaPassword;
/**
* Data (DML) script resource references.
*/
@Deprecated
private List<String> data;
/**
* Username of the database to execute DML scripts (if different).
*/
@Deprecated
private String dataUsername;
/**
* Password of the database to execute DML scripts (if different).
*/
@Deprecated
private String dataPassword;
/**
* Whether to stop if an error occurs while initializing the database.
*/
@Deprecated
private boolean continueOnError = false;
/**
* Statement separator in SQL initialization scripts.
*/
@Deprecated
private String separator = ";";
/**
* SQL scripts encoding.
*/
@Deprecated
private Charset sqlScriptEncoding;
對(duì)應(yīng)到配置文件里的屬性如下（這里僅列出部分，就不全部列出了，主要就是對(duì)應(yīng)上面源碼中的屬性）：
spring.datasource.schema=
spring.datasource.schema-username=
spring.datasource.schema-password=
...
這些配置主要用來(lái)指定數(shù)據(jù)源初始化之后要用什么用戶、去執(zhí)行哪些腳本、遇到錯(cuò)誤是否繼續(xù)等功能。
新的設(shè)計(jì)
Spring Boot 2.5.0開(kāi)始，啟用了全新的配置方式，我們可以從這個(gè)類(lèi)org.springframework.boot.autoconfigure.sql.init.SqlInitializationProperties里看到詳情。
下面我們通過(guò)一個(gè)簡(jiǎn)單的例子來(lái)體驗(yàn)這個(gè)功能的作用。
- 創(chuàng)建一個(gè)Spring Boot的基礎(chǔ)應(yīng)用，并在pom.xml中引入和mysql的依賴(lài)：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
- 在配置文件中增加數(shù)據(jù)源和初始化數(shù)據(jù)源的配置，具體如下：
spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
# Spring Boot 2.5.0 init schema & data
# 執(zhí)行初始化腳本的用戶名稱(chēng)
spring.sql.init.username=root
# 執(zhí)行初始化腳本的用戶密碼
spring.sql.init.password=
# 初始化的schema腳本位置
spring.sql.init.schema-locations=classpath*:schema-all.sql
- 根據(jù)上面配置的定義，接下來(lái)就在
resource目錄下，創(chuàng)建腳本文件schema-all.sql，并寫(xiě)入一些初始化表結(jié)構(gòu)的腳本
create table test.user_info
(
id int unsigned auto_increment comment '用戶id'
primary key,
open_id varchar(255) default '' null comment '微信小程序openid',
nick_name varchar(255) default '' null comment '微信名',
head_img varchar(255) default '' null comment '微信頭像',
sex varchar(255) default '' null comment '性別',
phone varchar(255) default '' null comment '手機(jī)',
province varchar(255) default '' null comment '注冊(cè)地址：省',
city varchar(255) default '' null comment '注冊(cè)地址：城市',
country varchar(255) default '' null comment '注冊(cè)地址：縣/區(qū)',
status tinyint unsigned default 0 not null comment '是否標(biāo)記刪除 0：否 1：是',
create_time datetime not null comment '創(chuàng)建時(shí)間',
update_time datetime not null comment '更新時(shí)間'
)
comment '用戶表';
- 完成上面步驟之后，啟動(dòng)應(yīng)用。然后打開(kāi)MySQL客戶端，可以看到在
test庫(kù)下，多了一個(gè)user_info表
通過(guò)上面的例子，不難想到這樣的功能主要可以用來(lái)管理應(yīng)用啟動(dòng)與數(shù)據(jù)庫(kù)配置的自動(dòng)執(zhí)行，以減少應(yīng)用部署過(guò)程中手工執(zhí)行的內(nèi)容，降低應(yīng)用部署的執(zhí)行步驟。
配置詳解
除了上面用到的配置屬性之外，還有一些其他的配置，下面詳細(xì)講解一下作用。
spring.sql.init.enabled：是否啟動(dòng)初始化的開(kāi)關(guān)，默認(rèn)是true。如果不想執(zhí)行初始化腳本，設(shè)置為false即可。通過(guò)-D的命令行參數(shù)會(huì)更容易控制。spring.sql.init.username和spring.sql.init.password：配置執(zhí)行初始化腳本的用戶名與密碼。這個(gè)非常有必要，因?yàn)榘踩芾硪螅ǔ＝o業(yè)務(wù)應(yīng)用分配的用戶對(duì)一些建表刪表等命令沒(méi)有權(quán)限。這樣就可以與datasource中的用戶分開(kāi)管理。spring.sql.init.schema-locations：配置與schema變更相關(guān)的sql腳本，可配置多個(gè)（默認(rèn)用;分割）spring.sql.init.data-locations：用來(lái)配置與數(shù)據(jù)相關(guān)的sql腳本，可配置多個(gè)（默認(rèn)用;分割）spring.sql.init.encoding：配置腳本文件的編碼spring.sql.init.separator：配置多個(gè)sql文件的分隔符，默認(rèn)是;spring.sql.init.continue-on-error：如果執(zhí)行腳本過(guò)程中碰到錯(cuò)誤是否繼續(xù)，默認(rèn)是false`；所以，上面的例子第二次執(zhí)行的時(shí)候會(huì)報(bào)錯(cuò)并啟動(dòng)失敗，因?yàn)榈谝淮螆?zhí)行的時(shí)候表已經(jīng)存在。
應(yīng)用建議
關(guān)于這些配置的應(yīng)用，相信有些朋友一定會(huì)把它與數(shù)據(jù)庫(kù)的版本管理聯(lián)系起來(lái)（因?yàn)榭梢宰詣?dòng)的執(zhí)行腳本）。
那么依靠這些配置，是否可以勝任業(yè)務(wù)應(yīng)用部署時(shí)候數(shù)據(jù)庫(kù)初始化的自動(dòng)化實(shí)現(xiàn)呢？
個(gè)人認(rèn)為就上述所介紹的配置，雖然具備了一定的自動(dòng)執(zhí)行能力。但由于缺失對(duì)當(dāng)前環(huán)境的判斷能力，所以要應(yīng)對(duì)實(shí)際的部署場(chǎng)景來(lái)說(shuō)，還是遠(yuǎn)遠(yuǎn)不夠的。
如果要自動(dòng)化的管理數(shù)據(jù)庫(kù)表結(jié)構(gòu)、初始化數(shù)據(jù)的話，我的建議是：
- 默認(rèn)提供的這個(gè)初始化功能可以且僅用于單元測(cè)試，自動(dòng)創(chuàng)建數(shù)據(jù)庫(kù)結(jié)構(gòu)與初始化數(shù)據(jù)，使用完畢后銷(xiāo)毀。可以方便的控制每次單元測(cè)試的執(zhí)行環(huán)境一致。
- 應(yīng)用在環(huán)境部署的時(shí)候，還是要使用之前介紹過(guò)的Flyway來(lái)實(shí)現(xiàn)，如何使用可見(jiàn)之前的分享：使用Flyway來(lái)管理數(shù)據(jù)庫(kù)版本。
- 聯(lián)合Flyway一同使用，通過(guò)
org.springframework.jdbc.datasource.init.DataSourceInitializer來(lái)定義更復(fù)雜的執(zhí)行邏輯。
注：本文轉(zhuǎn)載自“程序猿DD”，如有侵權(quán)，請(qǐng)聯(lián)系刪除！
