知識庫 / Spring RSS 訂閱

@BeforeStep
public void beforeStep(StepExecution stepExecution) {
    JobParameters parameters = stepExecution.getJobExecution()
      .getJobParameters();
    ...
    log.info("Before step params: {}", parameters);
}

4. 任務配置

讓我們將所有部分組合起來，以獲得整體視圖。

讀者、處理器和寫入器需要兩個屬性：BatchConstants.TRIGGERED_DATE_TIME 和 BatchConstants.TRACE_ID。

我們將使用相同的提取邏輯，用於所有步驟 Bean 定義中的常見參數：

private void enrichWithJobParameters(Map<String, Object> jobParameters, ContainsJobParameters container) {
    if (jobParameters.get(BatchConstants.TRIGGERED_DATE_TIME) != null) {
        container.setTriggeredDateTime(ZonedDateTime.parse(jobParameters.get(BatchConstants.TRIGGERED_DATE_TIME)
          .toString()));
    }
    if (jobParameters.get(BatchConstants.TRACE_ID) != null) {
        container.setTraceId(jobParameters.get(BatchConstants.TRACE_ID).toString());
    }
}

總而言之，其他參數是特定於組件的，並且沒有通用的邏輯。

4.1. 配置 ItemReader

首先，我們需要配置 ItemReader 並豐富常用參數：

@Bean
@StepScope
public ExpiresSoonMedicineReader expiresSoonMedicineReader(JdbcTemplate jdbcTemplate, @Value("#{jobParameters}") Map<String, Object> jobParameters) {

    ExpiresSoonMedicineReader medicineReader = new ExpiresSoonMedicineReader(jdbcTemplate);
    enrichWithJobParameters(jobParameters, medicineReader);
    return medicineReader;
}

讓我們更詳細地瞭解一下精確讀取器的實現。<em>TriggeredDateTime</em> 和 <em>traceId</em> 參數在 Bean 構造過程中直接注入，<em>defaultExpiration</em> 參數通過 setter 注入由 Spring 注入。為了演示，我們已經在 <em>doOpen()</em> 方法中使用了一切：

public class ExpiresSoonMedicineReader extends AbstractItemCountingItemStreamItemReader<Medicine> implements ContainsJobParameters {

    private ZonedDateTime triggeredDateTime;
    private String traceId;
    @Value("#{jobParameters['DEFAULT_EXPIRATION']}")
    private long defaultExpiration;

    private List<Medicine> expiringMedicineList;

    ...

    @Override
    protected void doOpen() {
        expiringMedicineList = jdbcTemplate.query(FIND_EXPIRING_SOON_MEDICINE, ps -> ps.setLong(1, defaultExpiration), (rs, row) -> getMedicine(rs));

        log.info("Trace = {}. Found {} meds that expires soon", traceId, expiringMedicineList.size());
        if (!expiringMedicineList.isEmpty()) {
            setMaxItemCount(expiringMedicineList.size());
        }
    }

    @PostConstruct
    public void init() {
        setName(ClassUtils.getShortName(getClass()));
    }

}

ItemReader 不應標記為 @Component。 此外，我們需要調用 setName() 方法來設置所需的讀取器名稱。

4.2. 配置 ItemProcessor 和 ItemWriter

ItemProcessor 和 ItemWriter 遵循與 ItemReader 相同的策略，因此它們不需要進行任何特定的配置即可訪問參數。 Bean 定義邏輯通過 enrichWithJobParameters() 方法初始化常用的參數。 其他用於單個類且不需要在所有組件中填充的參數，則由 Spring 通過 setter 注入在相應類中進行豐富。

我們應該標記所有依賴於屬性的 Bean 使用 @StepScope 註解。 否則，Spring 只會在上下文啓動時創建 Bean 一次，並且不會將參數的值注入。

4.3. 配置完整流程

我們無需採取任何特定操作來配置任務參數。因此，我們只需要將所有 Bean 組合起來：

@Bean
public Job medExpirationJob(JobRepository jobRepository,
    PlatformTransactionManager transactionManager,
    MedicineWriter medicineWriter,
    MedicineProcessor medicineProcessor,
    ExpiresSoonMedicineReader expiresSoonMedicineReader) {
    Step notifyAboutExpiringMedicine = new StepBuilder("notifyAboutExpiringMedicine", jobRepository).<Medicine, Medicine>chunk(10)
      .reader(expiresSoonMedicineReader)
      .processor(medicineProcessor)
      .writer(medicineWriter)
      .faultTolerant()
      .transactionManager(transactionManager)
      .build();

    return new JobBuilder("medExpirationJob", jobRepository)
      .incrementer(new RunIdIncrementer())
      .start(notifyAboutExpiringMedicine)
      .build();
}

5. 運行應用程序

讓我們運行一個完整的示例，並查看應用程序如何使用所有參數。我們需要從 SpringBatchExpireMedicationApplication 類啓動 Spring Boot 應用程序。

當計劃任務執行後，Spring 會記錄所有參數：

INFO  o.s.b.c.l.support.SimpleJobLauncher - Job: [SimpleJob: [name=medExpirationJob]] launched with the following parameters: [{'SALE_STARTS_DAYS':'{value=45, type=class java.lang.Long, identifying=true}','MEDICINE_SALE':'{value=0.1, type=class java.lang.Double, identifying=true}','TRACE_ID':'{value=e35a26a4-4d56-4dfe-bf36-c1e5f20940a5, type=class java.lang.String, identifying=true}','ALERT_TYPE':'{value=LOGS, type=class java.lang.String, identifying=true}','TRIGGERED_DATE_TIME':'{value=2023-12-06T22:36:00.011436600Z, type=class java.lang.String, identifying=true}','DEFAULT_EXPIRATION':'{value=60, type=class java.lang.Long, identifying=true}'}]

首先，ItemReader 根據 DEFAULT_EXPIRATION 參數，記錄已發現的藥品信息：

INFO  c.b.b.job.ExpiresSoonMedicineReader - Trace = e35a26a4-4d56-4dfe-bf36-c1e5f20940a5. Found 2 meds that expires soon

第二，ItemProcessor 使用 SALE_STARTS_DAYS 和 MEDICINE_SALE 參數來計算新的價格：

INFO  c.b.b.job.MedicineProcessor - Trace = e35a26a4-4d56-4dfe-bf36-c1e5f20940a5, calculated new sale price 18.0 for medicine 9d39321d-34f3-4eb7-bb9a-a69734e0e372
INFO  c.b.b.job.MedicineProcessor - Trace = e35a26a4-4d56-4dfe-bf36-c1e5f20940a5, calculated new sale price 36.0 for medicine acd99d6a-27be-4c89-babe-0edf4dca22cb

最後，ItemWriter 會將更新後的藥物記錄寫入同一追蹤的日誌：

INFO  c.b.b.job.MedicineWriter - Trace = e35a26a4-4d56-4dfe-bf36-c1e5f20940a5. This medicine is expiring Medicine(id=9d39321d-34f3-4eb7-bb9a-a69734e0e372, name=Flucloxacillin, type=ANTIBACTERIALS, expirationDate=2024-01-16 00:00:00.0, originalPrice=20.0, salePrice=18.0)
INFO  c.b.b.job.MedicineWriter - Trace = e35a26a4-4d56-4dfe-bf36-c1e5f20940a5. This medicine is expiring Medicine(id=acd99d6a-27be-4c89-babe-0edf4dca22cb, name=Prozac, type=ANTIDEPRESSANTS, expirationDate=2024-01-06 00:00:00.0, originalPrice=40.0, salePrice=36.0)
INFO  c.b.b.job.MedicineWriter - Finishing job started at 2023-12-07T11:58:00.014430400Z

6. 結論

在本文中，我們學習瞭如何在 Spring Batch 中使用 Job 參數。<em ItemReader</em>>, <em ItemProcessor</em>>, 和 <em ItemWriter</em>> 可以通過 Bean 初始化時手動添加參數，也可以通過 Spring 注入的<em @BeforeStep>` 或 setter 注入進行增強。