文章目錄

• • 依賴條件
  • data.sql文件
  • schema.sql 文件
  • @sql注解
  • @SqlConfig 注解

在Spring Boot中加載初始化數據

在Spring Boot中，Spring Boot會自動搜索映射的Entity，并且創建相應的table，但是有時候我們希望自定義某些內容，這時候我們就需要使用到data.sql和schema.sql。

依賴條件

Spring Boot的依賴我們就不將了，因為本例將會有數據庫的操作，我們這里使用H2內存數據庫方便測試：

<dependency><groupId>com.h2database</groupId><artifactId>h2</artifactId><scope>runtime</scope></dependency>

我們需要使用JPA來創建Entity：

@Entity public class Country {@Id@GeneratedValue(strategy = IDENTITY)private Integer id;@Column(nullable = false)private String name;//... }

我們這樣定義repository：

public interface CountryRepository extends CrudRepository<Country, Integer> {List<Country> findByName(String name); }

如果這時候我們啟動Spring Boot程序，將會自動創建Country表。

data.sql文件

上面我們創建好了數據表格，我們可以使用data.sql來加載文件：

INSERT INTO country (name) VALUES ('India'); INSERT INTO country (name) VALUES ('Brazil'); INSERT INTO country (name) VALUES ('USA'); INSERT INTO country (name) VALUES ('Italy');

在data.sql文件中我們插入了4條數據，可以寫個測試例子測試一下：

@RunWith(SpringRunner.class) @SpringBootTest(classes = LoadIniDataApp.class) public class SpringBootInitialLoadIntegrationTest {@Autowiredprivate CountryRepository countryRepository;@Testpublic void testInitDataForTestClass() {assertEquals(4, countryRepository.count());} }

schema.sql 文件

有時候我們需要自定義數據庫的schema，這時候我們可以使用到schema.sql文件。

先看一個schema.sql的例子：

CREATE TABLE country (id INTEGER NOT NULL AUTO_INCREMENT,name VARCHAR(128) NOT NULL,PRIMARY KEY (id) );

Spring Boot會自動加載這個schema文件。

我們需要關閉spring boot的schema自動創建功能以防沖突：

spring.jpa.hibernate.ddl-auto=none

spring.jpa.hibernate.ddl-auto 有如下幾個選項：

• create : 首先drop現有的tables，然后創建新的tables
• update : 這個模式不會刪除現有的tables，它會比較現有的tables和新的注解或者xml配置是否一致，然后更新。
• create-drop : 和create很類似，不同的是會在程序運行完畢后自動drop掉tables。通常用在單元測試中。
• validate : 只會做table是否存在的驗證，不存在則會報錯。
• none : 關閉ddl自動生成功能。

如果Spring Boot沒有檢測到自定義的schema manager的話，則會自動使用create-drop模式。否則使用none模式。

@sql注解

@Sql 是測試包中的一個注解，可以顯示的導入要執行的sql文件，它可以用在class上或者方法之上，如下所示：

@Test@Sql({"classpath:new_country.sql"})public void testLoadDataForTestCase() {assertEquals(6, countryRepository.count());}

上面的例子將會顯示的導入classpath中的new_country.sql文件。

@Sql有如下幾個屬性：

• config : 用來配置SQL腳本，我們在下面的@SqlConfig詳細講解。
• executionPhase : 可以選擇腳本是在BEFORE_TEST_METHOD 或者 AFTER_TEST_METHOD來執行。
• statements: 可以接受內聯的sql語句
• scripts: 可以指明要執行腳本的路徑

@SqlConfig 注解

@SqlConfig主要用在class級別或者用在@Sql注解的config屬性中：

@Sql(scripts = {"classpath:new_country2.sql"},config = @SqlConfig(encoding = "utf-8", transactionMode = SqlConfig.TransactionMode.ISOLATED))

@SqlConfig有如下幾個屬性：

• blockCommentStartDelimiter: 指明了SQL腳本的開始標記。
• blockCommentEndDelimiter: SQL腳本的結束標記。
• commentPrefix: SQL 腳本的注釋標記
• dataSource : javax.sql.DataSource的名字，指定該腳本將會在什么datasource下執行
• encoding: SQL 文件的編碼
• errorMode: 腳本遇到錯誤的處理模式
• separator: 分隔符
• transactionManager: 指定的PlatformTransactionManager
• transactionMode: 事務模式

@Sql是可以多個同時使用的，如下所示：

@Test@Sql({"classpath:new_country.sql"})@Sql(scripts = {"classpath:new_country2.sql"},config = @SqlConfig(encoding = "utf-8", transactionMode = SqlConfig.TransactionMode.ISOLATED))public void testLoadDataForTestCase() {assertEquals(6, countryRepository.count());}

本文的例子可以參考 : https://github.com/ddean2009/learn-springboot2/tree/master/springboot-load-ini-data

更多精彩內容且看：

• 區塊鏈從入門到放棄系列教程-涵蓋密碼學,超級賬本,以太坊,Libra,比特幣等持續更新
• Spring Boot 2.X系列教程:七天從無到有掌握Spring Boot-持續更新
• Spring 5.X系列教程:滿足你對Spring5的一切想象-持續更新
• java程序員從小工到專家成神之路（2020版）-持續更新中,附詳細文章教程

更多教程請參考 flydean的博客

總結

以上是生活随笔為你收集整理的在Spring Boot中加载初始化数据的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。