知識庫 / Spring / Spring Boot RSS 訂閱

@Sql({"/employees_schema.sql", "/import_employees.sql"})
public class SpringBootInitialLoadIntegrationTest {

    @Autowired
    private EmployeeRepository employeeRepository;

    @Test
    public void testLoadDataForTestClass() {
        assertEquals(3, employeeRepository.findAll().size());
    }
}

在上述代碼中，我們定義了兩個在測試方法之前執行的 SQL 腳本。@Sql 聲明利用了默認的 BEFORE_TEST_METHOD 執行階段。

Spring 6.1 和 Spring Boot 3.2.0 版本引入了對 executionPhase 參數的類級別支持，並提供了 BEFORE_TEST_CLASS 和 AFTER_TEST_CLASS 常量，用於確定腳本是否在測試類之前或之後運行。

讓我們更新 SpringBootInitialLoadIntegrationTest 類並顯式定義執行階段：

@Sql(scripts = {"/employees_schema.sql", "/import_employees.sql"}, executionPhase = BEFORE_TEST_CLASS)
public class SpringBootInitialLoadIntegrationTest { 
// ...  
}

在這裏，我們通過將 executionPhase 的值設置為 BEFORE_TEST_CLASS 來運行 SQL 腳本，在測試類之前。

此外，AFTER_TEST_CLASS 執行階段有助於在測試類之後加載 SQL 腳本。這在我們需要在測試後清除數據庫時可能很有用。

@Sql(scripts = {"/delete_employees_data.sql"}, executionPhase = AFTER_TEST_CLASS)
public class SpringBootInitialLoadIntegrationTest {
// ...
}

值得注意的是，這種配置不能被方法級別的腳本和語句覆蓋。相反，該腳本將在執行方法級別的腳本和語句的同時執行。

6.2. 在方法級別使用 @Sql 註解

我們將通過註解該方法來加載特定測試用例所需的額外數據：

@Test
@Sql({"/import_senior_employees.sql"})
public void testLoadDataForTestCase() {
    assertEquals(5, employeeRepository.findAll().size());
}

在此，SQL腳本在測試方法執行之前被執行。

再次，我們可以使用 BEFORE_TEST_METHOD 或 AFTER_TEST_METHOD 常量在方法級別明確定義執行階段：

@Test
@Sql(scripts = {"/import_senior_employees.sql"}, executionPhase = BEFORE_TEST_METHOD)
public void testLoadDataForTestCase() {
    assertEquals(5, employeeRepository.findAll().size());
}

AFTER_TEST_METHOD執行階段有助於在測試方法執行後加載SQL腳本。例如，我們可以利用它在測試方法執行後刪除數據庫表。

默認情況下，在方法級別聲明的@Sql註解會覆蓋類級別聲明的@Sql聲明。在這種情況下，方法級別的@Sql聲明優先於類級別定義的SQL：

@Sql(scripts = {"/employees_schema.sql", "/import_employees.sql"})
public class SpringBootInitialLoadIntegrationTest {

    @Autowired
    private EmployeeRepository employeeRepository;

    @Test 
    @Sql(scripts = {"/import_senior_employees.sql"})
    public void testLoadDataForTestClass() {
        assertEquals(5, employeeRepository.findAll().size());
   }
}

這裏僅執行 import_seioner_employees.sql，僅在運行測試時才會執行。

但是，我們可以通過使用 @SqlMergeMode 聲明進一步配置此行為，該聲明有助於將方法級別的 @Sql 聲明與類級別的 @Sql 聲明合併。

7. @SqlConfig 

我們可以通過使用@SqlConfig 註解</em title="SqlConfig">來配置我們解析和運行 SQL 腳本的方式。

@SqlConfig 可以聲明在類級別，作為全局配置。或者我們可以使用它來配置特定的@Sql 註解。

讓我們來看一個示例，其中我們還指定了 SQL 腳本的編碼以及執行腳本的事務模式：

@Test
@Sql(scripts = {"/import_senior_employees.sql"}, 
  config = @SqlConfig(encoding = "utf-8", transactionMode = TransactionMode.ISOLATED))
public void testLoadDataForTestCase() {
    assertEquals(5, employeeRepository.findAll().size());
}

讓我們來看一下屬性 @SqlConfig 的各種屬性：

• blockCommentStartDelimiter – 用於標識 SQL 腳本文件中註釋的起始分隔符
• blockCommentEndDelimiter – 用於表示 SQL 腳本文件中註釋的結束分隔符
• commentPrefix – 用於標識 SQL 腳本文件中單行註釋的前綴
• dataSource – 指定腳本和語句將要運行的 javax.sql.DataSource bean 的名稱
• encoding – SQL 腳本文件的編碼；默認值為平台編碼
• errorMode – 在運行腳本時遇到錯誤時使用的模式
• separator – 用於分隔單個語句的字符串；默認值為 “–“
• transactionManager – 指定將用於事務的 PlatformTransactionManager bean 的名稱
• transactionMode – 在事務模式下執行腳本時使用的模式

8.  

Java 8 及更高版本允許使用重複註解。我們可以利用此功能來處理 註解。對於 Java 7 及以下版本，存在一個容器註解—— 。

使用 註解，我們將聲明多個 註解：

@SqlGroup({
  @Sql(scripts = "/employees_schema.sql", 
    config = @SqlConfig(transactionMode = TransactionMode.ISOLATED)),
  @Sql("/import_employees.sql")})
public class SpringBootSqlGroupAnnotationIntegrationTest {

    @Autowired
    private EmployeeRepository employeeRepository;

    @Test
    public void testLoadDataForTestCase() {
        assertEquals(3, employeeRepository.findAll().size());
    }
}