在Spring Boot應(yīng)用的測(cè)試一文中,我們?cè)?em>StarterRunner類的run(...)方法中給數(shù)據(jù)庫中添加一些初始數(shù)據(jù)。盡管通過編程方式添加初始數(shù)據(jù)比較快捷方便,但長(zhǎng)期來看這并不是一個(gè)好辦法——特別是當(dāng)需要添加的數(shù)據(jù)量很大時(shí)。我們開發(fā)最好把數(shù)據(jù)庫準(zhǔn)備、數(shù)據(jù)庫修改和數(shù)據(jù)庫的配置與將要運(yùn)行的程序代碼分離,盡管這僅僅是為測(cè)試用例做準(zhǔn)備。Spring Boot已經(jīng)提供了相應(yīng)的支持來完成這個(gè)任務(wù)。
我們?cè)谥暗膽?yīng)用程序基礎(chǔ)上進(jìn)行實(shí)驗(yàn)。Spring Boot提供兩種方法來定義數(shù)據(jù)庫的表結(jié)構(gòu)以及添加數(shù)據(jù)。第一種方法是使用Hibernate提供的工具來創(chuàng)建表結(jié)構(gòu),該機(jī)制會(huì)自動(dòng)搜索@Entity實(shí)體對(duì)象并創(chuàng)建對(duì)應(yīng)的表,然后使用import.sql文件導(dǎo)入測(cè)試數(shù)據(jù);第二種方法是利用舊的Spring JDBC,通過schema.sql文件定義數(shù)據(jù)庫的表結(jié)構(gòu)、通過data.sql導(dǎo)入測(cè)試數(shù)據(jù)。
How Do
- 首先,將現(xiàn)有的“編程式初始化數(shù)據(jù)”的代碼注釋掉,因此在StarterRunner中run方法中注釋掉下列代碼:
@Override
public void run(String... strings) throws Exception {
// Author author = new Author("du", "qi");
// authorRepository.save(author);
// Publisher publisher = new Publisher("中文測(cè)試");
// publisherRepository.save(publisher);
// Book book = new Book(author, "9876-5432-1111", publisher, "瞅啥");
// book.setDescription("23333333,這是一本有趣的書");
// bookRepository.save(book);
logger.info("Number of books: " + bookRepository.count());
}
- 在resources目錄下新建import.sql文件(注意,SQL語句中指定的字段要與Hibernate自動(dòng)生成的表的字段相同),該文件的內(nèi)容如下:
INSERT INTO author (id, first_name, last_name) VALUES (1, 'Alex', 'Antonov');
INSERT INTO publisher (id, name) VALUES (1, 'Packt');
INSERT INTO book (isbn, title, author, publisher) VALUES ('9876-5432-1111', 'Spring Boot Recipes', 1,1);
- 現(xiàn)在運(yùn)行測(cè)試用例,發(fā)現(xiàn)可以通過;
- 第二種方法是獲取Spring JDBC的支持,需要我們提供schema.sql和data.sql文件?,F(xiàn)在可以將import.sql重命名為data.sql,然后再創(chuàng)建新的文件schema.sql。在刪除數(shù)據(jù)表時(shí),需要考慮依賴關(guān)系,例如表A依賴表B,則先刪除表B。創(chuàng)建數(shù)據(jù)庫關(guān)系的內(nèi)容如下:
-- clear context
DROP TABLE IF EXISTS `book_reviewers`;
DROP TABLE IF EXISTS `reviewer`;
DROP TABLE IF EXISTS `book`;
DROP TABLE IF EXISTS `author`;
DROP TABLE IF EXISTS `publisher`;
-- Create syntax for TABLE 'author'
CREATE TABLE `author` (
`id` BIGINT(20) NOT NULL AUTO_INCREMENT,
`first_name` VARCHAR(255) DEFAULT NULL ,
`last_name` VARCHAR(255) DEFAULT NULL ,
PRIMARY KEY (`id`)
);
-- Create syntax for TABLE 'publisher'
CREATE TABLE `publisher` (
`id` BIGINT(20) NOT NULL AUTO_INCREMENT,
`name` VARCHAR(255) DEFAULT NULL ,
PRIMARY KEY (`id`)
);
-- Create syntax for TABLE 'book'
CREATE TABLE `book` (
`id` BIGINT(20) NOT NULL AUTO_INCREMENT,
`description` VARCHAR(255) DEFAULT NULL ,
`isbn` VARCHAR(255) DEFAULT NULL ,
`title` VARCHAR(255) DEFAULT NULL ,
`author` BIGINT(20) DEFAULT NULL ,
`publisher` BIGINT(20) DEFAULT NULL ,
PRIMARY KEY (`id`),
CONSTRAINT `FK_publisher` FOREIGN KEY (`publisher`) REFERENCES `publisher` (`id`),
CONSTRAINT `FK_author` FOREIGN KEY (`author`) REFERENCES `author` (`id`)
);
-- Create syntax for TABLE 'reviewer'
CREATE TABLE `reviewer` (
`id` BIGINT(20) NOT NULL AUTO_INCREMENT,
`first_name` VARCHAR(255) DEFAULT NULL ,
`last_name` VARCHAR(255) DEFAULT NULL ,
PRIMARY KEY (`id`)
);
-- Create syntax for TABLE 'book_reviewers'
CREATE TABLE `book_reviewers` (
`books` BIGINT(20) NOT NULL ,
`reviewers` BIGINT(20) NOT NULL ,
CONSTRAINT `FK_book` FOREIGN KEY (`books`) REFERENCES `book` (`id`),
CONSTRAINT `FK_reviewer` FOREIGN KEY (`reviewers`) REFERENCES `reviewer` (`id`)
);
- 我們手動(dòng)創(chuàng)建了數(shù)據(jù)庫表結(jié)構(gòu),因此需要關(guān)掉Hibernate的自動(dòng)創(chuàng)建開關(guān),即在application.properties中設(shè)置spring.jpa.hibernate.ddl-auto = none
- 運(yùn)行測(cè)試,發(fā)現(xiàn)測(cè)試可以正常通過。
Note:個(gè)人建議是使用Hibernate的自動(dòng)創(chuàng)建機(jī)制,當(dāng)然這會(huì)少一點(diǎn)可定制性;最近更流行的是Mybatis,mybatis-spring-boot也可以使用,mybatis的可定制性更強(qiáng)。
分析
在Spring社區(qū)中常常可以通過使用各種組件,例如Spring JDBC、Spring JPA with Hibernate,或者Flyway、Liquidbase這類數(shù)據(jù)庫遷移工具,都能實(shí)現(xiàn)類似的功能。
Note:Flyway和Liquidbase都提供數(shù)據(jù)庫的增量遷移功能。當(dāng)項(xiàng)目中需要管理數(shù)據(jù)庫的增量變動(dòng),并且需要快速切換到指定的數(shù)據(jù)版本時(shí),非常適合使用Flyway和Liquidbase,更多的信息可以參考http://flywaydb.org/和http://www.liquibase.org/。
在上文中我們使用了兩種不同的方法來初始化數(shù)據(jù)庫和填充測(cè)試數(shù)據(jù)
使用Spring JPA with Hibernate初始化數(shù)據(jù)庫
這種方法中,由Hibernate庫完成大部分工作,我們只需要配置合適的配置項(xiàng),并創(chuàng)建對(duì)應(yīng)的實(shí)體類的定義。在這個(gè)方案中我們主要使用以下配置項(xiàng):
spring.jpa.hibernate.ddl-auto=create-drop配置項(xiàng)告訴Hibernate通過@Entity模型的定義自動(dòng)推斷數(shù)據(jù)庫定義并創(chuàng)建合適的表。在程序啟動(dòng)時(shí),經(jīng)由Hibernate計(jì)算出的schema會(huì)用來創(chuàng)建表結(jié)構(gòu),在程序結(jié)束時(shí)這些表也被刪除。即使程序強(qiáng)制退出或者奔潰,在重新啟動(dòng)的時(shí)候也會(huì)先把之前的表刪除,并重新創(chuàng)建——因此"create-drop"這種配置不適合生產(chǎn)環(huán)境。PS:如果程序沒有顯式配置spring.jpa.hibernate.ddl-auto屬性,Spring Boot會(huì)給H2這類的嵌入式數(shù)據(jù)庫配置create-drop,因此需要仔細(xì)斟酌這個(gè)配置項(xiàng)。
在classpath下創(chuàng)建import.sql文件供Hibernate使用,該文件中的內(nèi)容是一些SQL語句,將會(huì)在應(yīng)用程序啟動(dòng)時(shí)運(yùn)行。盡管該文件中可以寫任何有效的SQL語句,不過建議只寫數(shù)據(jù)操作語句,例如INSERT、UPDATE等等。
使用Spring JDBC初始化數(shù)據(jù)庫
如果項(xiàng)目中沒有用JPA或者你不想依賴Hibernate庫,Spring提供另外一種方法來設(shè)置數(shù)據(jù)庫,當(dāng)然,首先需要提供spring-boot-starter-jdbc依賴。
spring.jpa.hibernate.ddl-auto=none表示Hibernate不會(huì)自動(dòng)創(chuàng)建數(shù)據(jù)庫表結(jié)構(gòu)。在生產(chǎn)環(huán)境中最好用這個(gè)設(shè)置,能夠避免你不小心將數(shù)據(jù)庫全部刪除(那一定是一個(gè)噩夢(mèng))。
schema.sql文件包含創(chuàng)建數(shù)據(jù)庫表結(jié)構(gòu)的SQL語句,在應(yīng)用程序啟動(dòng)過程中,需要?jiǎng)?chuàng)建數(shù)據(jù)庫表結(jié)構(gòu)時(shí),執(zhí)行該文件中的DDL語句。Hibernate會(huì)自動(dòng)刪除已經(jīng)存在的表,如果我們希望只有某個(gè)表不存在的時(shí)候才創(chuàng)建它,可以在這個(gè)文件開頭最好先使用
DROP TABLE IF EXISTS刪除可能存在的表,再使用CREATE TABLE IF NOT EXISTS創(chuàng)建表。這種用法可以靈活得定義數(shù)據(jù)庫中的表結(jié)構(gòu),因此在生產(chǎn)環(huán)境中用更安全。data.sql的作用跟上一個(gè)方法的import.sql一樣,用于存放數(shù)據(jù)導(dǎo)入的SQL語句。
考慮到這是Spring的特性,我們可以不只是全局定義數(shù)據(jù)庫定義文件,還可以針對(duì)不同的數(shù)據(jù)庫定義不同的文件。例如,可以定義給Oracle數(shù)據(jù)庫使用的schema-oracle.sql,給MySQL數(shù)據(jù)庫用的schema-mysql.sql文件;對(duì)于data.sql文件,則可以由不同數(shù)據(jù)庫共用。如果你希望覆蓋Spring Boot的自動(dòng)推斷,可以配置spring.datasource.platform屬性。
Tip:如果你希望使用別的名字代替schema.sql或者data.sql,Spring Boot也提供了對(duì)應(yīng)的配置屬性,即spring.datasource.schema和spring.datasource.data。
本號(hào)專注于后端技術(shù)、JVM問題排查和優(yōu)化、Java面試題、個(gè)人成長(zhǎng)和自我管理等主題,為讀者提供一線開發(fā)者的工作和成長(zhǎng)經(jīng)驗(yàn),期待你能在這里有所收獲。
