企业官网建设流程全解析

Spring Boot 如何从命令行运行 Spring Boot 应用中的 Spring Batch 作业并重启失败的 Job？

【免费下载链接】spring-bootSpring Boot helps you to create Spring-powered, production-grade applications and services with absolute minimum fuss.项目地址: https://gitcode.com/gh_mirrors/sp/spring-boot

如果你用 Spring Boot 封装了一个包含 Spring Batch 作业（Job）的应用，需要解决两个问题：一是怎么在命令行上正确地给作业传参数，二是作业执行失败之后，重新拉起时该传哪些参数。Spring Boot 在自动配置 Spring Batch 时，会在启动时执行应用上下文中的Job，同时把命令行参数分为“Spring 环境属性”和“Batch 作业参数”两类，混用会导致参数根本传不进去。本文基于 Spring Boot 官方 how-to 文档与参考文档，给出这条操作路径。

运行前提：Spring Boot 会自动启动你的 Job

Spring Boot 自动配置 Spring Batch 时，行为如下（见 io/spring-batch.adoc）：

• 上下文中有且只有一个Jobbean 时，启动应用即执行该 Job（由JobLauncherApplicationRunner完成）；
• 有多个Jobbean 时，必须用spring.batch.job.name指定要执行哪一个，例如：

spring: batch: job: name: "importJob"

• 不希望启动时自动执行 Job，可以关闭：

spring: batch: job: enabled: false

如果你把作业元数据存在 SQL 数据库中，应用还需要一个javax.sql.DataSourcebean（默认要求唯一的DataSourcebean）。需要让 Spring Batch 使用区别于应用主数据源的数据源时，声明对应的DataSourcebean 并在@Bean方法上加@BatchDataSource注解；此时若想保留自动配置的主数据源，把@Bean的defaultCandidate属性设为false（见 how-to/batch.adoc）。

从命令行传作业参数：不要用--前缀

Spring Boot 会把所有以--开头的命令行参数转换为 SpringEnvironment中的属性（即普通 Spring 配置项）。官方文档明确说明：不要用这种方式给 batch 作业传参。作业参数使用不带--的普通name=value格式：

$ java -jar myapp.jar someParameter=someValue anotherParameter=anotherValue

这一点可以通过混合命令来验证文档描述的行为：

$ java -jar myapp.jar --server.port=7070 someParameter=someValue

按照文档，这条命令只会给 batch 作业提供一个参数：someParameter=someValue；--server.port=7070进入的是 Spring 环境，作业侧会忽略它（命令行属性的转换规则见 external-config.adoc 的 “Accessing Command Line Properties” 一节）。因此你可以这样判断参数是否正确送达：用--传的值作业读不到，不带--的name=value才是作业收到的参数。

如果多个 Job 共存，选择要运行的 Job 用的spring.batch.job.name本身是一个 Spring 属性，所以它要用--形式传：

$ java -jar myapp.jar --spring.batch.job.name=importJob someParameter=someValue

重启失败的 Job：所有参数必须重新指定

这是最容易踩的坑。官方文档（how-to/batch.adoc 的 “Restarting a Stopped or Failed Job” 一节）的规则是：

• 重启一个失败的Job时，所有参数——包括识别型参数（identifying）和非识别型参数（non-identifying）——都必须在命令行上重新指定；
• 非识别型参数不会从上一次执行中自动带过来，重新指定后才能被修改或移除；
• 注意：如果你使用了自定义的JobParametersIncrementer，重启失败的执行时必须收集该 incrementer 管理的全部参数，否则重启无法完成。

对应到上一条的启动命令，重启时应把作业参数完整写回去，例如：

$ java -jar myapp.jar --spring.batch.job.name=importJob someParameter=someValue anotherParameter=anotherValue

需要改变某个参数取值时，直接在重启命令里替换它的值即可；想删掉某个非识别型参数，就不在命令行中指定它。

结果验证与限制

• 参数是否送达：以文档示例为准，java -jar myapp.jar --server.port=7070 someParameter=someValue中作业只能收到someParameter=someValue。
• 进程退出码：BatchJobLauncherAutoConfiguration会在上下文中没有自定义ExitCodeGenerator时自动注册JobExecutionExitCodeGenerator（见 BatchJobLauncherAutoConfiguration.java），它把作业执行的退出码传播为应用退出码。因此java -jar进程的退出状态可以反映本次 Job 的执行结果，重启时可用它确认作业是否真正成功。

以下限制需要注意：

• --参数只影响 Spring 环境，永远不会作为作业参数出现；反过来，把本应作为环境属性的值写成不带--的格式，它也不会进入Environment。
• 如果你在自己的配置类上加了@EnableBatchProcessing或继承DefaultBatchConfiguration来手动接管 Spring Batch 配置，Spring Boot 的自动配置（包括 Batch 数据库/MongoDB schema 初始化）会整体退避，此时命令行启动行为以你自己的配置为准。
• 识别型参数决定“这是否是同一个逻辑作业实例”，重启时不要随意改它们的值，否则会被当作一次新的作业执行而不是重启。这一条是 Spring Batch 的通用语义，官方 how-to 文档强调的重点是：重启必须把所有参数重新写回命令行。

完整细节可继续阅读 Batch Applications（how-to） 与 Spring Batch（reference） 两篇官方文档。

【免费下载链接】spring-bootSpring Boot helps you to create Spring-powered, production-grade applications and services with absolute minimum fuss.项目地址: https://gitcode.com/gh_mirrors/sp/spring-boot