配置 Spring Batch 批處理失敗重試機制

鍋外的大佬發表於2020-12-11
SpringBAT

1. 引言

預設情況下，Spring批處理作業在執行過程中出現任何錯誤都會失敗。然而有些時候，為了提高應用程式的彈性，我們就需要處理這類間歇性的故障。
在這篇短文中，我們就來一起探討 如何在Spring批處理框架中配置重試邏輯。

2. 簡單舉例

假設有一個批處理作業，它讀取一個CSV檔案作為輸入：

username, userid, transaction_date, transaction_amount
sammy, 1234, 31/10/2015, 10000
john, 9999, 3/12/2015, 12321

然後，它通過訪問REST端點來處理每條記錄，獲取使用者的 age 和 postCode 屬性：

public class RetryItemProcessor implements ItemProcessor<Transaction, Transaction> {
    
    @Override
    public Transaction process(Transaction transaction) throws IOException {
        log.info("RetryItemProcessor, attempting to process: {}", transaction);
        HttpResponse response = fetchMoreUserDetails(transaction.getUserId());
        //parse user's age and postCode from response and update transaction
        ...
        return transaction;
    }
    ...
}

最後，它生成並輸出一個合併的XML：

<transactionRecord>
    <transactionRecord>
        <amount>10000.0</amount>
        <transactionDate>2015-10-31 00:00:00</transactionDate>
        <userId>1234</userId>
        <username>sammy</username>
        <age>10</age>
        <postCode>430222</postCode>
    </transactionRecord>
    ...
</transactionRecord>

spring batch

3. ItemProcessor 中新增重試

現在假設，如果到REST端點的連線由於某些網路速度慢而超時，該怎麼辦？如果發生這種情況，則我們的批處理工作將失敗。

在這種情況下，我們希望失敗的 item 處理重試幾次。因此，接下來我將批處理作業配置為：在出現故障時執行最多三次重試：

@Bean
public Step retryStep(
  ItemProcessor<Transaction, Transaction> processor,
  ItemWriter<Transaction> writer) throws ParseException {
    return stepBuilderFactory
      .get("retryStep")
      .<Transaction, Transaction>chunk(10)
      .reader(itemReader(inputCsv))
      .processor(processor)
      .writer(writer)
      .faultTolerant()
      .retryLimit(3)
      .retry(ConnectTimeoutException.class)
      .retry(DeadlockLoserDataAccessException.class)
      .build();
}

這裡呼叫了 faultTolerant() 來啟用重試功能。另外，我們使用 retry 和 retryLimit 分別定義符合重試條件的異常和 item 的最大重試次數。

4. 測試重試次數

假設我們有一個測試場景，其中返回 age 和 postCode 的REST端點關閉了一段時間。在這個測試場景中，我們只對前兩個 API 呼叫獲取一個 ConnectTimeoutException ，而第三個呼叫將成功：

@Test
public void whenEndpointFailsTwicePasses3rdTime_thenSuccess() throws Exception {
    FileSystemResource expectedResult = new FileSystemResource(EXPECTED_OUTPUT);
    FileSystemResource actualResult = new FileSystemResource(TEST_OUTPUT);

    when(httpResponse.getEntity())
      .thenReturn(new StringEntity("{ \"age\":10, \"postCode\":\"430222\" }"));
 
    //fails for first two calls and passes third time onwards
    when(httpClient.execute(any()))
      .thenThrow(new ConnectTimeoutException("Timeout count 1"))
      .thenThrow(new ConnectTimeoutException("Timeout count 2"))
      .thenReturn(httpResponse);

    JobExecution jobExecution = jobLauncherTestUtils
      .launchJob(defaultJobParameters());
    JobInstance actualJobInstance = jobExecution.getJobInstance();
    ExitStatus actualJobExitStatus = jobExecution.getExitStatus();

    assertThat(actualJobInstance.getJobName(), is("retryBatchJob"));
    assertThat(actualJobExitStatus.getExitCode(), is("COMPLETED"));
    AssertFile.assertFileEquals(expectedResult, actualResult);
}

在這裡，我們的工作成功地完成了。另外，從日誌中可以明顯看出 第一條記錄 id=1234 失敗了兩次，最後在第三次重試時成功了：

19:06:57.742 [main] INFO  o.s.batch.core.job.SimpleStepHandler - Executing step: [retryStep]
19:06:57.758 [main] INFO  o.b.batch.service.RetryItemProcessor - Attempting to process user with id=1234
19:06:57.758 [main] INFO  o.b.batch.service.RetryItemProcessor - Attempting to process user with id=1234
19:06:57.758 [main] INFO  o.b.batch.service.RetryItemProcessor - Attempting to process user with id=1234
19:06:57.758 [main] INFO  o.b.batch.service.RetryItemProcessor - Attempting to process user with id=9999
19:06:57.773 [main] INFO  o.s.batch.core.step.AbstractStep - Step: [retryStep] executed in 31ms

同樣，看下另一個測試用例，當所有重試次數都用完時會發生什麼：

@Test
public void whenEndpointAlwaysFail_thenJobFails() throws Exception {
    when(httpClient.execute(any()))
      .thenThrow(new ConnectTimeoutException("Endpoint is down"));

    JobExecution jobExecution = jobLauncherTestUtils
      .launchJob(defaultJobParameters());
    JobInstance actualJobInstance = jobExecution.getJobInstance();
    ExitStatus actualJobExitStatus = jobExecution.getExitStatus();

    assertThat(actualJobInstance.getJobName(), is("retryBatchJob"));
    assertThat(actualJobExitStatus.getExitCode(), is("FAILED"));
    assertThat(actualJobExitStatus.getExitDescription(),
      containsString("org.apache.http.conn.ConnectTimeoutException"));
}

在這個測試用例中，在作業因 ConnectTimeoutException 而失敗之前，會嘗試對第一條記錄重試三次。

5. 使用XML配置重試

最後，讓我們看一下與上述配置等價的XML：

<batch:job id="retryBatchJob">
    <batch:step id="retryStep">
        <batch:tasklet>
            <batch:chunk reader="itemReader" writer="itemWriter"
              processor="retryItemProcessor" commit-interval="10"
              retry-limit="3">
                <batch:retryable-exception-classes>
                    <batch:include class="org.apache.http.conn.ConnectTimeoutException"/>
                    <batch:include class="org.springframework.dao.DeadlockLoserDataAccessException"/>
                </batch:retryable-exception-classes>
            </batch:chunk>
        </batch:tasklet>
    </batch:step>
</batch:job>

6. 簡單總結

在本文中，我們學習瞭如何在Spring批處理中配置重試邏輯，其中包括使用Java和XML配置。以及使用單元測試來觀察重試在實踐中是如何工作的。
如果你覺得文章還不錯，記得關注公眾號： 鍋外的大佬
鍋外的大佬部落格

相關文章