在Spring Boot應(yīng)用的測試一文中,我們在StarterRunner類的run(...)方法中給數(shù)據(jù)庫中添加一些初始數(shù)據(jù)。盡管通過編程方式添加初始數(shù)據(jù)比較快捷方便识脆,但長期來看這并不是一個好辦法——特別是當(dāng)需要添加的數(shù)據(jù)量很大時。我們開發(fā)最好把數(shù)據(jù)庫準(zhǔn)備、數(shù)據(jù)庫修改和數(shù)據(jù)庫的配置與將要運行的程序代碼分離抖剿,盡管這僅僅是為測試用例做準(zhǔn)備。Spring Boot已經(jīng)提供了相應(yīng)的支持來完成這個任務(wù)识窿。
我們在之前的應(yīng)用程序基礎(chǔ)上進(jìn)行實驗斩郎。Spring Boot提供兩種方法來定義數(shù)據(jù)庫的表結(jié)構(gòu)以及添加數(shù)據(jù)。第一種方法是使用Hibernate提供的工具來創(chuàng)建表結(jié)構(gòu)喻频,該機制會自動搜索@Entity實體對象并創(chuàng)建對應(yīng)的表缩宜,然后使用import.sql文件導(dǎo)入測試數(shù)據(jù);第二種方法是利用舊的Spring JDBC甥温,通過schema.sql文件定義數(shù)據(jù)庫的表結(jié)構(gòu)锻煌、通過data.sql導(dǎo)入測試數(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("中文測試");
// 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自動生成的表的字段相同)狰挡,該文件的內(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)在運行測試用例捂龄,發(fā)現(xiàn)可以通過;
- 第二種方法是獲取Spring JDBC的支持,需要我們提供schema.sql和data.sql文件〖尤現(xiàn)在可以將import.sql重命名為data.sql倦沧,然后再創(chuàng)建新的文件schema.sql。在刪除數(shù)據(jù)表時它匕,需要考慮依賴關(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`)
);
- 我們手動創(chuàng)建了數(shù)據(jù)庫表結(jié)構(gòu)告希,因此需要關(guān)掉Hibernate的自動創(chuàng)建開關(guān),即在application.properties中設(shè)置spring.jpa.hibernate.ddl-auto = none
- 運行測試轮傍,發(fā)現(xiàn)測試可以正常通過暂雹。
Note:個人建議是使用Hibernate的自動創(chuàng)建機制,當(dāng)然這會少一點可定制性创夜;最近更流行的是Mybatis杭跪,mybatis-spring-boot也可以使用,mybatis的可定制性更強。
分析
在Spring社區(qū)中常辰颍可以通過使用各種組件系奉,例如Spring JDBC、Spring JPA with Hibernate姑廉,或者Flyway缺亮、Liquidbase這類數(shù)據(jù)庫遷移工具,都能實現(xiàn)類似的功能桥言。
Note:Flyway和Liquidbase都提供數(shù)據(jù)庫的增量遷移功能萌踱。當(dāng)項目中需要管理數(shù)據(jù)庫的增量變動,并且需要快速切換到指定的數(shù)據(jù)版本時号阿,非常適合使用Flyway和Liquidbase并鸵,更多的信息可以參考http://flywaydb.org/和http://www.liquibase.org/。
在上文中我們使用了兩種不同的方法來初始化數(shù)據(jù)庫和填充測試數(shù)據(jù)
使用Spring JPA with Hibernate初始化數(shù)據(jù)庫
這種方法中扔涧,由Hibernate庫完成大部分工作园担,我們只需要配置合適的配置項,并創(chuàng)建對應(yīng)的實體類的定義枯夜。在這個方案中我們主要使用以下配置項:
spring.jpa.hibernate.ddl-auto=create-drop配置項告訴Hibernate通過@Entity模型的定義自動推斷數(shù)據(jù)庫定義并創(chuàng)建合適的表弯汰。在程序啟動時,經(jīng)由Hibernate計算出的schema會用來創(chuàng)建表結(jié)構(gòu)湖雹,在程序結(jié)束時這些表也被刪除咏闪。即使程序強制退出或者奔潰,在重新啟動的時候也會先把之前的表刪除劝枣,并重新創(chuàng)建——因此"create-drop"這種配置不適合生產(chǎn)環(huán)境汤踏。PS:如果程序沒有顯式配置spring.jpa.hibernate.ddl-auto屬性织鲸,Spring Boot會給H2這類的嵌入式數(shù)據(jù)庫配置create-drop舔腾,因此需要仔細(xì)斟酌這個配置項。
在classpath下創(chuàng)建import.sql文件供Hibernate使用搂擦,該文件中的內(nèi)容是一些SQL語句稳诚,將會在應(yīng)用程序啟動時運行。盡管該文件中可以寫任何有效的SQL語句瀑踢,不過建議只寫數(shù)據(jù)操作語句扳还,例如INSERT、UPDATE等等橱夭。
使用Spring JDBC初始化數(shù)據(jù)庫
如果項目中沒有用JPA或者你不想依賴Hibernate庫氨距,Spring提供另外一種方法來設(shè)置數(shù)據(jù)庫,當(dāng)然棘劣,首先需要提供spring-boot-starter-jdbc依賴俏让。
spring.jpa.hibernate.ddl-auto=none表示Hibernate不會自動創(chuàng)建數(shù)據(jù)庫表結(jié)構(gòu)。在生產(chǎn)環(huán)境中最好用這個設(shè)置首昔,能夠避免你不小心將數(shù)據(jù)庫全部刪除(那一定是一個噩夢)寡喝。
schema.sql文件包含創(chuàng)建數(shù)據(jù)庫表結(jié)構(gòu)的SQL語句,在應(yīng)用程序啟動過程中勒奇,需要創(chuàng)建數(shù)據(jù)庫表結(jié)構(gòu)時预鬓,執(zhí)行該文件中的DDL語句。Hibernate會自動刪除已經(jīng)存在的表赊颠,如果我們希望只有某個表不存在的時候才創(chuàng)建它格二,可以在這個文件開頭最好先使用
DROP TABLE IF EXISTS
刪除可能存在的表,再使用CREATE TABLE IF NOT EXISTS
創(chuàng)建表竣蹦。這種用法可以靈活得定義數(shù)據(jù)庫中的表結(jié)構(gòu)蟋定,因此在生產(chǎn)環(huán)境中用更安全。data.sql的作用跟上一個方法的import.sql一樣草添,用于存放數(shù)據(jù)導(dǎo)入的SQL語句驶兜。
考慮到這是Spring的特性,我們可以不只是全局定義數(shù)據(jù)庫定義文件远寸,還可以針對不同的數(shù)據(jù)庫定義不同的文件抄淑。例如,可以定義給Oracle數(shù)據(jù)庫使用的schema-oracle.sql驰后,給MySQL數(shù)據(jù)庫用的schema-mysql.sql文件肆资;對于data.sql文件,則可以由不同數(shù)據(jù)庫共用灶芝。如果你希望覆蓋Spring Boot的自動推斷郑原,可以配置spring.datasource.platform屬性。
Tip:如果你希望使用別的名字代替schema.sql或者data.sql夜涕,Spring Boot也提供了對應(yīng)的配置屬性犯犁,即spring.datasource.schema和spring.datasource.data。
本號專注于后端技術(shù)女器、JVM問題排查和優(yōu)化酸役、Java面試題、個人成長和自我管理等主題驾胆,為讀者提供一線開發(fā)者的工作和成長經(jīng)驗涣澡,期待你能在這里有所收獲。