如何为Spring Batch的Step、Job、Flow添加自定义只读元数据？

核心需求是给Job、Flow、Step绑定只读的自定义元数据（与执行上下文的运行时数据区分开），用于UI可视化等场景。以下是几种可行的实现思路：

方案一：自定义包装类（推荐） #

创建自定义的包装类，内部持有原生Spring Batch组件和自定义元数据，既保留原生组件功能，又添加元数据支持：

// 自定义带元数据的Step包装类
public class MetadataStep<T> implements Step {
    private final Step delegate;
    private final T customMetadata;

    public MetadataStep(Step delegate, T customMetadata) {
        this.delegate = delegate;
        this.customMetadata = customMetadata;
    }

    // 实现Step接口的所有方法，全部委托给原生Step
    @Override
    public String getName() {
        return delegate.getName();
    }

    @Override
    public void execute(StepExecution stepExecution) throws JobInterruptedException, UnexpectedJobExecutionException {
        delegate.execute(stepExecution);
    }

    // 自定义获取元数据的方法
    public T getCustomMetadata() {
        return customMetadata;
    }

    // 其余Step接口方法同理，全部委托给delegate
}

// 构建Step时用包装类包裹原生实例
@Bean
public MetadataStep<MyMetadata> sampleStep(JobRepository jobRepository, PlatformTransactionManager transactionManager) {
    MyMetadata myMetaData = ...;
    Step originalStep = new StepBuilder("mySampleStep", jobRepository)
            .<String, String>chunk(10, transactionManager)
            .reader(itemReader())
            .writer(itemWriter())
            .build();
    return new MetadataStep<>(originalStep, myMetaData);
}

获取元数据时直接从包装类读取：

MetadataStep<MyMetadata> myStep = (MetadataStep<MyMetadata>) simpleJob.getStep("myStep");
MyMetadata myMetadata = myStep.getCustomMetadata();

同理可为Job、Flow创建MetadataJob、MetadataFlow包装类，统一实现元数据绑定逻辑。

方案二：利用Spring Bean元数据扩展 #

借助Spring容器的BeanDefinition机制，为Job/Step/Flow的Bean添加自定义属性，无需自定义类：

// 注册Step时将元数据存入BeanDefinition
@Bean
public Step sampleStep(JobRepository jobRepository, PlatformTransactionManager transactionManager, BeanFactory beanFactory) {
    MyMetadata myMetaData = ...;
    Step step = new StepBuilder("mySampleStep", jobRepository)
            .<String, String>chunk(10, transactionManager)
            .reader(itemReader())
            .writer(itemWriter())
            .build();
    // 向BeanDefinition添加自定义元数据属性
    BeanDefinitionRegistry registry = (BeanDefinitionRegistry) beanFactory;
    BeanDefinition beanDefinition = registry.getBeanDefinition("sampleStep");
    beanDefinition.setAttribute("customMetadata", myMetaData);
    return step;
}

// 获取元数据时从BeanDefinition读取
BeanFactory beanFactory = ...;
Step step = beanFactory.getBean("sampleStep", Step.class);
BeanDefinition beanDefinition = ((ConfigurableBeanFactory) beanFactory).getBeanDefinition("sampleStep");
MyMetadata myMetadata = (MyMetadata) beanDefinition.getAttribute("customMetadata");

这种方式依赖Spring容器机制，适合不需要强类型约束的场景。

方案三：扩展Spring Batch构建器 #

如果想贴近你最初设想的链式调用风格，可以扩展原生构建器，封装包装类的创建逻辑：

// 扩展StepBuilder，添加元数据设置方法
public class MetadataStepBuilder<T> extends StepBuilder {
    private T customMetadata;

    public MetadataStepBuilder(String name, JobRepository jobRepository) {
        super(name, jobRepository);
    }

    public MetadataStepBuilder<T> withCustomMetadata(T customMetadata) {
        this.customMetadata = customMetadata;
        return this;
    }

    @Override
    public Step build() {
        Step originalStep = super.build();
        return new MetadataStep<>(originalStep, customMetadata);
    }
}

// 使用自定义构建器创建带元数据的Step
@Bean
public MetadataStep<MyMetadata> sampleStep(JobRepository jobRepository, PlatformTransactionManager transactionManager) {
    MyMetadata myMetaData = ...;
    return new MetadataStepBuilder<MyMetadata>("mySampleStep", jobRepository)
            .withCustomMetadata(myMetaData)
            .<String, String>chunk(10, transactionManager)
            .reader(itemReader())
            .writer(itemWriter())
            .build();
}

这种方式保持了代码的流畅性，同时隐藏了包装类的细节。

内容的提问来源于stack exchange，提问作者Hristo Stoyanov