Spring Boot 2.5.0 重新設計的spring.sql.init 配置有啥用？

2021 年 5 月 25 日
筆記

前幾天Spring Boot 2.5.0發布了，其中提到了關於Datasource初始化機制的調整，有讀者私信想了解這方面做了什麼調整。那麼今天就要詳細說說這個重新設計的配置內容，並結合實際情況說說我的理解和實踐建議。

棄用內容

先來糾正一個誤區。主要之前在版本更新介紹的時候，存在一些表述上的問題。導致部分讀者認為這次的更新是Datasource本身初始化的調整，但其實並不是。這次重新設計的只是對Datasource腳本初始化機制的重新設計。

先來看看這次被棄用部分的內容（位於org.springframework.boot.autoconfigure.jdbc.DataSourceProperties），如果你有用過這些配置內容，那麼新配置就很容易理解了。

	/**
	 * 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;

對應到配置文件里的屬性如下（這裡僅列出部分，就不全部列出了，主要就是對應上面源碼中的屬性）：

spring.datasource.schema=
spring.datasource.schema-username=
spring.datasource.schema-password=
...

這些配置主要用來指定數據源初始化之後要用什麼用戶、去執行哪些腳本、遇到錯誤是否繼續等功能。

新的設計

Spring Boot 2.5.0開始，啟用了全新的配置方式，我們可以從這個類org.springframework.boot.autoconfigure.sql.init.SqlInitializationProperties里看到詳情。

下面我們通過一個簡單的例子來體驗這個功能的作用。

創建一個Spring Boot的基礎應用，並在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>

在配置文件中增加數據源和初始化數據源的配置，具體如下：

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
# 執行初始化腳本的用戶名稱
spring.sql.init.username=root
# 執行初始化腳本的用戶密碼
spring.sql.init.password=
# 初始化的schema腳本位置
spring.sql.init.schema-locations=classpath*:schema-all.sql

根據上面配置的定義，接下來就在resource目錄下，創建腳本文件schema-all.sql，並寫入一些初始化表結構的腳本

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 '註冊地址：縣/區',
    status      tinyint unsigned default 0  not null comment '是否標記刪除 0：否 1：是',
    create_time datetime                    not null comment '創建時間',
    update_time datetime                    not null comment '更新時間'
)
comment '用戶表';

完成上面步驟之後，啟動應用。然後打開MySQL客戶端，可以看到在test庫下，多了一個user_info表

通過上面的例子，不難想到這樣的功能主要可以用來管理應用啟動與資料庫配置的自動執行，以減少應用部署過程中手工執行的內容，降低應用部署的執行步驟。

配置詳解

除了上面用到的配置屬性之外，還有一些其他的配置，下面詳細講解一下作用。

spring.sql.init.enabled：是否啟動初始化的開關，默認是true。如果不想執行初始化腳本，設置為false即可。通過-D的命令行參數會更容易控制。
spring.sql.init.username和spring.sql.init.password：配置執行初始化腳本的用戶名與密碼。這個非常有必要，因為安全管理要求，通常給業務應用分配的用戶對一些建表刪表等命令沒有許可權。這樣就可以與datasource中的用戶分開管理。
spring.sql.init.schema-locations：配置與schema變更相關的sql腳本，可配置多個（默認用;分割）
spring.sql.init.data-locations：用來配置與數據相關的sql腳本，可配置多個（默認用;分割）
spring.sql.init.encoding：配置腳本文件的編碼
spring.sql.init.separator：配置多個sql文件的分隔符，默認是;
spring.sql.init.continue-on-error：如果執行腳本過程中碰到錯誤是否繼續，默認是false`；所以，上面的例子第二次執行的時候會報錯並啟動失敗，因為第一次執行的時候表已經存在。

應用建議

關於這些配置的應用，相信聰明的你一定會把它與資料庫的版本管理聯繫起來（因為可以自動的執行腳本）。

那麼依靠這些配置，是否可以勝任業務應用部署時候資料庫初始化的自動化實現呢？

個人認為就上述所介紹的配置，雖然具備了一定的自動執行能力。但由於缺失對當前環境的判斷能力，所以要應對實際的部署場景來說，還是遠遠不夠的。

如果要自動化的管理資料庫表結構、初始化數據的話，我的建議是：

默認提供的這個初始化功能可以且僅用於單元測試，自動創建資料庫結構與初始化數據，使用完畢後銷毀。可以方便的控制每次單元測試的執行環境一致。
應用在環境部署的時候，還是要使用之前介紹過的Flyway來實現，如何使用可見之前的分享：使用Flyway來管理資料庫版本。
聯合Flyway一同使用，通過org.springframework.jdbc.datasource.init.DataSourceInitializer來定義更複雜的執行邏輯。

更多本系列免費教程連載「點擊進入匯總目錄」

程式碼示例

本文的相關例子可以查看下面倉庫中的chapter3-13目錄：

Github：//github.com/dyc87112/SpringBoot-Learning/
Gitee：//gitee.com/didispace/SpringBoot-Learning/

原創不易，如果您覺得本文不錯，歡迎Star支援，您的關注是我堅持的動力！

歡迎關注我的公眾號：程式猿DD，分享外面看不到的乾貨與思考！