Spring Batch 作业对象-作业参数校验

已于 2023-02-01 15:48:24 修改
阅读量1.1k 收藏 2
点赞数
分类专栏： Spring Batch 极简入门 文章标签： spring boot java springbatch job 参数校验
于 2022-12-13 21:53:07 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/langfeiyes/article/details/128308518
版权

目录

引言

作业参数校验

定制参数校验器

默认参数校验器

组合参数校验器

转视频版

引言

接着上篇：Spring Batch 批处理-作业参数设置与获取，了解作业参数设置与获取后，本篇就来了解一下Spirng Batch 作业参数的校验。

作业参数校验

当外部传入的参数进入步骤处理时，我们需要确保参数符合期望。比如：web项目客户端发起请求带上参数来启动批处理，那为保证项目的健壮性需要对参数进行校验。那Spring Batch 的参数该如何进行校验呢？这时就得引入：JobParametersValidator 接口。

先来看下JobParametersValidator 接口源码：

public interface JobParametersValidator {
	void validate(@Nullable JobParameters parameters) throws JobParametersInvalidException;
}

JobParametersValidator 接口有且仅有唯一的validate方法，参数为JobParameters，没有返回值。这就要求进行参数校验时，如果不符合参数要求，需要抛出异常来结束步骤。

定制参数校验器

Spring Batch 提供JobParametersValidator参数校验接口，其目的就是让我们通过实现接口方式定制参数校验逻辑。

需求：如果步骤中 参数 name 为null 是报错

public class NameParamValidator  implements JobParametersValidator {
    @Override
    public void validate(JobParameters parameters) throws JobParametersInvalidException {
        String name = parameters.getString("name");

        if(!StringUtils.hasText(name)){
            throw new JobParametersInvalidException("name 参数不能为空");
        }
    }
}

其中的JobParametersInvalidException 异常是Spring Batch 专门提供参数校验失败异常，当然我们也可以自定义或使用其他异常。

package com.langfeiyes.batch._03_param_validator;

import org.springframework.batch.core.Job;
import org.springframework.batch.core.Step;
import org.springframework.batch.core.StepContribution;
import org.springframework.batch.core.configuration.annotation.EnableBatchProcessing;
import org.springframework.batch.core.configuration.annotation.JobBuilderFactory;
import org.springframework.batch.core.configuration.annotation.StepBuilderFactory;
import org.springframework.batch.core.configuration.annotation.StepScope;
import org.springframework.batch.core.scope.context.ChunkContext;
import org.springframework.batch.core.step.tasklet.Tasklet;
import org.springframework.batch.repeat.RepeatStatus;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

import java.util.Map;

@SpringBootApplication
@EnableBatchProcessing
public class ParamValidatorJob {
    @Autowired
    private JobBuilderFactory jobBuilderFactory;
    @Autowired
    private StepBuilderFactory stepBuilderFactory;

    @Bean
    public Tasklet tasklet(){
        return new Tasklet() {
            @Override
            public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
                Map<String, Object> parameters = chunkContext.getStepContext().getJobParameters();
                System.out.println("params---name:" + parameters.get("name"));
                return RepeatStatus.FINISHED;
            }
        };
    }

    @Bean
    public Step  step1(){
        return  stepBuilderFactory.get("step1")
                .tasklet(tasklet())
                .build();
    }

    //配置name参数校验器
    @Bean
    public NameParamValidator validator(){
        return new NameParamValidator();
    }

    @Bean
    public Job job(){
        return jobBuilderFactory.get("name-param-validator-job")
                .start(step1())
                .validator(validator())  //参数校验器
                .build();
    }
    public static void main(String[] args) {
        SpringApplication.run(ParamValidatorJob.class, args);
    }
}

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

第一次启动时，没有传任何参数

String name = parameters.getString("name");

name为null，直接报错

默认参数校验器

除去上面的定制参数校验器外，Spring Batch 也提供2个默认参数校验器：DefaultJobParametersValidator(默认参数解析器) 跟 CompositeJobParametersValidator(组合参数解析器)。

DefaultJobParametersValidator参数校验器

public class DefaultJobParametersValidator implements JobParametersValidator, InitializingBean {
	private Collection<String> requiredKeys;
	private Collection<String> optionalKeys;
    ....
}

默认的参数校验器它功能相对简单，维护2个key集合requiredKeys 跟 optionalKeys

  • requiredKeys 是一个集合，表示步骤参数jobParameters中必须包含集合中指定的keys

  • optionalKeys 也是一个集合，该集合中的key 是可选参数

需求：如果步骤参数没有name参数报错，age参数可有可无

package com.langfeiyes.batch._03_param_validator;

import org.springframework.batch.core.Job;
import org.springframework.batch.core.Step;
import org.springframework.batch.core.StepContribution;
import org.springframework.batch.core.configuration.annotation.EnableBatchProcessing;
import org.springframework.batch.core.configuration.annotation.JobBuilderFactory;
import org.springframework.batch.core.configuration.annotation.StepBuilderFactory;
import org.springframework.batch.core.configuration.annotation.StepScope;
import org.springframework.batch.core.job.DefaultJobParametersValidator;
import org.springframework.batch.core.scope.context.ChunkContext;
import org.springframework.batch.core.step.tasklet.Tasklet;
import org.springframework.batch.repeat.RepeatStatus;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

import java.util.Map;

@SpringBootApplication
@EnableBatchProcessing
public class ParamValidatorJob {
    @Autowired
    private JobBuilderFactory jobBuilderFactory;
    @Autowired
    private StepBuilderFactory stepBuilderFactory;

    @Bean
    public Tasklet tasklet(){
        return new Tasklet() {
            @Override
            public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
                Map<String, Object> parameters = chunkContext.getStepContext().getJobParameters();
                System.out.println("params---name:" + parameters.get("name"));
                System.out.println("params---age:" + parameters.get("age"));
                return RepeatStatus.FINISHED;
            }
        };
    }

    @Bean
    public Step  step1(){
        return  stepBuilderFactory.get("step1")
                .tasklet(tasklet())
                .build();
    }

    //配置name参数校验器
    @Bean
    public NameParamValidator validator(){
        return new NameParamValidator();
    }

     //配置默认参数校验器
    @Bean
    public DefaultJobParametersValidator defaultValidator(){
        DefaultJobParametersValidator defaultValidator = new DefaultJobParametersValidator();
        defaultValidator.setRequiredKeys(new String[]{"name"});  //必填
        defaultValidator.setOptionalKeys(new String[]{"age"});   //可选
        return defaultValidator;
    }

    @Bean
    public Job job(){
        return jobBuilderFactory.get("default-param-validator-job")
                .start(step1())
                //.validator(validator())  //参数校验器
                .validator(defaultValidator())  //默认参数校验器
                .build();
    }
    public static void main(String[] args) {
        SpringApplication.run(ParamValidatorJob.class, args);
    }
}

新定义defaultValidator() 实例方法，将默认参数解析器加到Spring容器中，修改job实例方法，加上.validator(defaultValidator())。

右键启动，不填name 跟 age 参数，直接报错

 如果填上name参数，即使不填age参数，可以通过，原因是age是可选的。

组合参数校验器

CompositeJobParametersValidator 组合参数校验器，顾名思义就是将多个参数校验器组合在一起。

看源码，大体能看出该校验器逻辑

public class CompositeJobParametersValidator implements JobParametersValidator, InitializingBean {

	private List<JobParametersValidator> validators;

	@Override
	public void validate(@Nullable JobParameters parameters) throws JobParametersInvalidException {
		for (JobParametersValidator validator : validators) {
			validator.validate(parameters);
		}
	}
	
	public void setValidators(List<JobParametersValidator> validators) {
		this.validators = validators;
	}

	@Override
	public void afterPropertiesSet() throws Exception {
		Assert.notNull(validators, "The 'validators' may not be null");
		Assert.notEmpty(validators, "The 'validators' may not be empty");
	}
}

底层维护一个validators 集合，校验时调用validate 方法，依次执行校验器集合中校验器方法。另外，多了一个afterPropertiesSet方法，用于校验validators 集合中的校验器是否为null。

需求：要求步骤中必须有name属性，并且不能为空

分析：必须有，使用DefaultJobParametersValidator 参数校验器， 不能为null，使用指定定义的NameParamValidator参数校验器

package com.langfeiyes.batch._03_param_validator;

import org.springframework.batch.core.Job;
import org.springframework.batch.core.Step;
import org.springframework.batch.core.StepContribution;
import org.springframework.batch.core.configuration.annotation.EnableBatchProcessing;
import org.springframework.batch.core.configuration.annotation.JobBuilderFactory;
import org.springframework.batch.core.configuration.annotation.StepBuilderFactory;
import org.springframework.batch.core.configuration.annotation.StepScope;
import org.springframework.batch.core.job.CompositeJobParametersValidator;
import org.springframework.batch.core.job.DefaultJobParametersValidator;
import org.springframework.batch.core.scope.context.ChunkContext;
import org.springframework.batch.core.step.tasklet.Tasklet;
import org.springframework.batch.repeat.RepeatStatus;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

import java.util.Arrays;
import java.util.Map;

@SpringBootApplication
@EnableBatchProcessing
public class ParamValidatorJob {
    @Autowired
    private JobBuilderFactory jobBuilderFactory;
    @Autowired
    private StepBuilderFactory stepBuilderFactory;

    @Bean
    public Tasklet tasklet(){
        return new Tasklet() {
            @Override
            public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
                Map<String, Object> parameters = chunkContext.getStepContext().getJobParameters();
                System.out.println("params---name:" + parameters.get("name"));
                System.out.println("params---age:" + parameters.get("age"));
                return RepeatStatus.FINISHED;
            }
        };
    }

    @Bean
    public Step  step1(){
        return  stepBuilderFactory.get("step1")
                .tasklet(tasklet())
                .build();
    }

    //配置name参数校验器
    @Bean
    public NameParamValidator validator(){
        return new NameParamValidator();
    }

     //配置默认参数校验器
    @Bean
    public DefaultJobParametersValidator defaultValidator(){
        DefaultJobParametersValidator defaultValidator = new DefaultJobParametersValidator();
        defaultValidator.setRequiredKeys(new String[]{"name"});  //必填
        defaultValidator.setOptionalKeys(new String[]{"age"});   //可选
        return defaultValidator;
    }

    //配置组合参数校验器
    @Bean
    public CompositeJobParametersValidator compositeValidator(){

        DefaultJobParametersValidator defaultValidator = new DefaultJobParametersValidator();
        defaultValidator.setRequiredKeys(new String[]{"name"});  //name必填
        defaultValidator.setOptionalKeys(new String[]{"age"});   //age可选

        NameParamValidator nameParamValidator = new NameParamValidator();  //name 不能为空

        CompositeJobParametersValidator compositeValidator = new CompositeJobParametersValidator();
        //按照传入的顺序，先执行defaultValidator 后执行nameParamValidator
        compositeValidator.setValidators(Arrays.asList(defaultValidator, nameParamValidator));

        try {
            compositeValidator.afterPropertiesSet();  //判断校验器是否为null
        } catch (Exception e) {
            e.printStackTrace();
        }

        return compositeValidator;
    }

    @Bean
    public Job job(){
        return jobBuilderFactory.get("composite-param-validator-job")
                .start(step1())
                //.validator(validator())  //参数校验器
                //.validator(defaultValidator())  //默认参数校验器
                .validator(compositeValidator())  //组合参数校验器
                .build();
    }
    public static void main(String[] args) {
        SpringApplication.run(ParamValidatorJob.class, args);
    }
}

新定义compositeValidator() 实例方法，将组合参数解析器加到spring容器中，修改job()实例方法，加上.validator(compositeValidator())。

右键启动，不填name参数，测试报错。如果放开name参数，传null值，一样报错。

到这，本篇就结束了，欲知后事如何，请听下回分解~

转视频版

看文字不过瘾可以切换视频版：Spring Batch高效批处理框架实战

浪飞yes
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
spring-batch-admin-1.3.0.RELEASE
01-16
spring-batch-admin-1.3.0.RELEASE，很多小朋友找不到 ，所以上传下
spring batch批处理框架使用
weixin_43081541的博客
06-09 1369
使用场景 一个典型的批处理程序通常： 从数据库、文件或队列中读取大量记录。 以某种方式处理数据。 以修改后的形式写回数据。 Spring Batch 自动化了这个基本的批处理迭代，提供了将类似事务作为一组处理的能力，通常是在离线环境中，无需任何用户交互。批处理作业是大多数 IT 项目的一部分，Spring Batch 是唯一提供强大的企业级解决方案的开源框架。 业务场景 定期提交批处理 并发批处理：一个作业的并行处理 分阶段的企业消息驱动处理 大规模并行批处理 失败后手动或计划重启 相关步骤的顺序处理（扩展
SpringBatch从入门到实战(三)：作业参数
人不风流枉少年
06-16 1411
自定义作业参数校验器，实现接口，当不满足条件时抛出异常。通过设置校验器。throw new JobParametersInvalidException("timestamp参数错误");} } }
还在为参数校验发愁？spring-validation最佳实践指南
伍六七
07-29 409
最近线上接口受到白帽子攻击，由于后端接口没有严格地进行参数校验，从而导致了系统程序异常和线上脏数据的问题。为了项目中参数校验方式的统一，因此在项目中引入了spring-validation作为后端接口参数校验方式。本文主要介绍了spring-validation在项目中最佳实践方案，希望能帮助大家很快很好的使用spring-validation。 实体命名方式推荐 在Spring项目组中，会存在有很多实体类，良好的命名方式能十分有效的理清项目的整体划分。下面分别介绍entity、DTO、VO实体类命名方式推
Spring Batch 作业对象-作业增量参数
langfeiyes的博客
12-15 1215
那如果想每次启动，又不想改动标识参数跟作业名怎么办呢？答案是：使用JobParametersIncrementer (作业参数增量器)
Spring Batch之Job Parameters校验（五）
qq_21370419的博客
11-11 1356
Spring Batch框架提供了Job作业参数的校验功能，可以让开发者决定哪些参数是必须的，哪些参数是可选的。开发者可以自定义实现参数校验器，这需要实现接口：org.springframework.batch.core.JobParametersValidator,也可以使用框架已经提供的校验组件类。 框架提供的校验组件类： CompositeJobParametersValidator DefaultJobParametersValidator 项目实现举例： 1.项目框架 ...
SpringBatch之JobParameter
weixin_43374749的博客
10-20 788
SpringBatch之JobParameterJobParameter1.1 设置 JobParameter1.1 ItemReader, ItemWriter, ItemProcessor中读取JobParameter中的参数，1.1.1 注解方式获取（1） 使用 @BeforeStep，如下示例（2） @Value直接注入1.1.2 xml配置方式获取 JobParameter 1.1 设置 JobParameter obLauncher.run(job, new JobParametersBuil
SpringBatch学习
YinXin的博客
02-26 697
什么是SpringBatch Spring Batch 是一个轻量级的、完善的批处理框架（并不是调度框架，需要配合Quartz等框架，实现定时任务）,旨在帮助企业建立健壮、高效的批处理应用。 Spring Batch 提供了大量可重用的组件,包括了日志、追踪、事务、任务作业统计、任务重启、跳过、重复、资源管理。对于大数据量和高性能的批处理任务,Spring Batch 同样提供了高级功能和特性来支...
Spring Batch 作业对象-作业参数设置与获取
langfeiyes的博客
12-13 2759
来，一起看下作业参数是啥一回事，同时又该怎么设置参数并获取参数的。
Spring batch学习 详细配置解读(3)
weixin_34413065的博客
08-21 132
第一篇讲到普通job 配置 那么spring batch 给我们提供了丰富的配置，包括定时任务，校验，复合监听器，父类，重启机制等。 下面看一个动态设置读取文件的配置 1.动态文件读取 <?xml version="1.0" encoding="UTF-8"?> <bean:b...
spring-batch-excel
05-10
Spring-Batch-Excel
spring-batch-accessDb-to-mongodb
06-07
spring-batch-accessDb Spring 批处理库，用于读取 Microsoft Access 数据库并将数据存储到 MongoDB。 作者：阿图尔·拜拉克
spring-batch-admin-ui:Spring Batch管理员是一个最初采用spring boot 2，spring security，oauth2，Spring data jpa作为基础框架，集成了quartz提供调度能力，集成了Spring Batch提供批处理能力的管理系统。展示以及常见批处理的配置以及运行能力
03-11
初始化数据库：找到目录：/ spring-batch-admin-backend / src / main / db，里面有两个文件，一个是数据库创建脚本，一个是表结构+数据的脚本，先执行创建库的，如果想在已经存在的库里面运行程序，可以省略这一步...
spring-batch包
08-21
spring-batch4.0.0 batch spring-batch集成 spring-batch.jar
实现spring boot 应用开机自启动之systemd service
04-23 419
centos下实现java 应用为systemd service运行，主要目的是显现开机自启动，并可以支持stop、restart功能。
快速构建Spring boot项目
Fxdll的博客
04-22 511
2、运行4、开发环境热部署查看目前已有的依赖。
# 使用 spring boot 时，@Autowired 注解 自动装配注入时，变量报红解决方法：
最新发布
段子手168的博客
04-29 112
# 使用 spring boot 时，@Autowired 注解 自动装配注入时，变量报红解决方法：
spring boot的项目+nginx,怎么预防点击劫持(clicekJacking)
keyboard专栏
04-23 577
通过这些措施，你可以在Spring Boot和Nginx层面有效防御点击劫持攻击。综合使用这些技术能够确保你的应用不仅安全，还能适应各种不同的部署环境和安全需求。这样的配置不仅增加了安全性，也提高了应用的健壮性。
spring的CacheManager
weixin_42594143的博客
04-26 445
上述代码中，我们通过@Cacheable注解将getUserById方法标记为需要缓存的方法，并指定缓存名称为"myCache"。当该方法被调用时，如果缓存中已经存在对应的结果，则直接返回缓存中的数据，否则执行方法体并将结果存入缓存中。需要注意的是，@Cacheable注解默认使用方法的参数作为缓存的key，因此在使用时需要保证参数的唯一性。在使用缓存的地方，可以通过@Cacheable注解来标记需要缓存的方法，并指定缓存名称。上述代码中，我们使用了用户对象的id属性作为缓存key，以保证缓存的唯一性。
SpringBatch集成mybatis-plus
06-03
要在Spring Batch项目中集成Mybatis-Plus，需要进行以下步骤： 1. 添加Mybatis-Plus依赖：在pom.xml文件中添加Mybatis-Plus的依赖。 ```xml <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

浪飞yes

我对钱没兴趣~

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值