Spring Batch 5 自动建表功能禁用指南

2024-03-20 02:40:25

在 Spring Batch 5 中巧妙关闭自动建表功能

引言

随着 Spring Batch 从版本 4 迈向版本 5，开发者们迎来了许多激动人心的新特性和改进。然而，其中一项改变可能让人略感意外——禁用 Spring Batch 在数据库中自动创建表的默认行为。本文将深入探讨如何在 Spring Batch 5 中关闭这一自动建表功能，并提供清晰的解决方案步骤。

问题概述

在 Spring Batch 4 中，BATCH_JOB_INSTANCE 等表是随着应用程序启动而自动创建的。然而，在 Spring Batch 5 中，这一行为已不再是默认选项。这可能会给习惯了自动建表的开发者带来一些困扰。

解决方案

要禁用 Spring Batch 5 中的自动建表功能，我们需要采用一种更显式的配置方式：

1. 使用 JobRepositoryFactoryBean

首先，我们需要使用 JobRepositoryFactoryBean 来创建 JobRepository，并为其设置 DataSource 和 PlatformTransactionManager：

@Bean(name = "jobRepository")
public JobRepository createJobRepository() throws Exception {
    JobRepositoryFactoryBean factoryBean = new JobRepositoryFactoryBean();
    factoryBean.setDataSource(dataSource);
    factoryBean.setTransactionManager(transactionManager());
    factoryBean.afterPropertiesSet();
    return factoryBean.getObject();
}

2. 显式创建 JobRepository

接下来，使用 JobRepositoryFactoryBean 创建 JobRepository：

@Bean(name = "jobname")
public Job jobname (PlatformTransactionManager transactionManager) throws Exception {
    return new JobBuilder("jobname ", createJobRepository())
      .start(getAlerteReader(transactionManager))
      .next(getAlerteProcess(transactionManager))
     .build();
}

避免导入 EnableBatchProcessing 和扩展 DefaultBatchConfiguration

在 Spring Batch 5 中，不再需要导入 EnableBatchProcessing 注解或扩展 DefaultBatchConfiguration。这些操作已被弃用。

错误排查：PreparedStatementCallback; bad SQL grammar

如果在构建项目时遇到 PreparedStatementCallback; bad SQL grammar 错误，可能是因为 BATCH_JOB_INSTANCE 表不存在。我们可以通过在数据库中手动创建该表来解决此问题：

CREATE TABLE BATCH_JOB_INSTANCE (
  JOB_INSTANCE_ID BIGINT NOT NULL,
  JOB_NAME VARCHAR(100) NOT NULL,
  JOB_KEY VARCHAR(255) NOT NULL,
  CREATE_TIME TIMESTAMP NOT NULL,
  START_TIME TIMESTAMP,
  END_TIME TIMESTAMP,
  STATUS VARCHAR(10) NOT NULL,
  EXIT_CODE VARCHAR(255),
  EXIT_MESSAGE VARCHAR(255),
  LAST_UPDATED TIMESTAMP,
  VERSION BIGINT NOT NULL,
  PRIMARY KEY (JOB_INSTANCE_ID)
);

总结

通过使用 JobRepositoryFactoryBean 并禁用 EnableBatchProcessing 和 DefaultBatchConfiguration，我们可以轻松关闭 Spring Batch 5 中的自动建表功能。此外，确保 BATCH_JOB_INSTANCE 表在数据库中存在，以避免 PreparedStatementCallback; bad SQL grammar 错误。

常见问题解答

为什么要关闭自动建表功能？

关闭自动建表功能可以让我们在数据库管理方面拥有更大的控制权。例如，我们可以选择在特定模式下创建表，或者为表指定特定的存储选项。

除了手动创建表，还有其他方法禁用自动建表功能吗？

没有其他方法可以完全禁用自动建表功能。但是，我们可以通过配置 Spring Batch 的 initializeSchema 属性来控制创建哪些表。

在 Spring Batch 4 和 5 中，禁用自动建表功能有什么不同？

在 Spring Batch 4 中，禁用自动建表功能需要使用 @EnableBatchProcessing(initializeSchema = false)。而在 Spring Batch 5 中，我们需要使用 JobRepositoryFactoryBean 并手动创建 JobRepository。