前幾天Spring Boot 2.5.0發(fā)布了原探,其中提到了關(guān)于Datasource初始化機制的調(diào)整,有讀者私信想了解這方面做了什么調(diào)整顽素。那么今天就要詳細(xì)說說這個重新設(shè)計的配置內(nèi)容咽弦,并結(jié)合實際情況說說我的理解和實踐建議。
棄用內(nèi)容
先來糾正一個誤區(qū)胁出。主要之前在版本更新介紹的時候型型,存在一些表述上的問題。導(dǎo)致部分讀者認(rèn)為這次的更新是Datasource本身初始化的調(diào)整全蝶,但其實并不是闹蒜。這次重新設(shè)計的只是對Datasource腳本初始化機制的重新設(shè)計。
先來看看這次被棄用部分的內(nèi)容(位于org.springframework.boot.autoconfigure.jdbc.DataSourceProperties
)抑淫,如果你有用過這些配置內(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;
對應(yīng)到配置文件里的屬性如下(這里僅列出部分始苇,就不全部列出了砌烁,主要就是對應(yīng)上面源碼中的屬性):
spring.datasource.schema=
spring.datasource.schema-username=
spring.datasource.schema-password=
...
這些配置主要用來指定數(shù)據(jù)源初始化之后要用什么用戶、去執(zhí)行哪些腳本催式、遇到錯誤是否繼續(xù)等功能往弓。
新的設(shè)計
Spring Boot 2.5.0開始,啟用了全新的配置方式蓄氧,我們可以從這個類org.springframework.boot.autoconfigure.sql.init.SqlInitializationProperties
里看到詳情函似。
下面我們通過一個簡單的例子來體驗這個功能的作用。
- 創(chuàng)建一個Spring Boot的基礎(chǔ)應(yīng)用喉童,并在pom.xml中引入和mysql的依賴:
<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í)行初始化腳本的用戶名稱
spring.sql.init.username=root
# 執(zhí)行初始化腳本的用戶密碼
spring.sql.init.password=
# 初始化的schema腳本位置
spring.sql.init.schema-locations=classpath*:schema-all.sql
- 根據(jù)上面配置的定義,接下來就在
resource
目錄下堂氯,創(chuàng)建腳本文件schema-all.sql
蔑担,并寫入一些初始化表結(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 '手機',
province varchar(255) default '' null comment '注冊地址:省',
city varchar(255) default '' null comment '注冊地址:城市',
country varchar(255) default '' null comment '注冊地址:縣/區(qū)',
status tinyint unsigned default 0 not null comment '是否標(biāo)記刪除 0:否 1:是',
create_time datetime not null comment '創(chuàng)建時間',
update_time datetime not null comment '更新時間'
)
comment '用戶表';
- 完成上面步驟之后,啟動應(yīng)用咽白。然后打開MySQL客戶端啤握,可以看到在
test
庫下,多了一個user_info
表
通過上面的例子晶框,不難想到這樣的功能主要可以用來管理應(yīng)用啟動與數(shù)據(jù)庫配置的自動執(zhí)行排抬,以減少應(yīng)用部署過程中手工執(zhí)行的內(nèi)容懂从,降低應(yīng)用部署的執(zhí)行步驟。
配置詳解
除了上面用到的配置屬性之外蹲蒲,還有一些其他的配置番甩,下面詳細(xì)講解一下作用。
-
spring.sql.init.enabled
:是否啟動初始化的開關(guān)届搁,默認(rèn)是true缘薛。如果不想執(zhí)行初始化腳本,設(shè)置為false即可卡睦。通過-D的命令行參數(shù)會更容易控制宴胧。 -
spring.sql.init.username
和spring.sql.init.password
:配置執(zhí)行初始化腳本的用戶名與密碼。這個非常有必要表锻,因為安全管理要求恕齐,通常給業(yè)務(wù)應(yīng)用分配的用戶對一些建表刪表等命令沒有權(quán)限。這樣就可以與datasource中的用戶分開管理浩嫌。 -
spring.sql.init.schema-locations
:配置與schema變更相關(guān)的sql腳本檐迟,可配置多個(默認(rèn)用;
分割) -
spring.sql.init.data-locations
:用來配置與數(shù)據(jù)相關(guān)的sql腳本,可配置多個(默認(rèn)用;
分割) -
spring.sql.init.encoding
:配置腳本文件的編碼 -
spring.sql.init.separator
:配置多個sql文件的分隔符码耐,默認(rèn)是;
-
spring.sql.init.continue-on-error:如果執(zhí)行腳本過程中碰到錯誤是否繼續(xù)追迟,默認(rèn)是
false`;所以骚腥,上面的例子第二次執(zhí)行的時候會報錯并啟動失敗敦间,因為第一次執(zhí)行的時候表已經(jīng)存在。
應(yīng)用建議
關(guān)于這些配置的應(yīng)用束铭,相信聰明的你一定會把它與數(shù)據(jù)庫的版本管理聯(lián)系起來(因為可以自動的執(zhí)行腳本)廓块。
那么依靠這些配置,是否可以勝任業(yè)務(wù)應(yīng)用部署時候數(shù)據(jù)庫初始化的自動化實現(xiàn)呢契沫?
個人認(rèn)為就上述所介紹的配置带猴,雖然具備了一定的自動執(zhí)行能力。但由于缺失對當(dāng)前環(huán)境的判斷能力懈万,所以要應(yīng)對實際的部署場景來說拴清,還是遠(yuǎn)遠(yuǎn)不夠的。
如果要自動化的管理數(shù)據(jù)庫表結(jié)構(gòu)会通、初始化數(shù)據(jù)的話口予,我的建議是:
- 默認(rèn)提供的這個初始化功能可以且僅用于單元測試,自動創(chuàng)建數(shù)據(jù)庫結(jié)構(gòu)與初始化數(shù)據(jù)涕侈,使用完畢后銷毀沪停。可以方便的控制每次單元測試的執(zhí)行環(huán)境一致。
- 應(yīng)用在環(huán)境部署的時候木张,還是要使用之前介紹過的Flyway來實現(xiàn)众辨,如何使用可見之前的分享:使用Flyway來管理數(shù)據(jù)庫版本。
- 聯(lián)合Flyway一同使用窟哺,通過
org.springframework.jdbc.datasource.init.DataSourceInitializer
來定義更復(fù)雜的執(zhí)行邏輯泻轰。
更多本系列免費教程連載「點擊進(jìn)入?yún)R總目錄」
代碼示例
本文的相關(guān)例子可以查看下面?zhèn)}庫中的chapter3-13
目錄:
- Github:https://github.com/dyc87112/SpringBoot-Learning/
- Gitee:https://gitee.com/didispace/SpringBoot-Learning/
原創(chuàng)不易技肩,如果您覺得本文不錯且轨,歡迎Star
支持,您的關(guān)注是我堅持的動力虚婿!
歡迎關(guān)注我的公眾號:程序猿DD旋奢,分享外面看不到的干貨!