运行 Job (Running a Job) | Spring Batch5.2.0-M1中文文档|Spring官方文档|SpringBoot 教程|Spring中文网

此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Batch 文档 5.1.2！spring-doc.cn

启动批处理作业至少需要两件事：要启动的作业和 .两者都可以包含在同一个 context 或不同的上下文。例如，如果您从命令行中，将为每个 .因此，每个 Job 有自己的 .但是，如果您可以从范围内的 Web 容器中运行，通常有一个（为异步作业配置 launching），多个请求调用以启动其作业。JobJobLauncherJobJobLauncherHttpRequestJobLauncherspring-doc.cn

从命令行运行 Job

如果要从企业运行作业 scheduler 中，命令行是主界面。这是因为大多数调度程序（Quartz 除外，除非使用）直接与 os 一起工作进程，主要由 shell 脚本启动。有很多方法启动除 shell 脚本之外的 Java 进程，例如 Perl、Ruby 或甚至构建工具，例如 Ant 或 Maven。但是，因为大多数人熟悉 shell 脚本，本示例重点介绍它们。NativeJobspring-doc.cn

The CommandLineJobRunner

因为启动作业的脚本必须启动 Java Virtual Machine 中，需要有一个类，其中包含一个作为主要入口点。Spring Batch 提供了一个实现，用于此目的：。注意这只是引导应用程序的一种方式。有启动 Java 进程的方法有很多种，这个类绝不应该是被视为确定的。执行四项任务：mainCommandLineJobRunnerCommandLineJobRunnerspring-doc.cn

加载相应的 .ApplicationContextspring-doc.cn
将命令行参数解析为 .JobParametersspring-doc.cn
根据参数找到合适的作业。spring-doc.cn
使用应用程序上下文中提供的来启动作业。JobLauncherspring-doc.cn

所有这些任务都只需传入参数即可完成。下表描述了所需的参数：spring-doc.cn

表 1.CommandLineJobRunner 参数
`jobPath`spring-doc.cn	XML 文件的位置，用于创建一个 .此文件应包含运行完整 .`ApplicationContextJob`spring-doc.cn
`jobName`spring-doc.cn	要运行的作业的名称。spring-doc.cn

必须传入这些参数，路径在前，名称在后。所有参数在这些被认为是作业参数后，它们被转换为对象，，并且必须采用 .JobParametersname=valuespring-doc.cn

Javaspring-doc.cn
XMLspring-doc.cn

以下示例显示了作为作业参数传递给 Java 中定义的作业的日期：spring-doc.cn

<bash$ java CommandLineJobRunner io.spring.EndOfDayJobConfiguration endOfDay schedule.date=2007-05-05,java.time.LocalDate

以下示例显示了作为作业参数传递给 XML 中定义的作业的日期：spring-doc.cn

<bash$ java CommandLineJobRunner endOfDayJob.xml endOfDay schedule.date=2007-05-05,java.time.LocalDate

默认情况下，它使用隐式转换用于标识作业参数的键/值对。但是，您可以显式指定哪些作业参数正在标识，哪些不是，分别通过给它们加上或后缀。CommandLineJobRunnerDefaultJobParametersConvertertruefalsespring-doc.cn

在以下示例中， is 是一个标识作业参数，while is not：schedule.datevendor.idspring-doc.cn

<bash$ java CommandLineJobRunner endOfDayJob.xml endOfDay \
                                 schedule.date=2007-05-05,java.time.LocalDate,true \
                                 vendor.id=123,java.lang.Long,false

<bash$ java CommandLineJobRunner io.spring.EndOfDayJobConfiguration endOfDay \
                                 schedule.date=2007-05-05,java.time.LocalDate,true \
                                 vendor.id=123,java.lang.Long,false

您可以通过使用自定义 .JobParametersConverterspring-doc.cn

Javaspring-doc.cn
XMLspring-doc.cn

在大多数情况下，您需要使用 manifest 在 jar 中声明您的类。然而为简单起见，该类被直接使用。此示例使用 Batch 的域语言中的示例。第一个 argument 是，这是完全限定的类名添加到包含 Job 的配置类中。第二个参数，表示作业名称。最后一个参数，被转换转换为类型为 .mainEndOfDayio.spring.EndOfDayJobConfigurationendOfDayschedule.date=2007-05-05,java.time.LocalDateJobParameterjava.time.LocalDatespring-doc.cn

以下示例显示了在 Java 中的配置示例：endOfDayspring-doc.cn

@Configuration
@EnableBatchProcessing
public class EndOfDayJobConfiguration {

    @Bean
    public Job endOfDay(JobRepository jobRepository, Step step1) {
        return new JobBuilder("endOfDay", jobRepository)
    				.start(step1)
    				.build();
    }

    @Bean
    public Step step1(JobRepository jobRepository, PlatformTransactionManager transactionManager) {
        return new StepBuilder("step1", jobRepository)
    				.tasklet((contribution, chunkContext) -> null, transactionManager)
    				.build();
    }
}

在大多数情况下，您需要使用 manifest 在 jar 中声明您的类。然而为简单起见，该类被直接使用。此示例使用 Batch 的域语言中的示例。第一个参数是，它是包含 .第二个参数表示作业名称。最后一个参数，将转换为类型为的对象。mainEndOfDayendOfDayJob.xmlJobendOfDay,schedule.date=2007-05-05,java.time.LocalDateJobParameterjava.time.LocalDatespring-doc.cn

以下示例显示了 in XML 的示例配置：endOfDayspring-doc.cn

<job id="endOfDay">
    <step id="step1" parent="simpleStep" />
</job>

<!-- Launcher details removed for clarity -->
<beans:bean id="jobLauncher"
         class="org.springframework.batch.core.launch.support.TaskExecutorJobLauncher" />

前面的示例过于简单，因为通常在 Spring Batch 中运行批处理作业，但它用于显示两个主要的的要求：和 .CommandLineJobRunnerJobJobLauncherspring-doc.cn

退出代码

从命令行启动批处理作业时，企业经常使用 scheduler。大多数调度程序都相当愚蠢，只能工作在流程级别。这意味着他们只知道一些操作系统进程（例如它们调用的 shell 脚本）。在这种情况下，与调度程序通信的唯一方法关于作业的成功或失败是通过返回代码。一个 return code 是进程返回给调度程序的数字以指示运行结果。在最简单的情况下，0 是成功，1 是失败。但是，可能还有更复杂的场景，例如“如果作业 A 返回 4，则启动作业 B，如果作业返回 5，则启动作业 B 下班 C。这种类型的行为在调度程序级别配置，但重要的是，像 Spring Batch 这样的处理框架提供一种方法来返回退出代码的数字表示形式对于特定的批处理作业。在 Spring Batch 中，这是封装的在中，在 more 详情见第 5 章。为了讨论退出代码，唯一需要知道的是，an 有一个 exit code 属性，该属性是设置，并作为从 .将转换此字符串值使用界面更改为数字：ExitStatusExitStatusJobExecutionJobLauncherCommandLineJobRunnerExitCodeMapperspring-doc.cn

public interface ExitCodeMapper {

    public int intValue(String exitCode);

}

an 的基本协定是，给定一个字符串 exit code 时，将返回一个数字表示形式。默认的 Job Runner 使用的实现是返回 0 表示完成、1 表示一般错误和 2 表示任何作业的实现运行器错误，例如无法在提供的上下文中找到 A。如果有更多 complex 的 3 个值，则自定义接口的实现必须提供。因为是创建因此，AN AND 不能是 'wired together' 时，任何需要覆盖的值都必须是自动装配。这意味着，如果在、在创建上下文后，它会注入到 Runner 中。都需要做的是提供你自己的作为根级 Bean 进行加载，并确保它是跑步者。ExitCodeMapperSimpleJvmExitCodeMapperJobExitCodeMapperCommandLineJobRunnerApplicationContextExitCodeMapperBeanFactoryExitCodeMapperApplicationContextspring-doc.cn

表 1.CommandLineJobRunner 参数
`jobPath`spring-doc.cn	XML 文件的位置，用于创建一个 .此文件应包含运行完整 .`ApplicationContextJob`spring-doc.cn
`jobName`spring-doc.cn	要运行的作业的名称。spring-doc.cn

在以下示例中， is 是一个标识作业参数，while is not：schedule.datevendor.idspring-doc.cn

<bash$ java CommandLineJobRunner endOfDayJob.xml endOfDay \
                                 schedule.date=2007-05-05,java.time.LocalDate,true \
                                 vendor.id=123,java.lang.Long,false

<bash$ java CommandLineJobRunner io.spring.EndOfDayJobConfiguration endOfDay \
                                 schedule.date=2007-05-05,java.time.LocalDate,true \
                                 vendor.id=123,java.lang.Long,false

您可以通过使用自定义 .JobParametersConverterspring-doc.cn

从 Web 容器中运行作业

从历史上看，离线处理（例如批处理作业）一直是从命令行启动，如前所述。但是，有在许多情况下，从启动一个更好的选择。许多此类用例包括报告、临时作业 running 和 Web 应用程序支持。因为批处理作业（根据定义）运行时间长，最关心的是启动 job 异步：HttpRequestspring-doc.cn

图 1.来自 Web 容器的异步作业Starters序列

在这种情况下，控制器是 Spring MVC 控制器。请参阅 Spring Framework 参考指南，了解有关 Spring MVC 的更多信息。控制器使用已配置为异步启动的来启动一个，该立即返回一个 .它可能仍在运行。但是，此非阻塞行为允许控制器立即返回，这在处理 .以下清单显示了一个例子：JobJobLauncherJobExecutionJobHttpRequestspring-doc.cn

@Controller
public class JobLauncherController {

    @Autowired
    JobLauncher jobLauncher;

    @Autowired
    Job job;

    @RequestMapping("/jobLauncher.html")
    public void handle() throws Exception{
        jobLauncher.run(job, new JobParameters());
    }
}