当前位置：首页 > news >正文

Spring Batch

news 来源：原创 2024/9/20 0:54:47

Spring Batch

请添加图片描述
Job instance(作业实例)
当作业运行时，会创建一个Job Instance(作业实例)，它代表作业的一次逻辑运行，可通过作业名称与作业标识参数进行区分。
比如一个业务需求：每天定期数据同步，作业名称-daily-sync-job 作业标记参数-当天时间
Job Execution(作业执行对象)
当作业运行时，也会创建一个Job Execution(作业执行器)，负责记录Job执行情况(比如：开始执行时间，结束时间，处理状态等)。

Job Instance = Job名称 + 识别参数
Job Instance 一次执行创建一个 Job Execution对象
完整的一次Job Instance 执行可能创建一个Job Execution对象，也可能创建多个Job Execution对象

入门案例-H2版

导入依赖

<parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.7.3</version><relativePath/>
</parent>
<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-batch</artifactId></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId></dependency><!--内存版--><dependency><groupId>com.h2database</groupId><artifactId>h2</artifactId><scope>runtime</scope></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId></dependency></dependencies>

测试方法

//之前使用@Component导致jobParameters获取失败
@Configuration
public class JobDemo1 {//作业启动器@Autowiredprivate JobLauncher jobLauncher;//Job构造工厂（构建job对象）@Autowiredprivate JobBuilderFactory jobBuilderFactory;//step构造工厂（构建step对象）@Autowiredprivate StepBuilderFactory stepBuilderFactory;//构造一个step对象执行的任务@Beanpublic Tasklet tasklet(){return new Tasklet() {@Overridepublic RepeatStatus execute(StepContribution stepContribution, ChunkContext chunkContext) throws Exception {//要执行逻辑  step步骤执行逻辑System.out.println("hello spring batch");return RepeatStatus.FINISHED;}};}//构造一个step对象@Beanpublic Step step1(){//tasklet指step执行逻辑return stepBuilderFactory.get("step1").tasklet(tasklet()).build();}//构造job对象//start(step1).next(step2)@Beanpublic Job job(){return jobBuilderFactory.get("hello-job").start(step1()).build();}
}

启动类

//启动springBatch
@EnableBatchProcessing
@SpringBootApplication
public class SpringbootApplication {public static void main(String[] args) {SpringApplication.run(SpringbootApplication.class, args);}
}

入门案例-MySQL版

依赖

 <!-- <dependency><groupId>com.h2database</groupId><artifactId>h2</artifactId><scope>runtime</scope>
</dependency> --><dependency><groupId>org.mariadb.jdbc</groupId><artifactId>mariadb-java-client</artifactId><version>2.7.2</version>
</dependency>

application-dev.yaml
此处测试时并没有自动创建表

server:port: 8896spring:datasource:username: rootpassword: rooturl: jdbc:mariadb://ip地址:3306/springbatch?serverTimezone=GMT%2B8&useSSL=false&allowPublicKeyRetrieval=truedriver-class-name: org.mariadb.jdbc.Driver# 初始化数据库，文件在依赖jar包中sql:init:schema-locations: classpath:org/springframework/batch/core/schema-mysql.sql#mode: alwaysmode: never

其余代码与H2版本相同

作业参数获取

在application中设置program arguments比如，name=zs
方案1：使用ChunkContext类
方案2：使用@Value 延时获取

//之前使用@Component导致jobParameters获取失败
@Configuration
public class JobDemo1 {//作业启动器@Autowiredprivate JobLauncher jobLauncher;//Job构造工厂（构建job对象）@Autowiredprivate JobBuilderFactory jobBuilderFactory;//step构造工厂（构建step对象）@Autowiredprivate StepBuilderFactory stepBuilderFactory;//构造一个step对象执行的任务@Beanpublic Tasklet tasklet(){return new Tasklet() {@Overridepublic RepeatStatus execute(StepContribution stepContribution, ChunkContext chunkContext) throws Exception {//方案1：使用ChunkContext类获取参数Map<String, Object> jobParameters = chunkContext.getStepContext().getJobParameters();System.out.println("job param name's value is "+jobParameters.get("name"));System.out.println("hello spring batch");return RepeatStatus.FINISHED;}};}//构造一个step对象执行的任务//@StepScope在启动项目的时候，不加载该Step步骤bean，等step1()被调用时才加载。这就是所谓延时获取@StepScope@Bean/方案2：使用@Value 延时获取public Tasklet tasklet2(@Value("#{jobParameters['name']}")String name){return new Tasklet() {@Overridepublic RepeatStatus execute(StepContribution stepContribution, ChunkContext chunkContext) throws Exception {//获取参数中设置的param的valueSystem.out.println("tasklet2: params---name is " + name);return RepeatStatus.FINISHED;}};}//构造一个step对象@Beanpublic Step step1(){//tasklet指step执行逻辑return stepBuilderFactory.get("step1").tasklet(tasklet()).build();}//构造一个step对象@Beanpublic Step step2(){//tasklet指step执行逻辑return stepBuilderFactory.get("step2").tasklet(tasklet2(null)).build();}//构造job对象//start(step1).next(step2)@Beanpublic Job job(){return jobBuilderFactory.get("param-job12").start(step1()).next(step2()).build();}
}

作业参数校验

定制参数校验器
JobParametersInvalidException 异常是Spring Batch 专门提供参数校验失败异常

public class NameParamValidator implements JobParametersValidator {@Overridepublic void validate(JobParameters parameters) throws JobParametersInvalidException {String name = parameters.getString("name");if(!StringUtils.hasText(name)){throw new JobParametersInvalidException("name 参数不能为空");}}
}

validator()实例方法，将定制的参数解析器加到Spring容器中，修改job()实例方法，加上.validator(validator()) 校验逻辑。

//之前使用@Component导致jobParameters获取失败
@Configuration
public class JobDemo2 {//作业启动器@Autowiredprivate JobLauncher jobLauncher;//Job构造工厂（构建job对象）@Autowiredprivate JobBuilderFactory jobBuilderFactory;//step构造工厂（构建step对象）@Autowiredprivate StepBuilderFactory stepBuilderFactory;//构造一个step对象执行的任务@Beanpublic Tasklet tasklet(){return new Tasklet() {@Overridepublic RepeatStatus execute(StepContribution stepContribution, ChunkContext chunkContext) throws Exception {//使用ChunkContext类获取参数Map<String, Object> jobParameters = chunkContext.getStepContext().getJobParameters();System.out.println("job param name's value is "+jobParameters.get("name"));System.out.println("hello spring batch");return RepeatStatus.FINISHED;}};}//构造一个step对象@Beanpublic Step step1(){//tasklet指step执行逻辑return stepBuilderFactory.get("step1").tasklet(tasklet()).build();}//注入自定义校验器@Beanpublic NameParamValidator nameParamValidator(){return new NameParamValidator();}//构造job对象//start(step1).next(step2)@Beanpublic Job job(){return jobBuilderFactory.get("param-valid").start(step1()).validator(nameParamValidator())//参数校验器.build();}
}