初始化數據庫和導入數據


Spring Boot應用的測試一文中,我們在StarterRunner類的run(...)方法中給數據庫中添加一些初始數據。盡管通過編程方式添加初始數據比較快捷方便,但長期來看這並不是一個好辦法——特別是當需要添加的數據量很大時。我們開發最好把數據庫准備、數據庫修改和數據庫的配置與將要運行的程序代碼分離,盡管這僅僅是為測試用例做准備。Spring Boot已經提供了相應的支持來完成這個任務。

我們在之前的應用程序基礎上進行實驗。Spring Boot提供兩種方法來定義數據庫的表結構以及添加數據。第一種方法是使用Hibernate提供的工具來創建表結構,該機制會自動搜索@Entity實體對象並創建對應的表,然后使用import.sql文件導入測試數據;第二種方法是利用舊的Spring JDBC,通過schema.sql文件定義數據庫的表結構、通過data.sql導入測試數據。

How Do

  • 首先,將現有的“編程式初始化數據”的代碼注釋掉,因此在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自動生成的表的字段相同),該文件的內容如下:
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);
  • 現在運行測試用例,發現可以通過;
  • 第二種方法是獲取Spring JDBC的支持,需要我們提供schema.sql和data.sql文件。現在可以將import.sql重命名為data.sql,然后再創建新的文件schema.sql。在刪除數據表時,需要考慮依賴關系,例如表A依賴表B,則先刪除表B。創建數據庫關系的內容如下:
-- 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`)
);
  • 我們手動創建了數據庫表結構,因此需要關掉Hibernate的自動創建開關,即在application.properties中設置spring.jpa.hibernate.ddl-auto = none
  • 運行測試,發現測試可以正常通過。

Note:個人建議是使用Hibernate的自動創建機制,當然這會少一點可定制性;最近更流行的是Mybatis,mybatis-spring-boot也可以使用,mybatis的可定制性更強。

分析

在Spring社區中常常可以通過使用各種組件,例如Spring JDBC、Spring JPA with Hibernate,或者Flyway、Liquidbase這類數據庫遷移工具,都能實現類似的功能。

Note:Flyway和Liquidbase都提供數據庫的增量遷移功能。當項目中需要管理數據庫的增量變動,並且需要快速切換到指定的數據版本時,非常適合使用Flyway和Liquidbase,更多的信息可以參考http://flywaydb.org/http://www.liquibase.org/

在上文中我們使用了兩種不同的方法來初始化數據庫和填充測試數據

使用Spring JPA with Hibernate初始化數據庫

這種方法中,由Hibernate庫完成大部分工作,我們只需要配置合適的配置項,並創建對應的實體類的定義。在這個方案中我們主要使用以下配置項:

  • spring.jpa.hibernate.ddl-auto=create-drop配置項告訴Hibernate通過@Entity模型的定義自動推斷數據庫定義並創建合適的表。在程序啟動時,經由Hibernate計算出的schema會用來創建表結構,在程序結束時這些表也被刪除。即使程序強制退出或者奔潰,在重新啟動的時候也會先把之前的表刪除,並重新創建——因此"create-drop"這種配置不適合生產環境。PS:如果程序沒有顯式配置spring.jpa.hibernate.ddl-auto屬性,Spring Boot會給H2這類的嵌入式數據庫配置create-drop,因此需要仔細斟酌這個配置項。

  • 在classpath下創建import.sql文件供Hibernate使用,該文件中的內容是一些SQL語句,將會在應用程序啟動時運行。盡管該文件中可以寫任何有效的SQL語句,不過建議只寫數據操作語句,例如INSERT、UPDATE等等。

使用Spring JDBC初始化數據庫

如果項目中沒有用JPA或者你不想依賴Hibernate庫,Spring提供另外一種方法來設置數據庫,當然,首先需要提供spring-boot-starter-jdbc依賴。

  • spring.jpa.hibernate.ddl-auto=none表示Hibernate不會自動創建數據庫表結構。在生產環境中最好用這個設置,能夠避免你不小心將數據庫全部刪除(那一定是一個噩夢)。

  • schema.sql文件包含創建數據庫表結構的SQL語句,在應用程序啟動過程中,需要創建數據庫表結構時,執行該文件中的DDL語句。Hibernate會自動刪除已經存在的表,如果我們希望只有某個表不存在的時候才創建它,可以在這個文件開頭最好先使用DROP TABLE IF EXISTS刪除可能存在的表,再使用CREATE TABLE IF NOT EXISTS創建表。這種用法可以靈活得定義數據庫中的表結構,因此在生產環境中用更安全。

  • data.sql的作用跟上一個方法的import.sql一樣,用於存放數據導入的SQL語句。

考慮到這是Spring的特性,我們可以不只是全局定義數據庫定義文件,還可以針對不同的數據庫定義不同的文件。例如,可以定義給Oracle數據庫使用的schema-oracle.sql,給MySQL數據庫用的schema-mysql.sql文件;對於data.sql文件,則可以由不同數據庫共用。如果你希望覆蓋Spring Boot的自動推斷,可以配置spring.datasource.platform屬性。

Tip:如果你希望使用別的名字代替schema.sql或者data.sql,Spring Boot也提供了對應的配置屬性,即spring.datasource.schemaspring.datasource.data


鏈接:https://www.jianshu.com/p/468a8fa752a7
來源:簡書
著作權歸作者所有。商業轉載請聯系作者獲得授權,非商業轉載請注明出處


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM