1. 程式人生 > 程式設計 >在Spring Boot中載入初始化資料的實現

在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 {

  @Autowired
  private CountryRepository countryRepository;

  @Test
  public 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"},transactionMode = SqlConfig.TransactionMode.ISOLATED))
  public void testLoadDataForTestCase() {
    assertEquals(6,countryRepository.count());
  }

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

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援我們。