元数据模式

概述

Spring Batch 元数据表与在 Java 中表示它们的领域对象密切对应。例如，JobInstance、JobExecution、JobParameters 和 StepExecution 分别映射到 BATCH_JOB_INSTANCE、BATCH_JOB_EXECUTION、BATCH_JOB_EXECUTION_PARAMS 和 BATCH_STEP_EXECUTION。ExecutionContext 映射到 BATCH_JOB_EXECUTION_CONTEXT 和 BATCH_STEP_EXECUTION_CONTEXT。JobRepository 负责将每个 Java 对象保存并存储到其对应的表中。本附录详细描述了元数据表，以及创建它们时所做的许多设计决策。查看本附录后面描述的各种表创建语句时，请注意使用的数据类型尽可能通用。Spring Batch 提供了许多模式作为示例。由于各个数据库供应商处理数据类型的方式不同，所有这些模式的数据类型各不相同。下图显示了所有六个表及其相互关系的 ERD 模型

图 1. Spring Batch 元数据 ERD

示例 DDL 脚本

Spring Batch Core JAR 文件包含用于创建多种数据库平台关系表的示例脚本（这些平台又会被 job repository factory bean 或等效的命名空间自动检测到）。这些脚本可以按原样使用，也可以根据需要添加额外的索引和约束进行修改。文件名格式为 schema-*.sql，其中 * 是目标数据库平台的短名称。这些脚本位于 org.springframework.batch.core 包中。

迁移 DDL 脚本

Spring Batch 提供了在升级版本时需要执行的迁移 DDL 脚本。这些脚本可以在 Core Jar 文件的 org/springframework/batch/core/migration 路径下找到。迁移脚本按引入的版本号组织到相应的文件夹中

2.2：包含从 2.2 之前版本迁移到 2.2 版本所需的脚本
4.1：包含从 4.1 之前版本迁移到 4.1 版本所需的脚本

版本

本附录中讨论的许多数据库表都包含一个版本列。这个列很重要，因为 Spring Batch 在处理数据库更新时采用了乐观锁策略。这意味着每次“触及”（更新）一条记录时，版本列中的值都会加一。当 Repository 回去保存值时，如果版本号已经改变，它会抛出 OptimisticLockingFailureException，表示存在并发访问错误。此检查是必要的，因为即使不同的批处理作业可能在不同的机器上运行，它们都使用相同的数据库表。

标识

BATCH_JOB_INSTANCE、BATCH_JOB_EXECUTION 和 BATCH_STEP_EXECUTION 都包含以 _ID 结尾的列。这些字段作为各自表的主键。但是，它们不是数据库生成的键。相反，它们是由单独的序列生成的。这是必要的，因为将其中一个领域对象插入数据库后，它获得的键需要设置在实际对象上，以便在 Java 中能够唯一标识它们。较新的数据库驱动程序（JDBC 3.0 及以上）支持数据库生成键的此特性。然而，为了不强制要求该特性，使用了序列。每种模式变体都包含以下语句的某种形式

CREATE SEQUENCE BATCH_STEP_EXECUTION_SEQ;
CREATE SEQUENCE BATCH_JOB_EXECUTION_SEQ;
CREATE SEQUENCE BATCH_JOB_SEQ;

许多数据库供应商不支持序列。在这种情况下，会使用变通方法，例如以下用于 MySQL 的语句

CREATE TABLE BATCH_STEP_EXECUTION_SEQ (ID BIGINT NOT NULL) type=InnoDB;
INSERT INTO BATCH_STEP_EXECUTION_SEQ values(0);
CREATE TABLE BATCH_JOB_EXECUTION_SEQ (ID BIGINT NOT NULL) type=InnoDB;
INSERT INTO BATCH_JOB_EXECUTION_SEQ values(0);
CREATE TABLE BATCH_JOB_SEQ (ID BIGINT NOT NULL) type=InnoDB;
INSERT INTO BATCH_JOB_SEQ values(0);

在上述情况下，使用一个表来代替每个序列。然后，Spring 核心类 MySQLMaxValueIncrementer 递增此序列中的一列以提供类似的功能。

`BATCH_JOB_INSTANCE` 表

BATCH_JOB_INSTANCE 表保存了与 JobInstance 相关的所有信息，并作为整个层次结构的顶部。以下是用于创建它的通用 DDL 语句

CREATE TABLE BATCH_JOB_INSTANCE  (
  JOB_INSTANCE_ID BIGINT  PRIMARY KEY ,
  VERSION BIGINT,
  JOB_NAME VARCHAR(100) NOT NULL ,
  JOB_KEY VARCHAR(32) NOT NULL
);

以下列表描述了表中的每一列

JOB_INSTANCE_ID：唯一标识实例的 ID。它也是主键。此列的值应该可以通过调用 JobInstance 的 getId 方法获得。
VERSION：参见版本。
JOB_NAME：从 Job 对象获取的作业名称。由于它是标识实例所必需的，因此不能为空。
JOB_KEY：JobParameters 的序列化，用于唯一标识同一作业的不同实例。（具有相同作业名称的 JobInstances 必须具有不同的 JobParameters，因此具有不同的 JOB_KEY 值）。

`BATCH_JOB_EXECUTION_PARAMS` 表

BATCH_JOB_EXECUTION_PARAMS 表保存了与 JobParameters 对象相关的所有信息。它包含传递给 Job 的 0 个或多个键值对，并作为作业运行参数的记录。对于每个有助于生成作业标识的参数，将 IDENTIFYING 标志设置为 true。请注意，该表已进行反范式化。没有为每种类型创建单独的表，而是有一个表，其中包含一个指示类型的列，如下所示

CREATE TABLE BATCH_JOB_EXECUTION_PARAMS  (
	JOB_EXECUTION_ID BIGINT NOT NULL ,
	PARAMETER_NAME VARCHAR(100) NOT NULL ,
	PARAMETER_TYPE VARCHAR(100) NOT NULL ,
	PARAMETER_VALUE VARCHAR(2500) ,
	IDENTIFYING CHAR(1) NOT NULL ,
	constraint JOB_EXEC_PARAMS_FK foreign key (JOB_EXECUTION_ID)
	references BATCH_JOB_EXECUTION(JOB_EXECUTION_ID)
);

以下列表描述了每一列

JOB_EXECUTION_ID：来自 BATCH_JOB_EXECUTION 表的外键，指示参数条目所属的作业执行。请注意，每个执行可能存在多行（即键值对）。
PARAMETER_NAME：参数名称。
PARAMETER_TYPE：参数类型的完全限定名称。
PARAMETER_VALUE：参数值
IDENTIFYING：指示参数是否对相关 JobInstance 的标识产生贡献的标志。

请注意，此表没有主键。这是因为框架不需要它，因此不强制要求。如果需要，您可以使用数据库生成的键添加主键，而不会对框架本身造成任何问题。

`BATCH_JOB_EXECUTION` 表

BATCH_JOB_EXECUTION 表保存了与 JobExecution 对象相关的所有信息。每次运行 Job 时，都会有一个新的 JobExecution 调用以及此表中的新行。以下列出了 BATCH_JOB_EXECUTION 表的定义

CREATE TABLE BATCH_JOB_EXECUTION  (
  JOB_EXECUTION_ID BIGINT  PRIMARY KEY ,
  VERSION BIGINT,
  JOB_INSTANCE_ID BIGINT NOT NULL,
  CREATE_TIME TIMESTAMP NOT NULL,
  START_TIME TIMESTAMP DEFAULT NULL,
  END_TIME TIMESTAMP DEFAULT NULL,
  STATUS VARCHAR(10),
  EXIT_CODE VARCHAR(20),
  EXIT_MESSAGE VARCHAR(2500),
  LAST_UPDATED TIMESTAMP,
  constraint JOB_INSTANCE_EXECUTION_FK foreign key (JOB_INSTANCE_ID)
  references BATCH_JOB_INSTANCE(JOB_INSTANCE_ID)
) ;

以下列表描述了每一列

JOB_EXECUTION_ID：唯一标识此执行的主键。此列的值可以通过调用 JobExecution 对象的 getId 方法获得。
VERSION：参见版本。
JOB_INSTANCE_ID：来自 BATCH_JOB_INSTANCE 表的外键。它指示此执行所属的实例。每个实例可能有一个以上的执行。
CREATE_TIME：表示执行创建时间的 timestamp。
START_TIME：表示执行开始时间的 timestamp。
END_TIME：表示执行完成时间的 timestamp，无论成功或失败。作业当前未运行时此列为空值，表示发生了某种错误，并且框架在失败前未能执行最后一次保存。
STATUS：表示执行状态的字符串。可以是 COMPLETED、STARTED 等。此列的对象表示是 BatchStatus 枚举。
EXIT_CODE：表示执行退出码的字符串。对于命令行作业，这可以转换为一个数字。
EXIT_MESSAGE：表示作业退出方式更详细描述的字符串。如果失败，这可能包括尽可能多的堆栈跟踪信息。
LAST_UPDATED：表示此执行最后一次持久化时间的 timestamp。

`BATCH_STEP_EXECUTION` 表

BATCH_STEP_EXECUTION 表保存了与 StepExecution 对象相关的所有信息。此表在许多方面与 BATCH_JOB_EXECUTION 表相似，并且每个创建的 JobExecution 针对每个 Step 至少有一个条目。以下列出了 BATCH_STEP_EXECUTION 表的定义

CREATE TABLE BATCH_STEP_EXECUTION  (
  STEP_EXECUTION_ID BIGINT NOT NULL PRIMARY KEY ,
  VERSION BIGINT NOT NULL,
  STEP_NAME VARCHAR(100) NOT NULL,
  JOB_EXECUTION_ID BIGINT NOT NULL,
  CREATE_TIME TIMESTAMP NOT NULL,
  START_TIME TIMESTAMP DEFAULT NULL ,
  END_TIME TIMESTAMP DEFAULT NULL,
  STATUS VARCHAR(10),
  COMMIT_COUNT BIGINT ,
  READ_COUNT BIGINT ,
  FILTER_COUNT BIGINT ,
  WRITE_COUNT BIGINT ,
  READ_SKIP_COUNT BIGINT ,
  WRITE_SKIP_COUNT BIGINT ,
  PROCESS_SKIP_COUNT BIGINT ,
  ROLLBACK_COUNT BIGINT ,
  EXIT_CODE VARCHAR(20) ,
  EXIT_MESSAGE VARCHAR(2500) ,
  LAST_UPDATED TIMESTAMP,
  constraint JOB_EXECUTION_STEP_FK foreign key (JOB_EXECUTION_ID)
  references BATCH_JOB_EXECUTION(JOB_EXECUTION_ID)
) ;

以下列表描述了每一列

STEP_EXECUTION_ID：唯一标识此执行的主键。此列的值应该可以通过调用 StepExecution 对象的 getId 方法获得。
VERSION：参见版本。
STEP_NAME：此执行所属步骤的名称。
JOB_EXECUTION_ID：来自 BATCH_JOB_EXECUTION 表的外键。它指示此 StepExecution 所属的 JobExecution。对于给定的 JobExecution 和给定的 Step 名称，可能只有一个 StepExecution。
START_TIME：表示执行开始时间的 timestamp。
END_TIME：表示执行完成时间的 timestamp，无论成功或失败。此列为空值（即使作业当前未运行）表示发生了某种错误，并且框架在失败前未能执行最后一次保存。
STATUS：表示执行状态的字符串。可以是 COMPLETED、STARTED 等。此列的对象表示是 BatchStatus 枚举。
COMMIT_COUNT：在此执行期间步骤已提交事务的次数。
READ_COUNT：在此执行期间读取的项目数。
FILTER_COUNT：在此执行期间被过滤掉的项目数。
WRITE_COUNT：在此执行期间写入并提交的项目数。
READ_SKIP_COUNT：在此执行期间读取时跳过的项目数。
WRITE_SKIP_COUNT：在此执行期间写入时跳过的项目数。
PROCESS_SKIP_COUNT：在此执行期间处理时跳过的项目数。
ROLLBACK_COUNT：在此执行期间回滚的次数。请注意，此计数包括每次发生回滚的次数，包括重试的回滚和跳过恢复过程中的回滚。
EXIT_CODE：表示执行退出码的字符串。对于命令行作业，这可以转换为一个数字。
EXIT_MESSAGE：表示作业退出方式更详细描述的字符串。如果失败，这可能包括尽可能多的堆栈跟踪信息。
LAST_UPDATED：表示此执行最后一次持久化时间的 timestamp。

`BATCH_JOB_EXECUTION_CONTEXT` 表

BATCH_JOB_EXECUTION_CONTEXT 表保存了与 Job 的 ExecutionContext 相关的所有信息。每个 JobExecution 恰好有一个 Job ExecutionContext，它包含特定作业执行所需的所有作业级别数据。此数据通常表示失败后必须检索的状态，以便 JobInstance 可以“从中断处继续”。以下列出了 BATCH_JOB_EXECUTION_CONTEXT 表的定义

CREATE TABLE BATCH_JOB_EXECUTION_CONTEXT  (
  JOB_EXECUTION_ID BIGINT PRIMARY KEY,
  SHORT_CONTEXT VARCHAR(2500) NOT NULL,
  SERIALIZED_CONTEXT CLOB,
  constraint JOB_EXEC_CTX_FK foreign key (JOB_EXECUTION_ID)
  references BATCH_JOB_EXECUTION(JOB_EXECUTION_ID)
) ;

以下列表描述了每一列

JOB_EXECUTION_ID：表示上下文所属 JobExecution 的外键。给定执行可能关联多行。
SHORT_CONTEXT：SERIALIZED_CONTEXT 的字符串版本。
SERIALIZED_CONTEXT：整个上下文，序列化后的。

`BATCH_STEP_EXECUTION_CONTEXT` 表

BATCH_STEP_EXECUTION_CONTEXT 表保存了与 Step 的 ExecutionContext 相关的所有信息。每个 StepExecution 恰好有一个 ExecutionContext，它包含特定步骤执行所需的所有持久化数据。此数据通常表示失败后必须检索的状态，以便 JobInstance 可以“从中断处继续”。以下列出了 BATCH_STEP_EXECUTION_CONTEXT 表的定义

CREATE TABLE BATCH_STEP_EXECUTION_CONTEXT  (
  STEP_EXECUTION_ID BIGINT PRIMARY KEY,
  SHORT_CONTEXT VARCHAR(2500) NOT NULL,
  SERIALIZED_CONTEXT CLOB,
  constraint STEP_EXEC_CTX_FK foreign key (STEP_EXECUTION_ID)
  references BATCH_STEP_EXECUTION(STEP_EXECUTION_ID)
) ;

以下列表描述了每一列

STEP_EXECUTION_ID：表示上下文所属 StepExecution 的外键。给定执行可能关联多行。
SHORT_CONTEXT：SERIALIZED_CONTEXT 的字符串版本。
SERIALIZED_CONTEXT：整个上下文，序列化后的。

国际化和多字节字符

如果您在业务处理中使用多字节字符集（如中文或西里尔文），这些字符可能需要持久化到 Spring Batch 模式中。许多用户发现，只需更改模式将 VARCHAR 列的长度加倍就足够了。其他人则倾向于将 JobRepository 配置为 max-varchar-length 为 VARCHAR 列长度值的一半。还有一些用户报告说，他们在模式定义中用 NVARCHAR 替换了 VARCHAR。最佳结果取决于数据库平台以及数据库服务器在本地的配置方式。

元数据表索引建议

Spring Batch 在核心 jar 文件中为几种常见的数据库平台提供了元数据表的 DDL 示例。该 DDL 中不包含索引声明，因为用户可能希望如何索引有太多差异，取决于其具体的平台、本地约定以及作业操作的业务需求。下表提供了一些指示，说明 Spring Batch 提供的 DAO 实现将在 WHERE 子句中使用哪些列以及它们可能的使用频率，以便各个项目可以自行决定索引方式

表 1. SQL 语句中的 Where 子句（不含主键）及其大致使用频率。
默认表名	Where 子句	频率
`BATCH_JOB_INSTANCE`	`JOB_NAME = ? and JOB_KEY = ?`	每次启动作业时
`BATCH_JOB_EXECUTION`	`JOB_INSTANCE_ID = ?`	每次重启作业时
`BATCH_STEP_EXECUTION`	`VERSION = ?`	在提交间隔，即分块时（以及步骤开始和结束时）
`BATCH_STEP_EXECUTION`	`STEP_NAME = ? and JOB_EXECUTION_ID = ?`	每次步骤执行前

元数据模式

概述

示例 DDL 脚本

迁移 DDL 脚本

版本

标识

BATCH_JOB_INSTANCE 表

BATCH_JOB_EXECUTION_PARAMS 表

BATCH_JOB_EXECUTION 表

BATCH_STEP_EXECUTION 表

BATCH_JOB_EXECUTION_CONTEXT 表

BATCH_STEP_EXECUTION_CONTEXT 表

归档

国际化和多字节字符

元数据表索引建议

`BATCH_JOB_INSTANCE` 表

`BATCH_JOB_EXECUTION_PARAMS` 表

`BATCH_JOB_EXECUTION` 表

`BATCH_STEP_EXECUTION` 表

`BATCH_JOB_EXECUTION_CONTEXT` 表

`BATCH_STEP_EXECUTION_CONTEXT` 表