转载

快速了解组件-spring batch(2)之helloworld

前面《数据批处理神器-Spring Batch(1)简介及使用场景》已经介绍了 Spring Batch 是一个轻量级，完善的批处理框架，它使用起来简单，方便，比较适合有点编程基础（特别是使用Spring及SpringBoot框架）的开发人员，针对业务编程，只需要关心具体的业务实现即可，把流程以及流程的控制交给 Spring Batch 就好。常言道" talk is cheap, show me the code "，下面我们就通过一个简单的 hello world ，进入 Spring Batch 的世界，通过这个示例，可以快速了解开发批处理的流程和 Spring Batch 开发用到的组件，为后续的操作打下基础。

2.开发环境

JDK: jdk1.8
Spring Boot: 2.1.4.RELEASE
Spring Batch:4.1.2.RELEASE
开发IDE: IDEA
构建工具Maven: 3.3.9
日志组件logback:1.2.3
lombok:1.18.6

3.helloworld开发

3.1 helloworld说明

本helloworld实现一个非常简单的功能，就是从数据组中读取字符串，把字符串转为大写，然后输出到控制台。如图：

整个过程就是一个批重任务（ Job ），它只有一个步骤（ Job Step ），步骤里分为三个阶段，读数据（ItemReader）、处理数据（ItemProcessor）、写数据（ItemWriter）。

3.2 开发流程

开发的主要代码如下：

总体来说就是，通过 Reader ， Processor 、 Writer 完成任务，结束后通过 Listener 进行监听，整个任务通过配置( BatchConfig )进行配置。

3.2.1 创建 `Spring Boot` 工程

直接使用Idea生成或在使用 Spring Initializr 生成即可，此处不详细说明。也可以直接使用我的代码示例。当前使用的 Spring Boot 版本是 2.1.4.RELEASE

3.2.2 添加相关依赖

Spring Batch 依赖在使用 spring-boot-starter-parent 的情况下，直接添加以下依赖即可：

<!-- 批处理框架-->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-batch</artifactId>
</dependency>
复制代码

引用后，会引用两个jar包，一个是 spring-batch-infrastructure ，一个是 spring-batch-core ，版本是 4.1.2.RELEASE 。分别对应的是基础框架层和核心层。

添加内存数据库H2 Spring Batch 是需要数据库来存储任务的基本信息以及运行状态的，本例中不需要操作数据库逻辑，直接使用内存数据库H2即可。添加以下依赖：

<dependency>
	<groupId>com.h2database</groupId>
	<artifactId>h2</artifactId>
</dependency>
复制代码

添加测试及工具类依赖为了简化开发，使用 lombok 进行处理。使用 Spring Boot 进行单元测试，添加依赖如下：

<!-- 工具包：lombok -->
<dependency>
	<groupId>org.projectlombok</groupId>
	<artifactId>lombok</artifactId>
	<version>1.18.6</version>
</dependency>
<!-- 测试框架 -->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-test</artifactId>
	<scope>test</scope>
</dependency>
复制代码

3.2.3 开发读数据组件ItemReader

添加完依赖后，就可以进入业务逻辑编程了。按 Spring Batch 的批处理流程，读数据 ItemReader 是第一步，当前示例中，我们的任务是从数组中读取数据。 ItemReader 是一个接口，开发人员直接实现此接口即可。此接口定义了核心方法 read() ，负责从给定的资源中读取可用的数据。具体实现如下：

@Slf4j
public class StringReader implements ItemReader<String> {
    private String[] messages = {"aaa1","aaa2","aaa3","aaa4"};
    private int count = 0;
    @Override
    public String read() throws UnexpectedInputException, ParseException, NonTransientResourceException {
        if(count < messages.length){
            String message = messages[count++];
            log.debug(LogConstants.LOG_TAG + "read data:"+message);
            return message;
        }else{
            log.debug(LogConstants.LOG_TAG + "read data end.");
            count = 0;
        }
        return null;
    }
}
复制代码

说明：

@Slf4j

3.2.4 开发处理数据组件ItemProcessor

读取数据后，返回的数据会流到 ItemProcessor 进行处理。同样， ItemProcessor 是一个接口，要实现自己的处理逻辑，实现此接口即可。当然，如果没有 ItemProcessor ，读到的数据直接就到 ItemWriter 流程也是可以的。此处， Spring Batch 有一个 Chunk 的概念，用于多次读，直到chunk指定的数量后，再统一给到processor和writer，以提高效率。本示例对于 ItemProcessor 的实现很简单，即把字符串转为大写。如下：

@Slf4j
public class ConvertProcessor implements ItemProcessor<String,String> {
    @Autowired
    private ConsoleService consoleService;
    @Override
    public String process(String data) {
        String dataProcessed = consoleService.convert2UpperCase(data);
        log.debug(LogConstants.LOG_TAG + data +" process data --> " + dataProcessed);
        return dataProcessed;
    }
}
复制代码

说明：

toUpperCase()

3.2.5 开发写数据组件ItemWriter

数据处理完后，会统一交给写组件( ItemWriter )进行写入。 ItemWriter 也是一个接口，核心方法是 write 方法，参数是数组。要实现自己的逻辑，实现此接口即可。本示例中，直接把数据输出到日志中即可。如下：

@Slf4j
public class ConsoleWriter implements ItemWriter<String> {
    @Override
    public void write(List<? extends String> list) {
        for (String msg :list) {
            log.debug(LogConstants.LOG_TAG + "write data: "+msg);
        }
    }
}
复制代码

3.2.6 开发任务完成后的监听器JobExecutionListener

数据写入到目标后，任务即结束，但有时候我们还需要在任务结束时去做一些其它工作，如清理数据，更新时间等，则需要在任务完成后进行逻辑处理。 Spring Batch 对于任务或步骤开始和结束都会提供监听，以便于开发人员实现监听逻辑。如通过继承 JobExecutionListenerSupport ，可以实现 beforeJob 和 afterJob 的监听，以实现开始任务前和结束任务后的处理。当前示例中，仅输出任务完成的日志。如下：

@Slf4j
public class ConsoleJobEndListener extends JobExecutionListenerSupport {
    @Override
    public void afterJob(JobExecution jobExecution) {
        if(jobExecution.getStatus() == BatchStatus.COMPLETED){
            log.debug("console batch job complete!");
        }
    }
}
复制代码

3.2.7 配置完整任务

经过上面的读、处理、写、任务完成后监听的操作，现在需要把它们组装在一起，形成一个完成的任务，使用 Spring Boot ，简单的使用几个配置即可完成任务的组装。任务及其相关组件的关系如下：

创建配置文件 ConsoleBatchConfig.java ，具体代码如下：

@Configuration
@EnableBatchProcessing
public class ConsoleBatchConfig {
    @Autowired
    public JobBuilderFactory jobBuilderFactory;
    @Autowired
    public StepBuilderFactory stepBuilderFactory;

    @Bean
    public Job consoleJob(Step consoleStep,JobExecutionListener consoleListener){
        String funcName = Thread.currentThread().getStackTrace()[1].getMethodName();
        return jobBuilderFactory.get(funcName).listener(consoleListener).flow(consoleStep)
                .end().build();
    }

    @Bean
    public Step consoleStep(ItemReader stringReader,ItemProcessor convertProcessor
            ,ItemWriter consoleWriter, CommonStepListener commonStepListener){
        String funcName = Thread.currentThread().getStackTrace()[1].getMethodName();
        return stepBuilderFactory.get(funcName).listener(commonStepListener)
                .<String,String>chunk(3).reader(stringReader).processor(convertProcessor)
                .writer(consoleWriter).build();
    }

    @Bean
    public ItemReader stringReader(){return new StringReader();}

    @Bean
    public ItemWriter consoleWriter(){return new ConsoleWriter();}

    @Bean
    public ItemProcessor convertProcessor(){return new ConvertProcessor();}

    @Bean
    public JobExecutionListener consoleListener(){return new ConsoleJobEndListener();}
}
复制代码

说明：

添加注解 @Configuration及 和 @EnableBatchProcessing ，标识为配置及启用 Spring Batch 的配置（可以直接使用 JobBuilderFactory 及 StepBuilderFactory 分别用于创建Job和Step）。
创建 ItemReader 、 ItemWriter 、 ItemProcessor 、 Listener 对应的 Bean ，以供Step及Job的注入。
使用 stepBuilderFactory 创建作业Step，其中chunk进行面向块的处理，即多次读取后再写入，提高效率。当前配置是3个为一个chunk。
使用 jobBuilderFactory 添加step，创建任务。
注意step和Job都需要有对应的名称( get 方法确定)，此处直接使用方法名作为Job和Step的名称。

3.2.8 测试批处理

经过上面的步骤，已经完成Job的开发，测试则可使用两种方式，一个是编写 Controller ，以接口调用的方式运行job，一种编写单元测试。

Job的运行通过 JobLauncher 的 run 方法来运行任务， run 方法参数分别是 Job 和 jobParameters ，即已配置的Job及job运行的参数。每个任务的区分是通过任务名（ jobName ）和任务参数（ jobParameters ）作为区别的，即如果 jobName 和 jobParameters 相同， Spring Batch 会认为是同一任务，若任务已运行成功，同一任务不会再运行。因此，一般来说，不同的任务，我们的 jobParameters 可以直接以时间作为参数，以便于区别。生成 jobParameters 。代码如下：

JobParameters jobParameters = new JobParametersBuilder()
                .addLong("time",System.currentTimeMillis())
                .toJobParameters();
复制代码

编写单元测试编写 ConsoleJobTest ，加载job，运行测试，如下所示：

@RunWith(SpringRunner.class)
@SpringBootTest(classes = {MainBootApplication.class,ConsoleBatchConfig.class})
@Slf4j
public class ConsoleJobTest {
    @Autowired
    private JobLauncher jobLauncher;

    @Autowired
    private Job consoleJob;

    public void testConsoleJob2() throws JobParametersInvalidException, JobExecutionAlreadyRunningException, JobRestartException, JobInstanceAlreadyCompleteException {
        //构建参数
        JobParameters jobParameters = new JobParametersBuilder()
                .addLong("time",System.currentTimeMillis())
                .toJobParameters();
        //执行任务
        JobExecution run = jobLauncher.run(consoleJob, jobParameters);
        ExitStatus exitStatus = run.getExitStatus();
        log.debug(exitStatus.toString());
    }
}
复制代码

说明：引入 SpringBootTest 注解时，需要把 Spring Batch 任务也引入进来。

执行结果输出执行结果如下图所示：

从输出可知，由于设置的 chunk 是3，读取3个数据后，就统一给 ItemProcessor 进行大写转换处理，然后统一交给 ItemWriter 进行写入。执行完成后，Job的exitCode表示任务执行的状态，如果正常则为 COMPLETED ，失败则为 FAILED 。